fix: Add docstring to MCP tool endpoint (#1652) #1713
Closed
Conversation
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
Fixes unclecode#1652 The MCP tool `md` endpoint was missing a docstring, which caused `inspect.getdoc()` in `_list_tools()` to return an empty description. This degraded the UX as LLMs rely on descriptions to understand tools. Added comprehensive docstring describing the tool's purpose and supported extraction modes. Co-Authored-By: Claude <[email protected]>
Fixes unclecode#1652 The `get_markdown` function in `deploy/docker/server.py` was missing a docstring, which caused the MCP tool description to be empty when listed via `list_tools()`. This degraded UX for LLMs and developers. Added comprehensive docstring describing the tool's purpose and supported extraction modes (fit, raw, bm25, llm). Co-Authored-By: Claude <[email protected]>
Author
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
🎯 Summary
Fixes #1652
📝 Description
The MCP tool
mdendpoint was missing a docstring, which causedinspect.getdoc()in_list_tools()to return an empty description. This degraded the UX as LLMs rely on descriptions to understand what tools do.🔧 Changes
get_markdown()function indeploy/docker/server.py✅ Verification
The
_list_tools()function inmcp_bridge.pyusesinspect.getdoc()to pull tool descriptions. With this docstring in place, themdtool will now have a proper description that LLMs can use to understand when and how to use this tool.📚 References
mdhas no description due to missing docstring #1652deploy/docker/mcp_bridge.py:116-124