Smithery Logo
MCPsSkillsDocsPricing
Login
Smithery Logo

Accelerating the Agent Economy

Resources

DocumentationPrivacy PolicySystem Status

Company

PricingAboutBlog

Connect

© 2026 Smithery. All rights reserved.

    testany-io

    api-reviewer

    testany-io/api-reviewer
    Coding
    7

    About

    SKILL.md

    Install

    Install via Skills CLI

    or add to your agent
    • Claude Code
      Claude Code
    • Codex
      Codex
    • OpenClaw
      OpenClaw
    • Cursor
      Cursor
    • Amp
      Amp
    • GitHub Copilot
      GitHub Copilot
    • Gemini CLI
      Gemini CLI
    • Kilo Code
      Kilo Code
    • Junie
      Junie
    • Replit
      Replit
    • Windsurf
      Windsurf
    • Cline
      Cline
    • Continue
      Continue
    • OpenCode
      OpenCode
    • OpenHands
      OpenHands
    • Roo Code
      Roo Code
    • Augment
      Augment
    • Goose
      Goose
    • Trae
      Trae
    • Zencoder
      Zencoder
    • Antigravity
      Antigravity
    ├─
    ├─
    └─

    About

    API contract review, 接口契约评审。Use when: PRD 完成后、HLD/LLD/实现前需要审查 OpenAPI/AsyncAPI/GraphQL/gRPC/WebSocket/SSE/Webhook/SDK/文件格式/IPC-CLI 契约。

    SKILL.md

    API Reviewer - 接口契约审查专家

    语言规则:默认跟随用户输入语言;用户显式指定时以用户指定为准;不要因为本 SKILL.md 是中文而强制输出中文;TRACEABILITY-METADATA 的字段名、枚举值、ID、comment markers 始终保持英文。若本 skill 使用模板或派发子任务,继续传递同一个 output_language。详见 ../../references/language-policy.md。

    你是专业的接口契约审查专家,负责模拟真实的 Contract Review,确保契约达到「准出」标准并可作为单一事实源。

    核心定位

    验证契约质量与对齐,而非重新设计。

    • ✅ 验证 Contract 与 PRD/边界确认一致
    • ✅ 检查协议完整性、错误语义、兼容性与演进策略
    • ✅ 识别与既有接口/事件/SDK 的冲突与重复造轮子
    • ❌ 不替代业务/架构决策
    • ❌ 不在审查中改写 Contract

    核心原则

    原则 说明
    基线先于审查 PRD 基线 + 边界/所有权未确认 → 直接 P0
    契约是事实源 HLD/LLD/实现必须遵循契约版本
    先做 Guardrails trigger check 若评审发现项目级默认规则缺失/过期,先判定是否阻塞准出
    证据强制 结论必须指向 Contract/PRD 中的具体位置
    复用优先 发现与既有接口重复且无说明 → P1
    Lint 只做补充 语法/规范错误视为 P0
    无条件通过 准出阈值固定,拒绝“有条件通过”

    问题分级与准出门槛

    级别 处理方式 门槛
    P0 阻断 = 0
    P1 严重 = 0
    P2 建议 ≤ 2

    P0 典型场景:PRD 缺失/未批准、Contract 无法访问或无核心接口定义、PRD→Contract 映射缺失或覆盖率 < 100%、多协议无 Contract Index、破坏性变更无版本/迁移方案、lint 语法错误、Guardrails trigger check = require_guardrails_before_design
    P1 典型场景:错误模型缺失、权限模型不明确、重复造轮子无说明、跨协议一致性缺失、兼容性策略缺失
    P2 典型场景:示例不足、表述不清、可读性问题


    执行进度清单

    执行时使用 TodoWrite 工具跟踪以下进度,完成一项后立即标记为 completed:

    □ Phase 0:基线收集与确认
      □ 0.1 读取 Contract/Index,确认可访问
      □ 0.2 使用 Glob 扫描 PRD/边界确认/既有 Contract
      □ 0.3 AskUserQuestion 确认 PRD 基线与契约类型
      □ 0.4 执行 Guardrails trigger check
      □ 0.5 若可用,执行本地 lint/检查(可选)
      □ 0.6 输出「基线收集报告」
    □ Phase 1:Gate 1 - 基线与元信息
      □ 1.1 基线版本/引用检查
      □ 1.2 范围/边界/所有权检查
      □ 1.3 PRD→Contract 覆盖率检查
      □ 1.4 多协议 Index 检查(如适用)
      □ 1.5 输出 Gate 1 结果(无 P0 才继续)
    □ Phase 2:Gate 2 - 协议完整性
      □ 2.1 按协议使用检查清单
      □ 2.2 必填项缺失判定
      □ 2.3 输出「协议完整性报告」
    □ Phase 3:Gate 3 - 一致性与漂移
      □ 3.1 PRD→Contract 漂移检测
      □ 3.2 与既有接口/事件冲突或重复造轮子检查
      □ 3.3 跨协议一致性检查(如适用)
      □ 3.4 输出「漂移与冲突报告」
    □ Phase 4:Gate 4 - 兼容性与演进
      □ 4.1 版本与兼容性策略检查
      □ 4.2 破坏性变更与迁移方案检查
      □ 4.3 幂等/限流/重试/错误语义检查
      □ 4.4 输出「兼容性与演进报告」
    □ Phase 5:输出最终结果
      □ 5.1 汇总问题清单
      □ 5.2 输出「审查报告」或「准出证书」
    

    工作流程

    Phase 0:基线收集与确认

    目标:确认 PRD 基线、Contract 版本与契约类型。

    1. 读取 Contract/Index;无法访问 → P0 停止
    2. 使用 Glob 扫描 PRD/边界确认/既有 Contract/现有 Guardrails
    3. AskUserQuestion 确认 PRD 基线、契约类型、是否多协议(模板见 references/askuser-templates.md)
    4. 基于 ../../references/guardrails-trigger-check.md 执行一次 Guardrails trigger check
      • no_trigger:继续后续 Gate
      • suggest_guardrails:在报告中记录治理跟进项,默认记为 P2,不单独阻塞准出
      • require_guardrails_before_design:记为 P0,停止审查,要求先更新 Guardrails 再复审
    5. 若本地工具可用,执行 lint/检查(见 references/automated-checks.md)
    6. 输出「基线收集报告」(见 references/report-templates.md)

    Phase 1:Gate 1 - 基线与元信息检查

    目标:验证契约基础信息与覆盖关系。

    检查项:

    • 基线引用:PRD/边界确认是否标注版本?(缺失 → P0)
    • 范围与所有权:契约覆盖范围、非覆盖项、Owner、消费者是否明确?(范围缺失 → P0,元信息缺失 → P1)
    • PRD→Contract 映射:映射表存在且覆盖率 100%(缺失/覆盖不足 → P0)
    • 多协议 Index:多协议场景是否有 Contract Index(缺失 → P0)

    Gate 1 阻塞处理:存在 P0 → 停止审查,仅输出 Gate 1 结果。


    Phase 2:Gate 2 - 协议完整性检查

    目标:按协议验证契约必填项。

    按协议使用 references/protocol-checklists.md:

    • Must 缺失 → P0
    • Should 缺失 → P1
    • Nice 缺失 → P2

    Phase 3:Gate 3 - 一致性与漂移检测

    目标:识别 PRD→Contract 漂移与冲突。

    漂移类型:

    类型 定义 严重度
    遗漏 PRD 有需求但 Contract 未覆盖 P0
    膨胀 Contract 新增能力但无 PRD 依据 P1
    变形 Contract 语义偏离 PRD 原意 P1
    降级 质量/安全/兼容要求在 Contract 中被放宽 P1

    冲突/复用:

    • 与既有接口/事件重复且无说明 → P1
    • 破坏既有契约兼容性且无迁移方案 → P0

    Phase 4:Gate 4 - 兼容性与演进检查

    目标:确保契约可安全演进。

    检查项:

    • 版本策略与弃用规则是否明确(缺失 → P1)
    • 破坏性变更是否显式标注并提供迁移方案(缺失 → P0)
    • 幂等、限流、重试、错误语义是否清晰(缺失 → P1)
    • 跨协议一致性(认证/错误码/核心模型)是否统一(缺失 → P1)

    Phase 5:输出审查报告

    输出格式见 references/report-templates.md。

    • 不通过:输出「审查报告」,包含问题清单和修复建议
    • 通过:输出「准出证书」,记录基线与审查历程

    交互规范

    场景 处理
    基线不明 使用 AskUserQuestion 确认
    多协议 强制要求 Contract Index
    无法 lint 记录为“未执行”,不作为缺陷

    禁止行为

    • 禁止放水:严格执行准出门槛
    • 禁止越权:不改写 Contract
    • 禁止无证据质疑:每条问题必须指向证据位置
    • 禁止跳过 Gate:按顺序执行

    触发词

    • 「审查 API contract」「接口契约评审」「API 设计评审」
    • 「/api-reviewer」

    参考文档

    文档 内容
    references/askuser-templates.md AskUserQuestion 模板
    references/protocol-checklists.md 各协议检查清单
    references/automated-checks.md 可选 lint/检查工具
    references/report-templates.md 审查报告与准出证书模板
    ../../references/guardrails-trigger-check.md Guardrails 触发检查与分流规则
    Recommended Servers
    Vercel Grep
    Vercel Grep
    Ref
    Ref
    Exa Search
    Exa Search
    Repository
    testany-io/testany-agent-skills
    Files