docs(mcp): add API key auth, multi-client setup, and missing tools#1179
Conversation
📝 WalkthroughWalkthroughUpdated the MCP documentation file to expand capabilities and provide comprehensive setup guidance. Added four new MCP tools (update_workspace, navigate_to_workspace, start_claude_session, start_claude_subagent), replaced static CLI guidance with multi-tab UI for multiple clients, introduced per-client configuration examples, and added API Key Authentication section. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@apps/docs/content/docs/mcp.mdx`:
- Around line 140-144: Update the opening sentences to make OAuth 2.1 the
default but not exclusive: replace "The MCP server uses OAuth 2.1. When you
first connect, you'll be prompted to authorize the connection in your browser.
The token is scoped to your active organization." with a single clear statement
like "By default, the MCP server uses OAuth 2.1; when you first connect you'll
be prompted to authorize in your browser and the token is scoped to your active
organization; API keys are also supported for headless environments." Ensure
this change appears in the OAuth section immediately before the "API Key
Authentication" heading so the relationship between defaults and alternatives is
clear.
- Around line 40-44: Clarify that the Open Code CLI command opencode mcp add is
interactive and accepts no inline arguments by updating the mcp.mdx example: add
a short explanatory sentence near the Tab block (the example showing the
opencode mcp add command) stating that the command will prompt for server name
and URL interactively rather than taking arguments, so users know to run it and
then respond to prompts.
| <Tab value="Open Code"> | ||
| ```bash title="terminal" | ||
| opencode mcp add | ||
| ``` | ||
| </Tab> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
cat -n apps/docs/content/docs/mcp.mdx | head -60Repository: superset-sh/superset
Length of output: 2200
🌐 Web query:
Open Code CLI opencode mcp add documentation syntax arguments
💡 Result:
opencode mcp add — syntax & arguments
Syntax
opencode mcp addArguments / flags
- None.
mcp addtakes no positional arguments and is an interactive command that guides you through adding either a local or remote MCP server to your OpenCode configuration. [1]
Where it’s stored / what it creates (config shape)
MCP servers are defined in your OpenCode config under mcp (each server keyed by a unique name, with an enabled flag). [2]
- Local MCP uses
type: "local"and a requiredcommand: [...]. [2] - Remote MCP uses
type: "remote"and a requiredurl: "..."(optionallyheaders,oauth, etc.). [2]
Sources: OpenCode CLI docs [1], OpenCode MCP servers docs [2].
Add clarification comment to explain that opencode mcp add is interactive.
The Open Code CLI's mcp add command differs from other clients because it's interactive and takes no arguments—it prompts you for the server name and URL. The example should clarify this to avoid confusion.
Suggested fix
- opencode mcp add
+ opencode mcp add # follow prompts for server name and URL📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Tab value="Open Code"> | |
| ```bash title="terminal" | |
| opencode mcp add | |
| ``` | |
| </Tab> | |
| <Tab value="Open Code"> |
🤖 Prompt for AI Agents
In `@apps/docs/content/docs/mcp.mdx` around lines 40 - 44, Clarify that the Open
Code CLI command opencode mcp add is interactive and accepts no inline arguments
by updating the mcp.mdx example: add a short explanatory sentence near the Tab
block (the example showing the opencode mcp add command) stating that the
command will prompt for server name and URL interactively rather than taking
arguments, so users know to run it and then respond to prompts.
| The MCP server uses OAuth 2.1. When you first connect, you'll be prompted to authorize the connection in your browser. The token is scoped to your active organization. | ||
|
|
||
| ### API Key Authentication | ||
|
|
||
| For headless environments, CI/CD pipelines, or scripts where browser-based OAuth isn't practical, you can authenticate with an API key instead. |
There was a problem hiding this comment.
Clarify that OAuth is default, not exclusive.
This sentence now conflicts with the API key section below. Reword to indicate OAuth 2.1 is the default while API keys are also supported.
✏️ Suggested rewording
-The MCP server uses OAuth 2.1. When you first connect, you'll be prompted to authorize the connection in your browser. The token is scoped to your active organization.
+The MCP server supports OAuth 2.1 by default. When you first connect, you'll be prompted to authorize the connection in your browser. The token is scoped to your active organization.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The MCP server uses OAuth 2.1. When you first connect, you'll be prompted to authorize the connection in your browser. The token is scoped to your active organization. | |
| ### API Key Authentication | |
| For headless environments, CI/CD pipelines, or scripts where browser-based OAuth isn't practical, you can authenticate with an API key instead. | |
| The MCP server supports OAuth 2.1 by default. When you first connect, you'll be prompted to authorize the connection in your browser. The token is scoped to your active organization. | |
| ### API Key Authentication | |
| For headless environments, CI/CD pipelines, or scripts where browser-based OAuth isn't practical, you can authenticate with an API key instead. |
🤖 Prompt for AI Agents
In `@apps/docs/content/docs/mcp.mdx` around lines 140 - 144, Update the opening
sentences to make OAuth 2.1 the default but not exclusive: replace "The MCP
server uses OAuth 2.1. When you first connect, you'll be prompted to authorize
the connection in your browser. The token is scoped to your active
organization." with a single clear statement like "By default, the MCP server
uses OAuth 2.1; when you first connect you'll be prompted to authorize in your
browser and the token is scoped to your active organization; API keys are also
supported for headless environments." Ensure this change appears in the OAuth
section immediately before the "API Key Authentication" heading so the
relationship between defaults and alternatives is clear.
🧹 Preview Cleanup CompleteThe following preview resources have been cleaned up:
Thank you for your contribution! 🎉 |
saddlepaddle
force-pushed
the
update-mcp-docs-add-api-key-auth-mcp-json-setup-an
branch
from
d4d05bb to
57239c7
Compare
- Restructure setup section with CLI Options (Claude Code, Codex, Gemini CLI, Open Code) and Manual Configuration tabs per client - Add API key authentication section with generation and usage docs - Add missing tools: update_workspace, start_claude_session, start_claude_subagent - Add AI Sessions category to capabilities and tools tables - Verify config formats against each client's official docs
saddlepaddle
force-pushed
the
update-mcp-docs-add-api-key-auth-mcp-json-setup-an
branch
from
cc49c02 to
7bd8939
Compare
saddlepaddle
had a problem deploying
to
preview
GitHub Actions
Failure
Kitenite
deleted the
update-mcp-docs-add-api-key-auth-mcp-json-setup-an
branch
1 participant
Summary
update_workspace,start_claude_session,start_claude_subagentTest plan
bun run typecheckpassesbun testpasses (1193 pass, 0 fail)Summary by CodeRabbit