plane-mcp-server
by: kelvin6365
plane mcp server
📌Overview
Purpose: To provide a Model Context Protocol (MCP) server that enables Large Language Models (LLMs) to interact with Plane.so for effective project and issue management.
Overview: The Plane MCP Server facilitates seamless communication between LLMs and Plane's robust project management API, allowing users to efficiently manage projects and issues while ensuring security and user control.
Key Features:
-
Project Management: List all projects in a workspace and retrieve detailed project information to stay organized and informed.
-
Issue Handling: Create new issues with customizable properties, and manage existing issues by listing, updating, or obtaining detailed information about specific issues, enabling flexible project issue tracking.
Plane MCP Server
A Model Context Protocol (MCP) server that enables LLMs to interact with Plane.so, allowing them to manage projects and issues through Plane's API. Using this server, LLMs like Claude can directly interact with your project management workflows while maintaining user control and security.
Features
- List all projects in your Plane workspace
- Get detailed information about specific projects
- Create new issues with customizable properties
- List and filter issues from projects
- Get detailed information about specific issues
- Update existing issues with new information
Prerequisites
- Node.js 22.x or higher
- A Plane.so API key
- A Plane.so workspace
Installation
Option 1: Using Smithery
The quickest way to get started is to use Smithery to install the server directly:
# Install to Claude for Desktop
npx -y @smithery/cli install @kelvin6365/plane-mcp-server --client claude
This command will automatically set up the Plane MCP Server for use with Claude. After installation, configure the server with your Plane API key and workspace slug through the Claude settings.
Valid client options include: claude, cline, windsurf, roo-cline, witsy, enconvo, cursor
Example for installing with Cursor:
npx -y @smithery/cli install @kelvin6365/plane-mcp-server --client cursor
Option 2: Manual Setup
If you prefer to set up the server manually, follow these steps:
- Clone this repository:
git clone https://github.com/kelvin6365/plane-mcp-server.git
cd plane-mcp-server
- Install dependencies:
npm install
- Build the server:
npm run build
Usage with Claude for Desktop
Note: If you used Option 1 (Smithery) above, you can skip this section.
-
Open your Claude for Desktop configuration file:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
- macOS:
-
Add the Plane MCP server configuration:
{
"mcpServers": {
"plane": {
"command": "node",
"args": ["path/to/plane-mcp-server/build/index.js"],
"env": {
"PLANE_API_KEY": "your_plane_api_key_here",
"PLANE_WORKSPACE_SLUG": "your_workspace_slug_here"
}
}
}
}
- Restart Claude for Desktop.
Available Tools
Note: Tool names use hyphens (e.g.,
list-projects
), not underscores. The server automatically converts underscores to hyphens for compatibility.
list-projects
Lists all projects in your Plane workspace.
Parameters: None
Example:
{}
get-project
Gets detailed information about a specific project.
Parameters:
project_id
: ID of the project to retrieve
Example:
{
"project_id": "01abc123-4567-89de-0123-456789abcdef"
}
create-issue
Creates a new issue in a specified project.
Parameters:
project_id
: ID of the project where the issue should be createdname
: Title of the issuedescription_html
: HTML description of the issue (required by Plane API)priority
(optional): Priority of the issue ("urgent", "high", "medium", "low", "none")state_id
(optional): ID of the state for this issueassignees
(optional): Array of user IDs to assign to this issue
Note: The
assignees
parameter must be an array of user ID strings. Avoid providing an object or nesting issue data insideassignees
.
Example:
{
"project_id": "01abc123-4567-89de-0123-456789abcdef",
"name": "Implement new feature",
"description_html": "<p>We need to implement the new reporting feature</p>",
"priority": "high",
"assignees": ["user-id-1", "user-id-2"]
}
list-issues
Lists issues from a specified project with optional filtering.
Parameters:
project_id
: ID of the project to get issues fromstate_id
(optional): Filter by state IDpriority
(optional): Filter by priorityassignee_id
(optional): Filter by assignee IDlimit
(optional): Maximum number of issues to return (default: 50)
Example:
{
"project_id": "01abc123-4567-89de-0123-456789abcdef",
"priority": "high",
"limit": 10
}
get-issue
Gets detailed information about a specific issue.
Parameters:
project_id
: ID of the project containing the issueissue_id
: ID of the issue to retrieve
Example:
{
"project_id": "01abc123-4567-89de-0123-456789abcdef",
"issue_id": "01def456-7890-12gh-3456-789ijklmnopq"
}
update-issue
Updates an existing issue in a project.
Parameters:
project_id
: ID of the project containing the issueissue_id
: ID of the issue to updatename
(optional): Updated title of the issuedescription_html
(optional): HTML description of the issue (required by Plane API)priority
(optional): Updated priority of the issuestate_id
(optional): Updated state ID of the issueassignees
(optional): Updated array of user IDs to assign to this issue
Note: The
assignees
parameter must be an array of user ID strings.
Example:
{
"project_id": "01abc123-4567-89de-0123-456789abcdef",
"issue_id": "01def456-7890-12gh-3456-789ijklmnopq",
"priority": "urgent",
"description_html": "<p>Updated description with <strong>more details</strong></p>"
}
Development
- Install development dependencies:
npm install --save-dev typescript @types/node
- Start the server in development mode:
npm run dev
Testing
Test the server using the MCP Inspector:
npx @modelcontextprotocol/inspector node dist/index.js
Examples
Example interactions to try with Claude after setting up the Plane MCP server:
- "Can you list all the projects in my Plane workspace?"
- "Please create a new high-priority issue in the Marketing project titled 'Update social media strategy'"
- "What are all the high-priority issues in the Development project?"
- "Update issue #123 in the QA project to change its priority to urgent"
Claude will use the appropriate tools to interact with Plane while asking for your approval before creating or modifying any issues.
Security Considerations
- The API key requires proper Plane permissions.
- All data modification operations require explicit user approval.
- Keep environment variables secure.
- Never commit API keys to version control.
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature
) - Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Support
If you encounter issues or have questions:
- Check the GitHub Issues section
- Consult the MCP documentation at modelcontextprotocol.io
- Open a new issue with detailed reproduction steps