Skip to main content
Glama

get_balance

Read-onlyIdempotent

Check the live account-wide Credits balance shared by all API keys for free without reserving or spending Credits.

Instructions

Read the live account-wide available Credits balance shared by all API keys. Free; does not reserve or spend Credits.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_balance"
  }
}

Input Schema

NameRequiredDescriptionDefault
response_formatNoAgent-readable presentation. MCP defaults to Markdown; json returns the original JSON text, text returns indented fields. Structured fields remain available. Does not change billing or the stored job.markdown

Output Schema

NameRequiredDescriptionDefault
codeNoMachine-readable error code when the operation fails.
noteNoBalance limitations.
unitNo
scopeNo
detailNoAdditional problem detail returned by the API.
messageNoError, delivery, or continuation instructions.
updatedAtNoLast recorded balance update time, if available.
request_idNoFlashData request identifier for support and tracing.
http_statusNoUpstream HTTP status, when an upstream request was made.
balanceCreditsNoLive account balance, shared by all API Keys.
availableCreditsNoNonnegative available balance at read time.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered by structured data. The description adds genuinely non-redundant behavior: the balance is live and account-wide across all API keys, and the call neither reserves nor spends Credits — cost semantics that no annotation expresses.

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?

Two short sentences with zero filler: the what/scope comes first and the cost caveat second. Every clause carries information an agent would otherwise have to guess.

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?

An output schema exists, so return values need no explanation, and annotations cover the safety profile; the description supplies the missing piece (cost and account-wide scope). The only residual gap is freshness/pagination nuance, which is largely moot for a single scalar balance.

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?

Only one optional parameter (response_format) with a 100% schema description covering the enum values and their meaning. The description adds nothing about it, so this sits at the baseline where the schema does all the work.

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 ('Read the live ... Credits balance') with scope modifiers ('account-wide', 'shared by all API keys') that separate it from per-key or per-period siblings such as get_usage. It does not, however, name any sibling outright, so the differentiation is inferential rather than explicit.

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?

Usage is implied by the noun 'balance' and reinforced by 'Free; does not reserve or spend Credits', which tells an agent this call is cost-free to make. There is no explicit when-to-use, when-not-to-use, or pointer to an alternative (e.g., get_usage for consumption history, get_limits for quotas).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.