docs: Add hosted MCP server setup to the MCP servers page - #797
docs: Add hosted MCP server setup to the MCP servers page#797promptless[bot] wants to merge 1 commit into
Conversation
Document the hosted Runpod MCP server (https://mcp.getrunpod.io/) with the guided installer and Sign in with Runpod OAuth as the recommended connection method, retaining the local API-key method as the alternative. Add a smoke test covering the hosted setup.
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
| The Runpod API MCP server gives AI tools access to the [Runpod REST API](/api-reference/overview), letting you create and manage Pods, Serverless endpoints, templates, network volumes, and container registries through natural language. | ||
|
|
||
| **Endpoint:** Available via npm package `@runpod/mcp-server` | ||
| **Hosted endpoint:** `https://mcp.getrunpod.io/` (Streamable HTTP transport) |
There was a problem hiding this comment.
Hosted MCP endpoint URL https://mcp.getrunpod.io/ confirmed by in-repo agent-skills.mdx, which uses the same URL for codex mcp add --transport http and Claude Code claude mcp add --transport http runpod ... https://mcp.getrunpod.io/.
Source:
docs/get-started/agent-skills.mdx
Line 103 in c6a990d
| The Runpod API MCP server gives AI tools access to the [Runpod REST API](/api-reference/overview), letting you create and manage Pods, Serverless endpoints, templates, network volumes, and container registries through natural language. | ||
|
|
||
| **Endpoint:** Available via npm package `@runpod/mcp-server` | ||
| **Hosted endpoint:** `https://mcp.getrunpod.io/` (Streamable HTTP transport) |
There was a problem hiding this comment.
"(Streamable HTTP transport)" label: Claude Code docs confirm --transport http is an alias for streamable-http, "The MCP specification uses the name streamable-http for this transport" — the hosted server (added via --transport http) is Streamable HTTP per the MCP spec.
|
|
||
| ### Hosted server (recommended) | ||
|
|
||
| The hosted server runs at `https://mcp.getrunpod.io/` and provides the same capabilities as the local server. OAuth-capable clients run a "Sign in with Runpod" flow on first connect: a browser opens, you log in to the Runpod console and approve the request, and the server obtains a session-scoped API key. Nothing is stored on disk. |
There was a problem hiding this comment.
"Sign in with Runpod" OAuth flow, connect over HTTP, no API key stored on disk, local API-key connections still work — confirmed by in-repo release-notes.mdx entry "Sign in with Runpod for the MCP server".
Source:
Line 57 in c6a990d
| The guided installer is the recommended path for supported clients. It detects your installed clients — Claude Code, Claude Desktop, Cursor, Windsurf, and VS Code — and configures each one, handling client-specific config-key differences automatically: | ||
|
|
||
| ```bash | ||
| npx @runpod/mcp-server@latest add |
There was a problem hiding this comment.
Guided installer npx @runpod/mcp-server@latest add / remove, and the detected-client list (Claude Code, Claude Desktop, Cursor, Windsurf, VS Code) — confirmed by in-repo release-notes.mdx "Guided install command for the MCP server" entry.
Source:
Line 69 in c6a990d
| #### Claude Code (hosted) | ||
|
|
||
| ```bash | ||
| claude mcp add --transport http runpod -s user https://mcp.getrunpod.io/ |
There was a problem hiding this comment.
Claude Code hosted-server HTTP add command claude mcp add --transport http runpod -s user https://mcp.getrunpod.io/ and the bearer-header override --header "Authorization: Bearer $RUNPOD_API_KEY" (used again at mcp-servers.mdx:78-79) — confirmed verbatim in agent-skills.mdx.
Source:
docs/get-started/agent-skills.mdx
Lines 121 to 123 in c6a990d
| ``` | ||
|
|
||
| ### Supported clients | ||
| Clients configured with JSON use a `headers` block instead. |
There was a problem hiding this comment.
"Clients configured with JSON use a headers block instead" — runpod/runpod-mcp README describes passing the bearer token via a JSON headers field for JSON-configured clients (no exact JSON sample given, but the headers-block mechanism is confirmed in prose).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Open in Promptless
The MCP servers page documented only the local, API-key-on-disk method for connecting the Runpod API MCP server, even though the officially hosted server at https://mcp.getrunpod.io/ (with "Sign in with Runpod" OAuth) is already referenced from the agent skills page and release notes.
This restructures the "Runpod API MCP server" section into two clearly labeled connection methods: a new "Hosted server (recommended)" covering the guided installer (npx @runpod/mcp-server@latest add), the Sign in with Runpod OAuth flow, per-client hosted setup for Claude Code, Claude Desktop, and VS Code, a generic remote-URL config for other clients, and a bearer-header API-key override; and the pre-existing "Local server (API key)" method, retained unchanged as the alternative. A smoke test covering the hosted connection was added.
Trigger Events
Tip: Add more repositories in your Configuration to keep multiple doc sites in sync 📚