diff --git a/get-started/agent-skills.mdx b/coding-agents/agent-skills.mdx similarity index 100% rename from get-started/agent-skills.mdx rename to coding-agents/agent-skills.mdx diff --git a/get-started/mcp-servers.mdx b/coding-agents/mcp-servers.mdx similarity index 100% rename from get-started/mcp-servers.mdx rename to coding-agents/mcp-servers.mdx diff --git a/coding-agents/overview.mdx b/coding-agents/overview.mdx new file mode 100644 index 000000000..f0b3b3654 --- /dev/null +++ b/coding-agents/overview.mdx @@ -0,0 +1,54 @@ +--- +title: "Coding agents" +sidebarTitle: "Overview" +description: "Use AI coding agents like Claude Code, Cursor, and Codex to manage Runpod infrastructure in natural language." +--- + +Runpod integrates with AI coding agents through two complementary tools: **agent skills** and **MCP servers**. Together they let your agent create Pods, deploy Serverless endpoints, transfer files, and query GPU availability — in natural language, without switching to the console. + +--- + +## What's available + +### Agent skills + +The Runpod skills plugin teaches your coding agent how to perform tasks on Runpod. Once installed, you describe what you want — "create a Pod with an RTX 4090" or "deploy this function to Serverless" — and the built-in router sends the request to the right skill. + +Skills work with Claude Code, Codex, Cursor, GitHub Copilot, Windsurf, Cline, and other agents. + +→ [Set up agent skills](/coding-agents/agent-skills) + +### MCP servers + +Runpod provides two Model Context Protocol (MCP) servers: + +- **Runpod API MCP server** — gives your agent structured tools to manage Pods, endpoints, templates, network volumes, and registries through the REST API. Requires a Runpod API key. +- **Runpod docs MCP server** — lets your agent search Runpod documentation for features, code examples, and guides. No authentication required. + +MCP servers work with any MCP-compatible client, including agents that don't support the skills plugin. + +→ [Set up MCP servers](/coding-agents/mcp-servers) + +--- + +## Which should I use? + +For most coding agents, install **both** — they complement each other. The skills plugin handles high-level task execution (e.g. deploying a full workflow), while the MCP server provides the underlying API tools the skills rely on. + +If your agent supports the Runpod skills plugin, start there — it sets up the MCP server automatically for Claude Code, and the guided installer handles other agents. + +If your agent only supports MCP (no skills marketplace), use the MCP server directly. + +--- + +## One-shot setup for coding agents + +The fastest way to get started is the **Onboard your agent to Runpod** banner on your [Runpod console home page](https://console.runpod.io). It gives you a one-line prompt you can copy directly into your coding agent: + +``` +Set up Runpod for me: fetch https://docs.runpod.io/agent-setup.md and follow it. +``` + +Paste this into your agent and it fetches the setup instructions, installs the skills plugin and MCP server, and confirms the connection — no manual config steps. This works with Claude Code, Codex, Cursor, GitHub Copilot, Windsurf, Cline, opencode, and Gemini. + +You can also copy the prompt from this page if you have dismissed the banner. diff --git a/docs.json b/docs.json index a742d18ac..659632795 100644 --- a/docs.json +++ b/docs.json @@ -47,12 +47,18 @@ "get-started", "get-started/connect-to-runpod", "get-started/concepts", - "get-started/api-keys", - "get-started/agent-skills", - "get-started/mcp-servers", + "get-started/api-keys", "get-started/early-access" ] }, + { + "group": "Coding agents", + "pages": [ + "coding-agents/overview", + "coding-agents/agent-skills", + "coding-agents/mcp-servers" + ] + }, { "group": "Flash", "pages": [