Skip to main content
Glama

Check an invoice

check_invoice
Read-only

Verify whether a crypto invoice has been paid and return the payment transaction details if payment exists.

Instructions

Check whether an invoice has been paid, with the payment transaction(s) if it has.

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": {
      "requestId": "<requestId>"
    },
    "name": "check_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
requestIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

The readOnlyHint annotation already establishes this is a safe read, so the description only needs to add context. It does disclose the shape of the answer (paid flag plus transactions if paid), but says nothing about what happens when the invoice is unknown, unpaid, or pending, nor about external lookup costs implied by openWorldHint.

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?

A single tightly written sentence that front-loads the core behavior and appends the conditional return detail. No filler or redundant restatement of the title.

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

Completeness3/5

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

For a one-parameter read tool with no output schema, the description adequately covers the return intent but leaves the sole input's meaning entirely undocumented. An agent may know what to expect back but not confidently what to pass in.

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

Parameters2/5

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

Schema description coverage is 0% for the single parameter, so the description must carry the burden of explaining it. It never clarifies that 'requestId' is an invoice identifier, nor explains the hex pattern or accepted forms, leaving the agent to guess how the input relates to the invoice being checked.

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 ('check') and resource ('invoice') and adds what the result contains: paid status plus payment transaction(s) when paid. It is distinguishable from create_invoice and list_invoices by its single-invoice status focus, though it never names a sibling explicitly.

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

Usage Guidelines2/5

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

There is no explicit when-to-use or when-not-to-use guidance and no routing toward alternatives such as get_payment_transactions or list_invoices. The overlap between 'with the payment transaction(s)' and get_payment_transactions is left for the agent to resolve on its own.

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