Slash command
API contract
Finds the changes in a diff that break somebody else's code, including the ones that still compile.
About
Finds the changes in a diff that break somebody else's code, including the ones that still compile.
Files in v1.0.0
- replicamd.plugin.json2396 B
- skills/changing-a-public-surface.md2191 B
Contributes
{
"commands": [
{
"id": "breaking",
"title": "Find breaking changes in the diff",
"prompt": "Read the working diff and find everything in it that could break a caller you cannot see.\n\nStart by working out what this project's public surface actually is: exported symbols and the package entry points for a library, routes and payload shapes for a service, flags and output format for a CLI, the schema for anything with a database. Say what you decided, because the rest depends on it.\n\nThen look for the breaks, including the quiet ones that still typecheck:\n- removed or renamed exports, endpoints, flags, columns\n- a parameter that became required, or narrowed its accepted type\n- a return shape that lost a field, or changed the type of one\n- a default that changed value\n- an error that is now thrown where none was, or a thrown error replaced by a null return\n- output a script might parse: log lines, exit codes, JSON key order where it is relied on\n- a timing or ordering guarantee that no longer holds\n\nFor each, name who breaks and how it shows up for them. Then say whether this needs a major version, a deprecation period, or nothing - and if the change can be made additive instead, say what that would look like."
},
{
"id": "deprecate",
"title": "Plan a deprecation instead of a break",
"prompt": "I want to change or remove part of the public surface without breaking callers overnight. Ask me which part, then write the plan.\n\nKeep the old thing working while the new one exists beside it. Say what warns, where the warning appears, and what it tells the caller to do instead - a deprecation notice with no migration instruction is just noise.\n\nGive the removal a condition rather than a date where you can: the next major, or once telemetry shows nobody calls it. Name what has to be true before the old path can go, and what proves it."
}
],
"skills": [
"skills/changing-a-public-surface.md"
]
}Versions
- v1.0.07/26/2026 · 2 files
Install
Install in ReplicaMDNothing happened? ReplicaMD may not be installed yet - or open it first, then Settings → Plugins and install by id.
Plugin id:
api-contractBundle endpoint:
https://replicamd.nl/api/registry/plugins/api-contract/download- Author
- Ardjun Debi - Tewarie @ardjun
- Latest
- v1.0.0
- License
- MIT
- Installs
- 0
apireviewcompatibilityrelease