Skip to main content
Glama
chia-mcp

chia-mcp

Official
by Chia-Network

get_address_summary

Read-only

Get an XCH balance summary for a Chia address or puzzle hash, paging unspent coin records and returning a flag when results are incomplete.

Instructions

Get a complete balance summary for a Chia address (xch1.../txch1...) or puzzle hash (0x...). Pages through unspent coin records using automatic height-windowed pagination (scanning from peak downward) to produce a total with a complete flag indicating whether all coins were reached. A single get_coin_records_by_puzzle_hash call may return at most 50,000 records (the Coinset per-request cap). Returns: total_mojos, total_xch (string), unspent_coin_count, pages_scanned, excludes (always [CAT, NFT, DID] — this tool counts XCH only), and a complete flag (true when all coins were enumerated; false if pagination was cut short — the result is a lower bound, not the full balance). ⚠️ Addresses with 50k+ coins (e.g. active farming addresses) may return complete: false with incomplete_reason: 'time_budget_exceeded' or 'early_exit_sparse' — the total_mojos is a lower bound, not the true balance. For full enumeration of large farming addresses, use get_coin_records_by_puzzle_hash with explicit start_height/end_height windows to page through the full history. Also returns a network-mismatch warning if the address prefix doesn't match the configured network. Use this tool for balance lookups — do NOT sum raw coin record results.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "address": "<address>"
    },
    "name": "get_address_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
addressYesA Chia address (xch1.../txch1...) or puzzle hash (0x-prefixed 64-char hex). Addresses are auto-decoded.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.2

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only supply readOnlyHint, and the description carries the rest: height-windowed downward pagination, the 50,000-record per-request Coinset cap, the semantics of the complete flag, the CAT/NFT/DID exclusion, and the network-mismatch warning. It also discloses the crucial failure modes (time_budget_exceeded, early_exit_sparse) where the total is a lower bound rather than a real balance.

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

Conciseness4/5

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

Front-loaded with the purpose, then pagination mechanics, then return fields, then the caveat — a sensible ordering. It loses a little to redundancy: the 'lower bound, not the full balance' warning is stated in the Returns parenthetical and then repeated verbatim in the warning block.

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?

There is no output schema, and the description compensates by enumerating the return fields (total_mojos, total_xch, unspent_coin_count, pages_scanned, excludes, complete) and explaining what complete: false implies. For a one-parameter read tool with real pagination edge cases, nothing an agent needs is missing.

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

Parameters3/5

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

Schema coverage is 100% for the single address parameter, and the description's mention of xch1/txch1 and 0x-prefixed puzzle hash largely restates the schema's own wording. The only added meaning is indirect — that the prefix is checked against the configured network — so the baseline 3 applies.

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?

States a specific verb and resource ('Get a complete balance summary for a Chia address ... or puzzle hash') and explicitly separates itself from the coin-record sibling by directing full enumeration to get_coin_records_by_puzzle_hash. An agent can pick between the two without opening either schema.

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?

Gives an explicit positive rule ('Use this tool for balance lookups'), an explicit prohibition ('do NOT sum raw coin record results'), and a named alternative with the exact condition that selects it (large 50k+ farming addresses → get_coin_records_by_puzzle_hash with start_height/end_height windows).

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