Skip to content

docs: remove v2 notice from top of README - #3604

Merged
maxisbey merged 1 commit into
mainfrom
claude/remove-v2-readme-notice
Sep 30, 2026
Merged

maxisbey merged 1 commit into
mainfrom
claude/remove-v2-readme-notice

Conversation

@claude

@claude claude Bot commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

Requested by Max Isbey · Slack thread

Removes the > [!NOTE] v2 callout that sits between the badge block and the "Documentation" section at the top of README.md.

Before: Immediately under the badges, a reader sees a three-paragraph > [!NOTE] callout beginning "This is v2 of the MCP Python SDK, the current stable release line. It is a major rework of the SDK…", followed by a "Not ready to migrate?" paragraph pointing at the v1.x branch and the mcp>=1.28,<2 pin advice, and a closing "Something rough, confusing, or broken?" line linking the v2-feedback issue template and the Discord channel.

After: The README opens directly with the title, tagline and badges, then goes straight into the "Documentation" section. Nothing else in the file changed (7 lines deleted, no additions).

v2 is released and is the stable line, so the "this is a rework" banner has served its purpose; a maintainer asked for it to go.

Note: the removed callout contained links (2026-07-28 spec, What's new in v2, migration guide, v1.x branch, v1 docs at py.sdk.modelcontextprotocol.io/v1/, v2-feedback issue template, Discord). They were removed together with the notice and not relocated. The "Documentation" section directly below still links What's new in v2 and the migration guide.

Motivation and Context

The v2 pre-release/rework notice at the top of the README is no longer needed now that v2 is the current stable release.

How Has This Been Tested?

  • uvx pre-commit run markdownlint --files README.md — Passed
  • uv sync --frozen --all-extras --dev then uv run --frozen python scripts/update_readme_snippets.py --check — "README.md code snippets are up to date"

Breaking Changes

None. Documentation only.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I am assigned to the linked issue (or it is labeled help wanted, or I'm a maintainer)
  • I have disclosed any AI assistance and can explain the change in my own words
  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

README.md is not generated from a template; only its code snippets are synced from docs_src/ by scripts/update_readme_snippets.py, so the file was edited directly.

🤖 Generated with Claude Code

https://claude.ai/code/session_01KRZ4537QQR9yexj3gZGcYu


Generated by Claude Code

The v2 rework banner at the top of README.md is no longer needed now that v2 is released.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KRZ4537QQR9yexj3gZGcYu

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, straightforward docs-only removal of the v2 callout from README.md.

What was reviewed:

  • Resulting markdown keeps a single blank line between </div> and ## Documentation, so markdownlint spacing is unaffected.
  • The mcp>=1.28,<2 pin advice and v1.x docs pointer still live in docs/whats-new.md (line 212) and docs/index.md (line 5), so the guidance is not lost from the published docs; README's Documentation section still links What's new in v2 and the migration guide.
  • No CODEOWNERS file covers the repo, and no other file references the removed callout text.
Extended reasoning...

The change deletes seven lines from README.md (the GitHub NOTE callout announcing v2, the v1.x branch pointer, and the <2 pin advice) and touches no code, tests, or other files. README.md doubles as the PyPI long_description, so the only user-visible effect is that PyPI readers lose the pin advice there; that guidance remains in docs/whats-new.md and docs/index.md. It touches no security-sensitive surface. The diff is tiny, mechanical, requested by a maintainer per the PR description, and leaves markdown structure intact, which decided approve.

@maxisbey
maxisbey enabled auto-merge (squash) September 30, 2026 21:14
@maxisbey
maxisbey merged commit d639cf7 into main Sep 30, 2026
35 checks passed
@maxisbey
maxisbey deleted the claude/remove-v2-readme-notice branch September 30, 2026 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants