Skip to content

getting-started.md

Latest commit

 

History

History
72 lines (52 loc) · 2.18 KB

getting-started.md

File metadata and controls

72 lines (52 loc) · 2.18 KB

Getting Started

This guide covers installation, configuration, and usage of the CodeQL Development MCP Server.

Prerequisites

Installation

From GitHub Releases

  1. Download the latest release from Releases
  2. Extract: unzip codeql-development-mcp-server-vX.X.X.zip -d /path/to/destination

From Source

git clone --recurse-submodules https://github.com/advanced-security/codeql-development-mcp-server.git
cd codeql-development-mcp-server
npm install && npm run build

VS Code Configuration

Add to your mcp.json file:

OS Location
macOS ~/Library/Application Support/Code/User/mcp.json
Windows %APPDATA%\Code\User\mcp.json
Linux ~/.config/Code/User/mcp.json 
{
  "servers": {
    "codeql-dev-mcp-server": {
      "command": "node",
      "args": ["/path/to/destination/server/dist/ql-mcp-server.js"],
      "type": "stdio"
    }
  }
}

Environment Variables

Variable Description Default
TRANSPORT_MODE stdio or http stdio
PORT HTTP port 3000
DEBUG Enable debug logging false
CODEQL_PATH Path to CodeQL CLI (PATH)

Verification

  1. Restart VS Code
  2. Open Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  3. Run "GitHub Copilot: List MCP Servers"
  4. Confirm codeql-dev-mcp-server appears

Troubleshooting

  • Server not listed: Verify absolute path in mcp.json, restart VS Code
  • CodeQL errors: Run codeql --version to confirm CLI is installed
  • Permission denied: Check file permissions on server directory

Next Steps