docs: add User Sources overview + add User Source to gateway auth options#978
docs: add User Sources overview + add User Source to gateway auth options#978wdawson wants to merge 3 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Introduces a new /guides/user-sources/ section with the User Sources overview as the index page, and adds User Source as a third option on the existing MCP Gateway authentication content. User Sources overview (/guides/user-sources): - Concept: a User Source is the OIDC connection between an MCP Gateway and your end-user identity provider, intentionally separate from any IdP used for Arcade admin sign-in - When to use: comparison vs. Arcade Auth (project members) and Arcade Headers (fallback for clients without browser OAuth) - Register the OAuth client at your identity provider (2-step block: configure the redirect URL https://cloud.arcade.dev/oauth2/intermediate_callback, then copy issuer URL, client ID, client secret) - Create a User Source from the dashboard, field by field - Use a User Source on a gateway (links to the gateway docs) - Manage: edit, rotate client secret, deactivate, delete (with the active-gateway guard documented) MCP Gateway auth content (folded GRO-92): - mcp-gateways/page.mdx: three-row Authentication table with User Source recommended for production - mcp-gateways/create-via-dashboard/page.mdx: bullets mirror the dashboard's two-level radio (Members of this Project / Non-Arcade Users → User Source or Arcade Headers) Tooling: - Add "User Source" / "User Sources" to the Arcade Vale vocabulary Closes GRO-93. Closes GRO-92. Part of the GRO-75 umbrella. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2535c11 to
cb71900
Compare
|
I'd hold on launching this page until User Sources is available to everyone in GA. And until all of the identity providers mentioned in the doc are actually supported. The docs changes overall look good, with one nit. Looking Good:
Nit:
Noting a follow on task on the MCP Client docs, maybe @torresmateo can help: Each of our MCP Client pages show Arcade Auth and Arcade Headers. If you don’t want Headers and don’t want users on Arcade accounts, we can include a line saying to set up a User Source with links to the guide + glossary. |
vfanelle
left a comment
There was a problem hiding this comment.
I commented in the thread already with the requested Glossary change
Place under "Authentication and Billing", next to Auth Provider, per Valerie's review. Enables the glossary auto-linker to surface the definition on hover for every "User Source" mention across the docs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Thanks Valerie! Nit (addressed): Added Hold on launch: Agreed — this PR (and the rest of GRO-75's sub-issues) will land as a unit. Going forward, the sibling PRs (GRO-99 next) will target this branch rather than MCP Client docs follow-on: Filed GRO-152 under GRO-75 to cover the per-client auth-mode mentions. Suggested assignee Mateo; milestone is "Broader Validation, Telemetry & Docs". |
Summary
/guides/user-sources/section with a User Sources overview as the index pageUser Source/User Sourcesto the Arcade Vale vocabularyCloses GRO-93 and GRO-92. Part of the GRO-75 umbrella — sibling per-provider guides and the consent-skip reference are still in flight.
What's on the User Sources overview page
https://cloud.arcade.dev/oauth2/intermediate_callbackand what credentials you'll need to copy out.sub, no provider-specific alternatives at this level).What's on the gateway auth pages
app/en/guides/mcp-gateways/page.mdx— Authentication table now lists three modes (Arcade Auth, User Source recommended, Arcade Headers fallback), with cross-links to the new User Sources overview.app/en/guides/mcp-gateways/create-via-dashboard/page.mdx— Authentication bullets now mirror the dashboard's actual two-level radio: "Members of this Project (Arcade Auth)" vs. "Non-Arcade Users → User Source (recommended) / Arcade Headers (fallback)."Decisions worth flagging
scope.Google.Headingsflags onmcp-gateways/page.mdxand a pre-existing<YOUR-GATEWAY-SLUG>MDX parser confusion oncreate-via-dashboard/page.mdxare not addressed in this PR.Test plan
valeclean onapp/en/guides/user-sources/page.mdxcheck-meta-keys— all_meta.tsxkeys validpnpm build—/en/guides/user-sourcesrenders;/en/guides/mcp-gatewaysand/en/guides/mcp-gateways/create-via-dashboardstill build🤖 Generated with Claude Code
Note
Low Risk
Low risk: documentation-only changes that add a new guide and update existing auth-mode wording/links; no runtime or API behavior is modified.
Overview
Adds a new
User Sourcesdocumentation section describing how to connect an OIDC identity provider to an Arcade MCP Gateway, including setup steps, redirect URL, configuration fields, and lifecycle operations (edit/rotate/deactivate/delete).Updates MCP Gateway authentication docs to introduce
User Sourceas the recommended production option alongsideArcade AuthandArcade Headers, and aligns the dashboard-creation guide wording with the UI’s two-level chooser.Refreshes related docs/indexing by adding a consistent “production end users” callout linking to
User Sourcesacross multiple MCP client guides, registeringuser-sourcesin guides metadata, and updating the glossary,llms.txt, and Vale vocabulary to include the new term.Reviewed by Cursor Bugbot for commit e3c619f. Bugbot is set up for automated code reviews on this repo. Configure here.