🚀 MCP-Zentao 项目文档
MCP-Zentao是一款专为禅道系统深度集成设计的工具，它提供了任务管理、Bug跟踪等核心功能，具有高效、稳定和可扩展的特点，能帮助团队更高效地协作和管理项目。
🚀 快速开始
安装完成后，在终端中运行：
npm start
打开浏览器，访问http://localhost:3000。按照界面提示登录或注册，即可开始使用MCP-Zentao。
✨ 主要特性
核心功能
- 任务管理：支持创建、查看和完成任务。
- Bug跟踪：提供Bug的报告、分配和解决功能。
- 项目管理：帮助团队协作，跟踪项目进度。
- 测试集成：与多种测试框架无缝集成。
技术特性
- API 支持：通过RESTful API接口实现数据交互。
- 插件系统：支持自定义插件扩展功能。
- UI 可定制性：提供高度可定制的用户界面，满足不同需求。
特点
- 高效性：优化的代码结构确保快速响应。
- 稳定性：经过严格测试，保证系统稳定运行。
- 扩展性：灵活的设计便于功能扩展和定制。
与其他项目区别
功能对比
| 特性 | MCP-Zentao | 其他工具 |
|---|---|---|
| 任务管理 | 高效支持 | 基本支持 |
| Bug跟踪 | 强大功能模块 | 普通功能 |
| 集成能力 | 支持多种接口 | 有限的扩展性 |
优势
- 专为禅道设计：深度集成禅道系统，提供更好的使用体验。
- 灵活配置：支持高度定制，满足不同团队需求。
📦 安装指南
要在您的系统上安装MCP-Zentao，请按照以下步骤操作：
- 下载：从MCP-Zentao官方页面下载最新版本的软件包。
- 解压：将下载的压缩包解压到您选择的目录中。
- 配置环境：根据安装指南设置必要的环境变量和依赖项。
- 启动服务：运行启动脚本以开始MCP-Zentao服务。
💻 使用示例
基础用法
首次配置
- 打开终端或命令提示符，进入解压后的目录。
- 运行以下命令开始首次配置：
npm install
- 安装完成后，运行初始设置脚本：
npx mcp-zentao init
- 按照提示输入您的禅道系统URL、用户名和密码。
后续使用
- 启动服务：每次需要使用时，运行以下命令：
npm start
- 打开浏览器，访问
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
- 其他依赖：请参考开发者文档
开发流程
- 克隆仓库：
git clone https://github.com/your-repo/mcp-zentao.git
cd mcp-zentao
- 安装依赖：
npm install
- 启动开发服务器：
npm run dev
- 测试： 运行单元测试和集成测试：
npm test
附录
命令行工具
MCP-Zentao 提供命令行工具mcp-cli，支持以下操作：
init：初始化项目。start：启动服务。build：构建生产环境。test：运行测试用例。
术语表
- 禅道：指禅道系统，用于项目和任务管理的平台。
🔧 技术细节
API 文档
类名和接口
- 类名：请参考MCP-Zentao SDK中的详细说明。
- 接口名：
Task: 表示任务对象Bug: 表示Bug对象BugResolution: 表示Bug解决方式
⚠️ 注意事项
- 兼容性：确保您的禅道系统版本与MCP-Zentao兼容。
- 数据同步：定期检查数据同步状态，避免数据丢失。
- 权限管理：合理设置用户权限，确保系统安全。
📄 许可证
MCP-Zentao遵循MIT License，允许个人和商业用途。请仔细阅读许可协议以了解具体条款。
💡 常见问题
- 无法启动服务？
- 检查端口是否被占用。
- 确保所有依赖已正确安装。
- 连接禅道失败？
- 核对禅道系统的URL、用户名和密码。
- 确保禅道系统正在运行且网络正常。
🤝 贡献指南
欢迎社区贡献！请参考贡献者文档了解如何参与开发。