-
Notifications
You must be signed in to change notification settings - Fork 2
Update README.md and **/package.json files to prepare for open-source release
#14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e89518c
Update package.json files : name, keywords & version
data-douser 1c77535
Update esbuild dev dependency to latest
data-douser 06a2c9f
Update license field in package.json files to reference LICENSE file …
Copilot 3ac8658
Update README.md
data-douser 6c36474
Fix unzip command syntax in release installation docs (#16)
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,139 @@ | ||
| # CodeQL Development MCP Server | ||
|
|
||
| A comprehensive Model Context Protocol (MCP) server designed specifically for agentic AI development of CodeQL (QL) code. This server provides tools and resources to help AI assistants write, validate, and optimize CodeQL queries for security analysis and code quality. | ||
| > Enabling AI-assisted CodeQL query development through the Model Context Protocol | ||
|
|
||
| ## Quick Start | ||
| A comprehensive [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server designed specifically for agentic AI development of CodeQL (QL) code. This server provides tools, prompts, and resources to help AI assistants write, validate, and optimize CodeQL queries for security analysis and code quality. | ||
|
|
||
| For users who want to quickly get started with the MCP server: | ||
| ## Features | ||
|
|
||
| ### Download and Install | ||
| - **Comprehensive Tool Suite** - Wraps CodeQL CLI commands for query compilation, execution, testing, and database operations | ||
| - **Multi-Language Support** - Supports CodeQL query development for 9 languages including Python, JavaScript, Java, C/C++, and more | ||
| - **AI-Optimized Prompts** - Built-in prompts and resources that guide AI assistants through CodeQL development workflows | ||
| - **Test-Driven Development** - Integrated testing tools for validating query accuracy with expected results | ||
| - **Flexible Transport** - Supports both stdio and HTTP transport modes for different integration scenarios | ||
|
|
||
| 1. Download the latest release from [GitHub Releases](https://github.com/advanced-security/codeql-development-mcp-server/releases) | ||
| 2. Extract the archive: | ||
| ## Limitations | ||
|
|
||
| - Requires CodeQL CLI to be installed separately | ||
| - Performance depends on the size of CodeQL databases being analyzed | ||
| - Some advanced CodeQL CLI features may not yet be exposed as tools | ||
|
|
||
| ## Project Status | ||
|
|
||
| **Active Development** - This project is actively maintained and used in production environments for AI-assisted CodeQL development. | ||
|
|
||
| ```bash | ||
| tar -xzvf codeql-development-mcp-server-vX.X.X.tar.gz -C /path/to/destination | ||
| ``` | ||
| ## Background | ||
|
|
||
| 3. Configure VS Code by adding to your `mcp.json`: | ||
| The `codeql-development-mcp-server` project is maintained by GitHub's CodeQL Expert Services team and builds (and hopefully improves) on the concepts from the [`advanced-security/codeql-development-template`](https://github.com/advanced-security/codeql-development-template) repository template. | ||
|
|
||
| ```json | ||
| { | ||
| "servers": { | ||
| "codeql-dev-mcp-server": { | ||
| "command": "node", | ||
| "args": ["/path/to/destination/server/dist/ql-mcp-server.js"], | ||
| "type": "stdio" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
| The main advantages of using the `codeql-development-mcp-server` are: | ||
|
|
||
| ## Contributing | ||
| 1. **Agnostic of development environment** | ||
| 2. **Agnostic of calling Large Language Model (LLM)** | ||
| 3. **MCP server tools codify advanced CodeQL development practices** | ||
|
|
||
| We welcome contributions to this project! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines on how to contribute. | ||
| ### Roadmap | ||
|
|
||
| Development priorities and open issues are tracked in [GitHub Issues](https://github.com/advanced-security/codeql-development-mcp-server/issues). | ||
|
|
||
| ### Contributing | ||
|
|
||
| We welcome contributions! Whether it's bug fixes, new features, documentation improvements, or additional language support, please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. | ||
|
|
||
| Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. | ||
|
|
||
| ## Requirements | ||
|
|
||
| ### Environment | ||
|
|
||
| - **Node.js** v25.2.1 or later ([nodejs.org](https://nodejs.org/)) | ||
| - **Some calling LLM** Bring your own LLM, but some LLMs are (much) better than others. | ||
|
|
||
| ### External Dependencies | ||
|
|
||
| - **CodeQL CLI** - Must be installed and available in PATH ([github.com/github/codeql-cli-binaries](https://github.com/github/codeql-cli-binaries/releases)) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| ### Download and Install | ||
|
|
||
| 1. Download the latest release from [GitHub Releases](https://github.com/advanced-security/codeql-development-mcp-server/releases) | ||
| 2. Extract the archive: | ||
|
|
||
| ```bash | ||
| unzip codeql-development-mcp-server-vX.X.X.zip -C /path/to/destination | ||
| ``` | ||
|
|
||
| ### VS Code Configuration | ||
|
|
||
| Add to your `mcp.json` file: | ||
|
|
||
| | OS | Location | | ||
| | ------- | -------------------------------------------------- | | ||
| | Linux | `~/.config/Code/User/mcp.json` | | ||
| | macOS | `~/Library/Application Support/Code/User/mcp.json` | | ||
| | Windows | `%APPDATA%\Code\User\mcp.json` | | ||
|
|
||
| ```json | ||
| { | ||
| "servers": { | ||
| "codeql-dev-mcp-server": { | ||
| "command": "node", | ||
| "args": ["/path/to/destination/server/dist/ql-mcp-server.js"], | ||
| "type": "stdio" | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Installing from Source | ||
|
|
||
| ```bash | ||
| git clone https://github.com/advanced-security/codeql-development-mcp-server.git | ||
| cd codeql-development-mcp-server | ||
| npm install && npm run build | ||
| ``` | ||
|
|
||
| ### 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 | ||
|
|
||
| ## Supported Languages | ||
|
|
||
| | Language | CodeQL Identifier | | ||
| | --------------------- | ----------------- | | ||
| | GitHub Actions | `actions` | | ||
| | C/C++ | `cpp` | | ||
| | C# | `csharp` | | ||
| | Go | `go` | | ||
| | Java/Kotlin | `java` | | ||
| | JavaScript/TypeScript | `javascript` | | ||
| | Python | `python` | | ||
| | Ruby | `ruby` | | ||
| | Swift | `swift` | | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [Getting Started Guide](docs/getting-started.md) - Installation and setup instructions | ||
| - [Tools Reference](docs/tools-reference.md) - Complete list of available MCP tools | ||
| - [Getting Started Guide](docs/getting-started.md) - Detailed installation and setup instructions | ||
| - [Tools Reference](docs/tools-reference.md) - Complete list of available MCP tools and usage examples | ||
|
|
||
| ## License | ||
|
|
||
| See [LICENSE.md](LICENSE.md) for license terms. | ||
| This project is licensed under the terms of the GitHub CodeQL Terms and Conditions. Please refer to [LICENSE](LICENSE) for the full terms. | ||
|
|
||
| ## Maintainers | ||
|
|
||
| This repository is maintained by the team specified in [CODEOWNERS](CODEOWNERS). | ||
|
|
||
| ## Support | ||
|
|
||
| This project uses GitHub issues to track bugs and feature requests. Please search existing issues before filing new ones to avoid duplicates. | ||
|
|
||
| This project comes with no expectation or guarantee of support, with more details in the [SUPPORT.md](SUPPORT.md) document. | ||
|
|
||
| ## Acknowledgement | ||
|
|
||
| This project builds upon the [CodeQL CLI](https://github.com/github/codeql-cli-binaries) and the broader [CodeQL ecosystem](https://codeql.github.com/) developed by GitHub. Special thanks to the GitHub Advanced Security team and the open-source community for their contributions. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.