Documentation
discard_batch
discard_batch MCP tool reference, parameters, return type, and safety hints.
What it does
Discards batch in the local Clovis ledger.
(tx_ids?: string[] | null, batch_id?: string | null, date_from?: string | null, date_to?: string | null, account_id?: string | null, dry_run?: boolean) => Record<string, unknown>Destructive. This can remove, void, discard, roll back, repair, or permanently change ledger data. Require explicit user approval.
When to use it
Use this section to decide whether the tool fits the user request before calling it.
Before calling
Agents should gather these facts or confirmations first.
No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.
Start with dry_run=true, show the preview, then ask before applying the change.
Create or confirm a backup and get explicit approval before running it for real.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
tx_idsoptionalList of transaction ids.
Default: nullbatch_idoptionalImport, commit, or mutation batch id.
Default: nulldate_fromoptionalStart date filter in YYYY-MM-DD format.
Default: nulldate_tooptionalEnd date filter in YYYY-MM-DD format.
Default: nullaccount_idoptionalLedger account id or resolvable account reference.
Default: nulldry_runoptionalPreview the result without committing changes.
Default: trueAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
discard_batch
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "discard_batch",
"arguments": {
"dry_run": true
}
}