Documentation
fx_transfer
fx_transfer MCP tool reference, parameters, return type, and safety hints.
What it does
Runs foreign exchange transfer in the local Clovis ledger.
(from_account_id: string, to_account_id: string, from_amount: number, to_amount: number, from_asset_id: string, to_asset_id: string, fx_account_id: string, date: string, description: string, status?: string, record_rate?: boolean, 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: from_account_id, to_account_id, from_amount, to_amount, from_asset_id, to_asset_id, fx_account_id, date, ....
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.
from_account_idrequiredSource account id for a transaction or transfer.
to_account_idrequiredDestination account id for a transaction or transfer.
from_amountrequiredMoney or quantity value in the relevant asset.
to_amountrequiredMoney or quantity value in the relevant asset.
from_asset_idrequiredIdentifier from the local Clovis ledger.
to_asset_idrequiredIdentifier from the local Clovis ledger.
fx_account_idrequiredIdentifier from the local Clovis ledger.
daterequiredLedger date in YYYY-MM-DD format.
descriptionrequiredHuman-readable transaction, account, rule, or journal description.
statusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "posted"record_rateoptionalBoolean switch for this workflow.
Default: trueAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
fx_transfer
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "fx_transfer",
"arguments": {
"from_account_id": "<from_account_id>",
"to_account_id": "<to_account_id>",
"from_amount": 100,
"to_amount": 100,
"from_asset_id": "USD",
"to_asset_id": "USD",
"fx_account_id": "<fx_account_id>",
"date": "2026-06-01",
"description": "<description>"
}
}