Skip to main content
Glama

get_btc_account_balance

Read-onlyIdempotent

Aggregate on-chain balances from all used addresses for a Ledger Bitcoin account index. Returns confirmed, mempool, and total sats/BTC with per-address breakdown.

Instructions

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).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountIndexYesLedger 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 scan time) for this accountIndex, sums their on-chain balances, and surfaces the per-address breakdown so the agent can show which legs hold the funds. Empty cached addresses are skipped to keep the response tight; if you suspect the cache is stale, call `rescan_btc_account` (indexer-only, no Ledger needed).
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already set readOnlyHint=true, but description adds detailed behavior: walks pairing cache, fans out to indexer, skips empty cache entries, returns per-address breakdown. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Single paragraph front-loaded with 'READ-ONLY'. Dense but efficient, every sentence adds value. No redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Covers purpose, caching mechanism, output details, dependencies, and troubleshooting. For a tool with one parameter and no output schema, this is complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with a detailed parameter description. The tool description reinforces the parameter meaning with additional context about cache staleness and pairing, but the schema already explains it well.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool sums on-chain balance for a Ledger Bitcoin account index using cached addresses. It distinguishes from siblings like rescan_btc_account and pair_ledger_btc by specifying when to use them instead.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit guidance: call rescan_btc_account if cache is stale, only re-pair when funds may have landed past the gap window. Also notes 'pure indexer fetch, no Ledger needed' indicating safe usage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/szhygulin/vaultpilot-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server