Updated the MCP Server#276
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughThis PR substantially rewrites ChangesPlane MCP Server Documentation Overhaul
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/dev-tools/mcp-server.md`:
- Around line 99-101: The fenced code block containing the example URL
"https://app.plane.so/acme-corp/" is missing a language tag; update the
triple-backtick fence to include a plaintext language (e.g., change ``` to
```text) so the block becomes ```text ... ``` to satisfy markdown linting and
Prettier formatting checks.
- Line 15: The phrase uses the incorrect single-word "usecase"; update the
sentence that currently reads "The server supports four transport modes. The
right one depends on your deployment and usecase." to use the two-word form "use
case" so it reads "...depends on your deployment and use case." Ensure the
documentation text in docs/dev-tools/mcp-server.md is replaced accordingly.
- Line 308: The emphasis marker contains an extra space — update the string "Go
to **Customize → Connectors ** in Claude.ai." to remove the space before the
closing emphasis marker so it reads "Go to **Customize → Connectors** in
Claude.ai.", ensuring the bold emphasis markers (`**`) directly enclose the text
to satisfy Prettier formatting checks.
- Around line 1384-1435: Several fenced code blocks in the "Common workflows"
examples are missing language tags causing Prettier/markdown-lint failures;
update each example code fence that contains natural-language prompts (e.g., the
blocks starting with "What is work item ENG-42 about?", "Create a high-priority
bug in the ENG project called \"Login times out on Safari\".", "Mark ENG-88 as
done and add a comment…", the "Sprint 15" cycle example, "Log 90 minutes on
ENG-42…", "Show me all high-priority bugs assigned to me…", and "Add ENG-55,
ENG-56, and ENG-57 to the \"Checkout Redesign\" module.") to use a plain text
language tag by changing ``` to ```text (or ```plaintext) so all seven blocks
use consistent language tags and pass formatting checks.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9f83720e-4708-4dcb-9695-8ec3ffe32650
📒 Files selected for processing (1)
docs/dev-tools/mcp-server.md
| ## Transport modes | ||
|
|
||
| ## Transport methods | ||
| The server supports four transport modes. The right one depends on your deployment and usecase. |
There was a problem hiding this comment.
Fix grammar: "use case" should be two words.
"usecase" should be "use case" for correct English grammar.
📝 Proposed fix
-The server supports four transport modes. The right one depends on your deployment and usecase.
+The server supports four transport modes. The right one depends on your deployment and use case.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The server supports four transport modes. The right one depends on your deployment and usecase. | |
| The server supports four transport modes. The right one depends on your deployment and use case. |
🧰 Tools
🪛 LanguageTool
[grammar] ~15-~15: Ensure spelling is correct
Context: ...ight one depends on your deployment and usecase. | Transport | For ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dev-tools/mcp-server.md` at line 15, The phrase uses the incorrect
single-word "usecase"; update the sentence that currently reads "The server
supports four transport modes. The right one depends on your deployment and
usecase." to use the two-word form "use case" so it reads "...depends on your
deployment and use case." Ensure the documentation text in
docs/dev-tools/mcp-server.md is replaced accordingly.
| ``` | ||
| https://app.plane.so/acme-corp/ | ||
| ``` |
There was a problem hiding this comment.
Add language tag to fenced code block.
Fenced code blocks should specify a language for proper syntax highlighting and to comply with markdown linting rules. For this URL example, use text or plaintext.
🔧 Proposed fix
-```
+```text
https://app.plane.so/acme-corp/</details>
As per coding guidelines, Prettier formatting checks must pass in CI.
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 99-99: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dev-tools/mcp-server.md` around lines 99 - 101, The fenced code block
containing the example URL "https://app.plane.so/acme-corp/" is missing a
language tag; update the triple-backtick fence to include a plaintext language
(e.g., change ``` to ```text) so the block becomes ```text ... ``` to satisfy
markdown linting and Prettier formatting checks.
|
|
||
| #### HTTP with OAuth | ||
|
|
||
| 1. Go to **Customize → Connectors ** in Claude.ai. |
There was a problem hiding this comment.
Remove extra space in emphasis markers.
There's an extra space before the closing emphasis marker: ** in Claude.ai. should be ** without the trailing space.
🔧 Proposed fix
-1. Go to **Customize → Connectors ** in Claude.ai.
+1. Go to **Customize → Connectors** in Claude.ai.As per coding guidelines, Prettier formatting checks must pass in CI.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Go to **Customize → Connectors ** in Claude.ai. | |
| 1. Go to **Customize → Connectors** in Claude.ai. |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 308-308: Spaces inside emphasis markers
(MD037, no-space-in-emphasis)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dev-tools/mcp-server.md` at line 308, The emphasis marker contains an
extra space — update the string "Go to **Customize → Connectors ** in
Claude.ai." to remove the space before the closing emphasis marker so it reads
"Go to **Customize → Connectors** in Claude.ai.", ensuring the bold emphasis
markers (`**`) directly enclose the text to satisfy Prettier formatting checks.
| ``` | ||
| What is work item ENG-42 about? | ||
| ``` | ||
|
|
||
| Model calls `retrieve_work_item_by_identifier` with `project_identifier="ENG"` and `work_item_identifier="42"`. | ||
|
|
||
| ### Create a work item | ||
|
|
||
| ``` | ||
| Create a high-priority bug in the ENG project called "Login times out on Safari". | ||
| Description: The OAuth callback redirects to a blank page on Safari 17+. | ||
| Assign it to me. | ||
| ``` | ||
|
|
||
| Model calls `list_projects` → `retrieve_work_item_by_identifier` (or `get_me` to resolve "me") → `create_work_item`. | ||
|
|
||
| ### Update work item state | ||
|
|
||
| ``` | ||
| Mark ENG-88 as done and add a comment: "Fixed in commit abc1234, needs QA." | ||
| ``` | ||
|
|
||
| Model resolves the UUID, calls `list_states` to find the Done state UUID, calls `update_work_item` and `create_work_item_comment`. | ||
|
|
||
| ### Sprint planning | ||
|
|
||
| ``` | ||
| Create a cycle called "Sprint 15" in ENG starting 2025-06-02, ending 2025-06-15. | ||
| Then move all incomplete issues from Sprint 14 into it. | ||
| ``` | ||
|
|
||
| Model calls `create_cycle` then `list_cycles` to find Sprint 14's UUID, then `transfer_cycle_work_items`. | ||
|
|
||
| ### Log time | ||
|
|
||
| ``` | ||
| Log 90 minutes on ENG-42: "Implemented retry logic for the upload endpoint." | ||
| ``` | ||
|
|
||
| ### Search across the workspace | ||
|
|
||
| ``` | ||
| Show me all high-priority bugs assigned to me that are still in progress. | ||
| ``` | ||
|
|
||
| Model calls `list_work_items` with filters `priorities=["high"]`, `state_groups=["started"]`, and the current user's UUID as `assignee_ids`. | ||
|
|
||
| ### Manage a module | ||
|
|
||
| ``` | ||
| Add ENG-55, ENG-56, and ENG-57 to the "Checkout Redesign" module. | ||
| ``` |
There was a problem hiding this comment.
Add language tags to workflow example code blocks.
All fenced code blocks in the Common workflows section lack language tags. For these natural language user prompt examples, use text or plaintext to comply with markdown linting rules.
🔧 Proposed fix for all workflow examples
Apply this pattern to all 7 code blocks in lines 1384, 1392, 1402, 1410, 1419, 1425, and 1433:
-```
+```text
What is work item ENG-42 about?
```diff
-```
+```text
Create a high-priority bug in the ENG project called "Login times out on Safari".
Description: The OAuth callback redirects to a blank page on Safari 17+.
Assign it to me.
Apply the same change to the remaining 5 code blocks.
</details>
As per coding guidelines, Prettier formatting checks must pass in CI.
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 1384-1384: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 1392-1392: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 1402-1402: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 1410-1410: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 1419-1419: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 1425-1425: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 1433-1433: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/dev-tools/mcp-server.md` around lines 1384 - 1435, Several fenced code
blocks in the "Common workflows" examples are missing language tags causing
Prettier/markdown-lint failures; update each example code fence that contains
natural-language prompts (e.g., the blocks starting with "What is work item
ENG-42 about?", "Create a high-priority bug in the ENG project called \"Login
times out on Safari\".", "Mark ENG-88 as done and add a comment…", the "Sprint
15" cycle example, "Log 90 minutes on ENG-42…", "Show me all high-priority bugs
assigned to me…", and "Add ENG-55, ENG-56, and ENG-57 to the \"Checkout
Redesign\" module.") to use a plain text language tag by changing ``` to ```text
(or ```plaintext) so all seven blocks use consistent language tags and pass
formatting checks.
1 participant
Description
Type of Change
Screenshots and Media (if applicable)
Test Scenarios
References
Summary by CodeRabbit