|
6 | 6 |
|
7 | 7 | The server exposes **38 default tools** and **11 opt-in monitoring tools**. Default tools are registered on startup; monitoring tools require explicit opt-in (see [Monitoring and Reporting](../mcp-server-monitoring-and-reporting.md)). Users control which tools are enabled in their MCP client configuration. |
8 | 8 |
|
9 | | -## Default Tools |
10 | | - |
11 | | -### CodeQL CLI Tools |
12 | | - |
13 | | -| Tool | Description | |
14 | | -| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | |
15 | | -| `codeql_bqrs_decode` | Decode BQRS result files to human-readable formats (text, csv, json). Supports `--result-set`, `--rows` for pagination | |
16 | | -| `codeql_bqrs_info` | Get metadata about BQRS result files: result sets, column types, row counts. Supports `--format=json` and pagination offsets | |
17 | | -| `codeql_bqrs_interpret` | Interpret BQRS result files according to query metadata and generate output in specified formats (CSV, SARIF, graph formats) | |
18 | | -| `codeql_database_analyze` | Run queries or query suites against CodeQL databases. Produces evaluator logs, BQRS, and SARIF output | |
19 | | -| `codeql_database_create` | Create a CodeQL database from source code | |
20 | | -| `codeql_generate_log-summary` | Create a summary of a structured JSON evaluator event log file | |
21 | | -| `codeql_generate_query-help` | Generate query help documentation from QLDoc comments | |
22 | | -| `codeql_pack_install` | Install CodeQL pack dependencies | |
23 | | -| `codeql_pack_ls` | List CodeQL packs under some local directory path | |
24 | | -| `codeql_query_compile` | Compile and validate CodeQL queries | |
25 | | -| `codeql_query_format` | Automatically format CodeQL source code files | |
26 | | -| `codeql_query_run` | Execute a CodeQL query against a database | |
27 | | -| `codeql_resolve_database` | Resolve database path and validate database structure | |
28 | | -| `codeql_resolve_languages` | List installed CodeQL extractor packs | |
29 | | -| `codeql_resolve_library-path` | Resolve library path for CodeQL queries and libraries | |
30 | | -| `codeql_resolve_metadata` | Resolve and return the key-value metadata pairs from a CodeQL query source file | |
31 | | -| `codeql_resolve_qlref` | Resolve qlref files to their corresponding query files | |
32 | | -| `codeql_resolve_queries` | List available CodeQL queries found on the local filesystem | |
33 | | -| `codeql_resolve_tests` | Resolve the local filesystem paths of unit tests and/or queries under some base directory | |
34 | | -| `codeql_test_accept` | Accept new test results as the expected baseline | |
35 | | -| `codeql_test_extract` | Extract test databases for CodeQL query tests | |
36 | | -| `codeql_test_run` | Run CodeQL query tests | |
| 9 | +> **Authoritative reference**: The MCP-served resource at `codeql://server/tools` ([`server/src/resources/server-tools.md`](../../server/src/resources/server-tools.md)) is the canonical documentation for default tools. Update that file when adding, removing, or changing any default tool. |
37 | 10 |
|
38 | | -### Language Server Protocol (LSP) Tools |
39 | | - |
40 | | -| Tool | Description | |
41 | | -| ------------------------ | ----------------------------------------------------------------------------------------------- | |
42 | | -| `codeql_lsp_completion` | Get code completions at a cursor position in a CodeQL file | |
43 | | -| `codeql_lsp_definition` | Go to the definition of a CodeQL symbol at a given position | |
44 | | -| `codeql_lsp_diagnostics` | Authoritative syntax and semantic validation of CodeQL (QL) code via the CodeQL Language Server | |
45 | | -| `codeql_lsp_references` | Find all references to a CodeQL symbol at a given position | |
46 | | - |
47 | | -### Query Development Tools |
| 11 | +## Default Tools |
48 | 12 |
|
49 | | -| Tool | Description | |
50 | | -| -------------------------------- | ------------------------------------------------------------------------------------------------------------------ | |
51 | | -| `create_codeql_query` | Create directory structure and files for a new CodeQL query with tests | |
52 | | -| `find_class_position` | Find the start/end line and column of a class for quick evaluation | |
53 | | -| `find_codeql_query_files` | Find and track all files and directories related to a CodeQL query, including resolved metadata | |
54 | | -| `find_predicate_position` | Find the start/end line and column of a predicate for quick evaluation | |
55 | | -| `list_codeql_databases` | List CodeQL databases discovered in configured base directories (`CODEQL_DATABASES_BASE_DIRS`). Filter by language | |
56 | | -| `list_mrva_run_results` | List MRVA (Multi-Repository Variant Analysis) run results with per-repo details (`CODEQL_MRVA_RUN_RESULTS_DIRS`) | |
57 | | -| `list_query_run_results` | List query run result directories with artifact inventory. Filter by `queryName`, `language`, or `queryPath` | |
58 | | -| `profile_codeql_query` | Profile the performance of a CodeQL query run against a specific database by analyzing the evaluator log JSON file | |
59 | | -| `profile_codeql_query_from_logs` | Parse existing CodeQL evaluator logs into a performance profile without re-running the query | |
60 | | -| `quick_evaluate` | Quick evaluate either a class or a predicate in a CodeQL query for debugging | |
61 | | -| `register_database` | Register a CodeQL database given a local path to the database directory | |
62 | | -| `validate_codeql_query` | Quick heuristic validation for CodeQL query structure (does not compile the query) | |
| 13 | +For the complete default tools reference (CodeQL CLI tools, LSP tools, query development tools, common workflows, and input conventions), see [`server/src/resources/server-tools.md`](../../server/src/resources/server-tools.md). |
63 | 14 |
|
64 | 15 | ## Optional Monitoring Tools |
65 | 16 |
|
|
0 commit comments