modelcontextprotocol / modelcontextprotocol/python-sdk
docs: no guidance for supporting SDK 1.x and 2.x at the same time
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 24.3k
- Forks
- 4k
- Merge medio
- 1 d 1 h
- PR fusionados (30 d)
- 31
Descripción
Problem
docs/migration.md is a one-way guide: it tells you what to change once you move to 2.x. It has no guidance for the case where you cannot hard-cut, which is the situation of anyone maintaining a published MCP server or library while the ecosystem is split across both majors.
Concretely: the day 2.0.0 shipped, fresh installs of our published servers started resolving mcp==2.0.0 and crashed at import (ModuleNotFoundError: No module named 'mcp.server.fastmcp'), while existing users were still on 1.x. The realistic fix for a package author in that window is not "migrate", it is "support both majors for a transition period". I could not find a recipe for that anywhere in docs/.
What we ended up doing
Running in production since late July on two registry-listed servers (data-profiler-mcp, acb-tax-mcp):
try:
# MCP SDK 2.x: FastMCP was renamed to MCPServer and the module moved.
from mcp.server.mcpserver import MCPServer as FastMCP
except ImportError:
# MCP SDK 1.x keeps the original path.
from mcp.server.fastmcp import FastMCP
together with:
- a dependency pin of
mcp>=1.2.0,<3so installs may resolve either major, and - a dedicated CI job that force-installs
"mcp>=1.2.0,<2"and re-runs the test suite, so the 1.x fallback path stays tested while the main matrix resolves 2.x.
For code that stays on the FastMCP-level API surface (constructor, @mcp.tool(), run()), this has been sufficient: both lines pass the same test suite unchanged.
Proposal
A short section, roughly "Supporting 1.x and 2.x during the transition", covering:
- the import shim above,
- dependency-pin guidance (
mcp>=1.2.0,<3, and why an upper bound of<2alone strands your users), - testing both lines in CI (one extra pinned job is enough), and
- a sentence on when to drop the 1.x path.
I would keep it to roughly 40 to 60 lines.
Scoping questions before I write anything
- #3183 is trimming
migration.mddown to genuine breaking changes, so this may not belong there. Would you rather see it as a short section inmigration.md, or as a separate small docs page (e.g.docs/compatibility.md)? - If the answer is "we deliberately do not want to encourage dual-major support", that is a fair position; happy to close.
If maintainers think it is worth having, I will send the PR.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Lee docs/migration.md y revisa el issue #3183 para comprender el alcance previsto de la documentación de migración. Después, determina si las instrucciones deben estar allí o en docs/compatibility.md, cubriendo el import shim propuesto, los límites de dependencias, la cobertura de CI para ambas versiones principales y cuándo eliminar la ruta 1.x; la tarea estará terminada cuando el procedimiento de transición esté documentado con claridad.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- Medio día
- Estado de actividad
- Activo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 62/100