Enhance prompts, resources, and tool descriptions based on real-world debugging session#294
Open
felickz wants to merge 2 commits into
Open
Enhance prompts, resources, and tool descriptions based on real-world debugging session#294felickz wants to merge 2 commits into
felickz wants to merge 2 commits into
Conversation
… debugging session - data-extension-development prompt: add troubleshooting table (compilation cache, CLI discovery, subtypes on stub types, missing chain hops, column count) and Phase 8 note about when to escalate to QL library changes - csharp_library_modeling resource: add subtypes flag section with caveat about library stub types (matches existing Java modeling resource pattern) - Tool descriptions: clarify register_database (session-scoped validation), codeql_bqrs_decode (array parameter), quick_evaluate (isolation scope) - ql-tdd-basic prompt: add compilation cache pitfall Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates MCP prompt/reference content and tool descriptions based on practical debugging learnings, aiming to make CodeQL modeling workflows and tool usage clearer for users of the CodeQL Development MCP Server.
Changes:
- Expanded prompt guidance for data-extension development and TDD, including troubleshooting and compilation-cache pitfalls.
- Added C# library modeling guidance for the
subtypesflag (with a caveat about stub/framework base types). - Refined several CodeQL tool parameter/behavior descriptions to reduce user confusion.
Show a summary per file
| File | Description |
|---|---|
| server/src/tools/codeql/register-database.ts | Updates register_database tool description to better communicate validation/usage scope. |
| server/src/tools/codeql/quick-evaluate.ts | Updates quick_evaluate tool description to clarify isolation/usage intent. |
| server/src/tools/codeql/bqrs-decode.ts | Clarifies that the files parameter is an array (even for a single BQRS). |
| server/src/resources/languages/csharp_library_modeling.md | Adds guidance and caveats for the subtypes flag in C# MaD tuples. |
| server/src/prompts/ql-tdd-basic.prompt.md | Adds a common pitfall about compilation cache masking data extension changes. |
| server/src/prompts/data-extension-development.prompt.md | Adds escalation guidance (“when data extensions aren’t enough”) and a troubleshooting table. |
Copilot's findings
- Files reviewed: 6/6 changed files
- Comments generated: 3
- register_database: remove 'in this session' claim — tool only validates, does not persist session state. Clarify it's a preflight check. - quick_evaluate: remove claim that it evaluates against the database — current implementation only resolves symbol position. Note that codeql_query_run should be used for full evaluation. - codeql_bqrs_decode: fix 'path(s)' to 'paths' per grammar feedback. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
from using MCP on this PR : github/codeql#21984