平面-MCP服务器

Name: 平面-MCP服务器
Author: makeplane

作者：makeplane111 星标更新：2025-11-17

安装使用来源：spider==github.com

项目介绍

平台 MCP 服务器

平台 MCP 服务器将模型上下文协议（MCP）引入到平台中，使AI代理和开发者工具能够与您的平台工作区进行程序化交互。

无论您是在构建智能助手、自动化脚本还是流程驱动工具，此服务器都提供了一个无缝连接到平台API的桥梁——这样您可以创建项目、管理问题、分配任务，并通过AI驱动工具保持工作同步。

您可以使用它做什么？

此服务器解锁了所有使用平台人员的各种有用功能：

直接从您的AI或应用程序界面启动项目和工作任务。
更新进度、分配团队成员、设置属性或添加评论——所有操作都可以通过编程方式完成。
将问题推进到工作流中并实时更新其状态。
使用标签、模块和周期组织工作。
分析团队在各个项目中的工作数据。
构建与平台自然交互的智能应用——无论是AI代理记录工作，还是机器人保持项目整洁。

使用方法

配置参数

PLANE_API_KEY - 您的平台API令牌。您可以在平台应用的工作区设置 > API令牌页面 (/settings/api-tokens/) 中生成一个。
PLANE_WORKSPACE_SLUG - 您的平台实例的工作区标识符。工作区标识符代表平台中工作区的唯一标识符。它可以在URL中找到。
PLANE_API_HOST_URL（可选） - 平台API服务器的主机URL。默认值为 https://api.plane.so/

Claude Desktop

您可以通过更新 claude_desktop_config.json 文件将平台添加到 Claude Desktop：

{
  "mcpServers": {
    "plane": {
       "command": "npx",
      "args": [
        "-y",
        "@makeplane/plane-mcp-server"
      ],
      "env": {
        "PLANE_API_KEY": "<YOUR_API_KEY>",
        "PLANE_API_HOST_URL": "<HOST_URL_FOR_SELF_HOSTED>",
        "PLANE_WORKSPACE_SLUG": "<YOUR_WORKSPACE_SLUG>"
      }
    }
  }
}

VSCode

您也可以通过编辑 .vscode.json 或 mcp.json 文件将平台连接到 VSCode：

{
  "servers": {
    "plane": {
      "command": "npx",
      "args": [
        "-y",
        "@makeplane/plane-mcp-server"
      ],
      "env": {
        "PLANE_API_KEY": "<YOUR_API_KEY>",
        "PLANE_API_HOST_URL": "<HOST_URL_FOR_SELF_HOSTED>",
        "PLANE_WORKSPACE_SLUG": "<YOUR_WORKSPACE_SLUG>"
      }
    }
  }
}

工具

用户

get_user
- 获取当前用户的信息
- 不需要任何参数

项目

get_projects
- 获取当前用户的全部项目
- 不需要任何参数
create_project
- 创建新项目
- 参数：
  - name (字符串，必需)：项目名称

问题类型

list_issue_types
- 获取特定项目的全部问题类型
- 参数：
  - project_id (字符串，必需)：项目的UUID
get_issue_type
- 获取特定问题类型的详细信息
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - type_id (字符串，必需)：问题类型的UUID
create_issue_type
- 在项目中创建新的问题类型
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_type_data：包含以下字段的对象：
    - name (字符串，必需)：问题类型的名称
    - description (字符串，必需)：问题类型的描述
update_issue_type
- 更新现有问题类型
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - type_id (字符串，必需)：问题类型的UUID
  - issue_type_data (对象)：要更新的问题类型字段
delete_issue_type
- 删除问题类型
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - type_id (字符串，必需)：问题类型的UUID

状态

list_states
- 获取特定项目的全部状态
- 参数：
  - project_id (字符串，必需)：项目的UUID
get_state
- 获取特定状态的详细信息
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - state_id (字符串，必需)：状态的UUID
create_state
- 在项目中创建新的状态
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - state_data：包含以下字段的对象：
    - name (字符串，必需)：状态的名称
    - color (字符串，必需)：状态的颜色代码
update_state
- 更新现有状态
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - state_id (字符串，必需)：状态的UUID
  - state_data (对象)：要更新的状态字段
delete_state
- 删除状态
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - state_id (字符串，必需)：状态的UUID

问题

get_issue_using_readable_identifier
- 使用可读标识符获取问题详情（例如，PROJ-123）
- 参数：
  - project_identifier (字符串，必需)
  - issue_identifier (字符串，必需)：问题编号：项目标识符（例如，“PROJ”）或（例如，“123”）
get_issue_comments
- 获取特定问题的所有评论
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
add_issue_comment
- 向问题添加评论
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
  - comment_html (字符串，必需)：评论的HTML内容
create_issue
- 创建新问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_data：包含以下字段的对象：
  - name (字符串，必需)：问题的标题
  - description_html (字符串，必需)：问题的HTML描述
update_issue
- 更新现有问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
  - issue_data (对象)：要更新的问题字段

模块

list_modules
- 获取特定项目的全部模块
- 参数：
  - project_id (字符串，必需)：项目的UUID
get_module
- 获取特定模块的详细信息
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_id (字符串，必需)：模块的UUID
create_module
- 在项目中创建新的模块
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_data：包含以下字段的对象：
    - name (字符串，必需)：模块的名称
update_module
- 更新现有模块
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_id (字符串，必需)：模块的UUID
  - module_data (对象)：要更新的模块字段
delete_module
- 删除模块
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_id (字符串，必需)：模块的UUID

模块问题

list_module_issues
- 获取特定模块的所有问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_id (字符串，必需)：模块的UUID
add_module_issues
- 向模块添加问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_id (字符串，必需)：模块的UUID
  - issues (字符串数组，必需)：要添加的问题UUID数组
delete_module_issue
- 从模块中移除问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - module_id (字符串，必需)：模块的UUID
  - issue_id (字符串，必需)：要移除的问题的UUID

周期

list_cycles
- 获取特定项目的全部周期
- 参数：
  - project_id (字符串，必需)：项目的UUID
get_cycle
- 获取特定周期的详细信息
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_id (字符串，必需)：周期的UUID
create_cycle
- 在项目中创建新的周期
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_data：包含以下字段的对象：
  - name (字符串，必需)：周期的名称
  - start_date (字符串，必需)：开始日期（YYYY-MM-DD）
  - end_date (字符串，必需)：结束日期（YYYY-MM-DD）
update_cycle
- 更新现有周期
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_id (字符串，必需)：周期的UUID
  - cycle_data (对象)：要更新的周期字段
delete_cycle
- 删除周期
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_id (字符串，必需)：周期的UUID

周期问题

list_cycle_issues
- 获取特定周期的所有问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_id (字符串，必需)：周期的UUID
add_cycle_issues
- 向周期添加问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_id (字符串，必需)：周期的UUID
  - issues (字符串数组，必需)：要添加的问题UUID数组
delete_cycle_issue
- 从周期中移除问题
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - cycle_id (字符串，必需)：周期的UUID
  - issue_id (字符串，必需)：要移除的问题的UUID

工作日志

get_issue_worklogs
- 获取特定问题的所有工作日志
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
get_total_worklogs
- 获取项目的总记录时间
- 参数：
  - project_id (字符串，必需)：项目的UUID
create_worklog
- 为问题创建新的工作日志
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
  - worklog_data：包含以下字段的对象：
    - description (字符串，必需)：已完成工作的描述
    - duration (整数，必需)：持续时间（分钟）
update_worklog
- 更新现有工作日志
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
  - worklog_id (字符串，必需)：工作日志的UUID
  - worklog_data (对象)：要更新的工作日志字段
delete_worklog
- 删除工作日志
- 参数：
  - project_id (字符串，必需)：项目的UUID
  - issue_id (字符串，必需)：问题的UUID
  - worklog_id (字符串，必需)：工作日志的UUID

许可证

此MCP服务器采用MIT许可证。这意味着您可以在遵守MIT许可证条款和条件的前提下自由使用、修改和分发该软件。如需更多细节，请参阅项目存储库中的LICENSE文件。