Documentation

export_transactions

export_transactions MCP tool reference, parameters, return type, and safety hints.

npm

What it does

Exports transactions in the local Clovis ledger.

Signature(account_id?: string | null, date_from?: string | null, date_to?: string | null, status?: string | null, output_path?: string | null) => Record<string, unknown>
read-only

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.

Use it when an agent needs to inspect the ledger or answer a question without changing records.
Use it when working with accounts, transactions, balances, registers, or double-entry records.
Use it only for local files the user has intentionally made available to Clovis.

Before calling

Agents should gather these facts or confirmations first.

1

No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.

2

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.

account_idoptional
string | null

Ledger account id or resolvable account reference.

Default: null
date_fromoptional
string | null

Start date filter in YYYY-MM-DD format.

Default: null
date_tooptional
string | null

End date filter in YYYY-MM-DD format.

Default: null
statusoptional
string | null

Transaction status filter or value: posted, pending, planned, or void.

Default: null
output_pathoptional
string | null

Local output path for a generated file or backup.

Default: null

Agent call shape

Use the exact tool name and pass arguments as structured JSON through the MCP client.

export_transactions

Copy this shape into agent instructions, evals, or MCP client tests.

{
  "tool": "export_transactions",
  "arguments": {}
}

Metadata