Skip to content

docs(mcp-auth): revamp README get started and add opaque token example - #51

Merged
xiaoyijun merged 4 commits into
masterfrom
xiaoyijun-docs-readme-opaque
Aug 29, 2026
Merged

xiaoyijun merged 4 commits into
masterfrom
xiaoyijun-docs-readme-opaque

Conversation

@xiaoyijun

@xiaoyijun xiaoyijun commented Aug 29, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Revamp the README to spotlight the mcp-auth surface and document how to verify opaque access tokens.

  • Add a docs & samples quick-links row under the tagline
  • Replace the two usage examples with a single trimmed "Get started" walkthrough (MCPAuth declaration, getBearerAuthOptions with requiredScopes, getAuthInfo with the per-tool scopes hint), pointing to mcp-auth.dev tutorials and the sample servers for complete projects
  • Add an "Opaque access tokens" section: a complete OAuthTokenVerifier implementation against an RFC 7662 introspection endpoint, reusing the metadata half of mcp-auth (resourceMetadataUrl, discovery documents, and the McpAuthInfo shape so getAuthInfo() keeps working)
  • Drop provider-list links pending the website revamp

Testing

Tested locally.

Checklist

  • .changeset
  • unit tests
  • integration tests
  • necessary TSDoc comments

🤖 Generated with Claude Code

@codecov

codecov Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@xiaoyijun xiaoyijun changed the title docs(mcp-auth): add quick links and opaque token example docs(mcp-auth): revamp README get started and add opaque token example Aug 29, 2026
@xiaoyijun
xiaoyijun merged commit 139fca4 into master Aug 29, 2026
5 checks passed
@xiaoyijun
xiaoyijun deleted the xiaoyijun-docs-readme-opaque branch August 29, 2026 09:57
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