modelcontextprotocol / modelcontextprotocol/python-sdk

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

Abierto
#2,053 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

auth enhancement v2
Lenguaje dominante
Python
Estrellas
24.3k
Forks
4k
Merge medio
1 d 1 h
PR fusionados (30 d)
31

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza localizando los modelos de Pydantic relacionados con auth que usan Field(description=...), y después revisa la lista de comprobación de V2 en #1253 para conocer el alcance previsto. Sustituye esas descripciones de campos por docstrings estándar de Python y verifica que ninguno de los modelos de auth incluidos siga usando este patrón de documentación.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
authentication
Tipo de issue
Refactorización
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
52/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.