kelvin6365/plane-mcp-server

完整文档

有效的 client 选项包括：claude, cline, windsurf, roo-cline, witsy, enconvo, cursor

使用 Cursor 安装的示例：

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

如果您倾向于手动设置服务器，请遵循以下步骤：

1. Clone 此 repository：

git clone https://github.com/kelvin6365/plane-mcp-server.git
cd plane-mcp-server

npm install

npm run build

> 注意： 如果你使用了上述的选项 1 (Smithery)，可以跳过本节。Smithery 会自动为你配置 MCP server。

1. 打开你的 Claude for Desktop 配置文件：

- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json

2. 添加 Plane MCP server 配置：

{
  "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",
        "PLANE_HOST": "optional"
      }
    }
  }
}

可用工具

> 注意： 工具名称使用连字符（例如 list-projects）而非下划线。服务器会自动将下划线转换为连字符以确保兼容性。

list-projects

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

参数：无

示例：

{}

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

参数：

• project_id: 要检索的项目 ID

示例：

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

在指定项目中创建新 issue。

参数：

• project_id: 创建 issue 的项目 ID

• name: issue 标题

• description_html: issue 的 HTML 描述（Plane API 必填）

• priority (可选): issue 优先级 ("urgent", "high", "medium", "low", "none")

• state_id (可选): 该 issue 的状态 ID

• assignees (可选): 分配给该 issue 的用户 ID 数组

> 注意： assignees 参数必须是用户 ID 字符串数组。常见错误包括提供字典/对象而非数组，或误将整个 issue 数据嵌套在 assignees 字段中。服务器会尝试处理这些情况，但建议使用正确格式。

示例：

{
  "project_id": "01abc123-4567-89de-0123-456789abcdef",
  "name": "Implement new feature",
  "description_html": "<p>We need to implement the new reporting feature</p>",
  "priority": "high",
  "assignees": ["user-id-1", "user-id-2"]
}

列出指定项目的 issue，支持可选过滤。

参数：

• project_id: 要获取 issue 的项目 ID

• state_id (可选): 按状态 ID 过滤

• priority (可选): 按优先级过滤

• assignee_id (可选): 按负责人 ID 过滤

• limit (可选): 返回 issue 的最大数量（默认：50）

示例：

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

获取特定 issue 的详细信息。

参数：

• project_id: 包含该 issue 的项目 ID

• issue_id: 要检索的 issue ID

示例：

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

更新项目中的现有 issue。

参数：

• project_id: 包含该 issue 的项目 ID

• issue_id: 要更新的 issue ID

• name (可选): 更新后的 issue 标题

• description_html (可选): issue 的 HTML 描述（Plane API 要求必填）

• priority (可选): 更新后的 issue 优先级

• state_id (可选): 更新后的 issue 状态 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>Updated description with <strong>more details</strong></p>"
}

1. 安装开发依赖：

npm install --save-dev typescript @types/node

npm run dev

你可以使用 MCP Inspector 来测试服务器：

npx @modelcontextprotocol/inspector node dist/index.js

在设置好 Plane MCP server 后，你可以尝试与 Claude 进行以下交互：

1. "Can you list all the projects in my Plane workspace?"
2. "Please create a new high-priority issue in the Marketing project titled 'Update social media strategy'"
3. "What are all the high-priority issues in the Development project?"
4. "Update issue #123 in the QA project to change its priority to urgent"

Claude 将使用相应的工具与 Plane 交互，并在创建或修改任何 issue 之前请求你的批准。

安全注意事项

• API key 需要具备相应的 Plane 权限才能正常工作

• 所有修改数据的操作都需要用户明确批准

• 环境变量应妥善加密

• API keys 绝不应提交至版本控制系统

贡献指南

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/amazing-feature)
3. 提交你的更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 提交 Pull Request

许可证

本项目采用 MIT License 许可证 - 详见 LICENSE 文件。

技术支持

如果你遇到任何问题或有疑问：

1. 查看 GitHub Issues 区域
2. 参考 modelcontextprotocol.io 的 MCP 文档
3. 提交一个新的 issue 并提供详细的复现步骤

Star 历史