[STESOL-596] Remove sysreport instructions tool and route guidance through knowledge search - #166
Conversation
There was a problem hiding this comment.
Pull request overview
This PR removes the sysreport_instructions MCP tool end-to-end and shifts Sysreport/host-diagnostics guidance to flow through knowledge_base_search, while updating tests, runtime validation, and downstream agent prompt integrations accordingly.
Changes:
- Removed the
sysreport_instructionstool implementation and all remaining references in tests, docs, and integration prompts. - Updated MCP tests and the runtime egress validator to reflect the new tool set / JSON-RPC id sequence.
- Improved knowledge retrieval for Sysreport by enriching source metadata and adding representative evaluation questions.
Reviewed changes
Copilot reviewed 32 out of 32 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Removes the sysreport tool mention from the feature list. |
| mcp-local/tests/test_mcp.py | Drops the sysreport tool test and reindexes subsequent expected response ids. |
| mcp-local/tests/constants.py | Removes sysreport request/expected payload constants and reindexes request ids. |
| mcp-local/server.py | Deletes the sysreport_instructions tool and adds Sysreport routing hint to knowledge_base_search. |
| mcp-local/scripts/validate-runtime-egress.py | Removes sysreport flow from runtime validation and reindexes mca validation id. |
| embedding-generation/vector-db-sources.csv | Adds Sysreport-related retrieval tags/keywords to improve matching. |
| embedding-generation/eval_questions.json | Adds Sysreport-oriented evaluation questions and expected URLs. |
| CONTRIBUTING.md | Updates documentation of runtime-egress flow coverage to remove sysreport. |
| agent-integrations/windsurf/arm-vs-x86-performance-comparison.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/windsurf/arm-migration.md | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/windsurf/arm-hotspots-optimization.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/vs-code/arm-vs-x86-performance-comparison.prompt.md | Removes sysreport tool reference from tools list and guidance. |
| agent-integrations/vs-code/arm-migration.prompt.md | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/vs-code/arm-hotspots-optimization.prompt.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/vs-code/arm-full-optimization.prompt.md | Removes sysreport tool from tools list. |
| agent-integrations/vs-code/arm-enablement.prompt.md | Removes sysreport tool references from tools list and optional validation guidance. |
| agent-integrations/kiro/arm-vs-x86-performance-comparison.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/kiro/arm-migration.md | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/kiro/arm-hotspots-optimization.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/gemini/arm-vs-x86-performance-comparison.toml | Removes references to the removed tool from prompt guidance. |
| agent-integrations/gemini/arm-migration.toml | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/gemini/arm-hotspots-optimization.toml | Removes references to the removed tool from prompt guidance. |
| agent-integrations/cursor/arm-vs-x86-performance-comparison.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/cursor/arm-migration.md | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/cursor/arm-hotspots-optimization.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/codex/arm-vs-x86-performance-comparison.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/codex/arm-migration.md | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/codex/arm-hotspots-optimization.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/codex/arm-enablement/SKILL.md | Updates the skill instructions to remove sysreport_instructions. |
| agent-integrations/antigravity/arm-vs-x86-performance-comparison.md | Removes references to the removed tool from prompt guidance. |
| agent-integrations/antigravity/arm-migration.md | Updates the listed available tools to remove sysreport_instructions. |
| agent-integrations/antigravity/arm-hotspots-optimization.md | Removes references to the removed tool from prompt guidance. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
| Tool usage guidance: | ||
| * Use `arm-mcp/apx_recipe_run` for both x86 and Arm runs. | ||
| * Use `arm-mcp/sysreport_instructions` when machine metadata (CPU model, core count, frequency behavior, memory) is missing and needed for interpretation. | ||
| * Use `arm-mcp/knowledge_base_search` for architecture-specific guidance when explaining hotspot differences or next optimizations. | ||
| * Use `search/codebase` and `edit/editFiles` only if user asks for code-level optimization after the comparison. |
There was a problem hiding this comment.
This was removed intentionally because the knowledge_base_search description already handles routing for missing host details. Adding Sysreport guidance here could unnecessarily direct users to Sysreport when enough information is already available.
Summary
sysreport_instructionsMCP tool and its registrations, schemas, tests, examples, and documentation references.knowledge_base_search.Validation
sysreport_instructions.knowledge_base_search.