modelcontextprotocol / modelcontextprotocol/python-sdk
Replace Field(description=...) with proper docstrings in auth models
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 24.3k
- Fork
- 4k
- Merge medio
- 1g 1h
- PR unite (30g)
- 31
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando i modelli Pydantic relativi ad auth che usano Field(description=...), quindi esamina la checklist V2 in #1253 per l'ambito previsto. Sostituisci queste descrizioni dei campi con docstring Python standard e verifica che tutti i modelli auth interessati non utilizzino più questo modello di documentazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- authentication
- Tipo di issue
- Refactoring
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 52/100