Zentaoapi Integration Package

🚀 MCP-Zentao 項目文檔

MCP-Zentao 是一款專為禪道系統深度集成設計的工具，具備任務管理、Bug 跟蹤等核心功能，能高效助力團隊項目協作，且具有良好的擴展性和定製性。

🚀 快速開始

安裝完成後，在終端中運行：

npm start

打開瀏覽器，訪問http://localhost:3000。按照界面提示登錄或註冊，即可開始使用 MCP-Zentao。

✨ 主要特性

核心功能

• 任務管理：支持創建、查看和完成任務。
• Bug 跟蹤：提供 Bug 的報告、分配和解決功能。
• 項目管理：幫助團隊協作，跟蹤項目進度。
• 測試集成：與多種測試框架無縫集成。

技術特性

• API 支持：通過 RESTful API 接口實現數據交互。
• 插件系統：支持自定義插件擴展功能。
• UI 可定製性：提供高度可定製的用戶界面，滿足不同需求。

特點

• 高效性：優化的代碼結構確保快速響應。
• 穩定性：經過嚴格測試，保證系統穩定運行。
• 擴展性：靈活的設計便於功能擴展和定製。

與其他項目區別

功能對比

優勢

• 專為禪道設計：深度集成禪道系統，提供更好的使用體驗。
• 靈活配置：支持高度定製，滿足不同團隊需求。

📦 安裝指南

要在您的系統上安裝 MCP-Zentao，請按照以下步驟操作：

1. 下載：從MCP-Zentao 官方頁面下載最新版本的軟件包。
2. 解壓：將下載的壓縮包解壓到您選擇的目錄中。
3. 配置環境：根據安裝指南設置必要的環境變量和依賴項。
4. 啟動服務：運行啟動腳本以開始 MCP-Zentao 服務。

💻 使用示例

基礎用法

首次配置

1. 打開終端或命令提示符，進入解壓後的目錄。
2. 運行以下命令開始首次配置：

npm install

3. 安裝完成後，運行初始設置腳本：

npx mcp-zentao init

4. 按照提示輸入您的禪道系統 URL、用戶名和密碼。

後續使用

1. 啟動服務：每次需要使用時，運行以下命令：

npm start

2. 打開瀏覽器，訪問http://localhost:3000進入 MCP-Zentao 界面。

更新配置

若需更新配置，請參考配置文檔。您可以通過編輯配置文件或重新運行初始化命令來完成更新：

npx mcp-zentao init

高級用法

API 使用示例

const { Task, Bug, BugResolution } = require('mcp-zentao');

// 創建一個新任務
const task = new Task({
    title: '完成用戶故事',
    description: '實現新增功能模塊'
});

// 提交任務
task.submit().then(() => {
    console.log('任務已提交');
}).catch(error => {
    console.error('提交失敗:', error);
});

📚 詳細文檔

配置文件位置

默認情況下，配置文件位於~/.config/mcp-zentao/config.json。您可以在此文件中找到和修改禪道系統的連接信息。

配置指南

環境變量配置

MCP-Zentao 支持通過環境變量進行配置。請在項目根目錄創建.env文件，並添加以下內容：

NODE_ENV=development
PORT=3000
ZENTAO_URL=http://your-zentao-instance

依賴管理

使用 npm 或 yarn 進行依賴管理：

• 使用 npm：

npm install

• 使用 yarn：

yarn install

本地開發

開發環境要求

• 操作系統：Linux, Windows, macOS
• Node.js 版本：>=14.0.0
• npm 版本：>=6.0.0
• 其他依賴：請參考開發者文檔

開發流程

1. 克隆倉庫：

git clone https://github.com/your-repo/mcp-zentao.git
cd mcp-zentao

2. 安裝依賴：

npm install

3. 啟動開發服務器：

npm run dev

4. 測試：運行單元測試和集成測試：

npm test

附錄

命令行工具

MCP-Zentao 提供命令行工具mcp-cli，支持以下操作：

• init：初始化項目。
• start：啟動服務。
• build：構建生產環境。
• test：運行測試用例。

術語表

• 禪道：指禪道系統，用於項目和任務管理的平臺。

API 文檔

類名和接口

• 類名：請參考MCP-Zentao SDK中的詳細說明。
• 接口名：
  • Task：表示任務對象
  • Bug：表示 Bug 對象
  • BugResolution：表示 Bug 解決方式

🔧 技術細節

注意事項

1. 兼容性：確保您的禪道系統版本與 MCP-Zentao 兼容。
2. 數據同步：定期檢查數據同步狀態，避免數據丟失。
3. 權限管理：合理設置用戶權限，確保系統安全。

常見問題

1. 無法啟動服務？
   • 檢查端口是否被佔用。
   • 確保所有依賴已正確安裝。
2. 連接禪道失敗？
   • 核對禪道系統的 URL、用戶名和密碼。
   • 確保禪道系統正在運行且網絡正常。

📄 許可證

MCP-Zentao 遵循MIT License，允許個人和商業用途。請仔細閱讀許可協議以瞭解具體條款。

貢獻指南

歡迎社區貢獻！請參考貢獻者文檔瞭解如何參與開發。