Software Planning Tool

🚀 軟件規劃工具

一個基於模型上下文協議（MCP）設計的服務器，旨在通過互動、結構化的流程來促進軟件開發規劃。該工具可幫助將複雜的軟件項目分解為易於管理的任務，跟蹤實施進度，並維護詳細的開發計劃。

🚀 快速開始

要使用軟件規劃工具，你可以按照以下步驟進行操作：

1. 安裝依賴：

npm install

2. 啟動工具：

npm start

3. 使用命令行交互：

start_planning "開發新功能模塊"  
add_todo {  
  title: "實現用戶認證",  
  description: "為系統添加用戶認證功能。",  
  complexity: 8  
}  
get_plan  
update_plan {  
  status: "in_progress"  
}  
clear_plan  

✨ 主要特性

• 互動規劃會議：啟動和管理開發規劃會議
• 待辦事項管理：創建、更新和跟蹤開發任務
• 複雜度評分：為任務分配複雜度分數以進行更好估算
• 代碼示例：在任務描述中包含相關代碼片段
• 實施計劃：保存並管理詳細的實施計劃

📦 安裝指南

通過 Smithery 安裝

要通過 Smithery 自動安裝軟件規劃工具以用於 Claude Desktop：

npx -y @smithery/cli install @NightTrek/Software-planning-mcp --client claude

手動安裝

1. 克隆倉庫
2. 安裝依賴項：

pnpm install

3. 構建項目：

pnpm run build

4. 添加到您的 MCP 設置配置文件中（通常位於 ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json）：

{
  "mcpServers": {
    "software-planning-tool": {
      "command": "node",
      "args": [
        "/path/to/software-planning-tool/build/index.js"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

💻 使用示例

基礎用法

# 啟動規劃會議
start_planning "開發新用戶界面"
# 添加待辦事項
add_todo {
  title: "設計主頁佈局",
  description: "創建新的主頁佈局，確保用戶體驗流暢。",
  complexity: 7
}
# 獲取當前計劃
get_plan
# 更新計劃
update_plan {
  timeline: { 
    phase1: "需求分析完成",
    phase2: "設計階段進行中"
  }
}
# 清除計劃
clear_plan

高級用法

# 在生產環境中使用前，進行充分測試
# 啟動規劃會議並指定更復雜的目標
start_planning "開發一個具有高併發處理能力的新服務模塊"
# 添加帶有代碼示例的待辦事項
add_todo {
  title: "實現數據緩存功能",
  description: "使用 Redis 實現數據緩存，提高系統性能。",
  complexity: 8,
  codeExample: "import redis; r = redis.Redis(host='localhost', port=6379, db=0); r.set('key', 'value')"
}
# 更新計劃狀態和其他詳細信息
update_plan {
  status: "in_progress",
  resources: {
    server: "new_server_1",
    memory: "8GB"
  }
}

📚 詳細文檔

可用工具

start_planning

以特定目標開始一個新的規劃會議。

{
  goal: string  // 軟件開發的目標
}

add_todo

向當前計劃添加一個新的待辦事項項。

{
  title: string,         // 待辦事項項的標題
  description: string,   // 詳細描述
  complexity: number,    // 複雜度：數字（0 - 10）
  codeExample?: string  // 可選：相關代碼示例
}

get_plan

獲取當前的實施計劃。

{
  plan: object  // 當前的實施計劃對象
}

update_plan

更新當前的實施計劃。

{
  updates: object  // 要更新的內容
}

clear_plan

清除當前的實施計劃。

clear_plan

項目結構

項目的文件結構如下：

Software Planning Tool  
├── src/  
│   ├── storage.ts      # 數據持久化  
│   ├── types.ts        # TypeScript 類型定義  
│   └── utils.ts        # 工具函數  
├── build/              # 構建輸出目錄  
└── package.json       # 項目依賴和配置

🔧 技術細節

該軟件規劃工具基於模型上下文協議（MCP）設計，通過互動、結構化的流程來促進軟件開發規劃。它使用了 TypeScript 進行類型定義，確保代碼的健壯性和可維護性。在數據持久化方面，使用了 storage.ts 文件來處理數據的存儲和讀取。工具函數則封裝在 utils.ts 中，方便代碼複用。

📄 許可證

[此處插入許可證信息]

⚠️ 重要提示

• 確保所有依賴已正確安裝。
• 在生產環境中使用前，建議進行充分的測試。
• 如果遇到問題，請檢查日誌文件或查閱文檔。

💡 使用建議

在使用軟件規劃工具時，建議你先從簡單的項目開始，熟悉工具的各項功能。在添加待辦事項時，儘量詳細地描述任務內容，併合理分配複雜度分數，以便更好地估算項目進度。

聯繫方式

如需聯繫開發者，請發送郵件至 your.email@example.com。

項目維護者

• John Doe - john.doe@example.com
• Jane Smith - jane.smith@example.com

感謝

感謝所有貢獻者和用戶的支持，使該項目得以成功。

這個工具旨在簡化軟件開發過程中的規劃階段，幫助團隊更高效地組織和執行項目。希望它能為您的下一個項目帶來便利！