modelcontextprotocol / modelcontextprotocol/python-sdk
docs: no guidance for supporting SDK 1.x and 2.x at the same time
还没有人认领这个 Issue。
- 主要语言
- Python
- 星标
- 24.3k
- 派生
- 4k
- 平均合并
- 1 天 1 小时
- 30 天内合并 PR
- 31
描述
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.
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
阅读 docs/migration.md 并审阅 issue #3183,以了解计划中的迁移文档范围。然后确定这些指导应放在那里还是放在 docs/compatibility.md 中,并涵盖提议的 import shim、依赖项边界、两个主版本的 CI 覆盖范围,以及何时移除 1.x 路径;当迁移方案得到清晰记录时,即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 半天
- 活跃度
- 活跃
- 描述清晰度
- 基本清楚
- 新手友好度
- 62/100