Skip to main content
Glama

Chargebee List Customers

chargebee_list_customers
Read-onlyIdempotent

List all customers with pagination. Returns customer IDs, names, emails, billing addresses, and creation dates.

Input Schema

NameRequiredDescriptionDefault
_siteYesChargebee site name
limitNoNumber of results to return (default 10, max 100)
offsetNoPagination offset from a previous response
_apiKeyYesChargebee API key

Output Schema

NameRequiredDescriptionDefault
listYesArray of customer 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 customer objects",
      +      "items": {
      +        "properties": {
      +          "customer": {
      +            "description": "Customer 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": 50
      +  }
      +]
  3. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the description adds value by specifying return fields and pagination behavior. It does not contradict annotations and provides useful context beyond the structured fields.

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?

The description is a single concise sentence that front-loads the key purpose. It is not verbose, but could be slightly more structured (e.g., bullet points) without adding length. It earns its place with clear information.

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?

Given the presence of annotations and a complete output schema, the description covers the essential points: listing with pagination and return fields. It is adequate for a simple list tool with good structured metadata, though it does not mention edge cases or error handling.

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%, meaning all parameters have descriptions in the schema. The tool description adds no additional parameter context beyond what the schema already provides, so the baseline score of 3 is appropriate.

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 verb 'List', the resource 'customers', and includes pagination details. It also lists the return fields, distinguishing it from siblings like chargebee_get_customer (single customer) and other list tools.

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 when to use (to list customers) but provides no explicit guidance on when not to use or how it differs from siblings like chargebee_get_customer. The agent can infer from sibling names, but the description itself lacks direct alternative differentiation.

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.