fix: add docstring to MCP tool /md endpoint#1696
Closed
majiayu000 wants to merge 1 commit intounclecode:developfrom
Closed
fix: add docstring to MCP tool /md endpoint#1696majiayu000 wants to merge 1 commit intounclecode:developfrom
majiayu000 wants to merge 1 commit intounclecode:developfrom
Conversation
Fixes unclecode#1652 The get_markdown endpoint was missing a docstring, causing the MCP tool to have an empty description when listed. This made it difficult for LLMs to understand the tool's purpose. Added a descriptive docstring explaining the supported extraction modes (fit, raw, bm25, llm) and when to use this tool. Also added a unit test to verify MCP tool docstrings are present. Signed-off-by: majiayu000 <1835304752@qq.com>
Owner
|
Closing as duplicate of #1722. Thanks for the contribution. |
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.
Summary
Fixes #1652
The
get_markdownendpoint was missing a docstring, causing the MCP tool to have an empty description when listed vialist_tools(). This made it difficult for LLMs to understand the tool's purpose.List of files changed and why
deploy/docker/server.py- Added docstring toget_markdownfunction explaining the supported extraction modes (fit, raw, bm25, llm) and when to use this tooltests/unit/test_mcp_tool_docstrings.py- Added unit test using AST parsing to verify MCP tool docstrings are presentHow Has This Been Tested?
Checklist: