Skip to content

Commit 57cda8c

Browse files
Add remote mcp docs (#181)
* Add remote mcp docs
1 parent 3cc5569 commit 57cda8c

File tree

1 file changed

+180
-55
lines changed

1 file changed

+180
-55
lines changed

README.md

Lines changed: 180 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,54 @@ MCP DigitalOcean Integration is an open-source project that provides a comprehen
44

55
> **DISCLAIMER:** "Use of MCP technology to interact with your DigitalOcean account [can come with risks](https://www.wiz.io/blog/mcp-security-research-briefing)"
66
7-
## Prerequisites
7+
## Installation
88

9-
- Node.js (v18 or later)
10-
- NPM (v8 or later)
9+
### Remote MCP (Recommended)
1110

12-
You can find installation guides at [https://nodejs.org/en/download](https://nodejs.org/en/download)
11+
The easiest way to get started is to use DigitalOcean's hosted MCP services. Each service is deployed as a standalone MCP server accessible via HTTPS, allowing you to connect without running any local server. You can connect to multiple endpoints simultaneously by adding multiple entries to your configuration.
1312

13+
#### Available Services
14+
15+
| Service | Remote MCP URL | Description |
16+
|--------------|---------------------------------------------|-----------------------------------------------------------------------------------------|
17+
| apps | https://apps.mcp.digitalocean.com/mcp | Manage DigitalOcean App Platform applications, including deployments and configurations. |
18+
| accounts | https://accounts.mcp.digitalocean.com/mcp | Get information about your DigitalOcean account, billing, balance, invoices, and SSH keys. |
19+
| databases | https://databases.mcp.digitalocean.com/mcp | Provision, manage, and monitor managed database clusters (Postgres, MySQL, Redis, etc.). |
20+
| doks | https://doks.mcp.digitalocean.com/mcp | Manage DigitalOcean Kubernetes clusters and node pools. |
21+
| droplets | https://droplets.mcp.digitalocean.com/mcp | Create, manage, resize, snapshot, and monitor droplets (virtual machines) on DigitalOcean. |
22+
| insights | https://insights.mcp.digitalocean.com/mcp | Monitors your resources, endpoints and alert you when they're slow, unavailable, or SSL certificates are expiring. |
23+
| marketplace | https://marketplace.mcp.digitalocean.com/mcp| Discover and manage DigitalOcean Marketplace applications. |
24+
| networking | https://networking.mcp.digitalocean.com/mcp | Manage domains, DNS records, certificates, firewalls, load balancers, reserved IPs, BYOIP Prefixes, VPCs, and CDNs. |
25+
| spaces | https://spaces.mcp.digitalocean.com/mcp | DigitalOcean Spaces object storage and Spaces access keys for S3-compatible storage. |
26+
27+
---
28+
29+
### Claude Code
30+
31+
#### Remote MCP (Recommended)
32+
33+
To add a remote DigitalOcean MCP server to [Claude Code](https://www.anthropic.com/claude-code), run the following command in your terminal:
1434

15-
Verify your installation:
1635
```bash
17-
node --version
18-
npm --version
36+
claude mcp add --transport http digitalocean-apps https://apps.mcp.digitalocean.com/mcp \
37+
--header "Authorization: Bearer YOUR_API_TOKEN"
1938
```
2039

21-
## Quick Test
40+
Replace `YOUR_API_TOKEN` with your actual DigitalOcean API token.
41+
42+
You can add multiple services by running the command for each endpoint:
2243

23-
To verify the MCP server works correctly, you can test it directly from the command line:
2444
```bash
25-
npx @digitalocean/mcp --services apps
45+
claude mcp add --transport http digitalocean-databases https://databases.mcp.digitalocean.com/mcp \
46+
--header "Authorization: Bearer YOUR_API_TOKEN"
47+
48+
claude mcp add --transport http digitalocean-droplets https://droplets.mcp.digitalocean.com/mcp \
49+
--header "Authorization: Bearer YOUR_API_TOKEN"
2650
```
2751

28-
## Installation
52+
See the [Available Services](#available-services) section for the complete list of available endpoints.
2953

30-
### Claude Code
54+
#### Local Installation
3155

3256
To add the DigitalOcean MCP server to [Claude Code](https://www.anthropic.com/claude-code), run the following command in your terminal:
3357

@@ -62,25 +86,7 @@ To remove it:
6286
claude mcp remove digitalocean-mcp
6387
```
6488

65-
### Claude Desktop
66-
67-
Alternatively, add the following to your claude_desktop_config.json file.
68-
69-
```json
70-
{
71-
"mcpServers": {
72-
"digitalocean": {
73-
"command": "npx",
74-
"args": ["@digitalocean/mcp", "--services apps"],
75-
"env": {
76-
"DIGITALOCEAN_API_TOKEN": "YOUR_API_TOKEN"
77-
}
78-
}
79-
}
80-
}
81-
```
82-
83-
### Claude Code (User Scope)
89+
##### User Scope
8490

8591
Local scope is great when you're testing or only using the server in one project. User scope is better if you want it available everywhere.
8692

@@ -102,8 +108,84 @@ To remove it:
102108
claude mcp remove -s user digitalocean-mcp-user-scope
103109
```
104110

111+
---
112+
113+
### Claude Desktop
114+
115+
#### Remote MCP (Recommended)
116+
117+
Add the remote MCP servers to your `claude_desktop_config.json` file:
118+
119+
```json
120+
{
121+
"mcpServers": {
122+
"digitalocean-apps": {
123+
"url": "https://apps.mcp.digitalocean.com/mcp",
124+
"headers": {
125+
"Authorization": "Bearer YOUR_API_TOKEN"
126+
}
127+
},
128+
"digitalocean-databases": {
129+
"url": "https://databases.mcp.digitalocean.com/mcp",
130+
"headers": {
131+
"Authorization": "Bearer YOUR_API_TOKEN"
132+
}
133+
}
134+
}
135+
}
136+
```
137+
138+
You can add any of the endpoints listed in the [Available Services](#available-services) section.
139+
140+
#### Local Installation
141+
142+
Add the following to your `claude_desktop_config.json` file:
143+
144+
```json
145+
{
146+
"mcpServers": {
147+
"digitalocean": {
148+
"command": "npx",
149+
"args": ["@digitalocean/mcp", "--services", "apps"],
150+
"env": {
151+
"DIGITALOCEAN_API_TOKEN": "YOUR_API_TOKEN"
152+
}
153+
}
154+
}
155+
}
156+
```
157+
158+
---
159+
105160
### Cursor
106161

162+
#### Remote MCP (Recommended)
163+
164+
Add the remote MCP servers to your Cursor settings file located at `~/.cursor/config.json`:
165+
166+
```json
167+
{
168+
"mcpServers": {
169+
"digitalocean-apps": {
170+
"url": "https://apps.mcp.digitalocean.com/mcp",
171+
"headers": {
172+
"Authorization": "Bearer YOUR_API_TOKEN"
173+
}
174+
},
175+
"digitalocean-databases": {
176+
"url": "https://databases.mcp.digitalocean.com/mcp",
177+
"headers": {
178+
"Authorization": "Bearer YOUR_API_TOKEN"
179+
}
180+
}
181+
}
182+
}
183+
```
184+
185+
You can add any of the endpoints listed in the [Available Services](#available-services) section.
186+
187+
#### Local Installation
188+
107189
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=digitalocean&config=eyJjb21tYW5kIjoibnB4IEBkaWdpdGFsb2NlYW4vbWNwIC0tc2VydmljZXMgYXBwcyIsImVudiI6eyJESUdJVEFMT0NFQU5fQVBJX1RPS0VOIjoiWU9VUl9BUElfVE9LRU4ifX0%3D)
108190

109191
Add the following to your Cursor settings file located at `~/.cursor/config.json`:
@@ -122,7 +204,7 @@ Add the following to your Cursor settings file located at `~/.cursor/config.json
122204
}
123205
```
124206

125-
#### Verify Installation in Cursor
207+
##### Verify Installation
126208

127209
1. Open Cursor and open Command Pallet ( `Shift + ⌘ + P` on Mac or `Ctrl+ Shift + P` on Windows/Linux )
128210
2. Search for "MCP" in the command pallet search bar
@@ -131,20 +213,52 @@ Add the following to your Cursor settings file located at `~/.cursor/config.json
131213
5. You should see "digitalocean" listed under Available MCP Servers
132214
6. Click on "N tools enabled" (N is the number of tools currently enabled).
133215

134-
#### Debugging in Cursor
216+
##### Debugging
135217

136218
To check MCP server logs and debug issues:
137219
1. Open the Command Palette (⌘+Shift+P on Mac or Ctrl+Shift+P on Windows/Linux)
138220
2. Type "Developer: Toggle Developer Tools" and press Enter
139221
3. Navigate to the Console tab to view MCP server logs
140222
4. You'll find MCP related logs as you interact with the MCP server
141223

142-
#### Testing the Connection
224+
##### Testing the Connection
143225

144226
In Cursor's chat, try asking: "List all my DigitalOcean apps" - this should trigger the MCP server to fetch your apps if properly configured. If you are getting an 401 error or authentication related errors, it is likely due to misconfiguring your access token.
145227

228+
---
229+
146230
### VS Code
147231

232+
#### Remote MCP (Recommended)
233+
234+
Add the remote MCP servers to your VS Code MCP configuration file:
235+
236+
```json
237+
{
238+
"mcp": {
239+
"inputs": [],
240+
"servers": {
241+
"digitalocean-apps": {
242+
"url": "https://apps.mcp.digitalocean.com/mcp",
243+
"headers": {
244+
"Authorization": "Bearer YOUR_API_TOKEN"
245+
}
246+
},
247+
"digitalocean-databases": {
248+
"url": "https://databases.mcp.digitalocean.com/mcp",
249+
"headers": {
250+
"Authorization": "Bearer YOUR_API_TOKEN"
251+
}
252+
}
253+
}
254+
}
255+
}
256+
```
257+
258+
You can add any of the endpoints listed in the [Available Services](#available-services) section.
259+
260+
#### Local Installation
261+
148262
Add the following to your VS Code MCP configuration file:
149263

150264
```json
@@ -168,21 +282,21 @@ Add the following to your VS Code MCP configuration file:
168282
}
169283
```
170284

171-
#### Verify Installation in VS Code
285+
##### Verify Installation
172286

173-
1. Open Cursor and open Command Pallet ( `Shift + ⌘ + P` on Mac or `Ctrl+ Shift + P` on Windows/Linux )
287+
1. Open VS Code and open Command Pallet ( `Shift + ⌘ + P` on Mac or `Ctrl+ Shift + P` on Windows/Linux )
174288
2. Search for "MCP" in the command pallet search bar
175289
3. Select "MCP: List Servers"
176290
4. Verify that "mcpDigitalOcean" appears in the list of configured servers
177291

178-
#### Viewing Available Tools
292+
##### Viewing Available Tools
179293

180294
To see what tools are available from the MCP server:
181295
1. Open the Command Palette (⌘+Shift+P on Mac or Ctrl+Shift+P on Windows/Linux)
182296
2. Select "Agent" mode in the chatbox,
183297
3. Click "Configure tools" on the right, and check for digitalocean related tools under `MCP Server: mcpDigitalocean`. You should be able to list available tools like `app-create`, `app-list`, `app-delete`, etc.
184298

185-
#### Debugging in VS Code
299+
##### Debugging
186300

187301
To troubleshoot MCP connections:
188302
1. Open the Command Palette (⌘+Shift+P on Mac or Ctrl+Shift+P on Windows/Linux)
@@ -192,30 +306,41 @@ To troubleshoot MCP connections:
192306

193307
If you are getting an 401 error or authentication related errors, it is likely due to misconfiguring your access token.
194308

195-
## Configuration
309+
---
310+
311+
## Prerequisites for Local Installation
312+
313+
If you're using the local installation method (not Remote MCP), you'll need:
314+
315+
- Node.js (v18 or later)
316+
- NPM (v8 or later)
317+
318+
You can find installation guides at [https://nodejs.org/en/download](https://nodejs.org/en/download)
319+
320+
Verify your installation:
321+
```bash
322+
node --version
323+
npm --version
324+
```
196325

197-
To configure tools, you use the `--services` flag to specify which service you want to enable. It is highly recommended to only
198-
enable the services you need to reduce context size and improve accuracy. See list of supported services below.
326+
### Quick Test
199327

328+
To verify the local MCP server works correctly, you can test it directly from the command line:
200329
```bash
201-
npx @digitalocean/mcp --services apps,droplets
330+
npx @digitalocean/mcp --services apps
202331
```
203332

204-
## Supported Services
333+
---
334+
335+
## Configuration
336+
337+
### Local Installation Configuration
205338

206-
The MCP DigitalOcean Integration supports the following services, allowing users to manage their DigitalOcean infrastructure effectively
339+
When using the local installation, you use the `--services` flag to specify which service you want to enable. It is highly recommended to only enable the services you need to reduce context size and improve accuracy. See list of supported services below.
207340

208-
| Service | Description |
209-
|--------------|-----------------------------------------------------------------------------------------|
210-
| apps | Manage DigitalOcean App Platform applications, including deployments and configurations. |
211-
| droplets | Create, manage, resize, snapshot, and monitor droplets (virtual machines) on DigitalOcean. |
212-
| accounts | Get information about your DigitalOcean account, billing, balance, invoices, and SSH keys. |
213-
| networking | Manage domains, DNS records, certificates, firewalls, load balancers, reserved IPs, BYOIP Prefixes, VPCs, and CDNs. |
214-
| insights | Monitors your resources, endpoints and alert you when they're slow, unavailable, or SSL certificates are expiring. |
215-
| spaces | DigitalOcean Spaces object storage and Spaces access keys for S3-compatible storage. |
216-
| databases | Provision, manage, and monitor managed database clusters (Postgres, MySQL, Redis, etc.). |
217-
| marketplace | Discover and manage DigitalOcean Marketplace applications. |
218-
| doks | Manage DigitalOcean Kubernetes clusters and node pools. |
341+
```bash
342+
npx @digitalocean/mcp --services apps,droplets
343+
```
219344

220345
## Documentation
221346

0 commit comments

Comments
 (0)