代码审查工具
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-rn88lg3j/code-reviews 到当前 AI 助手。
技能介绍
解决的具体问题
日常代码审查中,人工Review常面临三个痛点:一是耗时——开发者需逐行核对逻辑,难以快速覆盖规范、可维护性、安全性等多维度;二是维度不统一——不同审查者关注重点差异大,比如有人侧重语法,有人侧重业务逻辑,导致审查结果零散;三是提交前难以快速预判——合并代码时,往往只能通过跑测试验证功能,缺少对“这段代码是否该合并”的结构化评分参考。此外,跨项目审查时,风格不统一也是常见难题——A项目的审查标准是“优先可读性”,B项目是“优先性能”,人工切换成本高。
技能如何工作
这个基于MCP(Model Context Protocol)的代码审查工具,核心逻辑是“大模型做路由层,工具负责构建提示词与对接API”,具体能力围绕三类审查场景与评分解析展开:
- 多场景审查提示词构建:提供三个核心工具,对应不同审查需求——
scripts.tools.review_code用于待提交的整段代码整体审查,可传入代码文本、可选的审查风格或提交信息;scripts.tools.review_diff针对Git diff变更内容,聚焦“本次修改是否引入新问题”;scripts.tools.review_file针对单个文件,需提供文件路径与内容,适合批量处理独立模块。三者均不直接调用LLM,而是生成适配API的审查提示词,确保审查维度标准化。 - 结构化评分解析:通过
scripts.tools.parse_review_score从审查文本中提取“总分:XX分”格式的结果,将非结构化的审查内容转化为可量化的评分,方便快速判断代码质量等级。 - 关键工作步骤:大模型首先检查
scripts.config.settings.api_key是否为空,若无密钥则通过AskUserQuestion询问用户,拿到后调用scripts.config.set_api_key保存;再根据用户意图选择对应工具,提取必填参数(如代码文本、diff内容、文件路径等),若参数不完整则进一步询问;最后调用工具函数获取result["raw"]原始数据,整理后展示给用户。
适用边界与注意点
- 必须配置API密钥:密钥是工具运行的前提,无密钥时无法调用API获取审查结果,且禁止自行搜索或编造数据。
- 不直接调用LLM:工具仅负责构建审查提示词,实际的审查与打分需通过API完成,结果准确性依赖API的LLM能力。
- 参数完整性要求:每个工具都有必填参数(如
review_diff需提供diff内容),若参数缺失,需通过AskUserQuestion补全,否则无法构建有效提示词。 - 评分格式依赖:
parse_review_score仅能提取“总分:XX分”格式的评分,若审查文本未按此格式输出,可能无法正确解析。
使用场景
- 合并代码到主分支前,审查本次 Git diff 变更是否引入新问题并给出评分
- 提交新功能前,对整段代码做整体质量审查,获取结构化评分参考
- 批量处理多个文件时,逐个审查单文件内容并得到质量评估
- 收到含“总分:XX分”的审查反馈文本后,从中提取结构化评分数据
适合人员
- 开发工程师:提交或合并代码前,需要快速获得多维度的代码质量反馈
- 团队技术负责人:希望统一团队代码审查的维度和评分标准,减少评审分歧
- 独立开发者:没有专门的评审伙伴,需要工具对个人代码给出客观评分
- CI流程维护者:需要在自动化流水线中接入代码审查,并解析返回的评分