feat: adding claude code mcp guide#204
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdds a new docs page "MCP Server for Claude Code" and a navigation entry linking to it under the Dev Tools section in the site config. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/dev-tools/mcp-server-claude-code.md`:
- Around line 139-211: The fenced prompt code blocks in
docs/dev-tools/mcp-server-claude-code.md lack language identifiers which
triggers markdownlint MD040; fix by updating each prompt fence (the opening ```
lines for blocks containing prompts like "List all projects in my workspace.",
"Create a bug in project WEB titled ...", "Search for work items related to
...", etc.) to include a language tag such as text (change ``` to ```text) so
every fenced prompt block has an explicit language identifier.
| **Prompt:** | ||
| ``` | ||
| List all projects in my workspace. | ||
| ``` | ||
|
|
||
| Claude Code calls `list_projects` and returns a summary of all projects including their identifiers, lead, and status. | ||
|
|
||
| ### Create a work item | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Create a bug in project WEB titled "Fix login redirect loop" and assign it to me. | ||
| ``` | ||
|
|
||
| Claude Code calls `get_me` to find your user ID, then `create_work_item` with the project ID, name, and assignee. | ||
|
|
||
| ### Search across work items | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Search for work items related to "authentication" across the workspace. | ||
| ``` | ||
|
|
||
| Claude Code calls `search_work_items` with the query string and returns matching results from all projects. | ||
|
|
||
| ### Plan a cycle | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Create a new cycle called "Sprint 24" in project WEB starting today and | ||
| ending in 2 weeks. Add work items WEB-102, WEB-115, and WEB-118 to it. | ||
| ``` | ||
|
|
||
| Claude Code calls `create_cycle` with the name and dates, then `add_work_items_to_cycle` to attach the specified items. | ||
|
|
||
| ### Triage intake items | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Show me all intake items in project MOBILE and accept the ones related to | ||
| crash reports. | ||
| ``` | ||
|
|
||
| Claude Code calls `list_intake_work_items` to retrieve pending items, then `update_intake_work_item` to accept the relevant ones. | ||
|
|
||
| ### Get a project overview | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Give me a summary of project BACKEND — what cycles are active, how many | ||
| open work items are there, and who are the members? | ||
| ``` | ||
|
|
||
| Claude Code calls `retrieve_project`, `list_cycles`, `list_work_items`, and `get_project_members` to assemble a full overview. | ||
|
|
||
| ### Manage modules | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Create a module called "Auth Revamp" in project WEB and add all work items | ||
| tagged with the "auth" label to it. | ||
| ``` | ||
|
|
||
| Claude Code calls `create_module`, then `list_work_items` with label filtering, and finally `add_work_items_to_module` to associate the items. | ||
|
|
||
| ### Move work items between cycles | ||
|
|
||
| **Prompt:** | ||
| ``` | ||
| Transfer all incomplete work items from "Sprint 23" to "Sprint 24" in | ||
| project WEB. | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Add language identifiers to fenced prompt blocks (MD040).
markdownlint flags these prompt fences; use a language like text to keep lint clean.
💡 Suggested fix
-```
+```text
List all projects in my workspace.@@
- +text
Create a bug in project WEB titled "Fix login redirect loop" and assign it to me.
@@
-```
+```text
Search for work items related to "authentication" across the workspace.
@@
- +text
Create a new cycle called "Sprint 24" in project WEB starting today and
ending in 2 weeks. Add work items WEB-102, WEB-115, and WEB-118 to it.
@@
-```
+```text
Show me all intake items in project MOBILE and accept the ones related to
crash reports.
@@
- +text
Give me a summary of project BACKEND — what cycles are active, how many
open work items are there, and who are the members?
@@
-```
+```text
Create a module called "Auth Revamp" in project WEB and add all work items
tagged with the "auth" label to it.
@@
- +text
Transfer all incomplete work items from "Sprint 23" to "Sprint 24" in
project WEB.
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 140-140: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 149-149: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 158-158: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 167-167: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 177-177: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 187-187: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 197-197: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 207-207: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@docs/dev-tools/mcp-server-claude-code.md` around lines 139 - 211, The fenced
prompt code blocks in docs/dev-tools/mcp-server-claude-code.md lack language
identifiers which triggers markdownlint MD040; fix by updating each prompt fence
(the opening ``` lines for blocks containing prompts like "List all projects in
my workspace.", "Create a bug in project WEB titled ...", "Search for work items
related to ...", etc.) to include a language tag such as text (change ``` to
```text) so every fenced prompt block has an explicit language identifier.
|
@sriramveeraghanta any reason you create a new page instead of adding this in existing MCP server page? |
|
I wanted to keep it separate for SEO. |
3 participants
Add MCP Server Documentation for Claude Code Integration
Summary
This PR adds comprehensive documentation for integrating Plane with Claude Code using the Model Context Protocol (MCP), enabling AI-assisted project management directly from the terminal.
Changes
New Documentation
docs/dev-tools/mcp-server-claude-code.md- Complete guide for setting up and using the Plane MCP server with Claude CodeUpdated Files
docs/.vitepress/config.mts- Added new page to sidebar under "Build and extend Plane"Documentation Contents
The new guide includes:
1. Three Setup Methods
2. Configuration Options
--scope local,project,user) to control config storage locationclaude mcp list,claude mcp get, and/mcp3. Available Tools Reference
Complete table of 55+ tools organized across 8 categories:
4. Practical Examples
8 real-world scenarios showing:
Examples cover:
5. Troubleshooting Guide
Common issues and solutions:
Testing
Screenshots
Add screenshots of the rendered documentation if available
Related
Summary by CodeRabbit