使用说明
平面MCP
将Claude连接到您的Plane工作区,直接从Claude管理项目、工作项、周期、模块等。
这与官方的MCP飞机有何不同?
这 官方Plane MCP服务器 基于Python,支持云和自托管的Plane实例。它提供OAuth,托管HTTP端点(mcp.plane.so),以及Redis支持的会话。这个包裹是 轻量级Node.js替代品:
- 零基础设施 --通过以下方式在本地运行
npx,不需要Python/Docker/Redis - 单一依赖关系 --只是
@modelcontextprotocol/sdk,在几秒钟内安装 - 优化刀具数量 --默认情况下,77个核心工具(官方服务器中为80多个)经过调整,可用于可靠的AI模型工具选择,并具有选择加入扩展模式,可覆盖108个工具
- 批量操作 —
bulk_create_work_items具有自动速率限制处理功能(不在官方服务器中)
如果您需要OAuth或托管HTTP传输,请使用官方服务器。如果你想要一个在stdio上运行的快速、最小的Node.js MCP,请使用这个。
先决条件
你需要一个 平面API键.要生成一个:
- 首选
https://<your-plane-host>/<workspace>/settings/account/api-tokens - 点击 添加个人访问令牌
- 复制令牌
你也需要你的 工作空间段塞 (工作区的URL路径段,例如。 my-workspace).
设置
从npm安装包,并配置Claude Desktop或Claude Code来使用它。MCP服务器在每个用户的机器上本地运行,不需要托管基础设施。
运作原理
Your machine Cloud
┌─────────────────────────────┐
│ Claude Desktop / Claude Code│
│ ↕ stdio (stdin/stdout) │
│ plane-mcp-server (Node.js) │ ──HTTP──→ Plane Instance
└─────────────────────────────┘ (plane.company.com)
每个用户通过以下方式在本地运行服务器 npx服务器通过stdio接收来自Claude的工具调用,并使用用户的API键直接调用Plane REST API。
克劳德桌面版
添加到您的 claude_desktop_config.json:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
窗户: %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"plane": {
"command": "npx",
"args": ["-y", "@zethictech/plane-mcp-server"],
"env": {
"PLANE_BASE_URL": "https://your-plane-instance.com",
"PLANE_API_KEY": "YOUR_PLANE_API_KEY",
"DEFAULT_WORKSPACE_SLUG": "your-workspace-slug",
"PLANE_MCP_EXTENDED": "false"
}
}
}
}
集
PLANE_MCP_EXTENDED到"true"启用所有108个工具(管理、存档、摄入、时间跟踪等)。离开为"false"或者省略默认的77个核心工具。
保存后重新启动Claude Desktop。
克劳德代码
claude mcp add plane \
--command npx \
--args "@zethictech/plane-mcp-server" \
--env PLANE_BASE_URL=https://your-plane-instance.com \
--env PLANE_API_KEY=YOUR_PLANE_API_KEY \
--env DEFAULT_WORKSPACE_SLUG=your-workspace-slug \
--env PLANE_MCP_EXTENDED=false
添加
--env PLANE_MCP_EXTENDED=true完整的108套工具。
环境变量
| 变量 | 必填 | 描述 |
|---|---|---|
PLANE_BASE_URL |
是 | 您的Plane实例URL |
PLANE_API_KEY |
是 | 个人飞机API令牌 |
DEFAULT_WORKSPACE_SLUG |
是 | 来自您的Plane URL的工作区段塞 |
PLANE_MCP_EXTENDED |
否 | 设置为 true 启用所有108个工具(默认值:77) |
可用工具
默认情况下,服务器公开 77个核心工具 --通过AI模型优化了可靠的刀具选择。集 PLANE_MCP_EXTENDED=true 启用所有108个工具,包括管理、归档和利基功能。
核心工具(始终可用)
| 类别 | 工具 |
|---|---|
| 项目 | 列出、创建、检索、更新、删除项目;获取成员 |
| 工作项 | 列表、搜索、创建、更新、删除;按标识符检索(例如DEV-42) |
| 状态和标签 | 列出、创建、检索、更新、删除状态和标签 |
| 循环 | 列出、创建、检索、更新、删除;管理循环工作项目;转移 |
| 模块 | 列出、创建、检索、更新、删除;管理模块工作项 |
| 史诗 | 列表、创建、检索、更新、删除史诗 |
| 里程碑 | 列出、创建、检索、更新、删除;管理里程碑工作项 |
| 计划 | 列出、创建、检索、更新、删除计划 |
| 注释 | 列出、创建、检索、更新、删除工作项上的注释 |
| 关系和链接 | 管理工作项关系和外部链接 |
| 活动 | 列出工作项活动(审核日志) |
| 页面 | 创建、检索页面(工作区或项目) |
| 工作区 | 获取当前用户,获取成员 |
| 批量操作 | bulk_create_work_items --创建许多具有速率限制处理的项目 |
扩展工具(PLANE_MCP_EXTENDED=true)
| 类别 | 工具 |
|---|---|
| 项目管理 | 获取/更新项目功能;项目工作日志摘要 |
| 工作区管理 | 获取/更新工作区功能 |
| 循环存档 | 存档、非存档、列出存档的循环 |
| 模块存档 | 存档、非存档、列出存档的模块 |
| 工作项类型 | 列出、创建、检索、更新、删除工作项类型 |
| 工作项属性 | 列出、创建、检索、更新、删除自定义属性 |
| 取件 | 列出、创建、检索、更新、删除取件工作项 |
| 时间跟踪 | 列出、创建、更新、删除工作日志 |
| 活动(额外) | 检索单个活动条目 |
故障排除
服务器未启动?
- 验证是否已设置所有三个环境变量(
PLANE_BASE_URL,PLANE_API_KEY,DEFAULT_WORKSPACE_SLUG) - 检查您的Plane实例URL是否没有尾随斜线
- 跑
npx @zethictech/plane-mcp-server --version验证包裹装载情况
固定npx缓存?
npx --yes @zethictech/plane-mcp-server
API错误?
- 请确保您的API密钥有效并且可以访问工作区
- 检查工作区段符是否与Plane实例中的URL路径匹配
贡献
看 贡献.md 了解设置说明以及如何添加新工具。
许可证
麻省理工学院
