Skip to content

[v1.x] Add a v2 status banner to the README#2835

Merged
maxisbey merged 1 commit into
v1.xfrom
v1x-v2-status-banner
Jun 11, 2026
Merged

[v1.x] Add a v2 status banner to the README#2835
maxisbey merged 1 commit into
v1.xfrom
v1x-v2-status-banner

Conversation

@maxisbey

Copy link
Copy Markdown
Contributor

Adds a short banner to the v1.x README announcing the v2 alpha.

Motivation and Context

v2 pre-releases are about to be published to PyPI as 2.0.0aN. This branch's README is both the repository documentation for the stable line and the PyPI project description for every stable release, so it is the highest-traffic place to tell users three things: v2 is coming and is currently in alpha, installers will not give anyone a pre-release without an explicit opt-in, and packages that depend on mcp should add a <2 upper bound before the stable v2 release lands. It also states v1.x's maintenance-mode status.

The banner uses plain blockquote markup and absolute URLs so it renders correctly on PyPI (no GitHub-only alert syntax, no relative links).

A companion PR on main (#2834) updates that branch's README banner to match.

How Has This Been Tested?

markdownlint and pre-commit pass; docs-only change.

Breaking Changes

None.

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 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

AI Disclaimer

States that v2 is in alpha with pre-releases published to PyPI as
2.0.0aN, that installers never select a pre-release without an explicit
opt-in, that packages depending on mcp should add a <2 upper bound
before the stable v2 release, and that v1.x is in maintenance mode and
remains recommended for production. This README is also the PyPI
project description for stable releases, so the banner uses absolute
links and plain blockquote markup.
@maxisbey maxisbey marked this pull request as ready for review June 11, 2026 08:22
@maxisbey maxisbey merged commit 52258a9 into v1.x Jun 11, 2026
47 of 48 checks passed
@maxisbey maxisbey deleted the v1x-v2-status-banner branch June 11, 2026 08:39
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