Restructure docs: replace tools-reference.md with ql-mcp/ primitives docs and add testing strategy#33
Merged
data-douser merged 3 commits intomainfrom Feb 9, 2026
Conversation
…sting.md - Remove docs/tools-reference.md - Add docs/ql-mcp/tools.md (34 always-on + 11 optional monitoring tools) - Add docs/ql-mcp/prompts.md (10 prompts with categories) - Add docs/ql-mcp/resources.md (4 static + per-language resources) - Add docs/testing.md (3-layer testing strategy overview) - Update README.md, getting-started.md, public.md to link to new docs Co-authored-by: data-douser <70299490+data-douser@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve documentation for codeql-development-mcp-server
Restructure docs: replace tools-reference.md with ql-mcp/ primitives docs and add testing strategy
Feb 9, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures the documentation for the CodeQL Development MCP Server by replacing the single, monolithic tools reference with per-primitive docs under docs/ql-mcp/, and adding a user-facing testing strategy overview.
Changes:
- Removed
docs/tools-reference.mdand introduced per-primitive reference docs:docs/ql-mcp/tools.md,docs/ql-mcp/prompts.md,docs/ql-mcp/resources.md. - Added
docs/testing.mddescribing the unit → integration → agentic validation testing layers. - Updated top-level docs to link to the new
docs/ql-mcp/*.mdpages.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tools-reference.md | Removes legacy monolithic tools reference (superseded by docs/ql-mcp/tools.md). |
| docs/testing.md | Adds a testing strategy overview (unit/integration/agentic validation). |
| docs/ql-mcp/tools.md | New categorized tables documenting always-on tools and optional monitoring tools. |
| docs/ql-mcp/resources.md | New reference for static and language-scoped MCP resources and their URIs. |
| docs/ql-mcp/prompts.md | New reference for workflow prompts and their categories. |
| docs/public.md | Updates “Further Reading” links to new ql-mcp docs. |
| docs/getting-started.md | Updates “Next Steps” links to new ql-mcp docs. |
| README.md | Updates documentation links to new ql-mcp docs and adds testing strategy link. |
Comments suppressed due to low confidence (1)
docs/getting-started.md:110
- PR description mentions adding links to the new testing strategy docs from
docs/getting-started.md, but the “Next Steps” list only links to tools/prompts/resources. Either add a../testing.mdlink here (or wherever appropriate) or update the PR description to match.
## Next Steps
- [Tools Reference](./ql-mcp/tools.md) - Available MCP tools
- [Prompts Reference](./ql-mcp/prompts.md) - MCP prompts for CodeQL workflows
- [Resources Reference](./ql-mcp/resources.md) - MCP resources for CodeQL learning
Collaborator
|
@copilot apply changes based on the comments in this thread |
Address review comment: distinguish file-based tests (which diff before/ to after/) from monitoring-based tests (which generally do not diff after/ contents).
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.
Replaces the monolithic
docs/tools-reference.mdwith per-primitive documentation underdocs/ql-mcp/and adds a testing strategy overview.New files
docs/ql-mcp/tools.md— 34 always-on tools (CLI, LSP, query development) + 11 optional monitoring tools, organized in categorized tablesdocs/ql-mcp/prompts.md— All 10 MCP prompts with summary table and category breakdown (TDD, code understanding, documentation, workshops)docs/ql-mcp/resources.md— 4 static resources + per-language resource availability matrix (AST, security, dataflow, etc.)docs/testing.md— Three-layer testing strategy: unit tests → integration tests → agentic validationRemoved
docs/tools-reference.md— Superseded bydocs/ql-mcp/tools.mdUpdated links
README.md,docs/getting-started.md,docs/public.md— Point to newdocs/ql-mcp/*.mdpaths; added links to prompts, resources, and testing docsRelease workflow
No changes needed —
cp -r docs/*inrelease.ymlalready handles subdirectories.Original prompt
docs/**/*.mdforcodeql-development-mcp-server#32💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.