Commit 78149b5
committed
fix: revert README to v1.x documentation on main branch
The main branch README currently documents v2 (pre-alpha), which
confuses users who land on the repo expecting stable v1.x docs.
This moves the v2 README content to README.v2.md and replaces
the main README with v1.x-appropriate documentation that uses
FastMCP (the v1.x API) instead of MCPServer (the v2 API).
Key changes:
- README.md now documents v1.x with FastMCP imports/usage
- README.v2.md preserves the full v2/MCPServer documentation
- CI, pre-commit, and snippet tooling updated to target README.v2.md
- Code snippets in README.md use v1.x field names (e.g.,
structuredContent, inputSchema, uriTemplate)
- pyproject.toml ruff exclude updated for README.v2.md
Both READMEs include TODO(v2) comments marking where to swap
back when v2 is released.
Github-Issue: #19701 parent b38716e commit 78149b5
File tree
7 files changed
+2761
-188
lines changed- .github/workflows
- scripts
- tests
7 files changed
+2761
-188
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
83 | | - | |
| 83 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | | - | |
| 45 | + | |
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | | - | |
| 62 | + | |
63 | 63 | | |
0 commit comments