Skip to main content
Glama

Chargebee List Invoices

chargebee_list_invoices
Read-onlyIdempotent

List invoices filtered by status (e.g., 'paid', 'pending') and/or customer ID. Returns invoice numbers, amounts, dates, and payment status. Paginate with limit and offset.

Input Schema

NameRequiredDescriptionDefault
_siteYesChargebee site name
limitNoNumber of results to return (default 10, max 100)
offsetNoPagination offset from a previous response
statusNoFilter by invoice status: paid, posted, payment_due, not_paid, voided, pending
_apiKeyYesChargebee API key
customer_idNoFilter invoices by customer ID

Output Schema

NameRequiredDescriptionDefault
listYesArray of invoice objects
next_offsetNoPagination offset for next page of results

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "list": {
      +      "description": "Array of invoice objects",
      +      "items": {
      +        "properties": {
      +          "invoice": {
      +            "description": "Invoice details",
      +            "type": "object"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "next_offset": {
      +      "description": "Pagination offset for next page of results",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "list"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "_apiKey": "your-chargebee-api-key",
      +    "_site": "mycompany",
      +    "limit": 30,
      +    "status": "paid"
      +  },
      +  {
      +    "_apiKey": "your-chargebee-api-key",
      +    "_site": "mycompany",
      +    "customer_id": "cust_00123456789",
      +    "limit": 20,
      +    "status": "payment_due"
      +  }
      +]
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already indicate read-only, idempotent, non-destructive behavior. The description adds value by detailing pagination (limit and offset) and the returned fields, which are beyond the annotations. No contradictions.

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?

Two concise sentences: first states purpose and filters, second states return fields and pagination. No wasted words, front-loaded with key information.

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?

With output schema existing, the description covers all essential aspects: purpose, filters, pagination, and return fields. No missing elements given the tool's complexity and annotation richness.

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 parameters are well-documented. The description adds contextual grouping (filters vs pagination) and example values for status, but does not provide new semantic information beyond the 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?

The description clearly states the tool lists invoices with optional filtering by status and customer ID. It specifies returned fields (invoice numbers, amounts, dates, payment status), distinguishing it from sibling tools like chargebee_list_customers and chargebee_list_subscriptions.

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?

The description implies usage for listing invoices with filters, but lacks explicit guidance on when to use this tool versus alternatives (e.g., retrieving a single invoice or using other chargebee list tools). No when-not-to-use or alternative recommendations are provided.

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.