fix: revert README to v1.x documentation on main#1971
Merged
Conversation
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
The reverted v1 README contains code blocks that don't pass ruff validation. Extend the existing README.v2.md exclusions to also cover README.md.
maxisbey
force-pushed
the
fix/readme-v1-revert
branch
from
e1a47f9 to
75bad91
Compare
Github-Issue: #1970
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
Code ReviewFound 1 issue: PR Description - CLAUDE.md ViolationThe PR description contains an AI Disclaimer link at the end: <sub>[AI Disclaimer](https://gist.github.com/maxisbey/6123d132484e4c533eab519a2800693d)</sub>This violates CLAUDE.md which explicitly states:
Recommendation: Remove the AI Disclaimer link from the PR description to comply with the project's documentation guidelines. Code changes review: No issues found in the actual code changes. All modifications are consistent with the stated goal of reverting README to v1.x documentation. |
Kludex
reviewed
Jan 29, 2026
Kludex
previously approved these changes
Jan 29, 2026
Kludex
reviewed
Jan 29, 2026
Kludex
approved these changes
Jan 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The main branch README documents v2 APIs (e.g.
MCPServer) that don't exist in the current stable v1.x release, causing confusion for users (see #1970).This reverts
README.mdto v1.x content and preserves the v2 docs asREADME.v2.md. CI, pre-commit, and snippet tooling are updated to targetREADME.v2.md.TODO(v2)markers are added throughout for easy swapping when v2 ships.Closes #1970
AI Disclaimer