Skip to main content
Glama
Sign In
NimBooks

NimBooks

by subimpact
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Account summary

get_summary
Read-onlyIdempotent

Summarize a Nimiq address’s current balance and money in/out over a chosen date window, with staking and internal transfers reported separately. Read-only; never signs or sends.

Instructions

Balance and money in/out for a Nimiq address over a window. Read-only: never signs, never sends. Defaults to the full history the public index returns (up to 1000 transactions, newest first). Balance is the live account balance now, not the balance at the end of the window; any staked NIM is reported separately because it lives in the staking contract. Money out includes transfers into the staking contract and out of it — the same treatment as the app’s statement; validator rewards arrive through a separate channel and are reported as their own line (rewardsReceivedNim). Nimiq Pay’s round trips through its own contracts are the wallet’s own money and are reported as internalIn/internalOut, not as money in or out, the same split the app makes; netNim counts both.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_summary"
  }
}

Input Schema

NameRequiredDescriptionDefault
sinceNoStart of the window, YYYY-MM-DD or ISO 8601 (UTC). Default: no start.
untilNoEnd of the window, YYYY-MM-DD or ISO 8601 (UTC). Default: now.
addressNoNimiq address — "NQ82 6GYU …", the flat form, or 40 hex characters. Optional; defaults to the server’s configured address.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.3.0
    • changedInput schema / properties / address / description
      Previous value: -"Nimiq address — \"NQ43 Y1RH …\", the flat form, or 40 hex characters. Optional; defaults to the server’s configured address."New value: +"Nimiq address — \"NQ82 6GYU …\", the flat form, or 40 hex characters. Optional; defaults to the server’s configured address."
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description still adds real context: the 1000-transaction cap, newest-first ordering, live vs. window-end balance semantics, staked NIM living in a separate contract, and how staking transfers and internal round trips are classified. These are non-obvious behaviors an agent could not infer from the schema or annotations.

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 purpose and the read-only guarantee before diving into accounting semantics. The internal-transfer sentence is dense and hard to parse, and repeats 'the same treatment as the app' phrasing twice, but nearly every sentence carries information an agent needs.

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

Completeness4/5

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

With no output schema, the description carries the burden of explaining returns and does so for rewardsReceivedNim, internalIn/internalOut, and netNim, plus the transaction cap. It stops short of enumerating the full response shape or confirming whether a transaction list is included alongside the aggregates.

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%, so the baseline is 3, but the description adds meaning the schema does not: the window constrains money in/out but explicitly does not affect the reported balance, and the default window is full indexed history. Address and date formats are left entirely to the schema.

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

Purpose4/5

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

States a specific verb and resource: balance plus money in/out for a Nimiq address over a window. It is clearly distinguishable from mutation tools like draft_stake or create_payment_request, but it never explicitly names get_statement or list_transactions, which are the closest read-side alternatives.

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

Usage Guidelines3/5

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

Usage is only implied: it explains that the window defaults to full history and that balance is live rather than window-end. There is no explicit statement of when to prefer this over get_statement or list_transactions, and no exclusion conditions.

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

Deploy Server

Other Tools