Skip to content

Commit 1b02f68

Browse files
committed
Fix tidy and sync package-lock.json
1 parent 5003f24 commit 1b02f68

File tree

3 files changed

+29
-20
lines changed

3 files changed

+29
-20
lines changed

docs/ql-mcp/prompts.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ The server provides **11 prompts** that guide AI assistants through common CodeQ
88

99
## Prompt Reference
1010

11-
| Prompt | Description |
12-
| ------------------------------ | -------------------------------------------------------------------------------------------------------------------- |
13-
| `document_codeql_query` | Create or update documentation for a CodeQL query |
14-
| `explain_codeql_query` | Generate a detailed explanation of a CodeQL query for workshop learning content |
15-
| `ql_lsp_iterative_development` | Iterative CodeQL query development using LSP tools for completion, navigation, and validation |
16-
| `ql_tdd_advanced` | Advanced test-driven CodeQL development with AST visualization, control flow, and call graph analysis |
17-
| `ql_tdd_basic` | Test-driven CodeQL query development checklist — write tests first, implement query, iterate until tests pass |
11+
| Prompt | Description |
12+
| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
13+
| `document_codeql_query` | Create or update documentation for a CodeQL query |
14+
| `explain_codeql_query` | Generate a detailed explanation of a CodeQL query for workshop learning content |
15+
| `ql_lsp_iterative_development` | Iterative CodeQL query development using LSP tools for completion, navigation, and validation |
16+
| `ql_tdd_advanced` | Advanced test-driven CodeQL development with AST visualization, control flow, and call graph analysis |
17+
| `ql_tdd_basic` | Test-driven CodeQL query development checklist — write tests first, implement query, iterate until tests pass |
1818
| `run_query_and_summarize_false_positives` | Run a CodeQL query and summarize its false positives |
19-
| `sarif_rank_false_positives` | Analyze SARIF results to identify likely false positives in CodeQL query results |
20-
| `sarif_rank_true_positives` | Analyze SARIF results to identify likely true positives in CodeQL query results |
21-
| `test_driven_development` | Test-driven development workflow for CodeQL queries using MCP tools |
22-
| `tools_query_workflow` | Guide for using built-in tools queries (PrintAST, PrintCFG, CallGraphFrom, CallGraphTo) to understand code structure |
23-
| `workshop_creation_workflow` | Guide for creating CodeQL query development workshops from production-grade queries |
19+
| `sarif_rank_false_positives` | Analyze SARIF results to identify likely false positives in CodeQL query results |
20+
| `sarif_rank_true_positives` | Analyze SARIF results to identify likely true positives in CodeQL query results |
21+
| `test_driven_development` | Test-driven development workflow for CodeQL queries using MCP tools |
22+
| `tools_query_workflow` | Guide for using built-in tools queries (PrintAST, PrintCFG, CallGraphFrom, CallGraphTo) to understand code structure |
23+
| `workshop_creation_workflow` | Guide for creating CodeQL query development workshops from production-grade queries |
2424

2525
## Prompt Categories
2626

package-lock.json

Lines changed: 12 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

server/src/prompts/run-query-and-summarize-false-positives.prompt.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ Help a developer discover what kinds of false positives are produced by their cu
1212

1313
1. Read the provided CodeQL query to understand what patterns it is designed to detect.
1414
2. Discover the results of this query on a real database, by:
15-
- Running the tool `list_query_run_results` to find existing runs for this query
16-
- If no existing runs are found, run the query on a relevant database using `codeql_query_run` tool
15+
- Running the tool `list_query_run_results` to find existing runs for this query
16+
- If no existing runs are found, run the query on a relevant database using `codeql_query_run` tool
1717
3. Analyze and group the results into what appear to be similar types of results. This may mean:
18-
- Grouping results in the same file
19-
- Grouping results that reference the same elements
20-
- Grouping results with similar messages
18+
- Grouping results in the same file
19+
- Grouping results that reference the same elements
20+
- Grouping results with similar messages
2121
4. For each group, explore the actual code for a sample of alerts in that group, using the `read_database_source` tool to triage the results and determine which groups appear to be false positives
2222
5. For each false positive case discovered in this exploration, group them into categories of similar root causes. For example, a query might not properly account for unreachable code, or there may be a commonly used library that violates the query's assumptions but is actually safe.
2323
6. Explain these results to the user in order of most common to least common, so they can understand where their query may need improvement to reduce false positives.
@@ -77,7 +77,6 @@ The tool `read_database_source` can be used to read the code of a particular fin
7777
- **Mark uncertainty**: Use lower confidence scores when code snippets are missing
7878
- **Avoid false confidence**: If you cannot determine FP status, mark confidence as low
7979

80-
8180
## Output Format
8281

8382
Return a JSON array of ranked results, ordered by FP likelihood (highest first):

0 commit comments

Comments
 (0)