Documentation
export_ledger
export_ledger MCP tool reference, parameters, return type, and safety hints.
What it does
Exports ledger in the local Clovis ledger.
(output_path?: string | null, entity_id?: string | null, date_from?: string | null, date_to?: string | null, account_ids?: string[] | null) => Record<string, unknown>Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.
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.
Confirm the file path, permissions, and whether the agent is allowed to read or write that location.
Parameters
Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.
output_pathoptionalLocal output path for a generated file or backup.
Default: nullentity_idoptionalEntity id to filter reports when entity tracking is used.
Default: nulldate_fromoptionalStart date filter in YYYY-MM-DD format.
Default: nulldate_tooptionalEnd date filter in YYYY-MM-DD format.
Default: nullaccount_idsoptionalList of ledger account ids or account references.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
export_ledger
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "export_ledger",
"arguments": {}
}