Skip to main content
Glama

Get invoice status

get_invoice
Read-onlyIdempotent

Check whether an invoice you created is still pending or already paid. Pass the publicId or /r/ url from create_invoice. Use this before taking a follow-up action that should only run after payment. Only works for invoices owned by this spend key’s owner. Related: create_invoice, list_invoices.

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_invoice"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoInvoice URL from create_invoice.
publicIdNoInvoice publicId from create_invoice.

Output Schema

NameRequiredDescriptionDefault
okYes
paidNo
amountNo
statusNo
messageNo
publicIdNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already cover read-only, idempotent, non-destructive, and closed-world behavior, so the bar is lower. The description adds one genuinely useful constraint - 'Only works for invoices owned by this spend key's owner' - but says nothing about failure modes for unowned invoices or rate/expiry behavior.

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?

Four short sentences, front-loaded with purpose and immediately followed by the input source, the usage trigger, and the ownership constraint. Nothing is redundant with the title or annotation fields.

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?

An output schema exists, so return values need no explanation, and annotations carry the safety profile. For a two-parameter, optional-input read tool, the description covers purpose, input provenance, timing, and the ownership limitation without gaps.

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 adds modest value by naming create_invoice as the origin of both values and specifying the '/r/ url' form. The either/or requirement is already in the schema description, so it does not add further meaning.

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 ('Check whether an invoice ... is still pending or already paid') with the exact status scope. Sibling differentiation is only implicit via a 'Related:' list of names with no behavioral contrast, so it falls short of a 5.

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?

Gives clear when-to-use context: 'Use this before taking a follow-up action that should only run after payment,' which tells the agent this is a gating check. It also names the prerequisite source of the ID (create_invoice), but offers no explicit when-not guidance or named alternative for other invoice queries.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources