Plane MCP Server

🚀 平臺 MCP 服務器端

平臺 MCP 服務器端是一個用於與 Plane 協作的服務器端協議實現。藉助此工具，AI 模型能夠通過 Model Context Protocol（MCP）與 Plane 進行交互，實現創建、更新和查詢項目中的問題等操作，為項目管理提供了高效的解決方案。

🚀 快速開始

平臺 MCP 是遵循 Model Context Protocol（MCP）的實現，可讓 AI 模型與 Plane 平臺交互，實現創建、更新和查詢問題等功能。你可以按照以下步驟進行安裝和使用。

📦 安裝指南

快速安裝

在生產環境中，你可以使用以下命令快速安裝：

npm install plane-mcp-server

開發環境安裝

若你處於開發環境，可使用以下命令安裝：

npm install --save-dev plane-mcp-server

✨ 主要特性

核心功能

1. 創建問題
   • 支持指定問題標題和描述，讓問題信息更清晰。
   • 可靈活配置優先級、狀態和分配人，滿足不同場景需求。
2. 更新問題
   • 支持部分字段更新，避免覆蓋無關數據，保護已有信息。
   • 提供批量操作選項，提高處理效率。
3. 查詢問題
   • 支持按項目 ID 篩選，精準定位所需問題。
   • 可指定排序方式（如按時間或優先級），方便查看。
   • 限制返回結果數量，默認為 50，避免數據過多。
4. 列出項目
   • 獲取所有關聯項目的詳細信息，包括項目名稱、ID 和其他元數據。

其他特性

• 遵循 RESTful API 設計原則，保證接口的規範性和可擴展性。
• 支持中間件擴展，方便根據需求定製功能。
• 提供詳細的錯誤處理機制，及時反饋問題。
• 內置日誌記錄功能，便於排查和分析。

💻 使用示例

基礎用法

創建問題

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const issue = await mcp.createIssue({
        title: '新功能開發',
        description: '我們需要實現新的用戶認證模塊',
        priority: 'high',
        assignees: ['user-id-1', 'user-id-2']
    });

    console.log('新建問題:', issue);
}

main().catch(console.error);

查詢項目

const { PlaneMCP } = require('plane-mcp-server');

async function main() {
    const mcp = new PlaneMCP({
        projectId: 'your-project-id',
        planeApiKey: 'your-plane-api-key'
    });

    const projects = await mcp.listProjects();
    console.log('所有項目:', projects);
}

main().catch(console.error);

📚 詳細文檔

開發指南

安裝開發依賴

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

啟動開發服務器

npm run dev

測試方法

使用 MCP 檢查器進行測試：

npx @modelcontextprotocol/inspector dist/index.js

示例用法

以下是與 Claude 配合使用的一些示例場景：

1. "請列出我所有的項目"
2. "在 '新功能開發' 項目中創建一個問題，描述為 '我們需要實現新的用戶認證模塊'"
3. "更新問題 ID 123 的優先級為 'urgent'"

貢獻指南

提交代碼規範

1. 每個提交必須包含詳細的提交信息，方便後續查看和理解。
2. 新功能需配套單元測試，確保代碼質量。
3. 保持代碼風格一致，提高代碼可讀性。

提交流程

git add .
git commit -m "添加新功能：支持問題優先級設置"
git push origin main

📄 許可證

本項目遵循 MIT 許可證，具體內容如下：

MIT License

版權 (c) 年份 作者姓名 <郵件地址>

允許自由使用、複製、修改和分發此軟件及其中的源代碼，前提是保留上述版權聲明和本許可聲明。

DISCLAIMER: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

📞 聯繫方式

有問題或建議，請聯繫：

• 郵件：contact@example.com
• GitHub：你的 GitHub 鏈接

感謝使用 Plane MCP 服務器端！如需更多幫助，請隨時查看我們的文檔。