generate_code_review
Generate detailed code review reports by comparing branches or commits, producing HTML documents with author filtering and AI-generated summaries.
Instructions
生成代码Review报告。支持两种模式:
模式一:分支对比模式(需要 target_branch) 对比开发分支与目标分支的代码差异。
模式二:Commit Hash 模式(需要 from_commit,不需要 target_branch) 指定一个起始 commit hash,获取该 commit 之后到开发分支的所有变更并生成报告。
使用场景:
迭代结束后,需要在小组内分享代码改动
代码评审会议前准备Review材料
记录本次迭代的技术细节
使用方式: 直接调用此工具即可。如果不传 file_descriptions,系统会返回变更文件列表,你需要根据每个文件的完整路径理解其功能,生成简短的中文功能描述(50字以内),然后再次调用此工具传入 file_descriptions 参数。
参数说明:
repo_path: Git仓库的本地路径
dev_branch: 开发分支名称(你的工作分支)
target_branch: 目标对比分支(通常是main/master/develop),使用 from_commit 模式时可不传
from_commit: 起始 commit hash,指定后无需 target_branch
author: 你的Git用户名或邮箱(用于筛选你的提交,可选)
output_path: HTML报告输出路径(可选,默认生成在仓库根目录)
file_descriptions: 文件功能描述列表(可选,不传则返回文件列表供你生成描述)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| author | No | Git提交作者名称或邮箱(用于筛选特定作者的提交,可选) | |
| repo_path | Yes | Git仓库的本地路径 | |
| ai_summary | No | AI生成的代码审查总结(可选)。当传入 file_descriptions 后,系统会返回所有文件的diff内容,你需要分析这些diff并生成符合Code Review规范的技术总结,包括:技术思路、疑难解决、特殊说明、关键改动细节等。生成后通过此参数传入,系统会将其展示在报告中。 | |
| dev_branch | Yes | 开发分支名称 | |
| from_commit | No | 起始 commit hash。指定后,将获取该 commit 之后到 dev_branch 的所有变更,无需指定 target_branch。 | |
| output_path | No | HTML报告输出路径(可选,默认在仓库根目录生成) | |
| target_branch | No | 目标对比分支(如main、master、develop)。使用 from_commit 模式时可不传。 | |
| file_descriptions | No | 文件功能描述列表(可选),每个元素包含文件路径和对应的功能描述。如果不传,系统会返回变更文件列表,你需要根据每个文件的完整路径理解其功能,生成简短的中文描述(50字以内),然后再次调用此工具传入。 |