Skip to main content
Glama

Get customer credit ledger

orb_get_customer_credits_ledger
Read-only

Get the append-only credit ledger for a customer. Orb API: GET /customers/{customer_id}/credits/ledger.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax items to return (1–100, default 20).
cursorNoOpaque pagination cursor (from pagination_metadata.next_cursor).
currencyNoFilter to a single currency.
entry_typeNoFilter to a ledger entry type (e.g. increment, decrement, expiration_change).
customer_idYesOrb customer id.

TDQS

B3.3/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, and the description adds the behavioral fact that the ledger is append-only. However, it does not explain pagination behavior, ordering, filtering side effects, or what the response contains, so behavioral transparency is only moderately developed.

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?

The description is two concise sentences. The resource is stated immediately, the API endpoint is given for precision, and there is no filler or redundant elaboration.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The schema covers all parameters and the annotations cover read-only behavior, but there is no output schema and the description does not characterize the response shape or pagination metadata. It is adequate for a simple GET, but not fully complete.

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?

The input schema documents all five parameters with descriptions, so the schema carries the parameter semantics. The description adds no further parameter-level meaning beyond restating the customer_id path, 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.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb (Get) and the specific resource: the append-only credit ledger for a customer. It also provides the exact API path. It does not explicitly differentiate itself from the similarly named sibling orb_get_customer_credits, so sibling distinction is left to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

There is no guidance about when to use this tool versus alternatives. Given the sibling orb_get_customer_credits, an agent might reasonably confuse the ledger endpoint with a credits summary endpoint, but the description does not clarify which situation calls for which 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.

TDQS

A3.7/5.0
Disambiguation5/5

Every tool name clearly specifies a distinct action and resource (e.g., list_subscriptions vs get_subscription). There is no ambiguity between tools as each targets a unique combination of verb and noun.

Naming Consistency5/5

All tool names follow a consistent pattern: 'orb_<verb>_<resource>' in snake_case. This makes them predictable and easy to distinguish.

Tool Count4/5

With 26 tools, the set covers many resources and operations for a billing platform. While slightly above typical range, each tool justifies its existence given the domain complexity.

Completeness3/5

The tool surface provides extensive read capabilities and basic customer CRUD, but lacks create/update/delete for most other resources (e.g., subscriptions, invoices) and missing operations like void or cancel. This creates notable gaps for full lifecycle management.