docs: enrich tool docstrings to provide workflow context#16
Merged
Conversation
Remove global MCP instructions and move guidance directly into tool docstrings. This ensures that clients like Claude Desktop, which ignore metadata-level instructions, still provide the LLM with the necessary context to use the tools effectively. The docstrings now include 'Tips' and 'Related tools' sections, forming a forward-pointing DAG to guide the LLM through Enapter workflows. Fixes #13
There was a problem hiding this comment.
Pull request overview
This PR moves workflow guidance from server-level MCP instructions metadata into individual tool docstrings so that MCP clients that ignore metadata-level instructions still receive operational context when calling tools.
Changes:
- Removed the global
INSTRUCTIONSblock previously passed tofastmcp.FastMCP. - Added richer, workflow-oriented docstrings (with “Tips” and “Related tools”) to the exposed tools:
search_sites,search_devices,read_blueprint,search_command_executions, andget_historical_telemetry. - Explicitly disables server-level instructions by passing
instructions=Nonewhen creating the FastMCP server.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Remove global MCP instructions and move guidance directly into tool docstrings. This ensures that clients like Claude Desktop, which ignore metadata-level instructions, still provide the LLM with the necessary context to use the tools effectively.
The docstrings now include 'Tips' and 'Related tools' sections, forming a forward-pointing DAG to guide the LLM through Enapter workflows.
Fixes #13