JinDaGe - plane-mcp-server MCP Details

article

README

🚀 使用Plane MCP服务器

Plane 是一个功能强大的平台，可简化工作区的设置与管理。借助集成 Plane，您能轻松对问题、用户、角色、工作区等进行操作。

🚀 快速开始

安装和运行MCP服务器

您可以使用以下命令快速启动 MCP 服务器：

npx @makeplane/plane-mcp-server

配置环境变量

在运行 MCP 服务器之前，请确保设置以下环境变量： | 环境变量名 | 描述 | 必填 | |---------------------|------------------------------------------|------| | PLANE_API_KEY | Plane 的 API 访问密钥 | 是 | | PLANE_API_HOST_URL | Plane 的主机 URL（对于自托管） | 否 | | PLANE_WORKSPACE_SLUG | 工作区的唯一标识符 | 是 |

✨ 主要特性

核心概念

问题（Issues）：表示任务或需求。
平面（Planes）：指另一个系统或服务。
MCP 服务器：用于与 Plane 交互的接口。

📦 安装指南

此部分内容在“快速开始”中已详细说明，包括安装和运行 MCP 服务器的命令，以及配置环境变量的要求。

💻 使用示例

配置Claude Desktop

在 Claude Desktop 中配置 Plane MCP 服务器：

{
  "cli": {
    "mcpServer": {
      "command": "npx @makeplane/plane-mcp-server",
      "env": {
        "PLANE_API_KEY": "your_api_key_here",
        "PLANE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  }
}

配置Visual Studio Code

在 Visual Studio Code 中配置 Plane MCP 服务器：

{
  "configurations": [
    {
      "name": "Run Plane Server",
      "type": "shell",
      "command": "npx @makeplane/plane-mcp-server",
      "args": [],
      "env": {
        "PLANE_API_KEY": "your_api_key_here",
        "PLANE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  ]
}

📚 详细文档

项目管理

创建新项目

使用以下命令创建新的 Plane 项目：

plane create-project --name "New Project"

导出项目配置

将当前项目的配置导出为 JSON 文件：

plane export-config > project-config.json

用户管理

添加用户

添加一个新用户并分配角色：

plane add-user --email user@example.com --role developer

更新用户信息

更新现有用户的详细信息：

plane update-user --id 12345 --name "John Doe" --email john.doe@example.com

角色管理

列出所有角色

查看可用的角色及其权限：

plane list-roles

创建自定义角色

创建一个新的自定义角色并分配权限：

plane create-role --name "Dev Lead" --permissions ["manage-team", "view-reports"]

工作区管理

列出工作区

查看所有可用的工作区：

plane list-workspaces

创建新工作区

创建一个新的工作区并指定配置：

plane create-workspace --name "New Workspace" --config workspacesettings.json

问题追踪

创建问题

在项目中创建新的问题：

plane create-issue --project-id 12345 --title "Implement Feature X"

更新问题状态

更新现有问题的状态和详细信息：

plane update-issue --id 67890 --status "In Progress" --description "Working on feature implementation."

工作流管理

创建工作流

定义并创建一个新的自动化工作流：

plane create-workflow --name "Daily Backup" --script backup-script.sh

启用/禁用工作流

控制工作流的执行状态：

plane enable-workflow --id 12345

数据迁移

导出数据

将项目数据导出到指定目录：

plane export-data --project-id 67890 --output-dir /backups

进口数据

从备份文件中导入数据：

plane import-data --project-id 45678 --input-dir /backups/2023-10-01

监控和日志

查看实时监控

监控系统运行状态和性能指标：

plane monitor --dashboard

审查操作日志

查看用户操作的历史记录：

plane logs --operation audit

故障排除

检查服务状态

确认 MCP 服务器的运行状况：

plane status

重置数据库

在必要时重置数据库到初始状态：

plane reset-database

高级功能

API 文档

Plane 提供全面的 RESTful API，您可以参考以下链接获取详细信息： API 文档

扩展插件

Plane 支持多种扩展插件，增强其功能。更多信息请访问：插件文档

📄 许可证

Plane MCP 服务器遵循 MIT 许可证。请参阅LICENSE文件获取详细信息。

通过以上命令和配置，您可以轻松地管理和集成 Plane MCP 服务器到您的开发流程中。