|
| 1 | +--- |
| 2 | +title: Overview |
| 3 | +sidebar_label: Overview |
| 4 | +description: Use the Plane MCP server to integrate with Plane |
| 5 | +sidebar_position: 1 |
| 6 | +--- |
| 7 | + |
| 8 | +{frontMatter.description && <h3 class="description">{frontMatter.description}</h3>} |
| 9 | + |
| 10 | +## Introduction |
| 11 | + |
| 12 | +The [Model Context Protocol](https://modelcontextprotocol.io/overview) (MCP) is |
| 13 | +a standardized interface that enables AI models to communicate with external |
| 14 | +tools and services. When combined with Server-Sent Events (SSE), it provides a |
| 15 | +powerful mechanism for real-time data transfer between AI models and external |
| 16 | +systems. |
| 17 | + |
| 18 | +:::tip Alpha |
| 19 | +The Plane MCP Server is currently in **Alpha**. Some aspects of the API may change. |
| 20 | +While MCP is standardized, it is also rapidly evolving. The Plane MCP Server |
| 21 | +aims to provide a stable implementation that can be used by developers to build |
| 22 | +robust applications that leverage the power of AI. |
| 23 | +Please send feedback to [email protected]. |
| 24 | +::: |
| 25 | + |
| 26 | +## Using the Plane MCP Server |
| 27 | + |
| 28 | +Follow the steps below to integrate with the Plane MCP Server. |
| 29 | + |
| 30 | +### Claude.ai |
| 31 | + |
| 32 | +- Open **Settings** from the sidebar on the web or desktop app. |
| 33 | +- Scroll down to the **Integrations** section and click **Add more**. |
| 34 | +- Enter the following Integration URL: `https://mcp.plane.so/sse` |
| 35 | +- Click **Connect** to link your Plane workspace. |
| 36 | + |
| 37 | +### Claude Desktop |
| 38 | + |
| 39 | +You can add Plane to [Claude |
| 40 | +Desktop](https://modelcontextprotocol.io/quickstart/user) by updating your |
| 41 | +`claude_desktop_config.json`: |
| 42 | + |
| 43 | +```json |
| 44 | +{ |
| 45 | + "mcpServers": { |
| 46 | + "plane": { |
| 47 | + "command": "npx", |
| 48 | + "args": ["mcp-remote", "https://mcp.plane.so/sse"] |
| 49 | + } |
| 50 | + } |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +### VSCode |
| 55 | + |
| 56 | +You can also connect Plane to |
| 57 | +[VSCode](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server) |
| 58 | +by editing your `.vscode.json` or `mcp.json` file: |
| 59 | + |
| 60 | +```json |
| 61 | +{ |
| 62 | + "servers": { |
| 63 | + "plane": { |
| 64 | + "command": "npx", |
| 65 | + "args": ["mcp-remote", "https://mcp.plane.so/sse"] |
| 66 | + } |
| 67 | + } |
| 68 | +} |
| 69 | +``` |
| 70 | + |
| 71 | +If you face any issues with Plane Auth, please run the command below in the |
| 72 | +terminal to remove stale auth tokens. Then, restart the server. MCP Remote |
| 73 | +servers are still experimental. |
| 74 | + |
| 75 | +```bash |
| 76 | +rm -rf ~/.mcp-auth/mcp-remote-* |
| 77 | +``` |
| 78 | + |
| 79 | +## Activating the Plane MCP Server |
| 80 | + |
| 81 | +After following the above steps, when activating the server, you will be |
| 82 | +prompted via your browser to connect your Plane workspace to the MCP server. |
| 83 | + |
| 84 | +When prompted to authorize, click "**Approve**". |
| 85 | + |
| 86 | +import Approve from '@site/static/images/mcp/approve.png'; |
| 87 | + |
| 88 | +<img style={{width: '600px'}} src={Approve} alt="authorization" /> |
| 89 | + |
| 90 | +<br/> |
| 91 | +<br/> |
| 92 | +Next, choose the workspace to which you want to connect, review the permissions |
| 93 | +and click "**Accept**". |
| 94 | + |
| 95 | +import Accept from '@site/static/images/mcp/accept.png'; |
| 96 | + |
| 97 | +<img style={{width: '600px'}} src={Accept} alt="accept" /> |
| 98 | + |
| 99 | +## Congrats! |
| 100 | + |
| 101 | +You have successfully connected your Plane workspace to the MCP server! |
0 commit comments