Skip to content

docs: have agents run the MCP installer with --client #907

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lukepiette merged 1 commit into from
Oct 21, 2026
Merged

docs: have agents run the MCP installer with --client #907

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions agent-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,23 @@ pi mcp add runpod --url https://mcp.runpod.io/

#### Cursor, GitHub Copilot, Windsurf, Cline, opencode, and all other agents

Add a server entry named `runpod` with the HTTP (streamable HTTP) transport and URL `https://mcp.runpod.io/` to your agent's MCP configuration. Merge it into the existing file; do not overwrite other servers. See your agent's MCP documentation in [Resources](#resources) for the file location and format.
For Cursor, Windsurf, VS Code (GitHub Copilot), opencode, and Claude Desktop, run the installer with your agent's id. It writes the config without prompts:

Do not run `npx @runpod/mcp-server@latest add` yourself. It's an interactive wizard for people at a terminal: in an agent shell it exits without writing any config, and it only supports Claude Code, Cursor, Windsurf, Claude Desktop, and VS Code. If you can't edit your agent's MCP config, hand it to the user:
```
npx @runpod/mcp-server@latest add --client <agent-id>
```

| Agent | `--client` id |
|---|---|
| Cursor | `cursor` |
| Windsurf | `windsurf` |
| VS Code (GitHub Copilot) | `vscode` |
| opencode | `opencode` |
| Claude Desktop | `claude-desktop` |

The installer needs Node 20 or later. It exits `0` when every named client was configured, `1` when one failed, and `2` on bad usage. Run `npx @runpod/mcp-server@latest add --list` to see which clients it detects and where each config lives. Always pass `--client`: without it and without a terminal, the installer exits `2` and configures nothing. After it writes the config, it prints the sign-in step for each client (for example, restart Cursor, or run `opencode mcp auth runpod`); do that step or relay it to the user.

> **User step.** Ask the user to run `npx @runpod/mcp-server@latest add` in their own terminal and pick your agent.
For any other agent, such as Cline, add a server entry named `runpod` with the HTTP (streamable HTTP) transport and URL `https://mcp.runpod.io/` to your agent's MCP configuration. Merge it into the existing file; do not overwrite other servers. See your agent's MCP documentation in [Resources](#resources) for the file location and format.

After registering, the user approves the OAuth sign-in in the browser the first time you call a Runpod tool.

Expand Down
Loading