首页
学习
活动
专区
圈层
工具
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往
首页
学习
活动
专区
圈层
工具
MCP广场
MCP广场 >详情页
plane-mcp-server2025-05-300分享
github
一种模型上下文协议服务器,使大型语言模型能够与Plane.so交互,通过Plane的API管理项目和问题,从而实现更高效的工作流管理。
By kelvin6365
2025-05-300
github
详情内容

Plane MCP 服务器

smithery 徽章

MseeP.ai 安全评估徽章

一个模型上下文协议(MCP)服务器,使LLM能够与Plane.so交互,允许它们通过Plane的API管理项目和问题。使用此服务器,像Claude这样的LLM可以直接与您的项目管理流程交互,同时保持用户控制和安全。

功能

  • 列出您Plane工作区中的所有项目
  • 获取特定项目的详细信息
  • 创建具有可自定义属性的新问题
  • 列出和过滤项目中的问题
  • 获取特定问题的详细信息
  • 使用新信息更新现有问题

先决条件

  • Node.js 22.x 或更高版本
  • Plane.so API密钥
  • Plane.so 工作区

安装

选项1:使用Smithery

最快的方法是使用Smithery直接安装服务器:

# 安装到Claude for Desktop
npx -y @smithery/cli install @kelvin6365/plane-mcp-server --client claude

此命令将自动设置Plane MCP服务器以与Claude一起使用。安装后,您需要通过Claude设置配置服务器,提供您的Plane API密钥和工作区slug。

有效的客户端选项包括:claude, cline, windsurf, roo-cline, witsy, enconvo, cursor

例如,使用Cursor安装:

npx -y @smithery/cli install @kelvin6365/plane-mcp-server --client cursor

选项2:手动设置

如果您更喜欢手动设置服务器,请按照以下步骤操作:

  1. 克隆此仓库:
git clone https://github.com/kelvin6365/plane-mcp-server.git
cd plane-mcp-server
  1. 安装依赖:
npm install
  1. 构建服务器:
npm run build

与Claude for Desktop一起使用

注意: 如果您使用了上述选项1(Smithery),可以跳过此部分。Smithery会自动为您配置MCP服务器。

  1. 打开您的Claude for Desktop配置文件:

    • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
    • Windows: %APPDATA%\Claude\claude_desktop_config.json
  2. 添加Plane MCP服务器配置:

{
  "mcpServers": {
    "plane": {
      "command": "node",
      "args": ["path/to/plane-mcp-server/build/index.js"],
      "env": {
        "PLANE_API_KEY": "your_plane_api_key_here",
        "PLANE_WORKSPACE_SLUG": "your_workspace_slug_here"
      }
    }
  }
}
  1. 重启Claude for Desktop

可用工具

注意: 工具名称使用连字符(例如list-projects),而不是下划线。服务器会自动将下划线转换为连字符以确保兼容性。

list-projects

列出您Plane工作区中的所有项目。

参数:无

示例:

{}

get-project

获取特定项目的详细信息。

参数:

  • project_id: 要检索的项目的ID

示例:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef"
}

create-issue

在指定项目中创建新问题。

参数:

  • project_id: 要创建问题的项目的ID
  • name: 问题的标题
  • description_html: 问题的HTML描述(Plane API要求)
  • priority (可选): 问题的优先级("urgent", "high", "medium", "low", "none")
  • state_id (可选): 此问题的状态ID
  • assignees (可选): 分配给此问题的用户ID数组

注意: assignees 参数必须是用户ID字符串的数组。常见错误包括提供字典/对象而不是数组,或意外地将整个问题数据嵌套在assignees字段中。服务器将尝试处理这些情况,但最好使用正确的格式。

示例:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "name": "实现新功能",
  "description_html": "<p>我们需要实现新的报告功能</p>",
  "priority": "high",
  "assignees": ["user-id-1", "user-id-2"]
}

list-issues

从指定项目中列出问题,并可选择过滤。

参数:

  • project_id: 要获取问题的项目的ID
  • state_id (可选): 按状态ID过滤
  • priority (可选): 按优先级过滤
  • assignee_id (可选): 按分配者ID过滤
  • limit (可选): 返回的最大问题数(默认:50)

示例:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "priority": "high",
  "limit": 10
}

get-issue

获取特定问题的详细信息。

参数:

  • project_id: 包含问题的项目的ID
  • issue_id: 要检索的问题的ID

示例:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "issue_id": "01def456-7890-12gh-3456-789ijklmnopq"
}

update-issue

更新项目中的现有问题。

参数:

  • project_id: 包含问题的项目的ID
  • issue_id: 要更新的问题的ID
  • name (可选): 问题的更新标题
  • description_html (可选): 问题的HTML描述(Plane API要求)
  • priority (可选): 问题的更新优先级
  • state_id (可选): 问题的更新状态ID
  • assignees (可选): 分配给此问题的更新用户ID数组

注意: assignees 参数必须是用户ID字符串的数组,遵循与create-issue工具相同的格式指南。

示例:

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "issue_id": "01def456-7890-12gh-3456-789ijklmnopq",
  "priority": "urgent",
  "description_html": "<p>更新描述,包含<strong>更多细节</strong></p>"
}

开发

  1. 安装开发依赖:
npm install --save-dev typescript @types/node
  1. 以开发模式启动服务器:
npm run dev

测试

您可以使用MCP Inspector测试服务器:

npx @modelcontextprotocol/inspector node dist/index.js

示例

在设置Plane MCP服务器后,您可以尝试以下与Claude的示例交互:

  1. "你能列出我Plane工作区中的所有项目吗?"
  2. "请在Marketing项目中创建一个高优先级的问题,标题为'更新社交媒体策略'"
  3. "Development项目中所有高优先级的问题是什么?"
  4. "将QA项目中的问题#123的优先级更新为紧急"

Claude将使用适当的工具与Plane交互,并在创建或修改任何问题之前请求您的批准。

安全注意事项

  • API密钥需要适当的Plane权限才能正常工作
  • 所有修改数据的操作都需要明确的用户批准
  • 环境变量应妥善保护
  • API密钥不应提交到版本控制

贡献

  1. Fork 仓库
  2. 创建您的功能分支 (git checkout -b feature/amazing-feature)
  3. 提交您的更改 (git commit -m '添加一些很棒的功能')
  4. 推送到分支 (git push origin feature/amazing-feature)
  5. 打开一个Pull Request

许可证

该项目根据MIT许可证授权 - 有关详细信息,请参阅LICENSE文件。

支持

如果您遇到任何问题或有疑问:

  1. 查看GitHub Issues部分
  2. 查阅MCP文档 modelcontextprotocol.io
  3. 打开一个新问题,并提供详细的复现步骤

星标历史

星标历史图表

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档