Task MCP Server

🚀 任務API接口的任務管理器實現

本項目是一個基於MCP協議的任務管理器，支持通過命令行界面和網絡接口兩種方式管理任務。藉助它，你能夠輕鬆創建、更新、查詢和刪除任務，極大提升任務管理效率。

🚀 快速開始

本任務管理器支持兩種接口方式進行任務管理操作，下面為你分別介紹：

命令行界面 (STDIO)

適合在終端中使用，進行快速的任務管理操作。例如：

node index.js --list  # 列出所有任務
node index.js --create "完成項目報告"  # 創建新任務

網絡接口 (HTTP + SSE)

支持通過HTTP協議與SSE（服務器發送事件）進行交互，適合構建網絡應用程序。例如：

// 使用fetch API創建任務
fetch('http://localhost:3000/api/tasks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    task: "完成項目報告"
  })
});

✨ 主要特性

• 任務創建：允許用戶添加新的任務。
• 任務查詢：可以根據狀態、類別或優先級過濾任務列表。
• 任務更新：支持修改現有任務的詳細信息。
• 任務刪除：允許移除不再需要的任務。

📦 安裝指南

先決條件

• Node.js (版本建議：14.0+)
• npm/yarn包管理工具
• 環境變量配置文件（.env）

安裝步驟

1. 下載並安裝Node.js和npm。
2. 克隆項目倉庫到本地：

   git clone https://github.com/yourusername/mcp-task.git
   

3. 進入項目目錄：

   cd mcp-task
   

4. 安裝依賴項：

   npm install
   

環境變量配置

編輯項目的.env文件，添加以下內容：

TASK_MANAGER_API_BASE_URL=你的任務API地址  # 必須填寫
TASK_MANAGER_API_KEY=你的API密鑰         # 必須填寫
TASK_MANAGER_HTTP_PORT=3000              # 可選，默認為3000
PORT=其他端口名稱                       # 可選，優先級高於TASK_MANAGER_HTTP_PORT

📚 詳細文檔

項目結構

mcp-task/
├── dist/               # 編譯後的JavaScript文件目錄
├── src/                # TypeScript源代碼目錄
│   ├── index.ts        # STDIO服務器入口文件
│   ├── http-server.ts  # HTTP + SSE服務器入口文件
│   └── test-client.ts  # 測試客戶端實現
├── .env                # 環境變量配置文件
├── package.json       # 項目依賴管理文件
├── tsconfig.json      # TypeScript編譯器配置文件
└── README.md          # 項目文檔

開發指南

1. 啟動開發環境：

   npm run watch
   

   這將即時監視源代碼文件，自動進行編譯。
2. 運行測試：

   npm test
   

   執行所有預定義的測試用例，確保功能正常。
3. 構建項目：

   npm run build
   

   生成優化後的生產版本文件到dist/目錄。

使用說明

命令行工具 (STDIO)

列出任務 (listTasks)

node index.js --list [--status 狀態] [--category 類別] [--priority 優先級]

• --status: 可選，狀態包括："未完成"、"進行中"、"已完成"
• --category: 可選，類別包括："工作"、"學習"、"生活"
• --priority: 可選，優先級包括："低"、"中"、"高"

創建任務 (createTask)

node index.js --create <任務名稱>

更新任務 (updateTask)

node index.js --update <任務ID> [--status 狀態] [--category 類別] [--priority 優先級]

刪除任務 (deleteTask)

node index.js --delete <任務ID>

網絡接口 (HTTP + SSE)

所有API請求都需要通過認證。以下是常用的API端點：

• 創建任務：

  POST /api/tasks
  Content-Type: application/json
  
  {
    "task": "完成項目報告"
  }
  

• 查詢任務：

  GET /api/tasks?status=未完成&category=工作&priority=高
  

• 更新任務：

  PUT /api/tasks/{taskId}
  Content-Type: application/json
  
  {
    "status": "進行中",
    "category": "工作",
    "priority": "高"
  }
  

• 刪除任務：

  DELETE /api/tasks/{taskId}
  

📄 許可證

本項目遵循MIT許可證。

致謝

感謝以下項目的貢獻：

• MCP協議 - 提供了通信的標準。
• TypeScript - 用於編寫強類型代碼。