Skip to main content
Glama

Get balance

get_balance
Read-onlyIdempotent

Read the remaining credit balance: the pooled account, or one end user via external_user_id with a secret key. Use before a large spend or after an insufficient-credits error. Free.

Input Schema

NameRequiredDescriptionDefault
external_user_idNoEnd-user id; secret-key auth only.

Output Schema

NameRequiredDescriptionDefault
statusNo
creditsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedOutput schema / additionalProperties
      Removed value: -true
    • removedOutput schema / properties / credits / description
      Removed value: -"Remaining credit balance."
    • removedOutput schema / properties / status / description
      Removed value: -"Account status."
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "credits": {
      +      "description": "Remaining credit balance.",
      +      "type": "string"
      +    },
      +    "status": {
      +      "description": "Account status.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description only needs to add cost/auth context — and it does: 'Free' and 'secret key' auth for the end-user scope. It does not discuss rate limits or eventual consistency of the balance, which keeps it out of 5 territory.

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?

Three short clauses: what it reads, how scope is selected, when to call it, plus a one-word cost note. Zero filler, and the primary purpose is front-loaded ahead of the usage triggers.

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?

An output schema exists, so return-format details are unnecessary here. Between the description and schema an agent knows both scopes, the auth mode each requires, the trigger conditions, and that the call is free — nothing needed to invoke correctly is missing.

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 coverage is 100% and already documents external_user_id's type and auth requirement, so baseline is 3. The description goes beyond the schema by clarifying the default (omitting the parameter returns the pooled account balance rather than failing), which is behavioral meaning the schema does not encode.

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 concrete verb+resource ('Read the remaining credit balance') and immediately disambiguates the two scopes it can serve: the pooled account, or a single end user via external_user_id. An agent can distinguish it from the write-side sibling add_credits without opening any schema.

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

Usage Guidelines4/5

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

Gives two concrete triggers ('before a large spend', 'after an insufficient-credits error') that make the call condition actionable. It also states the auth precondition for the per-user mode. It stops short of naming an alternative tool or stating when not to use it, so it's strong but not exhaustive.

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.