Milkosten Task MCP Server

🚀 任務API服務器 - MCP TypeScript實現

本項目是基於MCP（模型上下文協議）的任務API服務器，支持通過標準輸入輸出(STDIO)和HTTP + SSE兩種方式與AI工具和服務交互，可實現任務的創建、讀取、更新和刪除操作。

🚀 快速開始

環境要求

• Node.js 14.0 或更高版本
• npm 6.0 或更高版本
• TypeScript 4.0 或更高版本

操作步驟

1. 克隆項目：

   git clone <repository-url>
   

2. 安裝依賴：

   cd mcp-template-ts && npm install
   

3. 啟動服務器（STDIO模式）：

   npm start
   

4. 或啟動HTTP + SSE服務器：

   npm run start:web
   

✨ 主要特性

核心功能

• 任務管理：支持 CRUD 操作（創建、讀取、更新、刪除）。
• 過濾器：可依據狀態、類別和優先級對任務進行篩選。
• 異步操作：HTTP + SSE 服務器支持長輪詢，即時返回任務狀態。

集成

• MCP協議：兼容 MCP 協議，便於與AI工具和服務集成。
• 外部任務API：通過配置環境變量可使用外部任務管理服務。

📦 安裝指南

環境要求

• Node.js 14.0 或更高版本
• npm 6.0 或更高版本
• TypeScript 4.0 或更高版本

安裝步驟

1. 克隆項目：

   git clone <repository-url>
   

2. 安裝依賴：

   cd mcp-template-ts && npm install
   

💻 使用示例

基礎用法

列出所有任務

const result = await client.callTool({
  name: "listTasks",
  arguments: {
    // 可選過濾條件
    status: "pending", // 根據狀態篩選
    category: "工作",  // 根據類別篩選
    priority: "high"   // 根據優先級篩選
  }
});

創建新任務

const result = await client.callTool({
  name: "createTask",
  arguments: {
    task: "完成項目報告",  // 必填：任務描述
    category: "工作",      // 可選：任務類別
    priority: "high"       // 可選：低、中、高
  }
});

更新現有任務

const result = await client.callTool({
  name: "updateTask",
  arguments: {
    taskId: 123,           // 必填：要更新的任務ID
    task: "更新後的描述",  // 可選：新描述
    status: "done",        // 可選：pending、started、done
    category: "個人",      // 可選：新的類別
    priority: "medium"     // 可選：低、中、高
  }
});

刪除任務

const result = await client.callTool({
  name: "deleteTask",
  arguments: {
    taskId: 123   // 必填：要刪除的任務ID
  }
});

📚 詳細文檔

項目結構

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

配置

環境變量

開發

1. 啟動TypeScript編譯器進行即時監聽：

   npm run watch
   

2. 運行測試以驗證更改：

   npm test
   

📄 許可證

本項目採用MIT許可證，具體條款請參閱LICENSE文件。

致謝

• 使用了@modelcontextprotocol/sdk實現MCP協議
• 旨在與AI工具和服務集成