René's URL Explorer Experiment


Title: ci: deploy docs to py.sdk.modelcontextprotocol.io via Pages artifact (v1 at /, v2 at /v2/) by maxisbey · Pull Request #2634 · modelcontextprotocol/python-sdk · GitHub

Open Graph Title: ci: deploy docs to py.sdk.modelcontextprotocol.io via Pages artifact (v1 at /, v2 at /v2/) by maxisbey · Pull Request #2634 · modelcontextprotocol/python-sdk

X Title: ci: deploy docs to py.sdk.modelcontextprotocol.io via Pages artifact (v1 at /, v2 at /v2/) by maxisbey · Pull Request #2634 · modelcontextprotocol/python-sdk

Description: Deploys docs to py.sdk.modelcontextprotocol.io via GitHub Pages artifact deployment, building both v1.x and main into a single site (v1 at /, v2 at /v2/). This mirrors the approach used by typescript-sdk. Closes #2614. Supersedes #2615 and #2632. Motivation and Context https://py.sdk.modelcontextprotocol.io/ currently returns 404. DNS is correctly configured (the CNAME and verification TXT records exist in modelcontextprotocol/dns), but this repo's Pages config has never claimed the domain (cname: null, no CNAME file on gh-pages), so GitHub serves the org-level 404. Separately, the current mkdocs gh-deploy --force setup runs identically on both main and v1.x and force-pushes to the same gh-pages branch — whichever branch released last overwrites the other's docs entirely. The first v2 release would silently replace the stable v1 docs. This PR fixes both: artifact-based deploy with the custom domain set in Pages settings (no CNAME file to lose), and a build script that always assembles both branches' docs into one site. How Has This Been Tested? Ran scripts/build-docs.sh locally; confirmed v1.x content lands at / and main content at /v2/, both mkdocs build invocations succeed under strict: true, and worktrees are cleaned up. The workflow itself can only be fully validated after merge + the Pages settings change (see below). Breaking Changes None for users. The modelcontextprotocol.github.io/python-sdk/ URL will auto-redirect to the custom domain once it's set. 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 Additional context Maintainer actions required Merge this PR and the v1.x backport #2635. Both Deploy Docs runs will fail at configure-pages because the Pages source is still "Deploy from a branch" — expected; the existing gh-pages content keeps serving in the meantime. Settings → Pages → Build and deployment → Source: change to GitHub Actions. Settings → Pages → Custom domain: py.sdk.modelcontextprotocol.io → Save. DNS check should pass immediately (records already exist). Tick "Enforce HTTPS" once the cert provisions. Actions tab → Deploy Docs → Run workflow (either branch). First successful deploy publishes v1 at / and v2 at /v2/ with correct canonical URLs. Once confirmed working, delete the gh-pages branch and close #2615. Merging both PRs before the settings flip means the first successful deploy reads the updated site_url from both branches; doing the flip first would work too but risks a brief 404 on the existing github.io/python-sdk/ URL. Design notes /v2/ (not /dev/) so the path survives the v2.0 GA — when v2 ships, only the root redirect changes. cancel-in-progress: false so an in-flight Pages deploy isn't cancelled by a closely-following push. paths: filter on the push trigger to avoid redeploying on unrelated changes; src/mcp/** is included because mkdocstrings introspects it for the API reference. The workflow file must exist on both main and v1.x for the push trigger to fire on each, but build-docs.sh always builds from origin/v1.x + origin/main tips, so output is identical regardless of which branch triggered. AI Disclaimer

Open Graph Description: Deploys docs to py.sdk.modelcontextprotocol.io via GitHub Pages artifact deployment, building both v1.x and main into a single site (v1 at /, v2 at /v2/). This mirrors the approach used by typescri...

X Description: Deploys docs to py.sdk.modelcontextprotocol.io via GitHub Pages artifact deployment, building both v1.x and main into a single site (v1 at /, v2 at /v2/). This mirrors the approach used by typescri...

Opengraph URL: https://github.com/modelcontextprotocol/python-sdk/pull/2634

X: @github

direct link

Domain: github.com

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:561057a9-9af2-fbe4-a98b-d401ae3a379d
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id88F2:DEFF0:81CCDF:B1A11D:6AFD29F3
html-safe-noncea94b2610bea23818f765dac5603b931f7d4c9303ada01136db929082be166155
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4OEYyOkRFRkYwOjgxQ0NERjpCMUExMUQ6NkFGRDI5RjMiLCJ2aXNpdG9yX2lkIjoiMjg4NTQ5NjA3OTM1OTIyNDMwNyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmacfbbb8caa86a6b460d9b665a5947356c3fba6eacbe69cfa83f0df8f86bddd7efb
hovercard-subject-tagpull_request:3702531510
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/modelcontextprotocol/python-sdk/pull/2634/files
twitter:imagehttps://avatars.githubusercontent.com/u/224885523?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/224885523?s=400&v=4
og:image:altDeploys docs to py.sdk.modelcontextprotocol.io via GitHub Pages artifact deployment, building both v1.x and main into a single site (v1 at /, v2 at /v2/). This mirrors the approach used by typescri...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None065128366c233a9d57ff68ab6c96e25b99dd1b0ab70d23b70873d3dd6b5e4f19
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/modelcontextprotocol/python-sdk git https://github.com/modelcontextprotocol/python-sdk.git
octolytics-dimension-user_id182288589
octolytics-dimension-user_loginmodelcontextprotocol
octolytics-dimension-repository_id862584018
octolytics-dimension-repository_nwomodelcontextprotocol/python-sdk
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id862584018
octolytics-dimension-repository_network_root_nwomodelcontextprotocol/python-sdk
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release941021edf0c2ec58298f4a2c8f27ae507d129c92
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmodelcontextprotocol%2Fpython-sdk%2Fpull%2F2634%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmodelcontextprotocol%2Fpython-sdk%2Fpull%2F2634%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=modelcontextprotocol%2Fpython-sdk
Reloadhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
Reloadhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
Reloadhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
modelcontextprotocolhttps://github.com/modelcontextprotocol
python-sdkhttps://github.com/modelcontextprotocol/python-sdk
Codehttps://github.com/modelcontextprotocol/python-sdk
Issues306 (306)https://github.com/modelcontextprotocol/python-sdk/issues
Pull requests112 (112)https://github.com/modelcontextprotocol/python-sdk/pulls
Actionshttps://github.com/modelcontextprotocol/python-sdk/actions
Projectshttps://github.com/modelcontextprotocol/python-sdk/projects
Security and quality12 (12)https://github.com/modelcontextprotocol/python-sdk/security
Insightshttps://github.com/modelcontextprotocol/python-sdk/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fmodelcontextprotocol%2Fpython-sdk%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fmodelcontextprotocol%2Fpython-sdk%2Fissues%2Fnew%2Fchoose
maxisbeyhttps://github.com/maxisbey
mainhttps://github.com/modelcontextprotocol/python-sdk/tree/main
docs-deploy-github-pages-actionshttps://github.com/modelcontextprotocol/python-sdk/tree/docs-deploy-github-pages-actions
Conversation 0 https://github.com/modelcontextprotocol/python-sdk/pull/2634
Commits 1 https://github.com/modelcontextprotocol/python-sdk/pull/2634/commits
Checks 31 https://github.com/modelcontextprotocol/python-sdk/pull/2634/checks
Files changed https://github.com/modelcontextprotocol/python-sdk/pull/2634/files
Please reload this pagehttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
ci: deploy docs to py.sdk.modelcontextprotocol.io via Pages artifact (v1 at /, v2 at /v2/) https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#top
Show all changes 1 commit https://github.com/modelcontextprotocol/python-sdk/pull/2634/files
357a7ce ci: deploy docs to py.sdk.modelcontextprotocol.io via GitHub Pages ar… maxisbey May 18, 2026 https://github.com/modelcontextprotocol/python-sdk/pull/2634/commits/357a7ce7aa4e68c679a583fbf27974f1cfa36910
Clear filters https://github.com/modelcontextprotocol/python-sdk/pull/2634/files
Please reload this pagehttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
Please reload this pagehttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
deploy-docs.yml https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-87e860af4b9db6c503ed680b6edb6333c6f8d7659f7d1a779a2487466bbc50f6
publish-docs-manually.yml https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-420070fb8fb46e243ee7ae4e264af19884b1b9b054121787be4974dbcd352b4c
publish-pypi.yml https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-d4585bdbbb00b46a400628c271f195eb312333d18474299152a0b75fb1a7ec4b
.gitignore https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947
index.md https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6
mkdocs.yml https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2
pyproject.toml https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711
build-docs.sh https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-5980041ae745e87cd24b9de0fda031024d4937deac5adf467a8aaa2e0f859f9d
.github/workflows/deploy-docs.ymlhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-87e860af4b9db6c503ed680b6edb6333c6f8d7659f7d1a779a2487466bbc50f6
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/.github/workflows/deploy-docs.yml
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
.github/workflows/publish-docs-manually.ymlhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-420070fb8fb46e243ee7ae4e264af19884b1b9b054121787be4974dbcd352b4c
View file https://github.com/modelcontextprotocol/python-sdk/blob/161834d4aee2633c42d3976c8f8751b6c4d947d5/.github/workflows/publish-docs-manually.yml
Open in desktop https://desktop.github.com
Please reload this pagehttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
.github/workflows/publish-pypi.ymlhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-d4585bdbbb00b46a400628c271f195eb312333d18474299152a0b75fb1a7ec4b
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/.github/workflows/publish-pypi.yml
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-d4585bdbbb00b46a400628c271f195eb312333d18474299152a0b75fb1a7ec4b
.gitignorehttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/.gitignore
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947
docs/index.mdhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/docs/index.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-b4d68dc855d0f9476d3f2ee343853bd21bf82ea9960d0cf06661baa244439dd6
mkdocs.ymlhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/mkdocs.yml
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-98d0f806abc9af24e6a7c545d3d77e8f9ad57643e27211d7a7b896113e420ed2
pyproject.tomlhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/pyproject.toml
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711
https://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711
scripts/build-docs.shhttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files#diff-5980041ae745e87cd24b9de0fda031024d4937deac5adf467a8aaa2e0f859f9d
View file https://github.com/modelcontextprotocol/python-sdk/blob/357a7ce7aa4e68c679a583fbf27974f1cfa36910/scripts/build-docs.sh
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/modelcontextprotocol/python-sdk/pull/2634/{{ revealButtonHref }}
Please reload this pagehttps://github.com/modelcontextprotocol/python-sdk/pull/2634/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.