Skip to main content
Glama
Japx09
by Japx09
README.md
# Plane MCP Server

A custom Model Context Protocol (MCP) server for Plane task management, tailored for a self-hosted instance.

This server exposes a focused set of Plane API v1 endpoints as MCP tools, allowing AI models in clients like Claude Desktop, Cursor, or Windsurf to directly interact with your Plane workspace.

## Setup

1. **Install dependencies:**
   ```bash
   npm install
   ```

2. **Build the server:**
   ```bash
   npm run build
   ```

3. **Configure Environment Variables:**
   Copy `.env.example` to `.env` (or configure these directly in your MCP client):
   ```bash
   cp .env.example .env
   ```
   Fill in your `PLANE_API_KEY`. (Generate this in your Plane instance under **Profile Settings → API Tokens**).

## Configuration for MCP Clients

### Antigravity IDE / Claude Desktop
Add this to your MCP client configuration file:

```json
{
  "mcpServers": {
    "plane-custom": {
      "command": "node",
      "args": ["/Users/japhethgonzales/MCP Plane/dist/index.js"],
      "env": {
        "PLANE_API_KEY": "<your-api-key>",
        "PLANE_WORKSPACE_SLUG": "ensight",
        "PLANE_BASE_URL": "https://ensight-plane-taskmngr-u33417.vm.elestio.app"
      }
    }
  }
}
```

## Available Tools

- **Members**: `get_me`, `list_workspace_members`, `list_project_members`
- **Projects**: `list_projects`, `get_project`, `create_project`
- **States & Labels**: `list_states`, `list_labels`, `create_label`
- **Work Items (Issues)**: `list_work_items`, `get_work_item`, `create_work_item`, `update_work_item`, `delete_work_item`, `search_work_items`, `add_comment`, `list_comments`
- **Cycles (Sprints)**: `list_cycles`, `get_cycle`, `create_cycle`, `add_work_items_to_cycle`
- **Modules**: `list_modules`, `get_module`, `create_module`, `add_work_items_to_module`