get_btc_account_balance

READ-ONLY — sum the on-chain balance across every cached USED address (txCount > 0 at last scan) for one Ledger Bitcoin account index. Walks the pairing cache populated by pair_ledger_btc's BIP44 gap-limit scan, fans out to the indexer for live balances, and returns both the rolled-up totals (con...

Server VaultPilot MCP vaultpilot-mcp
Category Read
Risk class Low
Parameters 11 required

What get_btc_account_balance does on VaultPilot MCP

AI agents call get_btc_account_balance to retrieve information from VaultPilot MCP without modifying anything — typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.

ParameterTypeRequiredDescription
accountIndex integer Yes Ledger Bitcoin account slot to aggregate. Must have been paired via `pair_ledger_btc` first — the tool fans out across every cached USED address (txCount > 0 at

Parameters from the server's own tool schema.

Why get_btc_account_balance needs a policy

Even though get_btc_account_balance only reads data, uncontrolled read access leaks sensitive information and racks up API costs — an agent caught in a retry loop can make thousands of calls a minute without anyone noticing.

Risk signalsBulk/mass operation — affects multiple targets

Questions about get_btc_account_balance

What does the get_btc_account_balance tool do? +

READ-ONLY — sum the on-chain balance across every cached USED address (txCount > 0 at last scan) for one Ledger Bitcoin account index. Walks the pairing cache populated by pair_ledger_btc's BIP44 gap-limit scan, fans out to the indexer for live balances, and returns both the rolled-up totals (confirmed + mempool + total sats / BTC) and a per-address breakdown including type, BIP-32 chain (0=receive, 1=change), and addressIndex. Skips empty cached entries (the trailing fresh-receive addresses) to keep fan-out tight. If the cache is stale (recent receive on a previously-empty cached address), call rescan_btc_account to refresh — pure indexer fetch, no Ledger needed. Only re-run pair_ledger_btc when funds may have landed PAST the originally-walked gap window (the rescan flags that case via needsExtend: true). It is categorised as a Read tool in the VaultPilot MCP MCP Server, which means it retrieves data without modifying state.

What parameters does get_btc_account_balance accept? +

get_btc_account_balance accepts 1 parameter: accountIndex. Required: accountIndex. The full parameter table on this page comes from the server's own tool schema.

How do I enforce a policy on get_btc_account_balance? +

Register the VaultPilot MCP server in PolicyLayer and add a rule for get_btc_account_balance: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches VaultPilot MCP. Nothing to install.

What risk level is get_btc_account_balance? +

get_btc_account_balance is a Read tool with low risk. Read-only tools are generally safe to allow by default.

Can I rate-limit get_btc_account_balance? +

Yes. Add a rate_limit block to the get_btc_account_balance rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.

How do I block get_btc_account_balance completely? +

Set action: deny in the PolicyLayer policy for get_btc_account_balance. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.

What MCP server provides get_btc_account_balance? +

get_btc_account_balance is provided by the VaultPilot MCP server (vaultpilot-mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.

// GET IN TOUCH

Have a question or want to learn more? Send us a message.

Message sent.

We'll get back to you soon.