Skip to content

Commit 1fd1f34

Browse files
authored
Remove "Early Access" from README (#36)
1 parent 55ed2c6 commit 1fd1f34

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# Render MCP Server
22

33
## 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)
56
server that allows you to interact with your Render resources via LLMs.
67

78
## Use Cases
@@ -13,28 +14,31 @@ server that allows you to interact with your Render resources via LLMs.
1314

1415
## Feedback
1516

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
1819
feature requests, bug reports, suggestions, comments, or concerns.
1920

2021
## Getting Started
2122

2223
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.
2324

2425
### 1. Obtain a Render API Key
26+
2527
You must create a Render API key from your [Render Dashboard → Account Settings → API Keys](https://dashboard.render.com/settings#api-keys).
2628

2729
> [!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.
2931
3032
### 2. Choose an Installation Method
3133

3234
Select one of the following methods to install and run the Render MCP Server.
3335

3436
#### Method A: Using Docker (Recommended)
37+
3538
This is the simplest way to get started if you have [Docker](https://www.docker.com) installed and running.
3639

3740
**Steps:**
41+
3842
1. Ensure Docker is installed and operational on your system.
3943
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:
4044
```json
@@ -63,12 +67,15 @@ This is the simplest way to get started if you have [Docker](https://www.docker.
6367
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=render&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXJtIC1lIFJFTkRFUl9BUElfS0VZIC12IHJlbmRlci1tY3Atc2VydmVyLWNvbmZpZzovY29uZmlnIGdoY3IuaW8vcmVuZGVyLW9zcy9yZW5kZXItbWNwLXNlcnZlciIsImVudiI6eyJSRU5ERVJfQVBJX0tFWSI6IllPVVJfQVBJX0tFWSJ9fQ%3D%3D)
6468

6569
#### Method B: Using the install script (Linux/MacOS only)
70+
6671
1. Run the following command:
72+
6773
```shell
6874
curl -fsSL https://raw.githubusercontent.com/render-oss/render-mcp-server/refs/heads/main/bin/install.sh | sh
6975
```
76+
7077
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:
7279
```json
7380
{
7481
"mcpServers": {
@@ -85,19 +92,23 @@ curl -fsSL https://raw.githubusercontent.com/render-oss/render-mcp-server/refs/h
8592
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/install-mcp?name=render&config=eyJjb21tYW5kIjoiL3BhdGgvdG8vcmVuZGVyLW1jcC1zZXJ2ZXIiLCJlbnYiOnsiUkVOREVSX0FQSV9LRVkiOiI8WU9VUl9BUElfS0VZPiJ9fQ%3D%3D)
8693

8794
#### Method C: Direct Download
95+
8896
Use this method if you prefer not to use Docker and a pre-compiled binary is available for your system.
8997

9098
**Steps:**
99+
91100
1. Open the MCP server's [GitHub releases page](https://github.com/render-oss/render-mcp-server/releases/).
92101
2. Download the executable that corresponds to your system's architecture.
93102
3. Note the full path to where you saved the downloaded executable.
94103
4. Configure your MCP client with the same settings as Method B.
95104
> **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.
96105
97106
#### Method D: Build from Source
107+
98108
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.
99109

100110
**Steps:**
111+
101112
1. Ensure Go is installed on your system.
102113
2. Clone the repository and build the executable:
103114
```shell
@@ -112,8 +123,8 @@ Choose this method if no pre-compiled binary suits your system, you want to buil
112123
## Limitations
113124

114125
> [!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).
117128
118129
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.
119130

@@ -134,9 +145,11 @@ feedback or would like to report a bug or feature request, please [create a GitH
134145
### Workspaces
135146

136147
- **list_workspaces** - List the workspaces that you have access to
148+
137149
- No parameters required
138150

139151
- **select_workspace** - Select a workspace to use
152+
140153
- `ownerID`: The ID of the workspace to use (string, required)
141154

142155
- **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
145158
### Services
146159

147160
- **list_services** - List all services in your Render account
161+
148162
- `includePreviews`: Whether to include preview services, defaults to false (boolean, optional)
149163

150164
- **get_service** - Get details about a specific service
165+
151166
- `serviceId`: The ID of the service to retrieve (string, required)
152167

153168
- **create_web_service** - Create a new web service in your Render account
169+
154170
- `name`: A unique name for your service (string, required)
155171
- `runtime`: Runtime environment for your service. Accepted values: 'node', 'python', 'go', 'rust', 'ruby', 'elixir', 'docker' (string, required)
156172
- `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
163179
- `envVars`: Environment variables array (array, optional)
164180

165181
- **create_static_site** - Create a new static site in your Render account
182+
166183
- `name`: A unique name for your service (string, required)
167184
- `buildCommand`: Command to build your app (string, required)
168185
- `repo`: Repository containing source code (string, optional)
@@ -178,6 +195,7 @@ feedback or would like to report a bug or feature request, please [create a GitH
178195
### Deployments
179196

180197
- **list_deploys** - List deployment history for a service
198+
181199
- `serviceId`: The ID of the service to get deployments for (string, required)
182200

183201
- **get_deploy** - Get details about a specific deployment
@@ -187,6 +205,7 @@ feedback or would like to report a bug or feature request, please [create a GitH
187205
### Logs
188206

189207
- **list_logs** - List logs matching the provided filters
208+
190209
- `resource`: Filter logs by their resource (array of strings, required)
191210
- `level`: Filter logs by their severity level (array of strings, optional)
192211
- `type`: Filter logs by their type (array of strings, optional)
@@ -233,13 +252,16 @@ feedback or would like to report a bug or feature request, please [create a GitH
233252
### Postgres Databases
234253

235254
- **query_render_postgres** - Run a read-only SQL query against a Render-hosted Postgres database
255+
236256
- `postgresId`: The ID of the Postgres instance to query (string, required)
237257
- `sql`: The SQL query to run (string, required)
238258

239259
- **list_postgres_instances** - List all PostgreSQL databases in your Render account
260+
240261
- No parameters required
241262

242263
- **get_postgres** - Get details about a specific PostgreSQL database
264+
243265
- `postgresId`: The ID of the PostgreSQL database to retrieve (string, required)
244266

245267
- **create_postgres** - Create a new PostgreSQL database
@@ -252,9 +274,11 @@ feedback or would like to report a bug or feature request, please [create a GitH
252274
### Key Value instances
253275

254276
- **list_key_value** - List all Key Value instances in your Render account
277+
255278
- No parameters required
256279

257280
- **get_key_value** - Get details about a specific Key Value instance
281+
258282
- `keyValueId`: The ID of the Key Value instance to retrieve (string, required)
259283

260284
- **create_key_value** - Create a new Key Value instance
@@ -314,11 +338,13 @@ feedback or would like to report a bug or feature request, please [create a GitH
314338
### Common Issues
315339

316340
1. **Connection Issues**
341+
317342
- Verify your RENDER_API_KEY is correct
318343
- Check your internet connection
319344
- Verify Render.com API status
320345

321346
2. **Authorization Errors**
347+
322348
- Check if your API key has expired
323349
- Ensure your API key is still valid and has not been revoked
324350

0 commit comments

Comments
 (0)