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 - 用于编写强类型代码。