modelcontextprotocol / modelcontextprotocol/python-sdk
Replace Field(description=...) with proper docstrings in auth models
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 24.3k
- Forks
- 4k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 31
Description
From the V2 checklist in #1253 (under "Refactor the auth way of using it"):
Drop the use of
Field(description=...), and use proper docstrings. As far as I know, we are not creating json schemas from it, so it's useless.
The auth-related Pydantic models currently use Field(description=...) to document fields. Since we are not generating JSON schemas from these models, the descriptions are not surfaced anywhere useful. They should be replaced with standard Python docstrings that are more discoverable via IDEs and help().
This is part of the broader auth refactor planned for V2.
Ref: Kludex's V2 checklist in #1253
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the auth-related Pydantic models that use Field(description=...), then review the V2 checklist in #1253 for intended scope. Replace those field descriptions with standard Python docstrings and verify that all targeted auth models no longer use this documentation pattern.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- authentication
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100