Plane MCP Server

🚀 Using the Plane MCP Server

Plane is a powerful platform designed to simplify the setup and management of workspaces. By integrating Plane, you can effortlessly perform operations on issues, users, roles, workspaces, and more.

✨ Features

Core Concepts

• Issues: Represent tasks or requirements.
• Planes: Refer to another system or service.
• MCP Server: An interface for interacting with Plane.

🚀 Quick Start

📦 Installation

You can quickly start the MCP server using the following command:

npx @makeplane/plane-mcp-server

Configuration

Before running the MCP server, make sure to set the following environment variables:

💻 Usage Examples

Project Management

Create a New Project

Use the following command to create a new Plane project:

plane create-project --name "New Project"

Export Project Configuration

Export the current project's configuration as a JSON file:

plane export-config > project-config.json

User Management

Add a User

Add a new user and assign a role:

plane add-user --email user@example.com --role developer

Update User Information

Update the details of an existing user:

plane update-user --id 12345 --name "John Doe" --email john.doe@example.com

Role Management

List All Roles

View available roles and their permissions:

plane list-roles

Create a Custom Role

Create a new custom role and assign permissions:

plane create-role --name "Dev Lead" --permissions ["manage-team", "view-reports"]

Workspace Management

List Workspaces

View all available workspaces:

plane list-workspaces

Create a New Workspace

Create a new workspace and specify the configuration:

plane create-workspace --name "New Workspace" --config workspacesettings.json

Issue Tracking

Create an Issue

Create a new issue in a project:

plane create-issue --project-id 12345 --title "Implement Feature X"

Update Issue Status

Update the status and details of an existing issue:

plane update-issue --id 67890 --status "In Progress" --description "Working on feature implementation."

Workflow Management

Create a Workflow

Define and create a new automated workflow:

plane create-workflow --name "Daily Backup" --script backup-script.sh

Enable/Disable a Workflow

Control the execution status of a workflow:

plane enable-workflow --id 12345

Data Migration

Export Data

Export project data to a specified directory:

plane export-data --project-id 67890 --output-dir /backups

Import Data

Import data from a backup file:

plane import-data --project-id 45678 --input-dir /backups/2023-10-01

Monitoring and Logging

View Real - Time Monitoring

Monitor the system's running status and performance metrics:

plane monitor --dashboard

Review Operation Logs

View the historical records of user operations:

plane logs --operation audit

Troubleshooting

Check Service Status

Confirm the running status of the MCP server:

plane status

Reset the Database

Reset the database to its initial state if necessary:

plane reset-database

📚 Documentation

API Documentation

Plane provides a comprehensive RESTful API. You can refer to the following link for detailed information: API Documentation

Extension Plugins

Plane supports various extension plugins to enhance its functionality. For more information, please visit: Plugin Documentation

Configuration Examples

Configure Claude Desktop

Configure the Plane MCP server in Claude Desktop:

{
  "cli": {
    "mcpServer": {
      "command": "npx @makeplane/plane-mcp-server",
      "env": {
        "PLANE_API_KEY": "your_api_key_here",
        "PLANE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  }
}

Configure Visual Studio Code

Configure the Plane MCP server in Visual Studio Code:

{
  "configurations": [
    {
      "name": "Run Plane Server",
      "type": "shell",
      "command": "npx @makeplane/plane-mcp-server",
      "args": [],
      "env": {
        "PLANE_API_KEY": "your_api_key_here",
        "PLANE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  ]
}

📄 License

The Plane MCP server is licensed under the MIT License. Please refer to the LICENSE file for detailed information.

With the above commands and configurations, you can easily manage and integrate the Plane MCP server into your development process.