Plane MCP Server

🚀 Platform MCP Server

The Platform MCP is a server - side protocol implementation for collaborating with Plane. It enables AI models to interact with Plane via the Model Context Protocol (MCP), performing operations such as creating, updating, and querying issues in projects.

🚀 Quick Start

The Platform MCP is a server - side protocol implementation that allows AI models to interact with the Plane platform through the Model Context Protocol (MCP). With this tool, AI models can perform operations like creating, updating, and querying issues in projects.

✨ Features

Core Features

1. Create Issue
   • Support specifying issue titles and descriptions.
   • Configure priority, status, and assignees.
2. Update Issue
   • Support partial field updates to avoid overwriting unrelated data.
   • Provide batch operation options.
3. Query Issue
   • Support filtering by project ID.
   • Specify sorting methods (e.g., by time or priority).
   • Limit the number of returned results, defaulting to 50.
4. List Projects
   • Get detailed information about all associated projects.
   • Include project names, IDs, and other metadata.

Other Features

• Follow RESTful API design principles.
• Support middleware extension.
• Provide a detailed error - handling mechanism.
• Have a built - in logging function.

📦 Installation

Quick Installation

npm install plane-mcp-server

Development Environment Installation

npm install --save-dev plane-mcp-server

💻 Usage Examples

Basic Usage

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const issue = await mcp.createIssue({
        title: 'New Feature Development',
        description: 'We need to implement a new user authentication module',
        priority: 'high',
        assignees: ['user-id-1', 'user-id-2']
    });

    console.log('Newly created issue:', issue);
}

main().catch(console.error);

Advanced Usage

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const projects = await mcp.listProjects();
    console.log('All projects:', projects);
}

main().catch(console.error);

📚 Documentation

Development Guide

Install Development Dependencies

npm install --save-dev typescript @types/node

Start the Development Server

npm run dev

Testing Method

Test using the MCP inspector:

npx @modelcontextprotocol/inspector dist/index.js

Example Scenarios

Here are some example scenarios for use with Claude:

1. "Please list all my projects."
2. "Create an issue in the 'New Feature Development' project with the description 'We need to implement a new user authentication module'."
3. "Update the priority of issue ID 123 to 'urgent'."

Contribution Guide

Code Submission Specifications

1. Each commit must include detailed commit information.
2. New features should be accompanied by unit tests.
3. Keep the code style consistent.

Submission Process

git add .
git commit -m "Add new feature: Support issue priority setting"
git push origin main

📄 License

This project is licensed under the MIT License. The specific content is as follows:

MIT License

Copyright (c) Year Author Name <Email Address>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Contact Information

If you have any questions or suggestions, please contact us:

• Email: contact@example.com
• GitHub: Your GitHub Link

Thank you for using the Plane MCP Server! For more help, please refer to our documentation at any time.