Skip to content

[STESOL-596] Remove sysreport instructions tool and route guidance through knowledge search - #166

Open
sairamvarmabudharaju wants to merge 6 commits into
arm:mainfrom
sairamvarmabudharaju:sysreport-knowledge-search-routing
Open

[STESOL-596] Remove sysreport instructions tool and route guidance through knowledge search#166
sairamvarmabudharaju wants to merge 6 commits into
arm:mainfrom
sairamvarmabudharaju:sysreport-knowledge-search-routing

Conversation

@sairamvarmabudharaju

Copy link
Copy Markdown
Collaborator

Summary

  • Remove the sysreport_instructions MCP tool and its registrations, schemas, tests, examples, and documentation references.
  • Route Sysreport and host diagnostic questions through knowledge_base_search.
  • Add the concise Sysreport routing hint to the knowledge-search description.
  • Improve retrieval metadata and add representative Sysreport evaluation questions.
  • Preserve detailed guidance in the existing Sysreport Learning Path.

Validation

  • Confirmed the server no longer exposes sysreport_instructions.
  • Verified representative prompts call knowledge_base_search.
  • Verified results include the existing Sysreport Learning Path URLs.
  • Embedding tests: 61 passed.
  • MCP tests: 36 passed.
  • Build/provenance contract tests: 39 passed.

Copilot AI lite review requested due to automatic review settings August 27, 2026 17:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_instructions tool 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.

Comment on lines 51 to 54
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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants