Todo List

🚀 待办事项列表 MCP 服务器

这是一个基于 Model Context Protocol (MCP) 的服务器，能通过全面的 API 来管理待办事项，为待办事项管理提供了便捷的解决方案。

📚 学习资源：此项目旨在作为 MCP 实现的教育示例。有关详细说明，请参阅 GUIDE.md 了解为什么以这种方式实现以及它是如何工作的。

✨ 主要特性

• 创建待办事项：可添加带有标题和 Markdown 描述的新任务。
• 更新待办事项：能够修改现有任务。
• 完成待办事项：可将任务标记为已完成。
• 删除待办事项：能从任务列表中删除任务。
• 搜索待办事项：支持按标题或创建日期查找任务。
• 总结待办事项：可快速概览所有未完成任务。

📦 安装指南

# 克隆仓库
git clone https://github.com/RegiByte/todo-list-mcp.git
cd todo-list-mcp

# 安装依赖项
npm install

# 构建项目
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。
• 添加一个新的 MCP 服务器，类型为 "command"。
• 添加服务器的绝对路径并用 node 运行它。
• 示例：node /absolute/path/to/todo-list-mcp/dist/index.js

高级用法

与 Claude for Desktop 或 Cursor 结合使用时，可以尝试以下命令：

• "创建一个待办事项以学习 MCP，并附上解释为什么 MCP 有用的描述"
• "列出我所有的活跃待办事项"
• "为明天的会议创建一个带有议程详细信息（用 Markdown 表示）的待办事项"
• "将我的学习 MCP 待办事项标记为已完成"
• "总结所有我的活跃待办事项"

📚 详细文档

项目结构

此项目遵循清晰的分层结构，以便于理解和维护：

src/
├── models/       # 数据结构和验证模式
├── services/     # 业务逻辑和服务操作
├── utils/        # 辅助函数和格式工具
├── config.ts     # 配置设置
├── client.ts     # 用于本地测试的客户端
└── index.ts      # 入口文件，包含 MCP 工具定义

学习指南

这个项目旨在作为教育示例。要充分利用它：

1. 阅读 GUIDE.md 以获得全面的设计解释。
2. 研究 heavily commented 源代码以理解实现细节。
3. 使用客户端进行本地测试，了解项目的运作方式。
4. 查看开发步骤和示例，进一步掌握 MCP 的使用。

开发步骤

# 克隆仓库到本地
git clone https://github.com/RegiByte/todo-list-mcp.git

# 进入项目目录
cd todo-list-mcp

# 安装依赖项
npm install

# 启动开发服务器
npm run dev

📄 许可证

此项目的代码遵循 MIT 许可证。请查看 LICENSE 以获取详细信息。

# 查看许可证内容
cat LICENSE

通过这个 MCP 项目，您可以方便地管理待办事项，并集成到各种应用中。希望这个示例对您理解 MCP 的工作原理有所帮助！