docs: update JS SDK docs for 1.0 - #78
Merged
Merged
Conversation
Rewrite the Get started, Configure Server, and tutorial pages for mcp-auth 1.0 on the MCP TypeScript SDK v2, add a v0.2 -> 1.0 migration guide, regenerate the JS API reference from 1.0.0-beta.1, and drop the stale i18n copies of the generated reference so locales fall back to English until translations are regenerated. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Deploying mcp-auth-docs with
|
| Latest commit: |
a3cd8a9
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6e5a6f66.mcp-auth-docs.pages.dev |
| Branch Preview URL: | https://xiaoyijun-docs-js-sdk-v1.mcp-auth-docs.pages.dev |
Replace the outdated "bridges the gap" narrative: the MCP SDK v2 ships the HTTP authorization layer itself, and mcp-auth supplies the token verifier and auth metadata it asks you to bring. List the five verifier pitfalls mcp-auth handles by default, and announce 1.0 in the subheader. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Apply lessons from migrating Logto Cloud's MCP server to mcp-auth 1.0: put the whoami tutorial before todo-manager (sidebar and navbar), deduplicate wiring code between Get started and the Configure Server pages, collapse the todo-manager tutorial's repeated Logto steps and considerations, condense the Get started provider section to the two requirements that matter in practice, add a Hono pointer and document McpAuthInfo.token, and move the migration guide after Provider Guides. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Logto now onboards MCP clients without pre-registration through dynamic apps (Client ID Metadata Documents). Update the provider list entry and the DCR guidance with CIMD, and point the Logto guide and tutorials at the two onboarding paths. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
xiaoyijun
enabled auto-merge (squash)
September 1, 2026 02:31
charIeszhao
approved these changes
Sep 1, 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
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.
Summary
Updates the JS SDK portions of the docs site for the mcp-auth 1.0 release (mcp-auth/js#50, published as
1.0.0-beta.1on thelatestdist-tag). mcp-auth 1.0 targets the MCP TypeScript SDK v2 (@modelcontextprotocol/server): the SDK now ships the HTTP layer of MCP authorization itself, and mcp-auth supplies the two inputs it asks you to bring — a token verifier and your auth metadata.Docs
Get started (
docs/README.mdx): rewritten for the 1.0 API — install with the@modelcontextprotocol/serverpeer dependency,protectedResourceMetadatadeclaration, SDK metadata helpers +requireBearerAuthwiring (fetch-native and Express tabs), andgetAuthInfoin tools. Points MCP SDK v1 users tomcp-auth@0.2.Configure MCP Auth (
configure-server/mcp-auth.mdx): rewritten around the new config shape — on-demand discovery vs.fetchServerConfig, wire-format (snake_case) metadata, fullprotectedResourceMetadataoptions, and serving the discovery documents via the SDK helpers. The#other-waysanchor is preserved.Configure Bearer auth (
configure-server/bearer-auth.mdx): rewritten around the SDK'srequireBearerAuth+getBearerAuthOptions, always-on audience validation (RFC 8707), per-tool scopes viagetAuthInfo,jwtVerifyOptions, and an opaque-token (introspection) custom-verifier example.New migration guide (
docs/migrate-to-v1.mdx, added to the sidebar): the v0.2 → 1.0 table and breaking-changes walkthrough from feat!: rewrite mcp-auth for MCP SDK v2 (1.0) js#50.Tutorials (
whoami,todo-manager): server code rebuilt on MCP SDK v2 (@modelcontextprotocol/express/nodeadapters), matching the new sample servers. The whoami tutorial now returns the verified JWT claims (no userinfo round-trip) and adds the Logto API resource step required for audience-bound tokens; provider/RBAC/VS Code sections are otherwise unchanged.Landing page:
_get-started-code.mdxsnippet updated to the 1.0 API; spec links now use thelatestspec URL. The "How about the MCP SDKs?" section is rewritten to the 1.0 positioning — the SDK ships the HTTP auth layer, mcp-auth brings the verifier + metadata, and the section lists the five verifier pitfalls mcp-auth handles by default (replacing the outdated "bridges the gap" narrative). The subheader now announces 1.0. New translation IDs fall back to English until translations regenerate.Practice-informed pass (after migrating a production MCP server — Logto Cloud's — to mcp-auth 1.0): tutorials reordered so whoami comes first (sidebar + navbar), wiring code deduplicated across Get started / Configure Server (the configure pages now frame the "two halves" and link to Get started for full wiring), the todo-manager tutorial's duplicated Logto steps and considerations collapsed, the Get started provider section condensed to the two requirements that matter in practice, a Hono pointer added,
McpAuthInfo.tokendocumented for downstream API calls, and the migration guide moved after Provider Guides.Generated content
docs/references/jsregenerated with typedoc from mcp-auth1.0.0-beta.1(new pages:getAuthInfo,McpAuthInfo,ProtectedResourceMetadataConfig, …; removed 0.2-only pages).Verification
pnpm buildpasses for all locales (broken-links check isthrow).pnpm lint/pnpm typecheckpass for the touched files (the 3 pre-existing MDX parsing errors inprovider-guides/*are unchanged on master).🤖 Generated with Claude Code