feat: extract parameter descriptions from function docstrings#1979
Open
heath-hunnicutt-ruach-tov wants to merge 1 commit intomodelcontextprotocol:mainfrom
Conversation
Parse Google, NumPy, and Sphinx-style docstrings to automatically populate parameter descriptions in tool/prompt/resource JSON schemas. Previously, parameter descriptions required explicit Field(description=...) annotations. Now they can come from standard docstrings, with Field() annotations taking precedence when both are present. Closes modelcontextprotocol#226 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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
Field(description=...)annotations; now they can come from standard docstringsField(description=...)annotations take precedence when both are present, ensuring full backward compatibilityCloses #226
Changes
src/mcp/server/mcpserver/utilities/docstring_utils.py— docstring parsing utility usinggriffewith auto-detection of Google/NumPy/Sphinx formatsfunc_metadata()accepts optionalparam_descriptionsdict, injected as fallback when noField(description=...)existsTool.from_function(),Prompt.from_function(),ResourceTemplate.from_function()— parse docstrings and pass results throughpyproject.toml— addedgriffe>=1.0as runtime dependencyTest plan
test_docstring_utils.pytests passtest_parameter_descriptions.pytests pass (1 existing + 7 new)🤖 Generated with Claude Code