---

MCP Todo.txt 集成

概述

MCP Todo.txt 集成是 Model Context Protocol (MCP) 的一个服务器实现，它允许与 Todo.txt 文件进行交互。此项目允许 LLM（大型语言模型）使用 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 许可证。