Skip to main content
Glama

get_client_invoice

Read-only

Get the full financial and delivery summary for one issued client invoice, including subtotal, markup, tax, advance applied, balance due, dates, status, source report, and private Google Doc/PDF/DOCX links when available. Provide invoiceId or invoiceNumber — one is required; invoiceNumber is accepted only when it is unique. Read-only.

Input Schema

NameRequiredDescriptionDefault
invoiceIdNoStable invoice ID from list_client_invoices. Required unless invoiceNumber is supplied.
clientEmailNoAccepted client's account email (accountants only).
invoiceNumberNoHuman invoice number when invoiceId is unavailable; it must identify one unique invoice.

Output Schema

NameRequiredDescriptionDefault
invoiceNoThe invoice record. Absent only on the error branch (not-found), which never carries structuredContent.
messageNo
successYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / clientEmail / description
      Previous value: -"Client account email. Accountants may use this only for an accepted ExpenseBot client."New value: +"Accepted client's account email (accountants only)."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "invoice": {
      +      "additionalProperties": true,
      +      "description": "The invoice record. Absent only on the error branch (not-found), which never carries structuredContent.",
      +      "properties": {
      +        "advanceApplied": {
      +          "type": "number"
      +        },
      +        "balanceDue": {
      +          "type": "number"
      +        },
      +        "billClientUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "clientName": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "clientTag": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "currency": {
      +          "type": "string"
      +        },
      +        "deliveryStatus": {
      +          "type": "string"
      +        },
      +        "displayStatus": {
      +          "description": "Derived: overdue is computed from status + dueDate, not stored.",
      +          "enum": [
      +            "open",
      +            "overdue",
      +            "paid",
      +            "void",
      +            "superseded",
      +            "needs_review"
      +          ],
      +          "type": "string"
      +        },
      +        "documentUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "dueDate": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "grandTotal": {
      +          "type": "number"
      +        },
      +        "invoiceId": {
      +          "description": "Durable invoice identity.",
      +          "type": "string"
      +        },
      +        "invoiceNumber": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "issueDate": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "paidAmount": {
      +          "description": "null until paid.",
      +          "type": [
      +            "number",
      +            "null"
      +          ]
      +        },
      +        "paidDate": {
      +          "description": "null until paid.",
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "pdfUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "reportUrl": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "status": {
      +          "description": "Stored status, e.g. \"open\", \"paid\", \"void\".",
      +          "type": "string"
      +        },
      +        "subtotal": {
      +          "type": "number"
      +        },
      +        "taxAmount": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "message": {
      +      "type": "string"
      +    },
      +    "success": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success"
      +  ],
      +  "type": "object"
      +}
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "additionalProperties": true,
      -  "description": "Standard ExpenseBot tool result envelope. `message` is the human-readable summary the AI cites; `data` is the structured payload (totals, breakdowns, ids, etc.). On failure, `success` is false and `error` carries a code/message/hint triple.",
      -  "properties": {
      -    "data": {
      -      "additionalProperties": true,
      -      "description": "Structured payload. Shape varies per tool — common keys: total, breakdown, comparison, sampleMeta, ids, expenseId, reportId, signupUrl, results.",
      -      "type": "object"
      -    },
      -    "error": {
      -      "additionalProperties": true,
      -      "description": "Present only when success === false.",
      -      "properties": {
      -        "code": {
      -          "type": "string"
      -        },
      -        "hint": {
      -          "type": "string"
      -        },
      -        "message": {
      -          "type": "string"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "message": {
      -      "description": "Human-readable result text. Always present on success; prefer rendering this verbatim before any further reasoning.",
      -      "type": "string"
      -    },
      -    "sampleMeta": {
      -      "additionalProperties": true,
      -      "description": "Set when the underlying dataset was truncated. isTruncated=true means the agent saw a sample of `sampleCount` of `totalCount` rows; aggregate totals are still accurate.",
      -      "properties": {
      -        "isTruncated": {
      -          "type": "boolean"
      -        },
      -        "sampleCount": {
      -          "type": "integer"
      -        },
      -        "totalCount": {
      -          "type": "integer"
      -        }
      -      },
      -      "type": "object"
      -    },
      -    "success": {
      -      "description": "False on tool errors; check before reading `data`.",
      -      "type": "boolean"
      -    }
      -  },
      -  "type": "object"
      -}New value: +null
  4. Changed2 schema fields changed
    • changedInput schema / properties / invoiceId / description
      Previous value: -"Stable invoice ID from list_client_invoices."New value: +"Stable invoice ID from list_client_invoices. Required unless invoiceNumber is supplied."
    • changedInput schema / properties / invoiceNumber / description
      Previous value: -"Human invoice number when invoiceId is unavailable."New value: +"Human invoice number when invoiceId is unavailable; it must identify one unique invoice."
  5. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description reinforces rather than contradicts that. It adds context annotations do not carry: links are 'private' Google Doc/PDF/DOCX and only present 'when available', and invoiceNumber lookups fail unless unique. No mention of failure behavior when the number is ambiguous, which is the one real gap.

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 sentences, front-loaded with purpose before constraints, and no filler. The return-field list is dense but each item maps to real output the agent may need, though it pushes the sentence toward a catalogue rather than a summary.

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?

An output schema exists, so the field enumeration is arguably redundant, but it is harmless and the identifier rules cover the only decision an agent must make before calling. The gap is guidance on recovering from a non-unique invoiceNumber or resolving the ID via list_client_invoices.

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%, so the schema already documents all three parameters, including the accountants-only constraint on clientEmail. The description adds only the 'exactly one identifier required' and 'must be unique' semantics, and it never mentions clientEmail at all, so it is at the baseline for a fully-covered 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 ('Get') and a precisely scoped resource ('full financial and delivery summary for one issued client invoice'), and the singular scope cleanly separates it from the sibling list_client_invoices. The enumeration of what the summary contains leaves no ambiguity about the payload.

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 explicit identifier rules: 'Provide invoiceId or invoiceNumber — one is required; invoiceNumber is accepted only when it is unique.' That tells the agent how to satisfy the call, but it never names list_client_invoices as the way to obtain an invoiceId, nor states when to prefer this over the list tool.

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.