Skip to content

chore: Add Doc for Plane MCP Server Setup#251

Open
akshat5302 wants to merge 2 commits intomasterfrom
plane-mcp-server-setup-doc
Open

chore: Add Doc for Plane MCP Server Setup#251
akshat5302 wants to merge 2 commits intomasterfrom
plane-mcp-server-setup-doc

Conversation

@akshat5302
Copy link
Copy Markdown
Member

@akshat5302 akshat5302 commented Mar 26, 2026

Description

A guide detailing how to deploy and configure a self-hosted Plane MCP Server, including OAuth app setup, Docker Compose and Helm deployment options, client connection instructions, and troubleshooting steps.

Type of Change

  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive self-hosting guide for the Plane MCP Server: prerequisites, OAuth app setup (redirect URIs and scopes), deployment options (Docker Compose and Helm) with configuration examples, client integration instructions for Claude Desktop/Cursor/Windsurf, Claude Code, VSCode and HTTP/PAT workflows, plus troubleshooting steps, upgrade/reset commands, and support resources.

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Mar 26, 2026 10:47am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6b0fdeab-aee3-4ad8-83ab-315ba7d25a80

📥 Commits

Reviewing files that changed from the base of the PR and between c329f90 and 142af6a.

📒 Files selected for processing (1)
  • docs/dev-tools/mcp-server-self-hosted.md
✅ Files skipped from review due to trivial changes (1)
  • docs/dev-tools/mcp-server-self-hosted.md

📝 Walkthrough

Walkthrough

Added a new documentation page that guides self-hosting the Plane MCP Server: prerequisites, creating a Plane OAuth application, Docker Compose and Helm deployment instructions, AI client configuration examples (OAuth, PAT, legacy SSE), and troubleshooting steps for startup, Valkey, OAuth, and Docker Compose resets. (48 words)

Changes

Cohort / File(s) Summary
MCP Server Self-Hosting Documentation
docs/dev-tools/mcp-server-self-hosted.md
New end-to-end guide describing prerequisites, Plane OAuth application setup (redirect URIs, scopes, client ID/secret), Docker Compose and Helm deployment examples (sample docker-compose.yaml, variables.env, values.yaml, commands), AI client configuration snippets (Claude Desktop, Cursor, Windsurf, Claude Code, VSCode, HTTP/PAT), and troubleshooting (server startup, Valkey health, OAuth errors, Docker Compose reset).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I stitched a page for servers to host,
With OAuth threads and compose to boast,
Helm charts snug, and clients set free,
Logs whisper calm — all humming with glee. 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: Add Doc for Plane MCP Server Setup' accurately and concisely summarizes the main change: adding documentation for setting up the Plane MCP Server, matching the added documentation file and PR objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch plane-mcp-server-setup-doc

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/dev-tools/mcp-server-self-hosted.md (1)

233-342: Add a “Related docs” cross-link for transport discovery.

Consider adding a short “Related docs” note linking to /dev-tools/mcp-server (and specifically its Local Stdio transport section) so self-hosted users can quickly compare connection modes. This reduces navigation friction across the two MCP guides.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/dev-tools/mcp-server-self-hosted.md` around lines 233 - 342, Add a short
"Related docs" note at the end of the "Step 3: Connect your AI tools" section
that links to the MCP server guide's Local Stdio transport; specifically
reference the /dev-tools/mcp-server doc and its "Local Stdio transport"
subsection so readers can compare connection modes and discovery options. Keep
the note one or two sentences and place it just before the "Troubleshooting"
header to reduce navigation friction for self-hosted users.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/dev-tools/mcp-server-self-hosted.md`:
- Around line 233-342: Add a short "Related docs" note at the end of the "Step
3: Connect your AI tools" section that links to the MCP server guide's Local
Stdio transport; specifically reference the /dev-tools/mcp-server doc and its
"Local Stdio transport" subsection so readers can compare connection modes and
discovery options. Keep the note one or two sentences and place it just before
the "Troubleshooting" header to reduce navigation friction for self-hosted
users.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b623b853-e812-4392-b95e-f4bd20efa302

📥 Commits

Reviewing files that changed from the base of the PR and between ed97fd7 and c329f90.

📒 Files selected for processing (1)
  • docs/dev-tools/mcp-server-self-hosted.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant