MCP/mcp-shrimp-task-manager
1
0
Fork 0
mirror of https://github.com/cjo4m06/mcp-shrimp-task-manager.git synced 2025-07-27 08:32:27 +08:00
Code Issues Packages Projects Releases Wiki Activity
mcp-shrimp-task-manager/docs/api-reference.md

481 lines
16 KiB
Markdown
Raw Normal View History

新增刪除任務功能，允許用戶刪除未完成的任務，並禁止刪除已完成的任務以維護系統記錄的完整性。同時，新增任務複雜度評估功能，系統在執行任務時自動評估複雜度並提供處理建議，並在任務完成時自動更新摘要。更新相關文檔以反映這些新功能，提升任務管理的靈活性與可操作性。
2025-04-11 17:31:48 +08:00
# 蝦米任務管理器 API 參考文檔
本文檔提供蝦米任務管理器的 API 參考，包含所有可用工具的詳細說明和參數列表。
更新 API 參考文檔，新增目錄及詳細的核心任務管理 API 說明，包括任務規劃、分析、反思、拆分、列出、執行及驗證功能，並強化參數驗證規則以提升用戶體驗。同時，更新工具函數以加入錯誤處理，確保輸入的有效性與一致性。
2025-04-12 00:17:05 +08:00
## 目錄
- [核心任務管理 API](#核心任務管理-api)
- [任務管理 API](#任務管理-api)
- [工作日誌功能](#工作日誌功能)
## 核心任務管理 API
### 1. 任務規劃
#### `plan_task`
初始化並詳細規劃任務流程，建立明確的目標與成功標準。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------------ | ------ | ---- | ------------------------------------------------------ |
| description | string | 是 | 完整詳細的任務問題描述，應包含任務目標、背景及預期成果 |
| requirements | string | 否 | 任務的特定技術要求、業務約束條件或品質標準（選填） |
**返回：**
- 成功：返回結構化的任務規劃結果
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const planResult = await mcp.mcp_shrimp_task_manager.plan_task({
description:
"開發一個用戶註冊功能，包含表單驗證、數據存儲和電子郵件確認流程。",
requirements: "必須符合GDPR數據保護規定，支持多語言，並通過所有安全測試。",
});
```
### 2. 任務分析
#### `analyze_task`
深入分析任務需求並系統性檢查代碼庫，評估技術可行性與潛在風險。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ---------------- | ------ | ---- | ------------------------------------------------------------ |
| summary | string | 是 | 結構化的任務摘要，包含任務目標、範圍與關鍵技術挑戰 |
| initialConcept | string | 是 | 初步解答構想，包含技術方案、架構設計和實施策略 |
| previousAnalysis | string | 否 | 前次迭代的分析結果，用於持續改進方案（僅在重新分析時需提供） |
**返回：**
- 成功：返回詳細的任務分析結果
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const analysisResult = await mcp.mcp_shrimp_task_manager.analyze_task({
summary: "開發用戶身份驗證模塊，包含登入、註冊和密碼重設功能",
initialConcept: "計劃使用JWT進行身份驗證，實現無狀態API設計...",
});
```
### 3. 方案反思
#### `reflect_task`
批判性審查分析結果，評估方案完整性並識別優化機會，確保解決方案符合最佳實踐。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| -------- | ------ | ---- | ------------------------------------------------------------ |
| summary | string | 是 | 結構化的任務摘要，保持與分析階段一致以確保連續性 |
| analysis | string | 是 | 完整詳盡的技術分析結果，包括所有技術細節、依賴組件和實施方案 |
**返回：**
- 成功：返回方案改進建議和優化機會
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const reflectionResult = await mcp.mcp_shrimp_task_manager.reflect_task({
summary: "開發用戶身份驗證模塊，包含登入、註冊和密碼重設功能",
analysis: "詳細的技術分析結果，包括JWT實現方式、安全考量等...",
});
```
### 4. 任務拆分
#### `split_tasks`
將複雜任務分解為獨立且可追蹤的子任務，建立明確的依賴關係和優先順序。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ----------- | ------- | ---- | --------------------------------------------------------------------------- |
| isOverwrite | boolean | 是 | 任務覆蓋模式選擇（true：清除並覆蓋所有現有任務；false：保留現有任務並新增） |
| tasks | array | 是 | 結構化的任務清單，每個任務應保持原子性且有明確的完成標準 |
**tasks 對象屬性：**
| 屬性名 | 類型 | 必填 | 描述 |
| ------------ | ------ | ---- | ------------------------------------------------ |
| name | string | 是 | 簡潔明確的任務名稱，應能清晰表達任務目的 |
| description | string | 是 | 詳細的任務描述，包含實施要點、技術細節和驗收標準 |
| notes | string | 否 | 補充說明、特殊處理要求或實施建議（選填） |
| dependencies | array | 否 | 此任務依賴的前置任務 ID 或任務名稱列表 |
**返回：**
- 成功：返回創建的任務列表
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const tasksResult = await mcp.mcp_shrimp_task_manager.split_tasks({
isOverwrite: false,
tasks: [
{
name: "設計用戶數據模型",
description: "定義用戶實體的數據結構和驗證規則...",
notes: "參考現有的權限模型",
dependencies: [],
},
{
name: "實現用戶註冊API",
description: "開發註冊端點，處理表單驗證和數據存儲...",
dependencies: ["設計用戶數據模型"],
},
],
});
```
### 5. 任務列表
#### `list_tasks`
生成結構化任務清單，包含完整狀態追蹤、優先級和依賴關係。
**參數：** 無
**返回：**
- 成功：返回系統中所有任務的結構化清單
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const tasksList = await mcp.mcp_shrimp_task_manager.list_tasks();
```
### 6. 任務執行
#### `execute_task`
按照預定義計劃執行特定任務，確保每個步驟的輸出符合質量標準。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------ | ------ | ---- | ----------------------------------------------------- |
| taskId | string | 是 | 待執行任務的唯一標識符，必須是系統中存在的有效任務 ID |
**返回：**
- 成功：返回任務執行指南和上下文
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const executeResult = await mcp.mcp_shrimp_task_manager.execute_task({
taskId: "task-uuid-here",
});
```
### 7. 任務驗證
#### `verify_task`
全面驗證任務完成度，確保所有需求與技術標準都已滿足，並無遺漏細節。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------ | ------ | ---- | ----------------------------------------------------- |
| taskId | string | 是 | 待驗證任務的唯一標識符，必須是系統中存在的有效任務 ID |
**返回：**
- 成功：返回任務驗證評估結果
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const verifyResult = await mcp.mcp_shrimp_task_manager.verify_task({
taskId: "task-uuid-here",
});
```
## 任務管理 API
新增刪除任務功能，允許用戶刪除未完成的任務，並禁止刪除已完成的任務以維護系統記錄的完整性。同時，新增任務複雜度評估功能，系統在執行任務時自動評估複雜度並提供處理建議，並在任務完成時自動更新摘要。更新相關文檔以反映這些新功能，提升任務管理的靈活性與可操作性。
2025-04-11 17:31:48 +08:00
### 1. 刪除任務功能
#### `delete_task`
允許刪除未完成狀態的任務，但禁止刪除已完成的任務。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------ | ------ | ---- | --------------------------------------------------------- |
| taskId | string | 是 | 待刪除任務的唯一標識符，必須是系統中存在且未完成的任務 ID |
**返回：**
- 成功：返回操作成功的確認訊息
- 失敗：返回錯誤訊息，說明失敗原因（任務不存在、任務已完成、有依賴關係等）
**使用範例：**
```javascript
const deleteResult = await mcp.mcp_shrimp_task_manager.delete_task({
taskId: "task-uuid-here",
});
```
**約束條件：**
- 不允許刪除已完成的任務（狀態為 `COMPLETED`）
- 如果有其他任務依賴於此任務，也不允許刪除
- 刪除操作不可逆，請謹慎使用
### 2. 任務複雜度自適應處理
系統會在執行任務時自動評估任務複雜度，並提供相應的處理建議。此功能無需額外的 API 調用，在執行 `execute_task` 時自動應用。
**複雜度級別：**
- **低複雜度**：簡單且直接的任務，通常不需要特殊處理
- **中等複雜度**：具有一定複雜性但仍可管理的任務
- **高複雜度**：複雜且耗時的任務，需要特別關注
- **極高複雜度**：極其複雜的任務，建議拆分處理
**複雜度評估指標：**
- **描述長度**：任務描述的字符數
- **依賴數量**：任務依賴的前置任務數量
- **注記長度**：任務注記的字符數（如果有）
**複雜度閾值：**
| 指標 | 中等複雜度 | 高複雜度 | 極高複雜度 |
| -------- | ---------- | ---------- | ---------- |
| 描述長度 | >500 字符 | >1000 字符 | >2000 字符 |
| 依賴數量 | >2 個 | >5 個 | >10 個 |
| 注記長度 | >200 字符 | >500 字符 | >1000 字符 |
### 3. 任務摘要自動更新機制
當任務完成時，系統會自動生成或使用提供的摘要信息，以優化 LLM 的記憶效能。
#### `complete_task`
標記任務為已完成狀態，可提供自定義摘要或使用系統自動生成的摘要。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------- | ------ | ---- | -------------------------------------------------------------------- |
| taskId | string | 是 | 待標記為完成的任務唯一標識符，必須是狀態為「進行中」的有效任務 ID |
| summary | string | 否 | 任務完成摘要，簡潔描述實施結果和重要決策（選填，如未提供將自動生成） |
**返回：**
- 成功：任務被標記為完成，並顯示任務報告要求
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
// 提供自定義摘要
const completeResult = await mcp.mcp_shrimp_task_manager.complete_task({
taskId: "task-uuid-here",
summary:
"成功實現用戶驗證功能，包括登入、登出和密碼重設流程。採用了 JWT 令牌機制確保安全性，並添加了針對常見攻擊的防護措施。",
});
// 使用自動生成的摘要
const completeResult = await mcp.mcp_shrimp_task_manager.complete_task({
taskId: "task-uuid-here",
});
```
**自動摘要生成：**
當未提供 `summary` 參數時，系統會根據任務名稱和描述自動生成摘要。
新增清除所有任務功能，允許用戶在確認後刪除系統中所有未完成的任務，並在執行前自動創建數據備份以確保安全性。同時，新增更新任務功能，支持用戶更新未完成任務的名稱、描述和注記，並擴展任務相關文件位置記錄功能以提升上下文記憶能力。更新相關文檔以反映這些新功能，增強任務管理的靈活性與可操作性。
2025-04-11 18:02:56 +08:00
### 4. 清除所有任務功能
#### `clear_all_tasks`
清除系統中所有未完成的任務，提供簡化的系統重置功能。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------- | ------- | ---- | ------------------------- |
| confirm | boolean | 是 | 確認刪除操作，必須為 true |
**返回：**
- 成功：返回清除操作的結果，包含被刪除的任務數量
- 失敗：返回錯誤訊息，說明失敗原因
**使用範例：**
```javascript
const clearResult = await mcp.mcp_shrimp_task_manager.clear_all_tasks({
confirm: true, // 必須明確確認
});
```
**安全機制：**
- 必須明確設置 `confirm` 參數為 `true` 才能執行操作
- 系統會自動在清除前創建數據備份，存放在 `data/backups` 目錄
- 所有清除操作都會記錄到系統日誌中
- 已完成的任務不會被刪除，確保歷史記錄完整性
### 5. 更新任務功能
#### `update_task`
更新未完成任務的內容，包括名稱、描述和注記。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------- |
| taskId | string | 是 | 待更新任務的唯一標識符，必須是未完成的有效任務 ID |
| name | string | 否 | 任務的新名稱（選填） |
| description | string | 否 | 任務的新描述（選填） |
| notes | string | 否 | 任務的新補充說明（選填） |
**返回：**
- 成功：返回更新後的任務數據
- 失敗：返回錯誤訊息，說明失敗原因（如任務不存在、已完成等）
**使用範例：**
```javascript
const updateResult = await mcp.mcp_shrimp_task_manager.update_task({
taskId: "task-uuid-here",
name: "優化後的任務名稱",
description: "更詳細的任務描述...",
notes: "補充重要資訊",
});
```
**約束條件：**
- 不允許更新已完成的任務
- 至少需要提供 name、description 或 notes 中的一個參數
- 任務 ID 和完成狀態不可通過此功能更改
### 6. 任務相關文件位置記錄功能
#### `update_task_files`
為任務添加或更新相關文件記錄，提升任務執行時的上下文記憶能力。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------------ | ------ | ---- | ------------------------------------ |
| taskId | string | 是 | 任務的唯一標識符 |
| relatedFiles | array | 是 | 相關文件列表，包含以下屬性的對象數組 |
**relatedFiles 對象屬性：**
| 屬性名 | 類型 | 必填 | 描述 |
| ----------- | ------ | ---- | ------------------------------------------------------------------------------------ |
| path | string | 是 | 文件路徑（相對於項目根目錄或絕對路徑） |
| type | string | 是 | 文件關聯類型，可選值：「待修改」、「參考資料」、「輸出結果」、「依賴文件」、「其他」 |
| description | string | 否 | 文件的補充描述（選填） |
| lineStart | number | 否 | 相關代碼區塊的起始行（選填） |
| lineEnd | number | 否 | 相關代碼區塊的結束行（選填） |
**返回：**
- 成功：返回更新後的任務數據，包含完整的相關文件列表
- 失敗：返回錯誤訊息
**使用範例：**
```javascript
const updateFilesResult = await mcp.mcp_shrimp_task_manager.update_task_files({
taskId: "task-uuid-here",
relatedFiles: [
{
path: "src/components/Button.tsx",
type: "待修改",
description: "需要修改按鈕組件以支持新狀態",
lineStart: 24,
lineEnd: 45,
},
{
path: "docs/design-spec.md",
type: "參考資料",
description: "包含按鈕設計規範",
},
],
});
```
新增刪除任務功能，允許用戶刪除未完成的任務，並禁止刪除已完成的任務以維護系統記錄的完整性。同時，新增任務複雜度評估功能，系統在執行任務時自動評估複雜度並提供處理建議，並在任務完成時自動更新摘要。更新相關文檔以反映這些新功能，提升任務管理的靈活性與可操作性。
2025-04-11 17:31:48 +08:00
## 工作日誌功能
### 1. 查詢日誌
#### `list_conversation_log`
查詢系統對話日誌，支持按任務 ID 或時間範圍過濾，提供分頁功能。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| --------- | ------ | ---- | ------------------------------------------- |
| taskId | string | 否 | 按任務 ID 過濾（選填） |
| startDate | string | 否 | 起始日期過濾，ISO 格式字串（選填） |
| endDate | string | 否 | 結束日期過濾，ISO 格式字串（選填） |
| limit | number | 否 | 返回結果數量限制，預設 20，最大 100（選填） |
| offset | number | 否 | 分頁偏移量，預設 0（選填） |
**使用範例：**
```javascript
const logResult = await mcp.mcp_shrimp_task_manager.list_conversation_log({
taskId: "task-uuid-here", // 選填，按特定任務過濾
startDate: "2025-01-01T00:00:00Z", // 選填，開始日期
endDate: "2025-12-31T23:59:59Z", // 選填，結束日期
limit: 20, // 選填，每頁顯示數量
offset: 0, // 選填，分頁起始位置
});
```
### 2. 清除日誌
#### `clear_conversation_log`
清除所有對話日誌記錄，操作不可逆。
**參數：**
| 參數名 | 類型 | 必填 | 描述 |
| ------- | ------- | ---- | ------------------------- |
| confirm | boolean | 是 | 確認刪除操作，必須為 true |
**使用範例：**
```javascript
const clearResult = await mcp.mcp_shrimp_task_manager.clear_conversation_log({
confirm: true, // 必填，確認刪除操作
});
```
更新 API 參考文檔，新增目錄及詳細的核心任務管理 API 說明，包括任務規劃、分析、反思、拆分、列出、執行及驗證功能，並強化參數驗證規則以提升用戶體驗。同時，更新工具函數以加入錯誤處理，確保輸入的有效性與一致性。
2025-04-12 00:17:05 +08:00
## 實用工具函數
Reference in New Issue Copy Permalink