modelcontextprotocol / modelcontextprotocol/python-sdk

Replace Field(description=...) with proper docstrings in auth models

未關閉
#2,053 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

auth enhancement v2
主要語言
Python
星號
24.3k
分支
4k
平均合併
1 天 1 小時
30 天內合併 PR
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

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先找出使用 Field(description=...) 的 auth 相關 Pydantic 模型,接著檢視 #1253 中的 V2 檢查清單,以確認預定範圍。將這些欄位描述替換為標準 Python docstring,並確認所有目標 auth 模型不再使用此文件模式。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
authentication
Issue 類型
重構
難度
3/5
預估耗時
1-2 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
52/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。