Skip to main content
Glama

Get Invoice Payment Status Tool

get-invoice-payment-status
Read-only

Returns the authoritative payment state for one authorized invoice without exposing payment links or provider identifiers. Use to get invoice payment status in the connected business. Returns payment, scope.

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": {
      "invoice_id": "<invoice_id>"
    },
    "name": "get-invoice-payment-status"
  }
}

Input Schema

NameRequiredDescriptionDefault
invoice_idYesInvoice ID returned by search-invoices.

Output Schema

NameRequiredDescriptionDefault
scopeYesAuthorization scope of this result; data remains restricted to the connected business.
paymentYesPayment data returned by the authorized safe projection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / required
      Added value: +[
      +  "invoice_id"
      +]
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "payment": {
      +      "description": "Payment data returned by the authorized safe projection.",
      +      "type": "object"
      +    },
      +    "scope": {
      +      "description": "Authorization scope of this result; data remains restricted to the connected business.",
      +      "enum": [
      +        "connection_business"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "payment",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

A3.7/5.0
Behavior4/5

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

The annotations already establish that the tool is a safe, closed read; the description goes further by promising an 'authoritative' state and explicitly noting that payment links and provider identifiers are withheld. The 'authorized invoice' wording also signals an access-scoping check before any data is returned. It stops short of saying what happens when the invoice is unauthorized or unknown.

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?

Two tight sentences front-load the core guarantee, with the redaction clause immediately after. The trailing fragment 'Returns payment, scope' is cryptic and adds little, especially since an output schema already exists, but the rest of the text is lean and well ordered.

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 one-parameter read with annotations and an output schema, the definition covers what the tool returns, what it deliberately withholds, and the authorization precondition. The only real gap is the absent routing guidance against sibling invoice tools, which a caller must infer.

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?

There is a single required parameter with full schema coverage, and the schema already explains that invoice_id comes from search-invoices. The description adds only the notion that the invoice must be authorized, and gives no further detail on format or lookup behavior, so the schema carries nearly all the weight.

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?

Names a specific verb and resource: returns 'the authoritative payment state for one authorized invoice.' That is more precise than the tool name alone, and the phrase 'payment state' separates it from a generic invoice-fetch such as get-invoice, though the description never states that distinction explicitly.

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?

'Use to get invoice payment status in the connected business' points at the context in which the tool applies, but only implicitly. There is no when-not guidance, no mention of when get-invoice or preview-invoice would be the better pick, and no stated prerequisite that the invoice must already be known to the caller.

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