Skip to main content
Glama

Get Invoice Tool

get-invoice
Read-only

Returns one authorized invoice with bounded customer, job, payment-state, due-date, and line-item fields; payment links, addresses, and internal notes are excluded. Use to get invoice in the connected business. Returns invoice, 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"
  }
}

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.
invoiceYesInvoice 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": {
      +    "invoice": {
      +      "description": "Invoice 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": [
      +    "invoice",
      +    "scope"
      +  ],
      +  "type": "object"
      +}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered structurally. The description does add real value by disclosing the data-minimization boundary — payment links, addresses, and internal notes are excluded — and by flagging that the invoice must be 'authorized', hinting at permission scoping. It says nothing about behavior on missing/unauthorized IDs, keeping it at a 3.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first clause is well front-loaded and information-dense, but the second sentence ('Use to get invoice in the connected business') largely restates the name, and 'Returns invoice, scope' duplicates what the output schema already declares. Roughly a third of the text does not earn its place.

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 single-parameter, read-only fetch with an output schema and full parameter documentation, the description covers what matters: what is returned, what is deliberately omitted, and that access is authorization-scoped. Only the routing versus sibling invoice tools is left implicit.

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?

Schema coverage is 100% and the single parameter already documents that invoice_id comes from search-invoices, so the schema carries the load. The description adds no further meaning about the parameter, which matches the baseline 3 for a fully documented single-param 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?

The description names a specific verb and resource ('Returns one authorized invoice') and enumerates the field families returned (customer, job, payment-state, due-date, line-item). It stops short of distinguishing itself from the sibling get-invoice-payment-status, so an agent must infer that this tool is the full-detail fetch rather than the narrow status check.

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 in the connected business' is implied context rather than real routing guidance; it states a scope but never says when to prefer this over get-invoice-payment-status or preview-invoice. No preconditions or exclusions are given, so usage is only weakly implied.

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