Documentation
buy_security
buy_security MCP tool reference, parameters, return type, and safety hints.
What it does
Records security in the local Clovis ledger.
(account_id: string, symbol: string, shares: number, total_cost_cents: number, date: string, commission_cents?: number, status?: string, asset_id?: 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: account_id, symbol, shares, total_cost_cents, 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.
account_idrequiredLedger account id or resolvable account reference.
symbolrequiredInput used by this tool.
sharesrequiredNumeric value used by this workflow.
total_cost_centsrequiredNumeric value used by this workflow.
daterequiredLedger date in YYYY-MM-DD format.
commission_centsoptionalNumeric value used by this workflow.
Default: 0statusoptionalTransaction status filter or value: posted, pending, planned, or void.
Default: "posted"asset_idoptionalAsset or currency id used by the ledger.
Default: nullAgent call shape
Use the exact tool name and pass arguments as structured JSON through the MCP client.
buy_security
Copy this shape into agent instructions, evals, or MCP client tests.
{
"tool": "buy_security",
"arguments": {
"account_id": "<account_id>",
"symbol": "<symbol>",
"shares": 1,
"total_cost_cents": 1,
"date": "2026-06-01"
}
}