Cancel an apply
cancel_applyStops a running background apply: no further steps start and its Shopify bulk operations are cancelled, while already written data stays intact. Use it to halt an apply or clean up after a server restart.
Instructions
Stop an apply that is running in the background: no further step is started and the Shopify bulk operations it started are cancelled. What was already written stays written (nothing is rolled back or deleted). Also stops bulk operations left running by an apply whose server was restarted. If the apply has already ended, nothing is cancelled and its final state is returned. Returns { plan_id, state (cancelling, or interrupted for an apply from before a restart), note }. Follow with apply_status, then plan_sync to see what is left.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "cancel_apply"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| plan_id | No | The plan being applied. Default: the most recent apply. |