Skip to content

docs(cli): document MCP OAuth CIMD and token auth overrides#1219

Merged
factory-ain3sh merged 2 commits into
mainfrom
ain3sh/cli-811-doc-mcp-oauth
Jun 12, 2026
Merged

docs(cli): document MCP OAuth CIMD and token auth overrides#1219
factory-ain3sh merged 2 commits into
mainfrom
ain3sh/cli-811-doc-mcp-oauth

Conversation

@factory-ain3sh

@factory-ain3sh factory-ain3sh commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Description

Droid now supports Client ID Metadata Documents (CIMD) and standards-aligned public-client defaults for remote MCP OAuth (factory-mono #14377), but the per-server oauth overrides in mcp.json had no public documentation, so advanced deployments had no reference for supplying a custom CIMD URL or forcing a token endpoint auth method. This PR adds an "OAuth Overrides" section to the MCP configuration page documenting the oauth object on http and sse servers, with emphasis on the new clientMetadataUrl and tokenEndpointAuthMethod fields.

Related Issue

Closes CLI-811
Documents behavior shipped in Factory-AI/factory-mono#14377 (CLI-662).

Reviewer Guide

Read order: docs/cli/configuration/mcp.mdx (single file).
Review depth: Standard. Field semantics and constraints are transcribed from McpOAuthOptionsSchema in factory-mono packages/common/src/settings/schema.ts; verify the prose matches shipped validation.

Risk & Impact

Low risk, docs-only. Main exposure is documenting constraints inaccurately; each rule (CIMD URL shape, clientMetadataUrl vs clientId/clientSecret exclusivity, public-client none requirement, authorizationServerIssuer requirement) was checked against the merged schema's superRefine logic.

Verification

Behavior verified. Field list, types, and all four constraint rules cross-checked against McpOAuthOptionsSchema and McpOAuthTokenEndpointAuthMethod on factory-mono dev (cabbdad93f, post-#14377 merge); acceptance criteria from CLI-811 each map to a documented item, verified @ 299e132.
Regression coverage. N/A (prose only).
Not tested. No live Mintlify preview render; table and code-fence syntax matches existing patterns on the same page. Merge with main (#1175 et al.) resolved by keeping this section over the brief inline oauth bullet list and retaining upstream's project-config secrets Warning.
Standard validators. npx mint broken-links clean; no other validators configured in this repo.

Documents the per-server oauth overrides on http MCP servers introduced by the CLI-662 CIMD work (factory-mono #14377): clientMetadataUrl and tokenEndpointAuthMethod, plus the existing override fields they interact with. Covers CIMD URL validation rules, mutual exclusivity with clientId/clientSecret, the public-client (none) requirement, and examples for a custom CIMD document and forcing tokenEndpointAuthMethod none.
@mintlify

mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
factory 🟢 Ready View Preview Jun 10, 2026, 8:36 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

…p-oauth

# Conflicts:
#	docs/cli/configuration/mcp.mdx
@factory-ain3sh factory-ain3sh merged commit a09d688 into main Jun 12, 2026
4 checks passed
@factory-ain3sh factory-ain3sh deleted the ain3sh/cli-811-doc-mcp-oauth branch June 12, 2026 19:48
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