Task API Server - MCP TypeScript Implementation

Task API Server - MCP TypeScript Implementation

site icon
2025.03.07 1
JavaScript任务管理API服务开发效率
Task API Server 是一个基于 TypeScript 实现的 Model Context Protocol (MCP) 任务管理服务。它提供了标准化的任务管理接口,支持两种运行模式:STDIO 模式用于 CLI 应用和 AI 代理集成,HTTP+SSE 模式用于浏览器和基于 HTTP 的客户端访问。该服务器提供完整的任务管理操作、广泛的验证和健壮的错误处理。
View on GitHub

Overview

基本能力

产品定位

Task API Server 是一个任务管理服务,提供标准化的任务管理接口,支持 CLI 和 Web 两种访问方式。

核心功能

  • 任务管理操作
  • 列出任务(支持过滤)
  • 创建新任务(支持自定义属性)
  • 更新任务详情(描述、状态、类别、优先级)
  • 删除任务

  • 双接口模式

  • STDIO 协议支持命令行和 AI 代理集成
  • HTTP+SSE 协议支持浏览器访问

  • MCP 协议实现

  • 完整的 Model Context Protocol 实现
  • 任务数据结构资源
  • 任务操作工具
  • 错误处理和信息提示

  • 质量保证

  • 全面的测试客户端
  • 测试完成后自动关闭服务器
  • 详细的 API 响应验证

适用场景

  • CLI 应用的任务管理
  • AI 代理的任务管理集成
  • 浏览器端的任务管理应用

工具列表

  • listTasks:列出所有任务,支持状态、类别和优先级过滤
  • createTask:创建新任务,支持设置描述、类别和优先级
  • updateTask:更新任务详情,包括描述、状态、类别和优先级
  • deleteTask:删除指定任务

常见问题解答

  • 如何更改 HTTP 服务器端口? 通过设置 TASK_MANAGER_HTTP_PORT 环境变量或 PORT 环境变量(优先级更高)
  • 如何连接到外部 Task API 服务? 在 .env 文件中设置 TASK_MANAGER_API_BASE_URLTASK_MANAGER_API_KEY

使用教程

使用依赖

  • Node.js 16.x 或更高版本
  • npm 或 pnpm 包管理器

安装教程

  1. 克隆仓库: git clone https://github.com/yourusername/mcp-template-ts.git cd mcp-template-ts

  2. 安装依赖: npm install 或使用 pnpm: pnpm install

  3. 创建 .env 文件并配置 Task API 凭据: TASK_MANAGER_API_BASE_URL=https://your-task-api-url.com/api TASK_MANAGER_API_KEY=your_api_key_here TASK_MANAGER_HTTP_PORT=3000

  4. 构建项目: npm run build

运行服务器

STDIO 模式(用于 CLI/AI 集成)

npm start

node dist/index.js

HTTP 模式(用于 Web 访问)

npm run start:http

node dist/http-server.js

调试方式

运行测试套件验证功能:

npm test

这将: 1. 构建项目 2. 启动服务器实例 3. 连接测试客户端到服务器 4. 运行所有任务操作 5. 验证正确响应 6. 自动关闭服务器

许可证

该项目遵循 MIT 开源许可条款。