Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 180 additions & 0 deletions docs/ai/mcp.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
---
title: MCP Server
sidebar_label: MCP Server
description: Use the Plane MCP server to integrate with Plane
---


## Introduction

The [Model Context Protocol](https://modelcontextprotocol.io/overview) (MCP) is a
standardized interface that enables AI models to communicate with external tools and
services. When combined with Server-Sent Events (SSE), it provides a powerful
mechanism for real-time data transfer between AI models and external systems.

:::tip Alpha
The Plane MCP Server is currently in **Alpha**. Some aspects of the API may change.
While MCP is standardized, it is also rapidly evolving. The Plane MCP Server aims to
provide a stable implementation for developers to build robust AI-powered
applications. Please send any issues to support@plane.so.
:::

## Prerequisites

Before setting up the Plane MCP Server, ensure you have the following installed:

### Node.js and npm
- **Node.js**: Version 20 or later (LTS recommended)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Resolve Node.js version inconsistency.

Line 27 states "Node.js: Version 20 or later" while Line 168 states "MCP servers require Node.js 18 or later." This creates confusion about the actual minimum required version.

Please clarify and use a consistent minimum version throughout the document. If Node.js 18 is the true minimum, update line 27. If Node.js 20 is required, update line 168.

-Ensure you have a recent version of Node.js installed. MCP servers require Node.js 18 or later.
+Ensure you have a recent version of Node.js installed. MCP servers require Node.js 20 or later.

Also applies to: 168-168

🤖 Prompt for AI Agents
In docs/ai/mcp.mdx around lines 27 and 168, the Node.js version is inconsistent
(line 27 states "Node.js: Version 20 or later" while line 168 states "MCP
servers require Node.js 18 or later"); decide on the correct minimum (either 18
or 20) and make both occurrences match by updating the text at both line 27 and
line 168 to the chosen minimum version and, if applicable, add "LTS recommended"
consistently.

- **npm**: Comes bundled with Node.js
- **npx**: Comes bundled with npm

You can verify your installation by running:
```bash
node --version
npm --version
npx --version
```

If you don't have Node.js installed, download it from [nodejs.org](https://nodejs.org/).

:::note
The MCP server uses `npx` to run the `mcp-remote` package, which handles the connection to Plane's MCP server. This is why Node.js and npx are required.
:::

## Using the Plane MCP Server

Follow these steps to integrate with the Plane MCP Server.

### Claude.ai

- Open **Settings** from the sidebar on the web or desktop app.
- Scroll to the **Integrations** section and click **Add more**.
- Enter the Integration URL: `https://mcp.plane.so/sse`
- Click **Connect** to link your Plane workspace.

### Claude Desktop

Add Plane to [Claude Desktop](https://modelcontextprotocol.io/quickstart/user) by
updating your `claude_desktop_config.json`:

```json
{
"mcpServers": {
"plane": {
"command": "npx",
"args": ["mcp-remote", "https://mcp.plane.so/sse"]
}
}
}
```

### VSCode

Connect Plane to [VSCode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server)
by editing your `.vscode.json` or `mcp.json` file:

```json
{
"servers": {
"plane": {
"command": "npx",
"args": ["mcp-remote", "https://mcp.plane.so/sse"]
}
}
}
```
Comment on lines +71 to +85
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion | 🟠 Major

🧩 Analysis chain

Clarify VSCode configuration file location.

Line 74 mentions editing ".vscode.json or mcp.json" but the standard VSCode MCP configuration typically uses settings.json within the .vscode directory or a workspace-specific MCP configuration file. The .vscode.json filename seems non-standard.

Please verify the correct configuration file path for VSCode MCP servers. Consider updating to reference the actual file location users need to edit (e.g., .vscode/settings.json or workspace-specific MCP config).


🌐 Web query:

What is the correct configuration file for MCP servers in VSCode?

💡 Result:

You can configure MCP servers in one of three places in VS Code:

  • Workspace file .vscode/mcp.json (project-specific). [1]
  • VS Code settings.json under the "mcp" key (user or remote/user settings). [2]
  • A .code-workspace settings file under "settings.mcp". [2]

Sources: Omni docs showing .vscode/mcp.json creation and example. [1] VS Code GitHub test plan describing supported locations and schema. [2]


Correct VSCode MCP config file path
Replace “.vscode.json” with “.vscode/mcp.json” – VS Code loads MCP servers from the workspace file at .vscode/mcp.json (or via the mcp key in settings.json or a .code-workspace file).

🤖 Prompt for AI Agents
In docs/ai/mcp.mdx around lines 71 to 85, the VSCode configuration path is
incorrect: it references “.vscode.json” but VS Code expects the MCP servers file
at “.vscode/mcp.json” (or via the `mcp` key in settings.json or a
.code-workspace file). Update the text and example to mention and use the
correct workspace path `.vscode/mcp.json` and optionally note the alternate
locations (settings.json `mcp` key or .code-workspace) for clarity.


### Windsurf

1. Press `Ctrl/Cmd + ,` to open Windsurf settings
2. Navigate to **Cascade** > **MCP servers**
3. Select **Add Server** > **Add custom server**
4. Add the following configuration:

```json
{
"mcpServers": {
"plane": {
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.plane.so/sse"]
}
}
}
```

### Zed

1. Press `Cmd + ,` to open Zed settings
2. Add the following configuration:

```json
{
"context_servers": {
"plane": {
"source": "custom",
"command": "npx",
"args": ["-y", "mcp-remote", "https://mcp.plane.so/sse"],
"env": {}
}
}
}
```

## Activating the Plane MCP Server

After setup, when activating the server, you will be prompted in your browser to
connect your Plane workspace to the MCP server.

When prompted to authorize, click **Approve**.

Next, choose the workspace you want to connect, review the permissions, and click
**Accept**.

## Troubleshooting

### Common Issues

**Authentication Errors**

If you encounter authentication issues, clear saved auth tokens:

```bash
rm -rf ~/.mcp-auth
```

**Connection Timeouts**

- Ensure you have a stable internet connection
- Check if your firewall or proxy is blocking MCP connections
- Try using the HTTP endpoint instead of SSE if available

**WSL on Windows**

If you're using WSL on Windows and encountering errors, use this configuration:

```json
{
"mcpServers": {
"plane": {
"command": "wsl",
"args": ["npx", "-y", "mcp-remote", "https://mcp.plane.so/sse", "--transport sse-only"]
}
}
}
```

**Node.js Version**

Ensure you have a recent version of Node.js installed. MCP servers require Node.js 18 or later.

### Getting Help

If you continue to experience issues:

1. Verify your authentication credentials
2. Contact support at support@plane.so for Plane-specific issues
3. Check the [MCP community forums](https://modelcontextprotocol.io) for general MCP issues

## Congrats!

You have successfully connected your Plane workspace to the MCP server!
4 changes: 2 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ const sidebars: SidebarsConfig = {
type: "link",
label: "Self-host Plane",
href: "https://developers.plane.so/self-hosting/overview",
}
},
],
},
{
Expand Down Expand Up @@ -141,7 +141,7 @@ const sidebars: SidebarsConfig = {
type: "category",
collapsed: false,
label: "AI",
items: ["ai/pi-chat"],
items: ["ai/pi-chat", "ai/mcp"],
},

{
Expand Down