Skip to main content
Glama

Chargebee MCP by usefulapi

List credit notes

chargebee_list_credit_notes
Read-only

List credit notes. Filter by customer. Chargebee API: GET /credit_notes.

Input Schema

NameRequiredDescriptionDefault
limitNoMax results per page (Chargebee max 100).
offsetNoOpaque pagination token from a previous response's `next_offset`.
customer_idNoOnly credit notes of this customer (→ customer_id[is]).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. First observed

TDQS

B3.3/5.0
Behavior2/5

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

readOnlyHint=true already tells the agent this is a safe read with no side effects. The description adds only the raw upstream endpoint (GET /credit_notes) and no behavioral context such as pagination expectations, result ordering, or empty-result semantics, so it contributes little beyond the annotation.

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?

Three short sentences, front-loaded with the action and the filter before the endpoint detail. Nothing is bloated, though the raw "Chargebee API: GET /credit_notes" line is arguably noise for an agent that already has the tool contract.

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?

For a simple paginated read tool with full schema documentation and a readOnlyHint annotation, and no output schema to explain, the definition covers what is needed. The remaining gap is behavioral expectation around pagination/ordering, which is minor.

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%, with limit, offset, and customer_id each fully documented including the Chargebee max of 100 and the customer_id[is] mapping. The description's "Filter by customer" merely restates customer_id, so baseline 3 is correct.

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?

States a specific verb and resource ("List credit notes") plus the supported filter, which is enough to distinguish it from list_invoices, list_transactions, and other list siblings by resource alone. No explicit sibling call-out, which keeps it at 4 rather than 5.

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?

"Filter by customer" implies the primary use case (retrieving credit notes, optionally scoped to one customer), but there is no when-to-use/when-not-to-use guidance, no mention of alternatives for related lookups (e.g., get_invoice), and no note on when the customer filter is required.

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.