@runpod/mcp-server 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +13 -0
- package/README.md +134 -0
- package/dist/index.d.cts +2 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +637 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +613 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +72 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
Copyright 2025 RunPod, Inc.
|
|
2
|
+
|
|
3
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
you may not use this file except in compliance with the License.
|
|
5
|
+
You may obtain a copy of the License at
|
|
6
|
+
|
|
7
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
|
|
9
|
+
Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
See the License for the specific language governing permissions and
|
|
13
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# RunPod MCP Server
|
|
2
|
+
[](https://smithery.ai/server/@runpod/runpod-mcp-ts)
|
|
3
|
+
|
|
4
|
+
This Model Context Protocol (MCP) server enables you to interact with the RunPod REST API through Claude or other MCP-compatible clients.
|
|
5
|
+
|
|
6
|
+
## Features
|
|
7
|
+
|
|
8
|
+
The server provides tools for managing:
|
|
9
|
+
|
|
10
|
+
- **Pods**: Create, list, get details, update, start, stop, and delete pods
|
|
11
|
+
- **Endpoints**: Create, list, get details, update, and delete serverless endpoints
|
|
12
|
+
- **Templates**: Create, list, get details, update, and delete templates
|
|
13
|
+
- **Network Volumes**: Create, list, get details, update, and delete network volumes
|
|
14
|
+
- **Container Registry Authentications**: Create, list, get details, and delete authentications
|
|
15
|
+
|
|
16
|
+
## Setup
|
|
17
|
+
|
|
18
|
+
### Prerequisites
|
|
19
|
+
|
|
20
|
+
- Node.js 18 or higher
|
|
21
|
+
- A RunPod account and API key
|
|
22
|
+
- Claude for Desktop or another MCP-compatible client
|
|
23
|
+
|
|
24
|
+
### Installing via Smithery
|
|
25
|
+
|
|
26
|
+
To install runpod-mcp-ts for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@runpod/runpod-mcp-ts):
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx -y @smithery/cli install @runpod/runpod-mcp-ts --client claude
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Installation
|
|
33
|
+
|
|
34
|
+
1. Clone the repository
|
|
35
|
+
2. Install dependencies:
|
|
36
|
+
```
|
|
37
|
+
pnpm install
|
|
38
|
+
```
|
|
39
|
+
3. Build the server:
|
|
40
|
+
```
|
|
41
|
+
pnpm build
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Configuration
|
|
45
|
+
|
|
46
|
+
Set your RunPod API key as an environment variable:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# Linux/macOS
|
|
50
|
+
export RUNPOD_API_KEY=your_api_key_here
|
|
51
|
+
|
|
52
|
+
# Windows (Command Prompt)
|
|
53
|
+
set RUNPOD_API_KEY=your_api_key_here
|
|
54
|
+
|
|
55
|
+
# Windows (PowerShell)
|
|
56
|
+
$env:RUNPOD_API_KEY="your_api_key_here"
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
You can get your API key from the [RunPod console](https://www.runpod.io/console/user/settings).
|
|
60
|
+
|
|
61
|
+
### Running the Server
|
|
62
|
+
|
|
63
|
+
Start the server:
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
pnpm start
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Setting up with Claude for Desktop
|
|
70
|
+
|
|
71
|
+
1. Open Claude for Desktop
|
|
72
|
+
2. Edit the config file: `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows)
|
|
73
|
+
3. Add the server configuration:
|
|
74
|
+
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"mcpServers": {
|
|
78
|
+
"runpod": {
|
|
79
|
+
"command": "node",
|
|
80
|
+
"args": ["/path/to/mcp-server/dist/index.js"],
|
|
81
|
+
"env": {
|
|
82
|
+
"RUNPOD_API_KEY": "your_api_key_here"
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Make sure to replace the `"args": ["/path/to/mcp-server/dist/index.js"]` with the path to the dist folder in the repository.
|
|
90
|
+
|
|
91
|
+
4. Restart Claude for Desktop
|
|
92
|
+
|
|
93
|
+
## Usage Examples
|
|
94
|
+
|
|
95
|
+
Here are some examples of how to use the server with Claude:
|
|
96
|
+
|
|
97
|
+
### List all pods
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
Can you list all my RunPod pods?
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Create a new pod
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
Create a new RunPod pod with the following specifications:
|
|
107
|
+
- Name: test-pod
|
|
108
|
+
- Image: runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04
|
|
109
|
+
- GPU Type: NVIDIA GeForce RTX 4090
|
|
110
|
+
- GPU Count: 1
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### Create a serverless endpoint
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
Create a RunPod serverless endpoint with the following configuration:
|
|
117
|
+
- Name: my-endpoint
|
|
118
|
+
- Template ID: 30zmvf89kd
|
|
119
|
+
- Minimum workers: 0
|
|
120
|
+
- Maximum workers: 3
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Security Considerations
|
|
124
|
+
|
|
125
|
+
This server requires your RunPod API key, which grants full access to your RunPod account. For security:
|
|
126
|
+
|
|
127
|
+
- Never share your API key
|
|
128
|
+
- Be cautious about what operations you perform
|
|
129
|
+
- Consider setting up a separate API key with limited permissions
|
|
130
|
+
- Don't use this in a production environment without proper security measures
|
|
131
|
+
|
|
132
|
+
## License
|
|
133
|
+
|
|
134
|
+
Apache-2.0
|
package/dist/index.d.cts
ADDED
package/dist/index.d.ts
ADDED