Skip to content

Commit a3726de

Browse files
committed
Update README.md for attribution / alternatives
1 parent 4952354 commit a3726de

1 file changed

Lines changed: 32 additions & 26 deletions

File tree

README.md

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,40 @@ A comprehensive [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
1212
- **Test-Driven Development** - Integrated testing tools for validating query accuracy with expected results
1313
- **Flexible Transport** - Supports both stdio and HTTP transport modes for different integration scenarios
1414

15+
## Supported Code Languages
16+
17+
| Language | CodeQL Identifier |
18+
| --------------------- | ----------------- |
19+
| GitHub Actions | `actions` |
20+
| C/C++ | `cpp` |
21+
| C# | `csharp` |
22+
| Go | `go` |
23+
| Java/Kotlin | `java` |
24+
| JavaScript/TypeScript | `javascript` |
25+
| Python | `python` |
26+
| Ruby | `ruby` |
27+
| Swift | `swift` |
28+
1529
## Limitations
1630

17-
- Requires CodeQL CLI to be installed separately
18-
- Performance depends on the size of CodeQL databases being analyzed
19-
- Some advanced CodeQL CLI features may not yet be exposed as tools
31+
- Requires matching version of the CodeQL CLI to be installed separately.
32+
- Only a subset of CodeQL CLI features are exposed as tools.
33+
- Performance depends on the size of CodeQL databases being analyzed.
34+
35+
## Alternative CodeQL MCP Servers
36+
37+
This project is partially inspired by [`JordyZomer/codeql-mcp`](https://github.com/JordyZomer/codeql-mcp) -- which remains a great alternative to `codeql-development-mcp-server`.
38+
39+
Another alternative is the [CodeQL MCP server bundled with GitHubSecurityLab/seclab-taskflow-agent](https://github.com/GitHubSecurityLab/seclab-taskflow-agent/tree/main/src/seclab_taskflow_agent/mcp_servers/codeql). The `CallGraphFrom` and `CallGraphTo` queries provided by this repository were inspired by the [`GitHubSecurityLab/seclab-taskflow-agent`](https://github.com/GitHubSecurityLab/seclab-taskflow-agent).
40+
41+
## Documentation
42+
43+
- [Public Installation Guide](docs/public.md) - Install and run without cloning the repository
44+
- [Getting Started Guide](docs/getting-started.md) - Detailed installation and setup instructions
45+
- [Tools Reference](docs/ql-mcp/tools.md) - Complete list of available MCP tools
46+
- [Prompts Reference](docs/ql-mcp/prompts.md) - MCP prompts for CodeQL development workflows
47+
- [Resources Reference](docs/ql-mcp/resources.md) - MCP resources for CodeQL learning and reference
48+
- [Testing Strategy](docs/testing.md) - Multi-layer testing approach
2049

2150
## Project Status
2251

@@ -120,29 +149,6 @@ npm install && npm run build
120149
3. Run "GitHub Copilot: List MCP Servers"
121150
4. Confirm `ql-mcp` appears
122151

123-
## Supported Languages
124-
125-
| Language | CodeQL Identifier |
126-
| --------------------- | ----------------- |
127-
| GitHub Actions | `actions` |
128-
| C/C++ | `cpp` |
129-
| C# | `csharp` |
130-
| Go | `go` |
131-
| Java/Kotlin | `java` |
132-
| JavaScript/TypeScript | `javascript` |
133-
| Python | `python` |
134-
| Ruby | `ruby` |
135-
| Swift | `swift` |
136-
137-
## Documentation
138-
139-
- [Public Installation Guide](docs/public.md) - Install and run without cloning the repository
140-
- [Getting Started Guide](docs/getting-started.md) - Detailed installation and setup instructions
141-
- [Tools Reference](docs/ql-mcp/tools.md) - Complete list of available MCP tools
142-
- [Prompts Reference](docs/ql-mcp/prompts.md) - MCP prompts for CodeQL development workflows
143-
- [Resources Reference](docs/ql-mcp/resources.md) - MCP resources for CodeQL learning and reference
144-
- [Testing Strategy](docs/testing.md) - Multi-layer testing approach
145-
146152
## License
147153

148154
This project is licensed under the terms of the GitHub CodeQL Terms and Conditions. Please refer to [LICENSE](LICENSE) for the full terms.

0 commit comments

Comments
 (0)