
Todo List MCP Server

2025.03.13
9
TypeScript任务管理待办事项日程管理
Todo List MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,提供了一套完整的 API 用于管理待办事项。它支持创建、更新、完成、删除和搜索待办事项,并能生成待办事项的摘要。该项目还作为 MCP 实现的教育示例,适合学习和理解 MCP 的工作原理。
View on GitHub
Overview
基本能力
产品定位
Todo List MCP Server 是一个用于管理个人或团队待办事项的服务,旨在提高任务管理的效率和便捷性。
核心功能
- 创建待办事项:添加新任务,包括标题和 Markdown 格式的描述
- 更新待办事项:修改现有任务的标题或描述
- 完成待办事项:标记任务为已完成
- 删除待办事项:从列表中移除任务
- 搜索待办事项:通过标题或创建日期查找任务
- 摘要生成:获取所有活跃任务的快速概览
适用场景
- 个人任务管理
- 团队协作中的任务分配与跟踪
- 学习 MCP 协议的实际应用
工具列表
create-todo
: 创建新的待办事项list-todos
: 列出所有待办事项get-todo
: 通过 ID 获取特定待办事项update-todo
: 更新待办事项的标题或描述complete-todo
: 标记待办事项为已完成delete-todo
: 删除待办事项search-todos-by-title
: 通过标题搜索待办事项(不区分大小写的部分匹配)search-todos-by-date
: 通过创建日期搜索待办事项(格式:YYYY-MM-DD)list-active-todos
: 列出所有未完成的待办事项summarize-active-todos
: 生成所有活跃(未完成)待办事项的摘要
常见问题解答
- 该项目主要作为 MCP 实现的教育示例,详细设计原理可参考 GUIDE.md
- 开发模式下可使用
npm run dev
命令 - 项目遵循清晰的关注点分离原则,便于理解和扩展
使用教程
使用依赖
# 确保已安装 Node.js 和 npm
node --version
npm --version
安装教程
# 克隆仓库
git clone https://github.com/RegiByte/todo-list-mcp.git
cd todo-list-mcp
# 安装依赖
npm install
# 构建项目
npm run build
调试方式
# 启动服务器
npm start
# 开发模式(自动重载)
npm run dev
配置示例
Claude Desktop
在 claude_desktop_config.json
中添加:
{
"mcpServers": {
"todo": {
"command": "node",
"args": ["/absolute/path/to/todo-list-mcp/dist/index.js"]
}
}
}
Cursor
- 转到 "Cursor Settings" -> MCP
- 添加一个新的 MCP 服务器,类型为 "command"
- 添加服务器的绝对路径并用 node 运行
- 示例:node /absolute/path/to/todo-list-mcp/dist/index.js
示例命令
- "Create a todo to learn MCP with a description explaining why MCP is useful"
- "List all my active todos"
- "Create a todo for tomorrow's meeting with details about the agenda in markdown"
- "Mark my learning MCP todo as completed"
- "Summarize all my active todos"