Documentation
import_file
import_file MCP tool reference, parameters, return type, and safety hints.
What it does
Imports a statement file into an account while preserving review-oriented metadata.
(file_path: string, account_id: string, counterpart_account_id: string, currency?: string | null, asset_id?: string | null, date_col?: string | null, amount_col?: string | null, desc_col?: string | null, inflow_col?: string | null, outflow_col?: string | null, counterpart_col?: string | null, tag_cols?: Record<string, unknown> | null, skip_rows?: number, skip_footer_rows?: number, date_format?: string, status?: string, amount_convention?: string, show_duplicates?: boolean, statement_type?: 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: file_path, account_id, counterpart_account_id.
Confirm the file path, permissions, and whether the agent is allowed to read or write that location.
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.
file_pathrequiredLocal file path made available to Clovis.
account_idrequiredLedger account id or resolvable account reference.
counterpart_account_idrequiredOffsetting account used for imported rows or generated transactions.
currencyoptionalCurrency symbol when the file or workflow needs an explicit currency.
Default: nullasset_idoptionalAsset or currency id used by the ledger.
Default: nulldate_coloptionalStatement column containing transaction dates.
Default: nullamount_coloptionalStatement column containing signed amounts.
Default: nulldesc_coloptionalStatement column containing merchant or transaction descriptions.
Default: nullinflow_coloptionalStatement column containing incoming amounts.
Default: nulloutflow_coloptionalStatement column containing outgoing amounts.
Default: nullcounterpart_coloptionalStatement column that maps rows to counterpart accounts.
Default: nulltag_colsoptionalMapping of statement columns to tags.
Default: nullskip_rowsoptionalNumber of header rows to ignore at the start of a statement file.
Default: 0skip_footer_rowsoptionalNumber of footer rows to ignore at the end of a statement file.
Default: 0date_formatoptionalStatement date parser format, or auto for automatic parsing.
Default: "auto"statusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "pending"amount_conventionoptionalHow statement amounts should be interpreted, such as signed or inflow/outflow.
Default: "signed"show_duplicatesoptionalBoolean switch for this workflow.
Default: falsestatement_typeoptionalOptional statement type hint, such as checking, credit card, or brokerage.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
import_file
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "import_file",
"arguments": {
"file_path": "./statement.csv",
"account_id": "<account_id>",
"counterpart_account_id": "<counterpart_account_id>"
}
}