Documentation
plan_transaction
plan_transaction MCP tool reference, parameters, return type, and safety hints.
What it does
Plans transaction in the local Clovis ledger.
(date: string, amount: number, from_account_id: string, to_account_id: string, description: string, branch?: string | null, dry_run?: boolean) => Record<string, unknown>Can write, but supports dry-run. Ask the agent to preview the result before committing changes.
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.
Have exact values for required inputs: date, amount, from_account_id, to_account_id, description.
Start with dry_run=true, show the preview, then ask before applying the change.
State the intended ledger change in plain language before calling the tool.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
daterequiredLedger date in YYYY-MM-DD format.
amountrequiredMoney or quantity amount in the selected asset.
from_account_idrequiredSource account id for a transaction or transfer.
to_account_idrequiredDestination account id for a transaction or transfer.
descriptionrequiredHuman-readable transaction, account, rule, or journal description.
branchoptionalScenario branch name or id.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
plan_transaction
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "plan_transaction",
"arguments": {
"date": "2026-06-01",
"amount": 100,
"from_account_id": "<from_account_id>",
"to_account_id": "<to_account_id>",
"description": "<description>"
}
}