Skip to main content
Glama

List Customer Charges

listCustomerCharges
Read-onlyIdempotent

List Customer Charges

Paginated revenue-charge history for one customer after ingest from billing systems.

List endpoints are paginated. Use the page and limit query parameters to paginate through results (at most 30 records per page). Check the pagination object in the response (current_page, last_page, total) to determine if more pages exist and whether to continue fetching.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUnique numeric identifier for the customer.
pageNoWhich page of results to return (1 is the first page). Omit this field or use 1 for the first page. Accepts minimum 1.
limitNoMaximum number of records to return per page. Accepts an integer from 1 to 30.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeNoShort code or application-level status code for this resource.
dataNoCharge rows newest-first by charged-at timestamp.
successNoIndicates whether the request completed successfully.
paginationNoPagination metadata for list responses.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, covering the safety profile. The description adds valuable behavioral detail about pagination (page/limit parameters and the pagination object in the response) beyond what annotations provide, so the agent knows how to handle large result sets.

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 concise and front-loaded with the core purpose, followed by pagination instructions. It repeats the tool name in the first line, but that is minor. The structure is logical and easy to scan, with no unnecessary fluff.

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 tool's simplicity (3 params, one required) and the presence of an output schema, the description covers what an agent needs: the resource scope, pagination handling, and how to detect more pages. It's complete for a read-only list endpoint.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% with clear descriptions for id, page, and limit. The description adds extra meaning by explaining the pagination object and how to check for more pages, which goes beyond the schema's basic parameter definitions.

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 states a specific action: listing revenue-charge history for a single customer, and distinguishes it from the sibling listCharges (which likely covers all customers). The phrase 'for one customer' makes the scope explicit, so an agent can immediately tell it apart from 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly indicates this is for a single customer's charge history and explains pagination mechanics. It doesn't explicitly name alternatives or state when not to use it, but the 'for one customer' scope provides clear context that implies listCharges would be used for all customers.

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