modelcontextprotocol / modelcontextprotocol/python-sdk
Replace Field(description=...) with proper docstrings in auth models
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 24.3k
- フォーク
- 4k
- 平均マージ
- 1日 1時間
- マージ済み PR(30日)
- 31
説明
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
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、Field(description=...) を使用している auth 関連の Pydantic モデルを見つけ、次に想定されている対象範囲を確認するために #1253 の V2 チェックリストを確認します。これらのフィールド説明を標準的な Python docstring に置き換え、対象となるすべての auth モデルがこのドキュメントパターンを使用しなくなっていることを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- authentication
- issue の種類
- リファクタリング
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 52/100