Todo List MCP

🚀 待办事项 MCP 服务器

这是一个基于 Model Context Protocol (MCP) 的服务器，它提供了全面的 API 来管理待办事项，能有效提升待办事项管理的效率和便捷性。

🚀 快速开始

此 MCP 服务器可助力你高效管理待办事项。以下是快速上手的步骤：

安装

# 克隆仓库
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 设置” -> “MCP”
• 添加一个新的 MCP 服务器，类型为“命令行”
• 添加服务器的绝对路径并使用 Node 运行
• 示例：node /absolute/path/to/todo-list-mcp/dist/index.js

示例命令

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

• “创建一个待办事项以学习 MCP，并添加描述说明为什么 MCP 有用”
• “列出我所有的活跃待办事项”
• “为明天的会议创建一个待办事项，并在 Markdown 格式中包含议程细节”
• “将我的学习 MCP 待办事项标记为已完成”
• “总结所有我的活跃待办事项”

✨ 主要特性

• 创建待办事项：可添加新任务，任务包含标题和 Markdown 格式的描述。
• 更新待办事项：能对现有任务进行修改。
• 完成待办事项：可将任务标记为已完成。
• 删除待办事项：可从列表中移除任务。
• 搜索待办事项：能按标题或创建日期查找任务。
• 总结待办事项：可获取所有活跃任务的快速概览。

📦 安装指南

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

# 安装依赖
npm install

# 构建项目
npm run build

💻 使用示例

基础用法

启动服务器：

npm start

高级用法

在不同的应用中配置使用该服务器：

Claude Desktop

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

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

Cursor

• 转到“Cursor 设置” -> “MCP”
• 添加一个新的 MCP 服务器，类型为“命令行”
• 添加服务器的绝对路径并使用 Node 运行
• 示例：node /absolute/path/to/todo-list-mcp/dist/index.js

📚 详细文档

工具

此 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：生成所有活跃（未完成）待办事项的摘要

项目结构

项目的代码目录如下：

• models：包含数据模型和数据库交互逻辑
• services：提供核心业务功能的实现
• routes：定义 API 路由和端点
• utils：包含辅助函数和其他工具模块

学习资源

此项目专为教育目的设计，提供了一个学习 MCP 实现的基础结构。通过阅读代码、实验功能以及探索其工作原理，开发者可以深入理解 MCP 的核心概念和技术。有关项目的详细信息及其实现方式，请参阅 GUIDE.md。

开发

构建

npm run build

运行

npm start

📄 许可证

此项目遵循 MIT 许可证。