MCP Server Zplanner

🚀 zPlanner v1.4.0

zPlanner是一款命令行工具，專注於項目規劃與管理，尤其在軟件開發項目管理方面表現出色。它滿足了直接在終端進行項目管理的需求，無需複雜的圖形界面。其核心亮點在於作為AI輔助開發IDE的記憶系統，通過維護結構化的項目記錄，保存開發上下文，讓AI助手更好地理解項目結構、歷史和當前狀態，進而提供更精準、貼合情境的建議與支持。

🚀 快速開始

zPlanner專為項目規劃與管理設計，特別是軟件開發項目。它能讓你直接在終端進行項目管理，無需複雜的圖形界面。同時，作為AI輔助開發IDE的記憶系統，能幫助AI更好地理解項目情況。

✨ 主要特性

目的

zPlanner的創建目標如下：

1. 簡潔性：可直接從終端進行項目管理。
2. 效率：減少行政任務的時間消耗。
3. 靈活性：能適應不同項目類型和方法論。
4. 可視化：可生成清晰的響應式HTML報告。
5. 可追溯性：維護進度歷史和更新記錄。
6. AI上下文：作為AI輔助開發的記憶系統，維護結構化的項目上下文。

AI優先設計

zPlanner針對現代AI輔助開發進行了優化：

• 上下文保留：維護供AI助手使用的結構化歷史記憶。
• 層次結構：有助於AI理解項目的組織結構。
• 變更跟蹤：使AI助手瞭解項目演變。
• 清晰文檔：統一格式提升AI的解讀能力。

功能

項目管理

• 項目創建與配置
• 分層結構（階段、任務及子任務）
• 自動進度計算
• 響應式HTML報告導出
• 更新日期跟蹤

階段組織

• 階段添加
• 階段重新排序
• 階段重命名
• 階段刪除
• 按階段計算進度

任務管理

• 主任務添加
• 子任務創建
• 完成標記
• 描述更新
• 任務刪除

HTML報告

• 現代響應式設計
• 清晰的層次結構可視化
• 進度指示器
• 更新歷史記錄
• 專業BEM CSS樣式

📦 安裝指南

npm install -g zplanner

💻 使用示例

基本用法

項目管理

# 初始化新項目
zplanner init

# 生成項目文檔
zplanner generate

# 配置項目設置
zplanner config

階段操作

# 創建新階段
zplanner phase create <名稱>

# 更新現有階段
zplanner phase update <名稱> --start=<開始日期> --end=<結束日期>

# 刪除階段
zplanner phase delete <名稱>

任務管理

# 添加任務到當前階段
zplanner task add <標題> --phase=<階段名>

# 更新任務詳情
zplanner task update <ID> --title=<新標題> --status=<狀態>

# 列出所有任務
zplanner task list --phase=<階段名>

📚 詳細文檔

項目結構

src/
├── main.ts        # 主程序入口
├── services/      # 服務模塊
│   ├── PhaseService.ts     # 階段服務
│   └── TaskService.ts      # 任務服務
└── utils/         # 工具函數
    └── config.ts   # 配置管理

config/
├── phases.json    # 階段定義
└── tasks.json     # 任務記錄

reports/
├── output.html     # 生成的報告文件
└── templates/      # 報告模板

開發環境設置

# 克隆倉庫並安裝依賴
git clone https://github.com/cyllas/zPlanner.git
cd zPlanner
npm install

# 啟動開發模式
npm run dev

配置文件

settings.ts允許進行如下配置：

export const settings = {
  defaultLanguage: "zh-CN",    # 默認語言設置為中文
  dateFormat: "MM/DD/YYYY",     # 日期格式：MM/DD/YYYY
  timeZone: "Asia/Shanghai",   # 時區設置為上海
  projectDefaults: {
    outputFormat: "html",       # 默認輸出格式為HTML
    indentSize: 2,              # 縮進大小為2個空格
  },
  repository: {                 # 倉庫信息
    url: "https://github.com/cyllas/zPlanner",
  },
  version: "1.4.0",            # 當前版本號
};

📄 許可證

本項目採用MIT許可證，具體條款詳見LICENSE文件。