使用说明
MCP Todo.txt集成
概述
MCP Todo.txt集成是模型上下文协议(MCP)的服务器实现,可以与Todo.txt文件进行交互。此项目允许LLM使用MCP协议以编程方式管理Todo.txt文件中的任务。
特性
核心功能
-
资源
- 将任务列表作为资源公开。
- 按上下文、项目或优先级筛选任务。
-
工具
- 添加任务:添加一个具有可选元数据的新任务。
- 标记任务为已完成:将任务标记为已完成。
- 删除任务:删除任务。
- 列出任务:使用筛选选项检索所有任务。
- 搜索任务:根据关键字或元数据搜索任务。
- 任务排序:按优先级、创建日期或完成日期对任务进行排序。
- 筛选任务:按特定条件筛选任务。
- 添加元数据:向任务添加自定义元数据。
- 删除元数据:从任务中删除特定元数据。
- 批量操作:执行批量更新或删除。
-
提示
- 总结任务。
- 生成新的任务描述。
高级功能
- 动态任务管理:根据输入或触发器动态更新任务。
- 会话管理:跨多个请求管理任务。
安装
为了快速安装,请使用下面的一键安装按钮
-
克隆存储库:
git clone <repository-url> cd todomcp -
安装依赖项:
npm install -
构建项目:
npm run build
用法
-
启动MCP服务器:
npm start -
使用符合MCP的客户端或工具与服务器交互。
配置
- Todo.txt文件的路径可以使用配置
TODO_FILE_PATH环境变量。如果未设置,则默认路径为todo.txt在项目根中。
发展
-
要在开发模式下运行项目,请执行以下操作:
npm run dev -
要运行测试,请执行以下操作:
npm test
依赖项
@modelcontextprotocol/sdkjsTodoTxtzod
文档
贡献
欢迎投稿!请打开一个问题或提交任何改进或错误修复的拉取请求。
许可证
该项目根据MIT许可证获得许可。
