Skip to content

Commit 39bfb3c

Browse files
committed
minor updates
1 parent 9318d5d commit 39bfb3c

1 file changed

Lines changed: 30 additions & 30 deletions

File tree

docs/dev-tools/mcp-server.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,7 @@ For cloud deployments, the server acts as an **OAuth proxy** to Plane's OAuth sy
3535
4. Subsequent MCP requests carry this token, from which the server extracts the workspace slug
3636

3737
The server supports OAuth redirect URIs for all major MCP clients:
38-
39-
- `http://localhost:*` (dynamic ports from desktop clients)
40-
- `cursor://`, `vscode://`, `vscode-insiders://`, `windsurf://`, `claude://`
38+
`cursor://`, `vscode://`, `vscode-insiders://`, `windsurf://`, `claude://`
4139

4240
### Header auth (HTTP with PAT Token)
4341

@@ -72,6 +70,8 @@ Plane uses two kinds of identifiers for work items.
7270

7371
## How-to guides
7472

73+
Plane hosts the MCP server for you at **`https://mcp.plane.so`**. If you run your own instance of the MCP server, replace `https://mcp.plane.so` with your own server's public URL (e.g., `https://mcp.yourcompany.com`) in all client config examples below.
74+
7575
### Prerequisites
7676

7777
**For all modes:**
@@ -136,7 +136,7 @@ Connects to a remote MCP server. Claude Desktop opens a browser window for the P
136136
{
137137
"mcpServers": {
138138
"plane": {
139-
"url": "https://your-mcp-server.com/http/mcp",
139+
"url": "https://mcp.plane.so/http/mcp",
140140
"type": "http"
141141
}
142142
}
@@ -151,7 +151,7 @@ Connects to the PAT endpoint using API key headers. No browser interaction requi
151151
{
152152
"mcpServers": {
153153
"plane": {
154-
"url": "https://your-mcp-server.com/http/api-key/mcp",
154+
"url": "https://mcp.plane.so/http/api-key/mcp",
155155
"type": "http",
156156
"headers": {
157157
"x-api-key": "your_api_key_here",
@@ -170,7 +170,7 @@ For existing integrations already using the SSE transport.
170170
{
171171
"mcpServers": {
172172
"plane": {
173-
"url": "https://your-mcp-server.com/sse",
173+
"url": "https://mcp.plane.so/sse",
174174
"type": "sse"
175175
}
176176
}
@@ -215,7 +215,7 @@ Settings file (`.claude/settings.json` for project scope, `~/.claude/settings.js
215215
```bash
216216
claude mcp add plane \
217217
--transport http \
218-
--url https://your-mcp-server.com/http/mcp
218+
--url https://mcp.plane.so/http/mcp
219219
```
220220

221221
Claude Code will open a browser for the Plane OAuth flow. Settings file equivalent:
@@ -224,7 +224,7 @@ Claude Code will open a browser for the Plane OAuth flow. Settings file equivale
224224
{
225225
"mcpServers": {
226226
"plane": {
227-
"url": "https://your-mcp-server.com/http/mcp",
227+
"url": "https://mcp.plane.so/http/mcp",
228228
"type": "http"
229229
}
230230
}
@@ -236,7 +236,7 @@ Claude Code will open a browser for the Plane OAuth flow. Settings file equivale
236236
```bash
237237
claude mcp add plane \
238238
--transport http \
239-
--url https://your-mcp-server.com/http/api-key/mcp \
239+
--url https://mcp.plane.so/http/api-key/mcp \
240240
--header "x-api-key: your_api_key_here" \
241241
--header "x-workspace-slug: your-workspace-slug"
242242
```
@@ -247,7 +247,7 @@ Settings file equivalent:
247247
{
248248
"mcpServers": {
249249
"plane": {
250-
"url": "https://your-mcp-server.com/http/api-key/mcp",
250+
"url": "https://mcp.plane.so/http/api-key/mcp",
251251
"type": "http",
252252
"headers": {
253253
"x-api-key": "your_api_key_here",
@@ -263,7 +263,7 @@ Settings file equivalent:
263263
```bash
264264
claude mcp add plane \
265265
--transport sse \
266-
--url https://your-mcp-server.com/sse
266+
--url https://mcp.plane.so/sse
267267
```
268268

269269
Settings file equivalent:
@@ -272,7 +272,7 @@ Settings file equivalent:
272272
{
273273
"mcpServers": {
274274
"plane": {
275-
"url": "https://your-mcp-server.com/sse",
275+
"url": "https://mcp.plane.so/sse",
276276
"type": "sse"
277277
}
278278
}
@@ -305,21 +305,21 @@ Claude.ai supports remote MCP servers for eligible plans. Because it runs in a b
305305
306306
#### HTTP with OAuth
307307
308-
1. Go to **SettingsIntegrations** in Claude.ai.
309-
2. Click **Add Integration**.
310-
3. Enter the server URL: `https://your-mcp-server.com/http/mcp`
308+
1. Go to **CustomizeConnectors ** in Claude.ai.
309+
2. Click **Add custom connector**.
310+
3. Enter the server URL: `https://mcp.plane.so/http/mcp`
311311
4. Claude.ai redirects you through the Plane OAuth flow.
312312
313313
#### HTTP with PAT Token
314314
315315
If your Claude.ai plan supports custom headers in integrations:
316316
317-
- URL: `https://your-mcp-server.com/http/api-key/mcp`
317+
- URL: `https://mcp.plane.so/http/api-key/mcp`
318318
- Headers: `x-api-key: your_api_key_here`, `x-workspace-slug: your-workspace-slug`
319319
320320
#### SSE (Legacy)
321321
322-
- URL: `https://your-mcp-server.com/sse`
322+
- URL: `https://mcp.plane.so/sse`
323323
324324
---
325325
@@ -355,7 +355,7 @@ The `cursor://` redirect URI is registered natively in the OAuth provider.
355355
{
356356
"mcpServers": {
357357
"plane": {
358-
"url": "https://your-mcp-server.com/http/mcp",
358+
"url": "https://mcp.plane.so/http/mcp",
359359
"type": "http"
360360
}
361361
}
@@ -368,7 +368,7 @@ The `cursor://` redirect URI is registered natively in the OAuth provider.
368368
{
369369
"mcpServers": {
370370
"plane": {
371-
"url": "https://your-mcp-server.com/http/api-key/mcp",
371+
"url": "https://mcp.plane.so/http/api-key/mcp",
372372
"type": "http",
373373
"headers": {
374374
"x-api-key": "your_api_key_here",
@@ -385,7 +385,7 @@ The `cursor://` redirect URI is registered natively in the OAuth provider.
385385
{
386386
"mcpServers": {
387387
"plane": {
388-
"url": "https://your-mcp-server.com/sse",
388+
"url": "https://mcp.plane.so/sse",
389389
"type": "sse"
390390
}
391391
}
@@ -424,7 +424,7 @@ Config can be set at workspace level (`.vscode/mcp.json`) or user level (VS Code
424424
{
425425
"servers": {
426426
"plane": {
427-
"url": "https://your-mcp-server.com/http/mcp",
427+
"url": "https://mcp.plane.so/http/mcp",
428428
"type": "http"
429429
}
430430
}
@@ -437,7 +437,7 @@ Config can be set at workspace level (`.vscode/mcp.json`) or user level (VS Code
437437
{
438438
"servers": {
439439
"plane": {
440-
"url": "https://your-mcp-server.com/http/api-key/mcp",
440+
"url": "https://mcp.plane.so/http/api-key/mcp",
441441
"type": "http",
442442
"headers": {
443443
"x-api-key": "your_api_key_here",
@@ -454,7 +454,7 @@ Config can be set at workspace level (`.vscode/mcp.json`) or user level (VS Code
454454
{
455455
"servers": {
456456
"plane": {
457-
"url": "https://your-mcp-server.com/sse",
457+
"url": "https://mcp.plane.so/sse",
458458
"type": "sse"
459459
}
460460
}
@@ -493,7 +493,7 @@ Restart Windsurf after saving, then open the Cascade panel. The `windsurf://` re
493493
{
494494
"mcpServers": {
495495
"plane": {
496-
"url": "https://your-mcp-server.com/http/mcp",
496+
"url": "https://mcp.plane.so/http/mcp",
497497
"type": "http"
498498
}
499499
}
@@ -506,7 +506,7 @@ Restart Windsurf after saving, then open the Cascade panel. The `windsurf://` re
506506
{
507507
"mcpServers": {
508508
"plane": {
509-
"url": "https://your-mcp-server.com/http/api-key/mcp",
509+
"url": "https://mcp.plane.so/http/api-key/mcp",
510510
"type": "http",
511511
"headers": {
512512
"x-api-key": "your_api_key_here",
@@ -523,7 +523,7 @@ Restart Windsurf after saving, then open the Cascade panel. The `windsurf://` re
523523
{
524524
"mcpServers": {
525525
"plane": {
526-
"url": "https://your-mcp-server.com/sse",
526+
"url": "https://mcp.plane.so/sse",
527527
"type": "sse"
528528
}
529529
}
@@ -563,7 +563,7 @@ Config file: `~/.config/zed/settings.json` under `"context_servers"`. Zed uses a
563563
{
564564
"context_servers": {
565565
"plane-mcp-server": {
566-
"url": "https://your-mcp-server.com/http/mcp",
566+
"url": "https://mcp.plane.so/http/mcp",
567567
"settings": {}
568568
}
569569
}
@@ -576,7 +576,7 @@ Config file: `~/.config/zed/settings.json` under `"context_servers"`. Zed uses a
576576
{
577577
"context_servers": {
578578
"plane-mcp-server": {
579-
"url": "https://your-mcp-server.com/http/api-key/mcp",
579+
"url": "https://mcp.plane.so/http/api-key/mcp",
580580
"headers": {
581581
"x-api-key": "your_api_key_here",
582582
"x-workspace-slug": "your-workspace-slug"
@@ -593,7 +593,7 @@ Config file: `~/.config/zed/settings.json` under `"context_servers"`. Zed uses a
593593
{
594594
"context_servers": {
595595
"plane-mcp-server": {
596-
"url": "https://your-mcp-server.com/sse",
596+
"url": "https://mcp.plane.so/sse",
597597
"settings": {}
598598
}
599599
}
@@ -1377,7 +1377,7 @@ Wiki-style documents. Pages can be workspace-scoped or project-scoped.
13771377
13781378
---
13791379
1380-
## Common Workflows
1380+
## Common workflows
13811381
13821382
### Look up a work item by ID
13831383

0 commit comments

Comments
 (0)