待办事项管理API

一个基于Model Context Protocol (MCP)的服务,提供全面的API用于管理待办事项,包括创建、更新、完成、删除和搜索任务等功能。

  • by RegiByte
  • TypeScript
  • 本地部署
  • 47 星标
  • 更新于
在 GitHub 查看 RegiByte/todo-list-mcp

使用说明

待办事项列表MCP服务器

一种模型上下文协议(MCP)服务器,它为管理todo项目提供了全面的API。

📚 学习资源:该项目旨在作为MCP实施的教育示例。看 GUIDE.md 全面解释项目是如何运作的,以及为什么事情会以这种方式实施。

特性

  • 创建全部:添加带有标题和标记描述的新任务
  • 全部更新:修改现有任务
  • 完成所有:将任务标记为已完成
  • 删除所有:从列表中删除任务
  • 搜索所有:按标题或创建日期查找任务
  • 总结待办事项:快速了解活动任务

工具

此MCP服务器公开了以下工具:

  1. create-todo:创建新的待办事项
  2. list-todos:列出所有
  3. get-todo:按ID获取特定待办事项
  4. update-todo:更新待办事项的标题或描述
  5. complete-todo:将待办事项标记为已完成
  6. delete-todo:删除待办事项
  7. search-todos-by-title:按标题搜索待办事项(不区分大小写的部分匹配)
  8. search-todos-by-date:按创建日期搜索待办事项(格式:YYYY-MM-DD)
  9. list-active-todos:列出所有未完成的待办事项
  10. summarize-active-todos:生成所有活动(未完成)待办事项的摘要

安装

# Clone the repository
git clone https://github.com/RegiByte/todo-list-mcp.git
cd todo-list-mcp

# Install dependencies
npm install

# Build the project
npm run build

用法

启动服务器

npm start

使用Claude for Desktop进行配置

克劳德桌面

将此添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "todo": {
      "command": "node",
      "args": ["/absolute/path/to/todo-list-mcp/dist/index.js"]
    }
  }
}

光标

  • 转到“光标设置”->MCP
  • 添加具有“命令”类型的新MCP服务器
  • 添加服务器的绝对路径并使用节点运行它
  • 示例:node/advolute/path/to/todo列表mcp/dist/index.js

示例命令

当使用Claude for Desktop或Cursor时,您可以尝试:

  • “创建学习MCP的待办事项,并说明为什么MCP有用”
  • “列出我所有的活动待办事项”
  • “为明天的会议创建一个待办事项,并在markdown中详细说明议程”
  • “将我的学习MCP待办事项标记为已完成”
  • “总结我所有的活动待办事项”

项目结构

该项目遵循明确的关注点分离,使代码易于理解:

src/
├── models/       # Data structures and validation schemas
├── services/     # Business logic and database operations
├── utils/        # Helper functions and formatters
├── config.ts     # Configuration settings
├── client.ts     # Test client for local testing
└── index.ts      # Main entry point with MCP tool definitions

从这个项目中学习

该项目旨在作为一种教育资源。要充分利用它:

  1. 阅读 GUIDE.md 对设计进行全面解释
  2. 研究注释过多的源代码以了解实现细节
  3. 使用测试客户端查看服务器在实践中的工作方式
  4. 尝试添加自己的工具或扩展现有工具

发展

建筑

npm run build

以开发模式运行

npm run dev

许可证

麻省理工学院