diff --git a/docs.json b/docs.json index eb5cb51c..99fe4211 100644 --- a/docs.json +++ b/docs.json @@ -41,7 +41,7 @@ "get-started/concepts", "get-started/manage-accounts", "get-started/api-keys", - "get-started/connect-to-runpod" + "get-started/mcp-servers" ] }, { diff --git a/get-started/mcp-servers.mdx b/get-started/mcp-servers.mdx new file mode 100644 index 00000000..af02a281 --- /dev/null +++ b/get-started/mcp-servers.mdx @@ -0,0 +1,113 @@ +--- +title: "Connect to Runpod's MCP servers" +sidebarTitle: "Connect to MCP" +description: "Manage Runpod resources and access documentation from within your favorite AI tools." +--- + +Runpod provides two Model Context Protocol (MCP) servers that connect AI tools and agents directly to Runpod. Use the API MCP server to manage your infrastructure, or the docs MCP server to get help with Runpod features. + +## Benefits + +With Runpod's MCP servers, you can: + +- **Manage resources without leaving your workflow.** Create Pods, configure endpoints, and monitor deployments directly from your AI assistant. +- **Get contextual help when you need it.** Access Runpod documentation from within your coding environment. Your AI assistant can look up features, configuration options, and best practices while helping you build. +- **Automate complex tasks with simple requests.** Describe what you want in plain language, and let the AI handle the API calls. Chain multiple operations together without writing scripts. +- **Reduce errors and guesswork.** The AI assistant validates your requests against the actual API, catching issues before they cause problems. + +## Runpod API MCP server + +The Runpod API MCP server gives MCP-compatible tools access to the [Runpod REST API](/api-reference/overview), letting you create and manage Pods, Serverless endpoints, and other resources through natural language. + +You can find the source code [on GitHub](https://github.com/runpod/runpod-mcp). + +### Connect with Claude Code + +Run this command to add the Runpod API MCP server to Claude Code: + +```bash +npx -y @smithery/cli install @runpod/runpod-mcp-ts --client claude-code +``` + +When prompted, enter your [Runpod API key](/get-started/api-keys). + +### Connect with Claude Desktop + +Run this command to add the Runpod API MCP server to Claude Desktop: + +```bash +npx -y @smithery/cli install @runpod/runpod-mcp-ts --client claude +``` + +When prompted, enter your Runpod API key. + +### Usage examples + +Once connected, you can ask your tool/agent to interact with your Runpod resources: + +**Manage Pods** + +``` +List all my Runpod Pods +``` + +``` +Create a new Runpod Pod with the following specifications: +- Name: test-pod +- Image: runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04 +- GPU Type: NVIDIA GeForce RTX 4090 +- GPU Count: 1 +``` + +``` +Delete the Pod "test-pod" +``` + +**Create a Serverless endpoint** + +``` +Create a Runpod Serverless endpoint with the following configuration: +- Name: my-endpoint +- Template ID: 30zmvf89kd +- Minimum workers: 0 +- Maximum workers: 3 +``` + +## Runpod docs MCP server + +The Runpod docs MCP server gives MCP-compatible tools access to Runpod documentation, making it easier to get answers about features and how to use them. + +The docs MCP server is available at: + +``` +https://docs.runpod.io/mcp +``` + +### Connect with Claude Code + +Run this command to add the Runpod docs MCP server to Claude Code: + +```bash +claude mcp add --transport http runpod-docs --scope user https://docs.runpod.io/mcp +``` + +### Connect with Claude (browser or desktop) + +To connect to the Runpod docs MCP server with Claude (browser or desktop): + +1. Open [Claude Desktop](https://claude.ai/desktop) or [Claude in your browser](https://claude.ai/) and go to **Settings** by clicking your profile icon. +2. Select **Connectors** in the sidebar. +3. Scroll down and select **Add custom connector**. +4. Enter `https://docs.runpod.io/mcp` as the URL and click **Add**. + +### Usage examples + +Once connected, you can ask your tool/agent questions about Runpod features and documentation: + +``` +Explain the Runpod Serverless model caching feature +``` + +``` +How does global networking work? +``` diff --git a/overview.mdx b/overview.mdx index 04164cd3..d5edd92b 100644 --- a/overview.mdx +++ b/overview.mdx @@ -20,8 +20,8 @@ If you're new to Runpod, start here to learn the essentials and deploy your firs Create API keys to manage your access to Runpod resources. - - Explore various methods for accessing and managing Runpod resources. + + Connect your AI tools to Runpod's MCP servers to manage resources and access docs. @@ -47,12 +47,13 @@ Serverless provides pay-per-second computing with automatic scaling for producti Learn how Serverless billing works and how to optimize your costs. + + Write a handler function, build a worker image, create an endpoint, and send your first request. + Deploy a large language model for text or image generation in minutes using vLLM. - - Build a custom worker and deploy it as a Serverless endpoint. - + ## Pods