Skip to main content
Glama
Sign In
NimBooks

NimBooks

by subimpact
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Check whether a request was paid

check_request_paid
Read-onlyIdempotent

Checks an address's latest transactions for a payment tagged with a request's reference to confirm whether that invoice has been paid, reporting the on-chain result without changing anything.

Instructions

Looks for a payment tagged with a request’s reference (nimbooks:invoice:) in the address’s transactions — the same match the NimBooks app uses to mark a request paid. Read-only: it reports what the chain says and changes nothing, here or in the app. Scans the newest 200 transactions.

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": {
      "id": "<id>"
    },
    "name": "check_request_paid"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesThe request id, as returned by create_payment_request.
addressNoThe payee address the request was made for. Optional; defaults to the server’s configured address.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description reinforces this without merely repeating it ('reports what the chain says and changes nothing, here or in the app'). The genuinely valuable addition is the disclosure that it scans only the newest 200 transactions, which tells the agent a negative result is not proof of non-payment. It stops short of describing the response shape, which matters since no output schema exists.

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?

Three tight sentences, front-loaded with the matching mechanism, followed by the safety profile and the scan limit. Every sentence carries distinct information with no repetition of the title or annotations.

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?

For a two-parameter read-only lookup with full annotation coverage, the description covers mechanism, safety, and the main accuracy caveat. The notable gap is the return value: with no output schema, an agent cannot tell whether it gets a boolean, a matching transaction, or a confirmation count.

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; the description earns a bump because it explains how the id parameter is actually used — transformed into the nimbooks:invoice:<id> reference tag that the search keys on — which the schema alone does not convey. The address parameter's default behavior is left entirely to the schema.

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 ('looks for a payment tagged with a request's reference') and names the exact tag format (nimbooks:invoice:<id>), so the agent knows precisely what matching logic runs. It also implicitly distinguishes itself from create_payment_request by consuming that tool's id, and from generic listing tools like list_transactions by being a targeted lookup.

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

Usage Guidelines4/5

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

It gives clear context for when this is the right call (verifying whether a payment request has been settled, using the app's own matching rule) but never states exclusions or names the alternative to use when the payment is older than the scanned window — e.g. falling back to list_transactions or get_statement.

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