MCP Todo.txt Integration

---

MCP Todo.txt 集成

概述

MCP Todo.txt 集成是 Model Context Protocol（MCP）的服务实现，可与 Todo.txt 文件交互。此项目允许大模型通过 MCP 协议以编程方式管理 Todo.txt 文件中的任务。

功能

核心功能

• 资源

  • 将任务列表公开为资源。
  • 按上下文、项目或优先级筛选任务。

• 工具

  1. 添加任务：添加带有可选元数据的新任务。
  2. 将任务标记为已完成：将任务标记为已完成。
  3. 删除任务：移除任务。
  4. 列出任务：检索所有任务，并提供筛选选项。
  5. 搜索任务：根据关键字或元数据搜索任务。
  6. 排序任务：按优先级、创建日期或完成日期对任务排序。
  7. 筛选任务：按特定条件筛选任务。
  8. 添加元数据：为任务添加自定义元数据。
  9. 移除元数据：从任务中移除指定元数据。
  10. 批量操作：执行批量更新或删除。

• 提示词

  • 总结任务。
  • 生成新的任务描述。

高级功能

• 动态任务管理：根据输入或触发条件动态更新任务。
• 会话管理：在多个请求之间管理任务。

安装

如需快速安装，请使用下方的一键安装按钮

1. 克隆仓库：

   git clone <repository-url>
   cd todomcp
   

2. 安装依赖：

   npm install
   

3. 构建项目：

   npm run build
   

使用

1. 启动 MCP 服务：

   npm start
   

2. 使用符合 MCP 规范的客户端或工具与服务交互。

配置

• 可以使用 TODO_FILE_PATH 环境变量配置 Todo.txt 文件的路径。如果未设置，默认路径为项目根目录下的 todo.txt。

开发

• 在开发模式下运行项目：

  npm run dev
  

• 运行测试：

  npm test
  

依赖项

• @modelcontextprotocol/sdk
• jsTodoTxt
• zod

文档

• Todo.txt 格式
• jsTodoTxt 文档

参与贡献

欢迎贡献！如有任何改进或错误修复，请提交问题或拉取请求。

许可证

此项目采用 MIT 许可证。