MP

makeplane/plane-mcp-server

开发工具官方

本页由 AI 翻译,技术细节请以原文为准。 查看原文

354 stars 205 forks 质量 86 趋势 35MIT

makeplane/plane-mcp-server 是从 https://github.com/makeplane/plane-mcp-server. 导入的 MCP 服务器候选

概览

makeplane/plane-mcp-server 是从 https://github.com/makeplane/plane-mcp-server. 导入的 MCP 服务器候选

概述(AI 翻译)

一个模型上下文协议服务器 Plane。为AI代理提供读取和管理项目的工具, 工作项目、周期、模块、发布、客户等等。

基于FastMCP和官方 plane-sdk。

  • 30个工具,每个平面资源一个,涵盖207项操作
  • 本地或远程 — stdio、可流式HTTP、SSE
  • OAuth 或 API 密钥 认证

快速开始

从 Plane 获取 API 密钥:Workspace 设置→ API 令牌。

将以下内容添加到你的MCP客户端配置中:

uvx 无需安装步骤。需要 Python 3.10+。

对于自主机飞机,添加"PLANE_BASE_URL": "https://plane.example.com"。

运输

Stdio — 本地

作为MCP客户端的一个子进程运行。配置如上所示;需求 PLANE_API_KEY 和 PLANE_WORKSPACE_SLUG。

HTTP with OAuth — 托管

https://mcp.plane.so/http/mcp

OAuth 流程在 Connect 上处理;配置中没有凭证。对于客户端 如果不支持本地远程MCP,则与mcp-remote桥接:

需要Node.js 22+。

带有个人访问令牌的HTTP — 托管

https://mcp.plane.so/http/api-key/mcp

头部 值
Authorization Bearer
X-Workspace-slug

本页由 AI 翻译,技术细节请以原文为准。

README

以下为原文 README 节选,完整内容请查看原文。

Plane MCP Server

A Model Context Protocol server for Plane. Gives an AI agent tools to read and manage projects, work items, cycles, modules, releases, customers and more.

Built on FastMCP and the official plane-sdk.

  • 30 tools, one per Plane resource, covering 207 operations
  • Local or remote — stdio, streamable HTTP, SSE
  • OAuth or API key authentication

Quick start

Get an API key from Plane: Workspace Settings → API tokens.

Add this to your MCP client’s configuration:

{
  "mcpServers": {
    "plane": {
      "command": "uvx",
      "args": ["plane-mcp-server", "stdio"],
      "env": {
        "PLANE_API_KEY": "",
        "PLANE_WORKSPACE_SLUG": ""
      }
    }
  }
}

uvx needs no install step. Requires Python 3.10+.

For a self-hosted Plane, add "PLANE_BASE_URL": "https://plane.example.com".

Transports

stdio — local

Runs as a subprocess of your MCP client. Configuration as shown above; needs PLANE_API_KEY and PLANE_WORKSPACE_SLUG.

PLANE_API_KEY=... PLANE_WORKSPACE_SLUG=... uvx plane-mcp-server stdio

HTTP with OAuth — hosted

https://mcp.plane.so/http/mcp

The OAuth flow is handled on connect; no credentials in your config. For clients without native remote MCP support, bridge with mcp-remote:

{
  "mcpServers": {
    "plane": {
      "command": "npx",
      "args": ["mcp-remote@latest", "https://mcp.plane.so/http/mcp"]
    }
  }
}

Requires Node.js 22+.

HTTP with a personal access token — hosted

https://mcp.plane.so/http/api-key/mcp

Header Value
Authorization Bearer
X-Workspace-slug ``
{
  "mcpServers": {
    "plane": {
      "command": "npx",
      "args": ["mcp-remote@latest", "https://mcp.plane.so/http/api-key/mcp"],
      "headers": {
        "Authorization": "Bearer ",
        "X-Workspace-slug": ""
      }
    }
  }
}

SSE — deprecated

https://mcp.plane.so/sse is maintained for backward compatibility only. Use an HTTP transport instead.

Tools

The server advertises 30 tools, one per resource. Each takes an action parameter that selects the operation:

workitem(action="create", project_id=..., name="Fix login")
workitem(action="list", project_id=..., pql='state__group = "started"')
cycle(action="archive", project_id=..., cycle_id=...)

Every tool’s description lists its actions with their required and optional parameters, so the catalogue is self-documenting at call time.

→ Full tool and action reference

Querying work items

List, count and search accept PQL, Plane’s query language:

workitem(action="list", project_id=..., pql='state__group = "started" AND priority = "urgent"')
在 GitHub 查看完整 README

安装

uvx plane-mcp-server stdio
新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "plane": { "command": "uvx", "args": ["plane-mcp-server", "stdio"], "env": { "PLANE_API_KEY": "<your-api-key>", "PLANE_WORKSPACE_SLUG": "<your-workspace-slug>" } } } }