Zentaoapi Integration Package

🚀 MCP-Zentao Project Documentation

MCP-Zentao is a powerful tool designed for in - depth integration with the Zentao system, offering efficient task management, bug tracking, and project management capabilities.

🚀 Quick Start

1. After installation, run the following command in the terminal:

   npm start
   

2. Open your browser and visit http://localhost:3000.
3. Log in or register according to the on - screen prompts to start using MCP - Zentao.

📦 Installation

To install MCP - Zentao on your system, follow these steps:

1. Download: Download the latest software package from the MCP - Zentao official page.
2. Extract: Extract the downloaded archive to the directory of your choice.
3. Configure the environment: Set the necessary environment variables and dependencies according to the Installation Guide.
4. Start the service: Run the startup script to start the MCP - Zentao service.

💻 Usage Examples

Initial Configuration

1. Open a terminal or command prompt and navigate to the extracted directory.
2. Run the following command to start the initial configuration:

   npm install
   

3. After the installation is complete, run the initial setup script:

   npx mcp - zentao init
   

4. Follow the prompts to enter your Zentao system URL, username, and password.

Subsequent Use

1. Start the service: Each time you need to use it, run the following command:

   npm start
   

2. Open your browser and visit http://localhost:3000 to access the MCP - Zentao interface.

Update Configuration

If you need to update the configuration, refer to the Configuration Documentation. You can update it by editing the configuration file or re - running the initialization command:

npx mcp - zentao init

📚 Configuration File Location

By default, the configuration file is located at ~/.config/mcp - zentao/config.json. You can find and modify the connection information for the Zentao system in this file.

✨ Features

Core Features

• Task Management: Supports creating, viewing, and completing tasks.
• Bug Tracking: Provides functions for reporting, assigning, and resolving bugs.
• Project Management: Helps teams collaborate and track project progress.
• Test Integration: Seamlessly integrates with multiple testing frameworks.

Technical Features

• API Support: Implements data interaction through RESTful API interfaces.
• Plugin System: Supports custom plugins to extend functionality.
• UI Customizability: Provides a highly customizable user interface to meet different needs.

❗ Important Notes

1. Compatibility: Ensure that your Zentao system version is compatible with MCP - Zentao.
2. Data Synchronization: Regularly check the data synchronization status to avoid data loss.
3. Permission Management: Set user permissions reasonably to ensure system security.

📄 License

MCP - Zentao follows the MIT License, allowing both personal and commercial use. Please read the license agreement carefully to understand the specific terms.

✨ Characteristics

• Efficiency: The optimized code structure ensures quick response.
• Stability: After rigorous testing, it guarantees stable system operation.
• Scalability: The flexible design facilitates function expansion and customization.

🆚 Difference from Other Projects

Feature Comparison

Advantages

• Designed for Zentao: Deeply integrated with the Zentao system, providing a better user experience.
• Flexible Configuration: Supports high - level customization to meet the needs of different teams.

👨‍💻 Local Development

Development Environment Requirements

• Operating System: Linux, Windows, macOS
• Node.js Version: >=14.0.0
• npm Version: >=6.0.0
• Other Dependencies: Please refer to the Developer Documentation

Development Process

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

4. Testing: Run unit tests and integration tests:

   npm test
   

📚 API Documentation

Class Names and Interfaces

• Class Name: Please refer to the detailed description in the MCP - Zentao SDK.
• Interface Names:
  • Task: Represents a task object.
  • Bug: Represents a bug object.
  • BugResolution: Represents a bug resolution method.

Example Code

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

// Create a new task
const task = new Task({
    title: 'Complete user story',
    description: 'Implement new feature module'
});

// Submit the task
task.submit().then(() => {
    console.log('Task has been submitted');
}).catch(error => {
    console.error('Submission failed:', error);
});

📋 Configuration Guide

Environment Variable Configuration

MCP - Zentao supports configuration through environment variables. Create a .env file in the project root directory and add the following content:

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

Dependency Management

Use npm or yarn for dependency management:

Using npm:

npm install

Using yarn:

yarn install

❓ Frequently Asked Questions

1. Can't start the service?

   • Check if the port is occupied.
   • Ensure that all dependencies are installed correctly.

2. Failed to connect to Zentao?

   • Verify the URL, username, and password of the Zentao system.
   • Ensure that the Zentao system is running and the network is normal.

🤝 Contribution Guide

Community contributions are welcome! Please refer to the Contributor Documentation to learn how to participate in the development.

📎 Appendix

Command - Line Tool

MCP - Zentao provides a command - line tool mcp - cli, which supports the following operations:

• init: Initialize the project.
• start: Start the service.
• build: Build for the production environment.
• test: Run test cases.

Glossary

• Zentao: Refers to the Zentao system, a platform for project and task management.