Todo List MCP Server

Todo List MCP 服务

一个模型上下文协议（MCP）服务，提供用于管理待办事项的综合 API。

📚 学习资源：本项目是 MCP 实现的教学示例。有关项目的工作原理以及采用这些实现方式的原因，请参阅 GUIDE.md。

功能

• 创建待办事项：添加带有标题和 Markdown 描述的新任务
• 更新待办事项：修改现有任务
• 完成待办事项：将任务标记为已完成
• 删除待办事项：从列表中移除任务
• 搜索待办事项：按标题或创建日期查找任务
• 汇总待办事项：快速查看未完成任务概况

工具

此 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

将以下内容添加到 claude_desktop_config.json：

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

Cursor

• 前往“Cursor Settings” -> MCP
• 添加一个类型为“command”的新 MCP 服务
• 添加服务的绝对路径，并使用 node 运行
• 示例：node /absolute/path/to/todo-list-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

许可证

MIT