Skip to main content
Glama

get_api_credit_balance

Read-onlyIdempotent

Read the prepaid model API credit balance (USD). Use it when the user asks about API credits, or after a checkout to confirm the payment landed. Zero means top up with create_api_credit_checkout (when enabled) or the platform Credits page. Requires api_credits:read.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, so the safety profile is covered; the description adds the required scope (api_credits:read) and the interpretation rule that zero means top up. It does not mention any rate limits or whether the balance is cached/eventually consistent, so it falls just short of a 5.

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?

Four short sentences, front-loaded with the identity of the resource, followed by usage, edge-case handling, and the permission requirement. Nothing is redundant or padded.

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

Completeness5/5

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

With no parameters and no output schema, the description supplies everything needed: what is returned (a USD credit balance), how to read a zero result, and the scope requirement. An agent can invoke it correctly without further information.

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?

Zero parameters, so there is nothing for the description to disambiguate; the baseline is 4. The '(USD)' qualifier usefully fixes the unit of the implicit return value.

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?

States a specific verb and resource ('Read the prepaid model API credit balance (USD)') and clearly distinguishes it from the write-side sibling create_api_credit_checkout. An agent can tell immediately this is a read of a scalar balance, not a transaction.

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

Usage Guidelines5/5

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

Gives two concrete triggers ('when the user asks about API credits' and 'after a checkout to confirm the payment landed') and routes the zero-balance case explicitly to create_api_credit_checkout or the Credits page. When-to-use and what-to-do-next are both spelled out.

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.