使用说明

项目简介

Plane MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器，它作为 LLM 客户端与 Plane 项目管理工具之间的桥梁。通过 Plane MCP Server，LLM 可以安全、可扩展地访问 Plane 平台上的项目、任务、工作日志等资源，并调用预置的工具来执行诸如创建项目、更新任务状态、添加评论等操作。这使得开发者能够构建基于 LLM 的智能应用，无缝集成 Plane 的项目管理生态系统。

主要功能点

项目与任务管理: 支持创建、读取、更新和删除 Plane 平台上的项目和任务（Issues）。
工作流管理: 允许 LLM 查询和操作任务的状态（States）、类型（Issue Types）和标签（Labels），以及模块（Modules）和周期（Cycles），实现工作流的自动化。
评论与工作日志: 支持为任务添加评论和记录工作日志，方便 LLM 理解和追踪任务进展。
用户信息获取: 提供获取当前用户信息和工作区成员信息的功能。
数据访问能力: 通过工具以 JSON 格式向 LLM 提供 Plane 平台上的各类数据，如项目列表、任务详情、工作日志等。

安装步骤

前提条件: 确保已安装 Node.js 和 npm (或 yarn)。

安装 Plane MCP Server: 由于该仓库已发布到 npm，您无需下载仓库代码，可以直接使用 npm 安装：

npm install -g @makeplane/plane-mcp-server

或者使用 yarn:

yarn global add @makeplane/plane-mcp-server

服务器配置

MCP 客户端（如 Claude Desktop, VSCode 等）需要配置 Plane MCP Server 的启动命令和参数才能连接。以下是配置示例，您需要根据您的实际环境进行调整。

Claude Desktop 配置 (编辑 'claude_desktop_config.json')

{
  "mcpServers": {
    "plane": {
       "command": "npx",
      "args": [
        "-y",
        "@makeplane/plane-mcp-server"
      ],
      "env": {
        "PLANE_API_KEY": "<YOUR_API_KEY>",  // 您的 Plane API 密钥，从 Plane UI 的 '/settings/api-tokens/' 页面获取
        "PLANE_API_HOST_URL": "<HOST_URL_FOR_SELF_HOSTED>", // 如果您使用自托管的 Plane，请替换为您的 Plane API Host URL，否则使用默认值 "https://api.plane.so/"
        "PLANE_WORKSPACE_SLUG": "<YOUR_WORKSPACE_SLUG>" // 您的 Plane 工作区 Slug
      }
    }
  }
}

VSCode 配置 (编辑 '.vscode/mcp.json')

{
  "servers": {
    "plane": {
      "command": "npx",
      "args": [
        "-y",
        "@makeplane/plane-mcp-server"
      ],
      "env": {
        "PLANE_API_KEY": "<YOUR_API_KEY>", // 您的 Plane API 密钥，从 Plane UI 的 '/settings/api-tokens/' 页面获取
        "PLANE_API_HOST_URL": "<HOST_URL_FOR_SELF_HOSTED>", // 如果您使用自托管的 Plane，请替换为您的 Plane API Host URL，否则使用默认值 "https://api.plane.so/"
        "PLANE_WORKSPACE_SLUG": "<YOUR_WORKSPACE_SLUG>" // 您的 Plane 工作区 Slug
      }
    }
  }
}

配置参数说明:

'PLANE_API_KEY': 必需。您的 Plane API 密钥，用于身份验证。
'PLANE_API_HOST_URL': 可选。Plane API 服务器的 Host URL。默认为 'https://api.plane.so/'，如果您使用自托管的 Plane 实例，请修改为您的 Host URL。
'PLANE_WORKSPACE_SLUG': 必需。您的 Plane 工作区的 Slug，用于指定操作的工作区。

基本使用方法

启动 MCP 服务器: 当 MCP 客户端（如 Claude Desktop, VSCode 等）尝试连接到 "plane" 服务器时，会根据您在配置文件中提供的 'command' 和 'args' 自动启动 Plane MCP Server。
在 LLM 中使用工具: 在支持 MCP 协议的 LLM 应用中，您可以指示 LLM 调用 Plane MCP Server 提供的工具来访问和操作 Plane 平台的数据。例如，您可以指示 LLM 使用 'get_projects' 工具来获取项目列表，或使用 'create_issue' 工具来创建一个新的任务。
工具列表: Plane MCP Server 提供了丰富的工具，涵盖项目、任务、状态、标签、周期、工作日志等多个方面。您可以在仓库的 README.md 文件或本说明文档的 “主要功能点” 部分查看完整的工具列表和使用方法。

注意: 您需要拥有有效的 Plane 账号和 API 密钥才能使用 Plane MCP Server 访问和操作 Plane 平台的数据。

关键词