Skip to content

Link the released 2026-07-28 spec and point migrators at /v1/ - #3214

Merged
maxisbey merged 2 commits into
mainfrom
docs/spec-link-and-v1-pointer
Jul 29, 2026
Merged

Link the released 2026-07-28 spec and point migrators at /v1/#3214
maxisbey merged 2 commits into
mainfrom
docs/spec-link-and-v1-pointer

Conversation

@maxisbey

Copy link
Copy Markdown
Contributor

Two small link fixes in the v2-facing docs.

Motivation and Context

The README banner linked the spec's release-candidate blog post; the 2026-07-28 specification is published now, so link it directly. The migration guide's "Need Help?" section also gets the same pointer to the v1.x maintenance-line docs (/v1/) that index.md and whats-new.md already carry.

How Has This Been Tested?

Link targets checked (spec URL returns 200).

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

The README banner still linked the spec's release-candidate blog post;
the specification is now published, so link it directly. Also give
the migration guide's help section the same pointer to the v1.x
maintenance-line docs that index.md and whats-new.md already carry.

No-Verification-Needed: doc-only change
@maxisbey
maxisbey marked this pull request as ready for review July 29, 2026 13:49
@github-actions

github-actions Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

📚 Documentation preview

Preview https://pr-3214.mcp-python-docs.pages.dev
Deployment https://42ab45eb.mcp-python-docs.pages.dev
Commit 058dc8f
Triggered by @maxisbey
Updated 2026-07-29 13:58:48 UTC

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 2 files

Re-trigger cubic

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM — two straightforward documentation link updates.

What was reviewed

  • README banner spec link: the new URL matches the canonical 2026-07-28 spec URL already used in the codebase (SPEC_2026_BASE_URL in tests/interaction/_requirements.py).
  • New migration-guide /v1/ pointer: consistent with the same link in docs/index.md and docs/whats-new.md, and its wording matches the maintenance-line policy in AGENTS.md.
Extended reasoning...

Overview

This PR changes two documentation files: README.md swaps the spec link in the v2 banner from the release-candidate blog post to the published 2026-07-28 specification page, and docs/migration.md appends a two-line pointer to the v1.x maintenance-line docs at /v1/ in the "Need Help?" section. No code, config, or build files are touched.

Security risks

None. The changes are Markdown-only link edits pointing at first-party domains (modelcontextprotocol.io and py.sdk.modelcontextprotocol.io) already referenced throughout the repository.

Level of scrutiny

Minimal scrutiny is appropriate: this is a docs-only PR with no behavioral impact. The main things worth verifying were link correctness and consistency, both of which check out — the new spec URL exactly matches SPEC_2026_BASE_URL (https://modelcontextprotocol.io/specification/2026-07-28) asserted in tests/interaction/test_coverage.py, and the /v1/ URL matches the identical links in docs/index.md and docs/whats-new.md.

Other factors

The bug hunting system found no issues, and the PR timeline has no outstanding reviewer comments. The added migration-guide text accurately reflects the repository's stated v1.x maintenance policy (critical bug fixes and security patches only). The change fits squarely in the "simple, mechanical, obvious" approval category.

Put it right under the intro as an admonition, matching the "Coming from
v1?" note elsewhere, instead of at the end of the Need Help section
where nobody scrolls to.

No-Verification-Needed: doc-only change

@claude claude Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM — two small docs-only link fixes, no code changes.

What was reviewed

  • README banner: spec link swapped from the release-candidate blog post to the published spec URL (modelcontextprotocol.io/specification/2026-07-28), matching the format of the existing spec-url badge; rest of the line is unchanged.
  • docs/migration.md: new "Not ready to migrate yet?" admonition points at /v1/ — same URL and wording pattern already used in docs/index.md and docs/whats-new.md.
  • Checked no other references to the old release-candidate blog link remain in the repo.
Extended reasoning...

Overview

This PR touches only README.md and docs/migration.md. It replaces the README banner's link to the 2026-07-28 release-candidate blog post with the now-published specification URL, and adds a "Not ready to migrate yet?" MkDocs admonition to the top of the migration guide pointing at the v1.x maintenance-line docs at /v1/.

Security risks

None. The change is purely documentation — no code, config, dependency, or CI changes. The new link targets are on the official modelcontextprotocol.io and py.sdk.modelcontextprotocol.io domains already used throughout the repo.

Level of scrutiny

Low. This is exactly the kind of simple, mechanical documentation change suitable for shadow approval: two hyperlink edits following patterns already established elsewhere in the docs. I verified the new spec URL format matches the repo's existing spec-url badge (/specification/latest), that the /v1/ pointer matches the identical references in docs/index.md and docs/whats-new.md, and that no stale references to the release-candidate blog post remain anywhere in the repo.

Other factors

The bug hunting system found no issues. The only timeline activity is the automated docs-preview bot comment, and the docs preview built successfully against the PR commit. The change is consistent with the repo's branching-model guidance (README documents v2, v1 docs live at /v1/), and no migration-guide or test updates are required for a docs-only link fix.

@maxisbey
maxisbey merged commit a4f4ccd into main Jul 29, 2026
38 checks passed
@maxisbey
maxisbey deleted the docs/spec-link-and-v1-pointer branch July 29, 2026 14:01
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.

1 participant