docs(cli): document MCP OAuth resource override#1327
Open
factory-ain3sh wants to merge 2 commits into
Open
Conversation
List the new oauth.resource setting so users can configure a custom OAuth audience or omit the RFC 8707 resource indicator for compatible MCP servers.
Contributor
|
Droid finished @factory-ain3sh's task —— View job Droid review complete. Docs change looks correct and low risk. Please keep the Japanese MCP OAuth reference in sync by adding the new |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Document oauth.resource in the Japanese OAuth Overrides table so localized MCP configuration references expose the same supported field and omission behavior.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Description
What
The public MCP configuration reference omitted the supported
oauth.resourceoverride, so users could not discover how to target an OAuth audience that differs from the MCP endpoint or omit the resource indicator.Why
CLI-1432 tracks the documentation gap introduced by the MCP OAuth resource override.
How
This PR adds the
string | falsesetting to the OAuth Overrides table and documents the default replacement and explicit omission behavior.Related Issue
Closes CLI-1432
Reviewer Guide
Diff shape: 100% documentation; one row in
docs/cli/configuration/mcp.mdx.Review depth: Skim — the change documents an existing configuration field without changing runtime behavior.
Read order:
docs/cli/configuration/mcp.mdx— confirm the field type and resource-selection semantics match the CLI contract.Risk & Impact
Low risk. The change is documentation-only and does not alter configuration parsing, OAuth requests, or runtime behavior.
Verification
Behavior verified. The table now describes
oauth.resourceas a custom resource indicator or explicit omission, matching the source feature's three-state behavior. Regression coverage. Not applicable to a documentation-only change. Not tested. No runtime test was added because the implementation is unchanged. Standard validators.git diff --checkpassed; no formatter, linter, typecheck, or test configuration is present for this docs-only repository.