article
README
🚀 mcp-todo-server
模型上下文协议(MCP)服务器,用于管理TODO.md和CHANGELOG.md文件,能高效处理文件编辑、读取及版本管理等任务。
🚀 快速开始
mcp-todo-server是一个强大的模型上下文协议(MCP)服务器,可用于精确管理TODO.md和CHANGELOG.md文件。通过它,你可以轻松实现基于行的文件编辑、读取以及版本管理等功能。
✨ 主要特性
- 精确的基于行的文件编辑和读取功能,确保对文件内容的精准操作。
- 高效的部分文件访问,通过行范围实现,特别适合大型语言模型工具的使用。
- 可通过指定行范围获取特定文件内容,灵活满足不同需求。
- 支持在单个请求中从多个文件获取多个行范围的内容,提高操作效率。
- 应用基于行的补丁,能正确调整行号变化,保证文件内容的一致性。
- 支持广泛字符编码(如
utf-8、shift_jis、latin1等),适应不同的文件编码需求。 - 对多文件进行原子操作,确保操作的完整性和一致性。
- 使用自定义错误类型实现稳健错误处理,增强系统的稳定性。
- 遵循语义化版本控制和保持变更日志规范,便于项目的版本管理和维护。
📦 安装指南
安装要求
- Go语言版本1.23以上
- 支持Linux、macOS或Windows系统
- 文件系统读写权限
安装命令
go install codeberg.org/mutker/mcp-todo-server/cmd/mcp-todo-server@latest
💻 使用示例
基础用法
- 询问“当前0.2.0版本的任务有哪些?”
- 指令“在0.2.0版本中添加一个新的任务,实施OAuth认证”
- 请求“根据
TODO.md中已完成的任务生成0.1.0版本的变更日志条目” - 命令“从
/path/to/my/TODO.md导入现有的TODO.md文件”
服务器能够智能处理任务解析、版本管理,并提供丰富的语义化任务和变更日志条目的理解。
高级用法
服务器可根据用户的复杂需求,对多个文件进行原子操作,同时支持广泛的字符编码,确保在不同环境下都能稳定运行。
📚 详细文档
可用MCP工具
TODO.md操作
get-todo-tasks- 获取TODO.md中的所有任务get-todo-tasks-by-version- 获取特定版本的任务add-todo-task- 为特定版本添加新任务update-todo-task- 更新现有任务add-todo-version- 添加新的版本部分import-todo- 导入并格式化现有的TODO.md
CHANGELOG.md操作
get-changelog- 获取所有变更日志条目get-changelog-by-version- 获取特定版本的变更日志条目add-changelog-entry- 添加新的变更日志版本条目update-changelog-entry- 更新现有变更日志条目import-changelog- 导入并格式化现有的CHANGELOG.mdgenerate-changelog-from-todo- 根据TODO.md中已完成的任务生成新的CHANGELOG.md条目
📄 许可证
本项目采用MIT许可证,详见LICENSE获取完整许可文本。
致谢
感谢tumf/mcp-text-editor的启发。
微信扫一扫