Skip to content

Commit 78149b5

Browse files
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: #1970
1 parent b38716e commit 78149b5

File tree

7 files changed

+2761
-188
lines changed

7 files changed

+2761
-188
lines changed

.github/workflows/shared.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ jobs:
8080
run: uv sync --frozen --all-extras --python 3.10
8181

8282
- name: Check README snippets are up to date
83-
run: uv run --frozen scripts/update_readme_snippets.py --check
83+
run: uv run --frozen scripts/update_readme_snippets.py --check --readme README.v2.md

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ repos:
4242
types: [python]
4343
language: system
4444
pass_filenames: false
45-
exclude: ^README\.md$
45+
exclude: ^README\.v2\.md$
4646
- id: pyright
4747
name: pyright
4848
entry: uv run --frozen pyright
@@ -59,5 +59,5 @@ repos:
5959
name: Check README snippets are up to date
6060
entry: uv run --frozen python scripts/update_readme_snippets.py --check
6161
language: system
62-
files: ^(README\.md|examples/.*\.py|scripts/update_readme_snippets\.py)$
62+
files: ^(README\.v2\.md|examples/.*\.py|scripts/update_readme_snippets\.py)$
6363
pass_filenames: false

0 commit comments

Comments
 (0)