MCP Server Zplanner

🚀 zPlanner v1.4.0

zPlanner is a command-line tool designed to assist in project planning and management, with a particular focus on software development project management. It was developed to meet the need for direct project management in the terminal without the need for a complex graphical interface.

🚀 Quick Start

Purpose

The goals of creating zPlanner are as follows:

1. Simplicity: Manage projects directly from the terminal.
2. Efficiency: Reduce time spent on administrative tasks.
3. Flexibility: Adapt to different project types and methodologies.
4. Visualization: Generate clear and responsive HTML reports.
5. Traceability: Maintain progress history and update records.
6. AI Context: Serve as a memory system for AI-assisted development, maintaining a structured project context.

AI-First Design

zPlanner is optimized for modern AI-assisted development:

• Context Preservation: Maintain a structured historical memory for AI assistants.
• Hierarchical Structure: Help AI understand the project's organizational structure.
• Change Tracking: Enable AI assistants to understand project evolution.
• Clear Documentation: A unified format enhances AI interpretation.

✨ Features

Project Management

• Create and configure projects.
• Use a hierarchical structure (phases, tasks, and subtasks).
• Automatically calculate progress.
• Export responsive HTML reports.
• Track update dates.

Phase Organization

• Add phases.
• Reorder phases.
• Rename phases.
• Delete phases.
• Calculate progress by phase.

Task Management

• Add main tasks.
• Create subtasks.
• Mark tasks as completed.
• Update task descriptions.
• Delete tasks.

HTML Reports

• Modern and responsive design.
• Clear hierarchical structure visualization.
• Progress indicators.
• Update history records.
• Professional BEM CSS styles.

📦 Installation

npm install -g zplanner

💻 Usage Examples

Basic Usage

Project Management

# Initialize a new project
zplanner init

# Generate project documentation
zplanner generate

# Configure project settings
zplanner config

Phase Operations

# Create a new phase
zplanner phase create <name>

# Update an existing phase
zplanner phase update <name> --start=<start_date> --end=<end_date>

# Delete a phase
zplanner phase delete <name>

Task Management

# Add a task to the current phase
zplanner task add <title> --phase=<phase_name>

# Update task details
zplanner task update <ID> --title=<new_title> --status=<status>

# List all tasks
zplanner task list --phase=<phase_name>

📚 Documentation

Project Structure

src/
├── main.ts        # Main program entry
├── services/      # Service modules
│   ├── PhaseService.ts     # Phase service
│   └── TaskService.ts      # Task service
└── utils/         # Utility functions
    └── config.ts   # Configuration management

config/
├── phases.json    # Phase definitions
└── tasks.json     # Task records

reports/
├── output.html     # Generated report file
└── templates/      # Report templates

Development Environment Setup

# Clone the repository and install dependencies
git clone https://github.com/cyllas/zPlanner.git
cd zPlanner
npm install

# Start development mode
npm run dev

Configuration File

The settings.ts file allows configuration:

export const settings = {
  defaultLanguage: "zh-CN",    // Default language is set to Chinese
  dateFormat: "MM/DD/YYYY",     // Date format: MM/DD/YYYY
  timeZone: "Asia/Shanghai",   // Time zone is set to Shanghai
  projectDefaults: {
    outputFormat: "html",       // Default output format is HTML
    indentSize: 2,              // Indent size is 2 spaces
  },
  repository: {                 // Repository information
    url: "https://github.com/cyllas/zPlanner",
  },
  version: "1.4.0",            // Current version number
};

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.