feat: add docs for Plane MCP Server #357
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds a new user-facing documentation page for the Plane MCP Server and updates the site sidebar to include the new doc under the AI category. No code or API behavior changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Prashant-Surya
force-pushed
the
feat/mcp
branch
from
70b380b to
63cbd3e
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/ai/mcp.mdx(1 hunks)sidebars.ts(2 hunks)
🔇 Additional comments (10)
sidebars.ts (2)
32-32: LGTM!The trailing comma addition follows TypeScript best practices and improves future diff readability.
144-144: LGTM!The addition of "ai/mcp" correctly registers the new MCP Server documentation in the AI category sidebar.
docs/ai/mcp.mdx (8)
1-5: LGTM!The frontmatter is properly structured with appropriate title, sidebar label, and description for the MCP Server documentation.
8-20: LGTM!The introduction provides a clear explanation of MCP and SSE, and appropriately warns users about the Alpha status with a tip callout.
40-42: LGTM!The note callout effectively explains why Node.js and npx are prerequisites, helping users understand the dependency requirements.
48-68: LGTM!The configuration instructions for Claude.ai and Claude Desktop are clear and well-structured with proper JSON formatting.
87-121: LGTM!The Windsurf and Zed configuration instructions are clear and properly formatted, with appropriate step-by-step guidance.
123-131: LGTM!The activation flow is clearly explained with actionable steps for users to authorize and connect their workspace.
133-176: LGTM!The troubleshooting section covers common issues comprehensively, including authentication errors, connection timeouts, WSL-specific configuration, and Node.js version requirements. The Getting Help section provides appropriate escalation paths.
178-180: LGTM!The conclusion provides positive reinforcement for successful setup.
| 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) |
There was a problem hiding this comment.
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.
| ### 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"] | ||
| } | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
🛠️ 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.
|
Added on developer docs. Will link to that page from Docs |
Description
Type of Change
Summary by CodeRabbit