api-contract-reviewer

Detect breaking changes in public API surfaces and output migration guidance.

11|1|Updated Mar 3, 2026
One-click install
npx skills add https://github.com/ylxmf2005/AgentCorp --skill api-contract-reviewer-ylxmf2005
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-contract-reviewer
Source: https://github.com/ylxmf2005/AgentCorp/tree/main/agentcorp/api-contract-reviewer
Command: npx skills add https://github.com/ylxmf2005/AgentCorp --skill api-contract-reviewer-ylxmf2005

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Judges whether changes to a public or shared API silently break existing consumers, acting as a proxy for callers to ensure compatibility across surfaces.

Core Features & Use Cases

  • Assess consumer-facing surfaces: routes, JSON-RPC/A2A methods, CLI surfaces, schemas, exported types, status codes, error shapes, and auth contracts.
  • Flag breaking changes and provide guidance on migration paths or compatibility constraints.
  • Enforce compliance with policy that non-migration changes require explicit versioning and deprecation strategies.

Quick Start

Submit the diff or change set to the reviewer to begin an assessment of consumer-facing surface compatibility.

Frequently Asked Questions about api-contract-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check if API changes break existing consumers?

You can check if API changes break existing consumers by submitting the diff to evaluate surface stability across routes, schemas, and exported types. The review flags incompatible modifications and outputs findings with recommended migration paths.

What is an API contract review and when do I need it?

An API contract review identifies whether changes to a public API silently break existing consumers. You need it when modifying routes, JSON-RPC methods, CLI surfaces, schemas, exported types, status codes, error shapes, or auth contracts across module boundaries.

How do I assess breaking changes in JSON-RPC methods and schemas?

To assess breaking changes in JSON-RPC methods and schemas, provide the change set for evaluation. The review checks consumer-facing surfaces and flags incompatible modifications, enforcing compliance with versioning and deprecation strategies.

Does this API compatibility check cover CLI surfaces and auth contracts?

Yes, this API compatibility check covers CLI surfaces and auth contracts. It evaluates consumer-facing surfaces including routes, exported types, status codes, and error shapes across module boundaries to ensure non-migration changes require explicit versioning.

What is the best way to enforce API versioning and deprecation strategies?

The best way to enforce API versioning and deprecation strategies is to review diffs for consumer-facing surface compatibility. This ensures non-migration changes require explicit versioning and provides recommended migrations with confidence levels for breaking changes.

What happens when an API change is detected as breaking?

When an API change is detected as breaking, the review evaluates surface stability without migration paths and flags the incompatible modifications. It then outputs findings with recommended migrations and confidence levels to guide consumer updates.