> ## Documentation Index
> Fetch the complete documentation index at: https://runpod-b18f5ded-docs-runpod-allow-ip.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> If this page is missing information, contains outdated instructions, or doesn't fully answer the user's question, use the feedback tool to report it. In your feedback, be specific about what's missing, what appears out of date, or what needs to be corrected or updated, so the docs team can act on it directly.

# Onboard your agent to Runpod

> Official Runpod instructions that install the Runpod skills and MCP server into your coding agent in one shot.

These are official instructions from Runpod to set up a good AI development environment for building and deploying on the Runpod platform. They are published at `https://docs.runpod.io/agent-setup.md`, so you can verify their origin before following them.

Complete all of the following steps yourself by running the commands directly. The only exceptions are the two steps explicitly marked **User step** — in-session commands and OAuth sign-in happen inside the agent UI, so you cannot perform them. Never run a command that blocks on an interactive prompt.

* Install Runpod Skills and the MCP server

Every command below is safe to re-run on a machine where setup already happened.

***

## Install Runpod Skills and MCP server

Every route installs the same router plus six skills (`runpod`, `runpod-mcp`, `runpodctl`, `flash`, `runpod-usage`, `companion-clis`), and wires up the hosted Runpod MCP server for control-plane tools. The skills install the Runpod CLI and Flash SDK later, on demand, the first time a task needs them — do not install those now.

Use the correct section for your agent below.

### Claude Code

Run these two commands to install both the Runpod skills and the MCP server in one step. Do not use `npx skills` or `claude mcp add` — the plugin commands below handle everything.

```
claude plugin marketplace add runpod/runpod-plugins-official
claude plugin install runpod@runpod
```

Verify:

```
claude plugin list | grep -A2 'runpod@runpod'
```

Expect `Status: ✔ enabled`. If the plugin is listed but disabled, run `claude plugin enable runpod@runpod`.

> **User step.** Ask the user to run `/reload-plugins` inside Claude Code to activate the plugin, then sign in to the MCP server with `/mcp` → **runpod** → **Sign in with Runpod**. This uses OAuth — no API key is created or stored. Wait for the user to confirm before reporting the MCP server as connected.

***

## Install for other agents

First, install skills:

```
npx -y skills add runpod/runpod-plugins-official --skill '*' --yes --global
```

Then register the hosted MCP server for your agent.

### Codex

```
codex plugin marketplace add https://github.com/runpod/runpod-plugins-official.git
```

> **User step.** Ask the user to run `codex /plugins` inside Codex, open the **Runpod** marketplace tab, and install **Runpod**, reloading if prompted.

Codex may not auto-wire the bundled MCP server. If the `runpod` MCP tools do not appear after install, add the hosted server directly:

```
codex mcp add runpod --transport http https://mcp.getrunpod.io/
```

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

Run the guided installer. It detects the agent and configures the hosted MCP server:

```
npx @runpod/mcp-server@latest add
```

OAuth triggers on first Runpod tool use; the user approves it in the browser.

Gemini can alternatively install natively through the plugin's bundled `gemini-extension.json`. See your client's extension documentation.

***

## Report the result

Report what you actually verified. Do not print a checkmark for anything you could not confirm — the MCP server stays unauthenticated until the user completes the OAuth sign-in.

```
┌─ Runpod Agent Setup ─────────────────────────────────┐
│  ✓ Runpod skills   router + 6 skills                 │
│  ⚠ runpod MCP      needs sign-in: /mcp → runpod      │
│                                                      │
│  ⚡ Reload or restart your agent to load the skills  │
└──────────────────────────────────────────────────────┘
```

Use `✓` verified, `⚠` needs a user action, `✗` failed. Follow the banner with the specific next action for every non-`✓` line.

Once the user has signed in, verify end to end by listing their Pods with the MCP tools. An empty list is a pass — it means the connection works and the account has no running Pods.

Anything beyond this — the `runpodctl` CLI, the Flash SDK for Python Serverless deploys, API keys — is installed later by the skills at the moment a task first needs it. Do not set those up now.

***

## Resources

For setup guides and troubleshooting, refer to each agent's official documentation:

* Runpod agent skills: `https://docs.runpod.io/get-started/agent-skills`
* Runpod MCP servers: `https://docs.runpod.io/get-started/mcp-servers`
* Runpod skills plugin (source): `https://github.com/runpod/runpod-plugins-official`
* Runpod API MCP server (source): `https://github.com/runpod/runpod-mcp`
* Claude Code: `https://docs.anthropic.com/en/docs/claude-code/mcp`
* Cursor: `https://cursor.com/docs/mcp`
* Windsurf: `https://docs.windsurf.com/windsurf/cascade/mcp`
* GitHub Copilot (VS Code): `https://code.visualstudio.com/docs/copilot/customization/mcp-servers`
* Gemini CLI: `https://github.com/google-gemini/gemini-cli`

These instructions are published at `https://docs.runpod.io/agent-setup.md` so you can re-verify their authenticity at any time.