Skip to content

docs: update mcp setup docs for updated dashboard taxanomy - #220

Merged
simplesagar merged 1 commit into
mainfrom
docs/identity-section-refresh
Oct 1, 2026
Merged

simplesagar merged 1 commit into
mainfrom
docs/identity-section-refresh

Conversation

@simplesagar

Copy link
Copy Markdown
Member

Every setup guide's Speakeasy steps now match the Control Plane's new Identity section. Until this merges, none of the guides can be followed on current main.

Why

Between 09-26 and 09-30, gram #6364, #6905, #6906, #6813 and #6974 replaced the remote-server Authentication section and the Attach Remote Identity Provider sheet. An audit of all 22 guides against gram main found that every guide still pointed readers to Use Discovered, Configure Manually, Session Client / Client Type, comma-separated Scope (override), or Upstream Headers. None of those exist on remote servers any more.

What changed

doctrine/speakeasy-setup.md is re-pinned to gram 68b3f78 and its skeleton is rewritten. A CHANGELOG.md entry is added.

  • The identity mode (User Identity, Service Account, No Identity) is now chosen when the server is added, in the catalog Add to Project dialog or on Hosted remotely after Verify connectivity.
  • Settings > Identity has a provider picker. Providers that can't be discovered go through Create a custom identity provider.
  • Clients are set up with Existing client, Auto-Configure (CIMD or DCR) or Manual. The Dossier now records when Manual must override the Auto-Configure default.
  • Scopes go under Advanced > Scope, space-separated. A blank Scope requests every scope in the protected-resource metadata. The auth-method and audience steps are gone.
  • API keys go in the Service Account credential.
  • When identity setup is still needed, the catalog result shows Finish setup and the server stays Disabled. It is enabled from Danger Zone > Server Availability.

guides/*/speakeasy.md: all 22 guides are rewritten against the new skeleton. The registration choice for each guide comes from live probes of its endpoints on 2026-09-30.

Setup Guides
User Identity, Manual Asana, GitHub, Gmail, Google (Calendar, Docs, Drive, People, Sheets, Slides, BigQuery, Compute Engine), HubSpot, Salesforce, Slack, Snowflake
User Identity, custom provider then Existing client Box (the protected-resource metadata issuer has a trailing slash that doesn't match), Intercom, NetSuite
User Identity, Auto-Configure Atlassian, Zapier
Service Account (Bearer) X
No Identity X Docs

Provider-side fixes from the audit, each re-verified live before editing:

  • Atlassian: moved to the v2 endpoint https://mcp.atlassian.com/v2/mcp and the path issuer.
  • HubSpot: "MCP auth apps" renamed to MCP Connectors.
  • Google: Developer Preview prerequisite added to Drive, Docs, Sheets and People; MCP Tool User grant added to Docs; broken link text fixed in Calendar and Docs.
  • Intercom: EU OAuth values.
  • Salesforce: sandbox endpoints and missing anchors.
  • Snowflake: tool call responses are now streamed (SSE).
  • X: OAuth discovery is now published, recorded in research.md.
  • GitHub: prerequisite wording.
  • Box: both names Box uses for the integration tile.
  • BigQuery: now added from the catalog (the entry is listed as "BigQuery").
  • Stale docs links: speakeasy.com/docs/.../distribute/... links updated.

research.md Speakeasy sections now record the probe outcome, issuer, CIMD/DCR support, registration choice and scope string. go/generated is left for the regen workflow, per GO-MODULE.md.

Before merging

  • Production spot check. Labels come from gram main. Not all of #6813 and #6974 is in a tagged dashboard release yet. Confirm on app.getgram.ai that a remote server's Settings shows the Identity section with Manual and Advanced > Scope. Also confirm the visible label of the Server Availability switch.
  • Not tested end to end:
    • Box's custom-provider route.
    • Snowflake discovery and NetSuite issuer values (no test accounts).
    • Intercom EU values.
    • Salesforce with a Consumer Key-only public client.
    • Atlassian with CIMD against the path issuer (only DCR was exercised).
  • Open questions:
    • Should Atlassian use its gateway URL ?tools=all?
    • Is Google People in the catalog? That guide keeps both add-server paths.
    • Should the X guide offer User Identity now that X publishes OAuth metadata?
    • Is there a minimal GitHub scope set to recommend? The guide gives the full advertised list for readers to trim.

Verification

cd go && for g in ../guides/*/; do go run ./cmd/lint-guide $g; done   # all 22 pass

🤖 Generated with Claude Code

https://claude.ai/code/session_01KZCNTjfmouUkm5b3SUtGEa

The Control Plane replaced the remote-server Authentication section and
Attach Remote Identity Provider sheet with an Identity section (User
Identity / Service Account / No Identity, provider picker, Existing
client / Auto-Configure / Manual). Re-pin the canonical Speakeasy setup
doctrine to gram main 68b3f78, rewrite every guide's speakeasy.md
against it, and apply verified provider-side fixes from the audit.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KZCNTjfmouUkm5b3SUtGEa
@simplesagar simplesagar changed the title docs: move credential setup to the Identity section docs: update mcp setup docs for updated dashboard taxanomy Sep 30, 2026
@simplesagar
simplesagar merged commit 943ace8 into main Oct 1, 2026
1 check passed
@simplesagar
simplesagar deleted the docs/identity-section-refresh branch October 1, 2026 01:37
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.

3 participants