| name | contract-check |
| description | Detect interface-contract drift between @pipelex/sdk's client surface and the wire specs it implements (defaults to comparing against the last release tag, but the user can specify any tag or commit). Compares the PipelexApiClient request/response shapes against the protocol and validation specs in ../docs/specs/. Use when the user says "check the contract", "contract review", "contract check", "did we break the contract", "check interfaces", "API contract", "protocol drift", "compare to vX.Y.Z", or before shipping/releasing a version that touches the client wire surface. Also trigger automatically before the /release skill runs. |
Contract Check
Detects discrepancies between the wire surface @pipelex/sdk implements and the specs that document it. The SDK's PipelexApiClient is a client of the Pipelex hosted API: it re-implements the official MTHDS protocol routes (execute / start / validate / models / version) using mthds/protocol types, and adds the Pipelex-product routes (methods catalog, organizations, billing, API keys, storage, onboarding). A discrepancy means the code and the spec disagree — but this skill does NOT presume which side is wrong. The code may need fixing, the spec may need updating, or both. That judgment belongs to the human reviewing the report.
Prerequisites: Locate the Specs
The specs live at ../docs/specs/ (relative to this repo root, i.e. the sibling workspace-root docs directory). Before doing anything else:
- Check that the directory
../docs/specs/ exists.
- Check that it contains
pipelex-mthds-protocol.md and pipelex-validation-api.md.
If the directory is missing or does not contain the expected spec files, stop immediately and tell the user the specs directory was not found and they need access to the workspace-root /.
