Plane MCP Server

🚀 使用Plane MCP服務器

Plane 是一個功能強大的平臺，可簡化工作區的設置與管理。通過集成 Plane，您能輕鬆對問題、用戶、角色、工作區等進行操作。

🚀 快速開始

安裝和運行MCP服務器

您可以使用以下命令快速啟動 MCP 服務器：

npx @makeplane/plane-mcp-server

配置環境變量

在運行 MCP 服務器之前，請確保設置以下環境變量：

✨ 主要特性

核心概念

• 問題（Issues）：表示任務或需求。
• 平面（Planes）：指另一個系統或服務。
• MCP 服務器：用於與 Plane 交互的接口。

📦 安裝指南

創建新項目

使用以下命令創建新的 Plane 項目：

plane create-project --name "New Project"

導出項目配置

將當前項目的配置導出為 JSON 文件：

plane export-config > project-config.json

💻 使用示例

基礎用法

配置 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 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 服務器到您的開發流程中。