mcpField
R
review

review

github.com/shiplightai测试与质量2607 次安装16 周前更新
代码仓库

关于 review

Review Orchestrator 是用于应用评审的入口技能,会先判断评审范围,再运行适用的专项检查并汇总报告,面向上线准备、事后复盘或明确领域检查。它涵盖安全、隐私、合规、设计、韧性、性能、SEO 和 GEO 等领域。

主要功能

  1. 01评审范围分诊与计划制定
  2. 02支持全面或定向评审
  3. 03覆盖八类应用评审领域
  4. 04按领域加载参考流程
  5. 05合并结果并生成统一报告

适用场景

  1. 01上线前评估应用准备情况
  2. 02规划事件后的复盘检查
  3. 03定向检查应用安全或 SEO
  4. 04汇总多领域评审结果

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/shiplightai/agent-skills --skill review

安装后在 Claude Code 中输入/review确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
compliance.md
design.md
geo.md
performance.md
privacy.md
report-format.md
resilience.md
security.md
seo.md

详细介绍

评审编排器

应用评审的统一入口。它会筛选出重要事项,然后运行一个或多个领域评审,并将结果合并为一份统一报告。每个领域的内容位于 references/<domain>.md 中,只有选中时才会加载。

适用场景

  • 用户想要进行评审,但不确定评审类型
  • 发布前就绪度评估
  • 事后复盘规划
  • 针对单一领域的请求(“检查我的应用的安全性”“评审 SEO”)

模式

  • 分诊(默认,/review)— 提出背景问题,推荐计划并执行。
  • 完整套件(/review --all)— 运行所有适用领域。
  • 定向评审(/review <domain>)— 直接进入某个领域,跳过分诊。例如:/review security、/review seo。可选深度标志(--quick / --thorough)。

领域

每一行对应一个参考文件。只有选中某个领域时才加载该文件。

领域参考文件适用情形(触发信号)
securityreferences/security.md身份验证/登录变更、敏感数据、OWASP、标头/CORS/CSP、供应链
privacyreferences/privacy.md收集 PII、跟踪/分析、同意横幅、GDPR/CCPA
compliancereferences/compliance.md受监管行业、审计准备、HIPAA/SOC 2/PCI-DSS/GDPR、支付或健康数据
designreferences/design.md未经设计师参与即发布 UI、响应式设计、无障碍、排版、i18n
resiliencereferences/resilience.md错误处理、网络/API 故障、空状态/边界状态、降级
performancereferences/performance.md页面缓慢、Core Web Vitals、包体积、运行时/渲染性能
seoreferences/seo.md公开网站、元标签、结构化数据、可抓取性、站点地图
georeferences/geo.md通过 AI 助手被发现、大模型引用就绪度、llms.txt、实体清晰度

通用规范(阶段、评分、置信度、严重程度、输出路径)位于 references/report-format.md — 每个领域都遵循这些规范。

步骤

1. 收集背景信息
  • 阅读项目:技术栈、框架、package.json、路由、组件。
  • 检查 git diff,了解近期变更。
  • 查找 shiplight/reports/ 中的现有报告。
  • 自动检测合规标记(HIPAA/PHI、PCI/支付字段、GDPR/Cookie 同意)。

如果以 /review <domain> 调用,则跳到步骤 4,执行指定领域的评审。

2. 提出有针对性的问题(最多 4 个)

逐个提问,并提供自动检测的默认值:

  1. 应用属于哪种类型?(SaaS、医疗保健、金融科技、电子商务、内部工具、营销网站、仅 API)
  2. 是什么触发了此次评审?(发布前、新功能、依赖项更新、安全事件、审计准备、例行评审)
  3. 是否有合规要求?(无、HIPAA、SOC2、PCI-DSS、GDPR、多项)— 根据代码库自动检测
  4. 是否有具体顾虑?(开放式问题,可选)
3. 生成评审计划

将每个适用领域归类为 CRITICAL(必须执行)、RECOMMENDED(价值显著)或 OPTIONAL(可做可不做),并估算评审深度(快速/标准/彻底)。

按产品类型确定 SEO 与 GEO 的优先级:

产品类型SEOGEO
开发者工具、API 产品、SaaSRECOMMENDEDCRITICAL
电子商务、本地企业、市场平台CRITICALOPTIONAL
内容/媒体、文档、博客CRITICALCRITICAL
内部工具——

展示决策矩阵:

评审优先级原因深度
securityCRITICAL新增身份验证功能 + SaaS 应用thorough
privacyCRITICAL处理用户 PII,适用 GDPRstandard
…
4. 执行

询问:“现在运行所有 CRITICAL 评审?[Y/n] 或选择具体项目。”

对于每个选定的领域,阅读 references/<domain>.md 并遵循其中的五个阶段,应用 references/report-format.md 中的评分、严重程度和输出路径规范。按顺序运行各领域;每个领域完成后,先展示简要摘要再继续。

5. 统一报告

所选领域完成后,将各领域报告合并为一份报告, 保存到 shiplight/reports/review-{date}.md:

  • 总体就绪度评分(0–10)及各领域评分
  • 所有领域中按严重程度排列的前 5 项发现
  • 回归测试摘要(生成的 YAML 测试总数,位于 shiplight/tests/)

提示

  • 每次重要发布前运行 /review。
  • 如果已经知道需要什么,/review <domain> 是快捷方式。
  • 报告会累积在 shiplight/reports/ 中,编排器可以展示趋势。
  • 评审生成的 YAML 回归测试会累积在 shiplight/tests/ 中。

评论

支持 Markdown