Skip to main content
Glama

paywall__customer_get_credit_balance

Returns the customer's credit balance in currency. Credit balances are generated when overpaying for a subscription or when purposefully redeeming vouchers to pay for additional fup units @param customer_id: The customer's database id @return: a json object,in the "values" object

Input Schema

NameRequiredDescriptionDefault
customer_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "type": "object"
      -}New value: +null
  2. Added

TDQS

B3.2/5.0
Behavior3/5

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

No annotations are present, so the description carries the full behavioral burden. It adds useful domain context (balances are generated by overpayment or voucher redemption) and hints at the return shape ('values' object), but does not state read-only semantics, auth requirements, or rate limits. Some value beyond the empty annotation set, but thin for a zero-annotation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose is front-loaded in the first sentence, which is good, but the doc-comment artifacts ('@param', '@return: a json object, in the "values" object') are awkwardly formatted and the return note is garbled. The middle sentence is useful but slightly verbose.

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?

For a simple one-parameter read tool with no output schema and no annotations, the description covers the parameter and hints at the return container. It stops short of explaining response fields or usage context, which are the remaining gaps.

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 description coverage is 0%, so the description must compensate, and it does: 'customer_id: The customer's database id' clarifies that this is an internal database identifier rather than an external reference. The single parameter is adequately explained.

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+resource ('Returns the customer's credit balance in currency') and adds domain context about when credit balances arise. No sibling is explicitly contrasted (e.g., vs. wallet_accounts_and_balance or payment_history), but the purpose is unambiguous.

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?

The description explains what a credit balance is but gives no guidance on when to call this versus related balance/history tools such as wallet_accounts_and_balance or customer_payment_history. No prerequisites or exclusions are stated.

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