Skip to main content
Glama

list_client_invoices

Read-only

List the user's issued client invoices (accounts receivable) — who owes them money, how much, and when it is due. Examples: 'which invoices are outstanding', 'what does Acme still owe me', 'any overdue invoices', 'how much am I waiting to get paid'. status accepts 'active' (default), 'open', 'overdue', 'needs_review', 'paid', 'void', 'superseded', or 'all'. Returns invoice numbers, status, totals by currency, delivery state, and private document links. Read-only.

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": "list_client_invoices"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoMax invoices to return (default 25, max 100).
statusNoFilter by invoice status (default active/outstanding).
clientNameNoOptional: exact client name (case-insensitive).
clientEmailNoAccountants: accepted client email only.

Output Schema

NameRequiredDescriptionDefault
successYes
invoicesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedOutput schema / properties / invoices / items / additionalProperties
      Removed value: -true
    • removedOutput schema / properties / invoices / items / properties
      Removed value: -{
      -  "advanceApplied": {
      -    "type": "number"
      -  },
      -  "clientName": {
      -    "type": [
      -      "string",
      -      "null"
      -    ]
      -  },
      -  "currency": {
      -    "type": "string"
      -  },
      -  "displayStatus": {
      -    "enum": [
      -      "open",
      -      "overdue",
      -      "paid",
      -      "void",
      -      "superseded",
      -      "needs_review"
      -    ],
      -    "type": "string"
      -  },
      -  "grandTotal": {
      -    "type": "number"
      -  },
      -  "invoiceId": {
      -    "type": "string"
      -  },
      -  "invoiceNumber": {
      -    "type": [
      -      "string",
      -      "null"
      -    ]
      -  },
      -  "issueDate": {
      -    "type": [
      -      "string",
      -      "null"
      -    ]
      -  },
      -  "status": {
      -    "type": "string"
      -  },
      -  "total": {
      -    "type": "number"
      -  }
      -}
  2. Changed1 schema field changed
    • changedInput schema / properties / clientEmail / description
      Previous value: -"Accepted client's account email (accountants only)."New value: +"Accountants: accepted client email only."
  3. 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)."
  4. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "invoices": {
      +      "items": {
      +        "additionalProperties": true,
      +        "properties": {
      +          "advanceApplied": {
      +            "type": "number"
      +          },
      +          "clientName": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "currency": {
      +            "type": "string"
      +          },
      +          "displayStatus": {
      +            "enum": [
      +              "open",
      +              "overdue",
      +              "paid",
      +              "void",
      +              "superseded",
      +              "needs_review"
      +            ],
      +            "type": "string"
      +          },
      +          "grandTotal": {
      +            "type": "number"
      +          },
      +          "invoiceId": {
      +            "type": "string"
      +          },
      +          "invoiceNumber": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "issueDate": {
      +            "type": [
      +              "string",
      +              "null"
      +            ]
      +          },
      +          "status": {
      +            "type": "string"
      +          },
      +          "total": {
      +            "type": "number"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "success": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "success",
      +    "invoices"
      +  ],
      +  "type": "object"
      +}
  5. 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
  6. Changed2 schema fields changed
    • changedInput schema / properties / status / description
      Previous value: -"Filter by invoice status (default open)."New value: +"Filter by invoice status (default active/outstanding)."
    • changedInput schema / properties / status / enum
      Previous value: -[
      -  "open",
      -  "paid",
      -  "all"
      -]New value: +[
      +  "active",
      +  "open",
      +  "overdue",
      +  "needs_review",
      +  "paid",
      +  "void",
      +  "superseded",
      +  "all"
      +]
  7. First observed

TDQS

A4.2/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, so the trailing 'Read-only.' earns no credit. The description does add real context beyond annotations: the default status of 'active' meaning outstanding only, and that results include per-currency totals, delivery state, and private document links — useful for judging output scope and sensitivity.

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?

Front-loaded with purpose, then examples, then the status vocabulary and return contents — a sensible order. The inline enum listing is somewhat redundant with the schema and could be trimmed, but nothing is confusing or padded.

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 the description needn't explain return payloads, and it still names the key fields. All four optional parameters and the important default filter are covered, leaving nothing an agent needs in order to call it correctly.

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 description coverage is 100%, so limit, status, clientName, and clientEmail are already documented. The description restates the status enum and its 'active' default, which largely duplicates the schema enum rather than adding constraints or format nuances beyond what is supplied.

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 and resource ('List the user's issued client invoices') and disambiguates with '(accounts receivable)' plus the plain-language gloss 'who owes them money, how much, and when it is due'. The example queries make the domain unmistakable versus income/expense listing siblings like list_income_categories.

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?

Four concrete user-phrasing examples ('which invoices are outstanding', 'what does Acme still owe me', 'any overdue invoices') give a clear picture of when to select this tool. It stops short of explicitly routing to siblings (e.g. 'use get_client_invoice for a single invoice'), so no exclusions or named alternatives.

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.