用途:更新项目 README.md,使文档与代码变更保持一致。触发方式包括关键词 readme、说明、文档、怎么用、安装说明,以及被 git-precommit 自动调用。
主要能力:按变更类型更新对应区块——新功能更新功能列表,新依赖更新安装说明,API 变更更新使用范例,目录变更更新项目结构,新设置更新配置说明。授权信息、贡献指南、致谢属于保护区块,不自动修改。
使用方式:使用 read_file("README.md")、replace_string_in_file、list_dir、get_changed_files 等工具。工作流为:read_file("README.md") 加 get_changed_files(),分析变更并对应更新区块,再用 replace_string_in_file 更新对应区块。
适用场景:需要随代码改动同步维护 README 的项目,尤其是提交前自动更新文档的流程。
限制:保护区块不自动修改;其余具体配置、安装与调用细节暂未提供。