You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-7Lines changed: 33 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
# Render MCP Server
2
2
3
3
## Overview
4
-
The Render MCP Server is an early access [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)
4
+
5
+
The Render MCP Server is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)
5
6
server that allows you to interact with your Render resources via LLMs.
6
7
7
8
## Use Cases
@@ -13,28 +14,31 @@ server that allows you to interact with your Render resources via LLMs.
13
14
14
15
## Feedback
15
16
16
-
The official Render MCP server is currently in early access. Please leave feedback via
17
-
[filing a GitHub issue](https://github.com/render-oss/render-mcp-server/issues) if you have any
17
+
Please leave feedback via
18
+
[filing a GitHub issue](https://github.com/render-oss/render-mcp-server/issues) if you have any
18
19
feature requests, bug reports, suggestions, comments, or concerns.
19
20
20
21
## Getting Started
21
22
22
23
This guide will help you set up the Render MCP Server. To use the server, you will need a desktop application that can act as an MCP client (e.g., Claude Desktop, Cursor IDE, VS Code). All installation methods require a Render API Key, and you will configure your chosen MCP client with the server details.
23
24
24
25
### 1. Obtain a Render API Key
26
+
25
27
You must create a Render API key from your [Render Dashboard → Account Settings → API Keys](https://dashboard.render.com/settings#api-keys).
26
28
27
29
> [!IMPORTANT]
28
-
> Render API keys are currently broadly scoped, giving your AI tools the same permissions that you would have access to. This MCP server avoids destructive operations, but please make sure you're comfortable granting your AI tools these permissions.
30
+
> Render API keys are currently broadly scoped, giving your AI tools the same permissions that you would have access to. This MCP server avoids destructive operations, but please make sure you're comfortable granting your AI tools these permissions.
29
31
30
32
### 2. Choose an Installation Method
31
33
32
34
Select one of the following methods to install and run the Render MCP Server.
33
35
34
36
#### Method A: Using Docker (Recommended)
37
+
35
38
This is the simplest way to get started if you have [Docker](https://www.docker.com) installed and running.
36
39
37
40
**Steps:**
41
+
38
42
1. Ensure Docker is installed and operational on your system.
39
43
2. Configure your MCP client with the following settings (or by using the one-click install buttons below), replacing `<YOUR_API_KEY>` with the API key you obtained in Step 1:
40
44
```json
@@ -63,12 +67,15 @@ This is the simplest way to get started if you have [Docker](https://www.docker.
63
67
[](https://cursor.com/install-mcp?name=render&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXJtIC1lIFJFTkRFUl9BUElfS0VZIC12IHJlbmRlci1tY3Atc2VydmVyLWNvbmZpZzovY29uZmlnIGdoY3IuaW8vcmVuZGVyLW9zcy9yZW5kZXItbWNwLXNlcnZlciIsImVudiI6eyJSRU5ERVJfQVBJX0tFWSI6IllPVVJfQVBJX0tFWSJ9fQ%3D%3D)
64
68
65
69
#### Method B: Using the install script (Linux/MacOS only)
70
+
66
71
1. Run the following command:
72
+
67
73
```shell
68
74
curl -fsSL https://raw.githubusercontent.com/render-oss/render-mcp-server/refs/heads/main/bin/install.sh | sh
69
75
```
76
+
70
77
2. Note the full path where the install script saved the downloaded executable. It should have a directory where it was installed e.g., `✨ Successfully installed Render MCP Server to /Users/example/.local/bin/render-mcp-server`
71
-
2. Configure your MCP client with the following settings (or by using the one-click install buttons below). Replace `/path/to/render-mcp-server` with the actual path to the executable and `<YOUR_API_KEY>` with your API key:
78
+
3. Configure your MCP client with the following settings (or by using the one-click install buttons below). Replace `/path/to/render-mcp-server` with the actual path to the executable and `<YOUR_API_KEY>` with your API key:
[](https://cursor.com/install-mcp?name=render&config=eyJjb21tYW5kIjoiL3BhdGgvdG8vcmVuZGVyLW1jcC1zZXJ2ZXIiLCJlbnYiOnsiUkVOREVSX0FQSV9LRVkiOiI8WU9VUl9BUElfS0VZPiJ9fQ%3D%3D)
86
93
87
94
#### Method C: Direct Download
95
+
88
96
Use this method if you prefer not to use Docker and a pre-compiled binary is available for your system.
89
97
90
98
**Steps:**
99
+
91
100
1. Open the MCP server's [GitHub releases page](https://github.com/render-oss/render-mcp-server/releases/).
92
101
2. Download the executable that corresponds to your system's architecture.
93
102
3. Note the full path to where you saved the downloaded executable.
94
103
4. Configure your MCP client with the same settings as Method B.
95
104
> **macOS Users**: If you run the binary directly on macOS, you may need to grant an exception for it to run. See the [Limitations](#limitations) section for more details and a link to Apple's support page.
96
105
97
106
#### Method D: Build from Source
107
+
98
108
Choose this method if no pre-compiled binary suits your system, you want to build from the latest code, or you are a developer modifying the server. You will need [Go (Golang)](https://go.dev/doc/install) installed.
99
109
100
110
**Steps:**
111
+
101
112
1. Ensure Go is installed on your system.
102
113
2. Clone the repository and build the executable:
103
114
```shell
@@ -112,8 +123,8 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
112
123
## Limitations
113
124
114
125
> [!NOTE]
115
-
> The MCP server is currently in early access, and there are several limitations. If you have specific
116
-
feedback or would like to report a bug or feature request, please [create a GitHub Issue](https://github.com/render-oss/render-mcp-server/issues).
126
+
> The MCP server has several limitations. If you have specific
127
+
> feedback or would like to report a bug or feature request, please [create a GitHub Issue](https://github.com/render-oss/render-mcp-server/issues).
117
128
118
129
1.**macOS Users**: If you download and run the binary directly on macOS, you may need to grant an exception to run it as it's from an "unknown developer". You can find instructions on how to do this [here](https://support.apple.com/guide/mac-help/open-a-mac-app-from-an-unknown-developer-mh40616/mac). This issue might not present a pop-up if the binary is launched from within another application like Claude or Cursor. This is not an issue if you are launching the MCP server via Docker.
119
130
@@ -134,9 +145,11 @@ feedback or would like to report a bug or feature request, please [create a GitH
134
145
### Workspaces
135
146
136
147
-**list_workspaces** - List the workspaces that you have access to
148
+
137
149
- No parameters required
138
150
139
151
-**select_workspace** - Select a workspace to use
152
+
140
153
-`ownerID`: The ID of the workspace to use (string, required)
141
154
142
155
-**get_selected_workspace** - Get the currently selected workspace
@@ -145,12 +158,15 @@ feedback or would like to report a bug or feature request, please [create a GitH
145
158
### Services
146
159
147
160
-**list_services** - List all services in your Render account
161
+
148
162
-`includePreviews`: Whether to include preview services, defaults to false (boolean, optional)
149
163
150
164
-**get_service** - Get details about a specific service
165
+
151
166
-`serviceId`: The ID of the service to retrieve (string, required)
152
167
153
168
-**create_web_service** - Create a new web service in your Render account
169
+
154
170
-`name`: A unique name for your service (string, required)
155
171
-`runtime`: Runtime environment for your service. Accepted values: 'node', 'python', 'go', 'rust', 'ruby', 'elixir', 'docker' (string, required)
156
172
-`buildCommand`: Command used to build your service (string, required)
@@ -163,6 +179,7 @@ feedback or would like to report a bug or feature request, please [create a GitH
0 commit comments