..

English | 中文

目錄

MCP 蝦米任務管理器

Shrimp Task Manager Demo

smithery badge

🚀 基於 Model Context Protocol (MCP) 的智能任務管理系統,為 AI Agent 提供高效的程式開發工作流程框架。

蝦米任務管理器透過結構化的工作流程引導,協助 Agent 系統性規劃程式開發步驟,強化任務記憶管理機制,有效避免冗餘與重複的編程工作。

功能特點

  • 任務規劃與分析:深入理解與分析複雜任務需求
  • 智能任務拆分:將大型任務自動拆分為可管理的小型任務
  • 依賴關係管理:精確處理任務間的依賴關係,確保正確的執行順序
  • 執行狀態追蹤:即時監控任務執行進度和狀態
  • 任務完整性驗證:確保任務成果符合預期要求
  • 任務複雜度評估:自動評估任務複雜度並提供最佳處理建議
  • 任務摘要自動更新:完成任務時自動產生摘要,優化記憶效能
  • 任務記憶功能:自動備份任務歷史記錄,提供長期記憶和參考能力
  • 思維鏈過程:通過步驟化的推理系統性地分析複雜問題
  • 專案規範初始化:定義專案標準和規則,維持大型專案的一致性
  • 網頁圖形介面:提供選用的網頁圖形化使用者介面來管理任務。透過在您的 .env 檔案中設定 ENABLE_GUI=true 來啟用。啟用後,將會在您的 DATA_DIR 中建立一個包含存取網址的 WebGUI.md 檔案。

🧭 使用指南

蝦米任務管理器提供結構化的 AI 輔助程式開發方法,通過引導式工作流程和系統化任務管理實現高效開發。

什麼是蝦米?

蝦米本質上是一個提示詞範本,通過一系列提示詞引導 AI Agent 更好地理解和適應您的專案。它確保 Agent 能夠更貼近您專案的特定需求和慣例。

首次使用設置

在使用新專案時,只需對 Agent 說「init project rules」初始化專案規則。這將引導 Agent 生成一份符合您專案特定需求和結構的規則檔案。

任務規劃流程

要開發或更新功能使用命令「plan task [您的描述]」(規劃任務 [您的描述])。系統將參考先前建立的規則,嘗試理解您的專案,搜尋相關程式碼區塊,並根據專案的當前狀態提出全面的計劃。

反饋機制

在規劃過程中,蝦米引導 Agent 進行多步驟思考。您可以審查這個過程如果您覺得某個部分偏離了您的目標可以直接打斷並提出您的觀點。Agent 將採納您的反饋並繼續思考過程。

任務執行

當您對規劃內容滿意後使用「execute task [任務名稱或 ID]」(執行任務 [任務名稱或 ID])來實施計劃。如果您不指定任務名稱或 ID系統將自動識別並執行最優先的任務。

連續模式

如果您希望連續執行所有任務而不需要為每個任務手動干預可以使用「continuous mode」連續模式自動處理整個任務隊列。

Token 限制注意事項

由於 LLM 的 Token 限制,在長時間對話中可能會喪失上下文。如果發生這種情況,只需開啟新的聊天會話並請 Agent 繼續執行即可。系統將從上次中斷的地方繼續,無需重複任務細節或上下文。

提示詞語言與客製化

您可以透過設定 TEMPLATES_USE 環境變數來切換系統提示詞的語言。預設支援 en(英文)和 zh(繁體中文)。此外,您也可以複製現有的模板目錄(例如 src/prompts/templates_en)到 DATA_DIR 指定的位置,進行修改後,將 TEMPLATES_USE 指向您的客製化模板目錄名稱,以實現更深度的提示詞客製化

🧠 任務記憶功能

蝦米任務管理器具備長期記憶功能,可以自動保存任務執行的歷史記錄,並在規劃新任務時提供參考經驗。

功能特點

  • 系統會自動將任務備份到 memory 目錄中
  • 備份文件按照時間順序命名,格式為 tasks_backup_YYYY-MM-DDThh-mm-ss.json
  • 任務規劃 Agent 會自動獲得關於如何利用記憶功能的指導

優勢與效益

  • 避免重複工作:參考過去任務,不必從零開始解決類似問題
  • 借鑒成功經驗:利用已驗證有效的解決方案,提高開發效率
  • 學習與改進:識別過去的錯誤或低效方案,持續優化工作流程
  • 知識沉澱:隨著系統使用時間增長,形成持續擴展的知識庫

通過有效利用任務記憶功能,系統能夠不斷積累經驗,智能化程度和工作效率將持續提升。

🤔 思維鏈過程

思維鏈功能通過結構化思考增強問題解決能力:

  • 系統化推理:將複雜問題分解為邏輯步驟
  • 假設測試:挑戰假設以驗證解決方案的可行性
  • 批判性分析:使用嚴格標準評估各種解決方案選項
  • 改進決策過程:通過深思熟慮達成更可靠的結論

當啟用此功能(預設設定)時,系統會引導 Agent 使用 process_thought 工具進行逐步推理,確保在實施前進行徹底的問題分析。

📋 專案規範初始化

專案規範功能有助於維持代碼庫的一致性:

  • 標準化開發:建立一致的編碼模式和實踐
  • 新開發者引導:為專案貢獻提供明確的指南
  • 維持品質:確保所有代碼符合既定的專案標準

⚠️ 建議:當專案規模不斷擴大或發生重大變更時,請初始化專案規範。這有助於在複雜度增加時維持一致性和品質。

在以下情況使用 init_project_rules 工具設置或更新專案標準:

  • 啟動新的大型專案
  • 有新團隊成員加入
  • 實施重大架構變更
  • 採用新的開發慣例

使用範例

您可以透過簡單的自然語言指令輕鬆使用此功能:

  • 首次設定時:只需對 Agent 說「初始化規則」或「初始化專案規則」
  • 需要更新時:當專案發展變化時,對 Agent 說「更新規則」或「更新專案規則」

當您的代碼庫擴展或經歷重大結構變化時,此工具特別有價值,有助於在整個專案生命週期中保持一致的開發實踐。

📚 文件資源

🔧 安裝與使用

Installing via Smithery

To install 蝦米任務管理器 for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @cjo4m06/mcp-shrimp-task-manager --client claude

Manual Installation

# 安裝依賴套件
npm install

# 建置並啟動服務
npm run build

🔌 在支援 MCP 的客戶端中使用

蝦米任務管理器可以與任何支援 Model Context Protocol 的客戶端一起使用,例如 Cursor IDE。

在 Cursor IDE 中配置

蝦米任務管理器提供兩種配置方式:全局配置和專案特定配置。

全局配置

  1. 開啟 Cursor IDE 的全局設定檔案(通常位於 ~/.cursor/mcp.json
  2. mcpServers 區段中添加以下配置:
{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "node",
      "args": ["/mcp-shrimp-task-manager/dist/index.js"],
      "env": {
        "DATA_DIR": "/mcp-shrimp-task-manager/data",
        "ENABLE_THOUGHT_CHAIN": "true",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

or

{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "npx",
      "args": ["-y", "mcp-shrimp-task-manager"],
      "env": {
        "DATA_DIR": "/mcp-shrimp-task-manager/data",
        "ENABLE_THOUGHT_CHAIN": "true",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

⚠️ 請將 /mcp-shrimp-task-manager 替換為您的實際路徑。

專案特定配置

您也可以為每個專案設定專屬配置,以便針對不同專案使用獨立的數據目錄:

  1. 在專案根目錄創建 .cursor 目錄
  2. 在該目錄下創建 mcp.json 文件,內容如下:
{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "node",
      "args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
      "env": {
        "DATA_DIR": "/path/to/project/data", // 必須使用絕對路徑
        "ENABLE_THOUGHT_CHAIN": "true",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

or

{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "npx",
      "args": ["-y", "mcp-shrimp-task-manager"],
      "env": {
        "DATA_DIR": "/path/to/project/data", // 必須使用絕對路徑
        "ENABLE_THOUGHT_CHAIN": "true",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

⚠️ 重要配置說明

DATA_DIR 參數是蝦米任務管理器存儲任務數據、對話記錄等信息的目錄,正確設置此參數對於系統的正常運行至關重要。此參數必須使用絕對路徑,使用相對路徑可能導致系統無法正確定位數據目錄,造成數據丟失或功能失效。

警告:使用相對路徑可能導致以下問題:

  • 數據檔案找不到,導致系統初始化失敗
  • 任務狀態丟失或無法正確保存
  • 應用程式在不同環境下行為不一致
  • 系統崩潰或無法啟動

🔧 環境變數配置

蝦米任務管理器支援透過環境變數自定義提示詞行為,讓您無需修改程式碼即可微調 AI 助手的回應。您可以在配置中或透過 .env 文件設置這些變數:

{
  "mcpServers": {
    "shrimp-task-manager": {
      "command": "node",
      "args": ["/path/to/mcp-shrimp-task-manager/dist/index.js"],
      "env": {
        "DATA_DIR": "/path/to/project/data",
        "MCP_PROMPT_PLAN_TASK": "自定義規劃指導...",
        "MCP_PROMPT_EXECUTE_TASK_APPEND": "附加執行說明...",
        "ENABLE_THOUGHT_CHAIN": "true",
        "TEMPLATES_USE": "en",
        "ENABLE_GUI": "false"
      }
    }
  }
}

提供兩種自定義方式:

  • 覆蓋模式MCP_PROMPT_[FUNCTION_NAME]):完全替換預設提示詞
  • 追加模式MCP_PROMPT_[FUNCTION_NAME]_APPEND):在現有提示詞基礎上增加內容

此外,還有其他系統配置變數:

  • DATA_DIR:指定任務數據存儲的目錄
  • ENABLE_THOUGHT_CHAIN:控制任務規劃工作流中的思考模式。當設置為 true(預設值)時,系統引導用戶使用 process_thought 工具進行逐步推理。當設置為 false 時,系統直接使用 analyze_task 提交分析結果,跳過詳細的思考過程。
  • TEMPLATES_USE:指定提示詞使用的模板集。預設為 en。目前可用的選項有 enzh。若要使用自定義模板,請將 src/prompts/templates_en 目錄複製到 DATA_DIR 指定的位置,重新命名複製的目錄(例如,my_templates),並將 TEMPLATES_USE 設置為新的目錄名稱(例如,my_templates)。

有關自定義提示詞的詳細說明,包括支援的參數和範例,請參閱提示詞自定義指南

💡 系統提示詞指導

Cursor IDE 配置

您可以啟用 Cursor Settings => Features => Custom modes 功能,並配置以下兩個模式:

TaskPlanner 模式

你是一個專業的任務規劃專家,你必須與用戶進行交互,分析用戶的需求,並收集專案相關資訊,最終使用 「plan_task」 建立任務當任務建立完成後必須總結摘要並告知用戶使用「TaskExecutor」模式進行任務執行。
你必須專心於任務規劃禁止使用 「execute_task」 來執行任務,
嚴重警告你是任務規劃專家,你不能直接修改程式碼,你只能規劃任務,並且你不能直接修改程式碼,你只能規劃任務。

TaskExecutor 模式

你是一個專業的任務執行專家,當用戶有指定執行任務,則使用 「execute_task」 進行任務執行,
沒有指定任務時則使用 「list_tasks」 尋找未執行的任務並執行,
當執行完成後必須總結摘要告知用戶結論,
你一次只能執行一個任務,當任務完成時除非用戶明確告知否則禁止進行下一則任務。
用戶如果要求「連續模式」則按照順序連續執行所有任務

💡 根據您的需求場景選擇適當的模式:

  • 當需要規劃任務時使用 TaskPlanner 模式
  • 當需要執行任務時使用 TaskExecutor 模式

在其他工具中使用

如果您的工具不支援 Custom modes 功能,可以:

  • 在不同階段手動貼上相應的提示詞
  • 或直接使用簡單命令如 請規劃以下任務:......請開始執行任務...

🛠️ 可用工具一覽

配置完成後,您可使用以下工具:

功能分類 工具名稱 功能描述
任務規劃 plan_task 開始規劃任務
任務分析 analyze_task 深入分析任務需求
process_thought 針對複雜問題進行步驟化推理
方案評估 reflect_task 反思與改進方案構想
專案管理 init_project_rules 初始化或更新專案標準與規則
任務管理 split_tasks 將任務拆分為子任務
list_tasks 顯示所有任務及狀態
query_task 搜尋並列出任務
get_task_detail 顯示完整任務詳情
delete_task 刪除未完成的任務
任務執行 execute_task 執行特定任務
verify_task 檢驗任務完成情況
complete_task 標記任務為已完成

📄 許可協議

此專案根據 MIT 許可協議授權 - 詳情請參閱 LICENSE 文件。

🤖 推薦模型

為了獲得最佳體驗,建議使用以下模型:

  • Claude 3.7: 提供強大的理解和生成能力。
  • Gemini 2.5: Google 的最新模型,表現優異。

由於不同模型的訓練方式和理解能力存在差異,使用其他模型可能會導致相同的提示詞產生不同的效果。本專案已針對 Claude 3.7 和 Gemini 2.5 進行了最佳化。

Star History

Star History Chart