Skip to main content
Glama

Get credits balance

get_credits_balance
Read-only

Studio credit balance and top-up link. Requires an API key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyNoAPI key if the client can't send an Authorization header

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoWhat one credit buys
errorNoMachine-readable error code (only present on failures)
creditsNoAvailable studio credits (subscription + bonus)
messageNoHuman-readable explanation of the failure
topup_urlNoWhere to buy more credits

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / api_key / description
      Added value: +"API key if the client can't send an Authorization header"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "additionalProperties": true,
      +  "properties": {
      +    "credits": {
      +      "description": "Available studio credits (subscription + bonus)",
      +      "type": "number"
      +    },
      +    "error": {
      +      "description": "Machine-readable error code (only present on failures)",
      +      "type": "string"
      +    },
      +    "message": {
      +      "description": "Human-readable explanation of the failure",
      +      "type": "string"
      +    },
      +    "note": {
      +      "description": "What one credit buys",
      +      "type": "string"
      +    },
      +    "topup_url": {
      +      "description": "Where to buy more credits",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description adds useful behavioral context: the API key requirement and the presence of a top-up link in the response. This goes beyond what annotations convey, even if it doesn't detail the full response shape.

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?

The description is two short, front-loaded sentences. The core purpose comes first, followed by the auth requirement. No fluff or redundant elaboration.

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?

For a simple read-only tool with one optional parameter, output schema, and clear annotations, the description covers the essential purpose and auth prerequisite. Nothing critical is missing.

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 coverage is 100% for the only parameter. The description's 'Requires an API key' restates the parameter description without adding new semantics. Baseline 3 applies because the schema already documents the parameter adequately.

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?

The description clearly identifies the tool's function: retrieving the studio credit balance and providing a top-up link. It is distinct from sibling tools (audit, jobs, preview, seasonal guide) and leaves no ambiguity about what it does.

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?

The description gives clear context (checking credit balance) and a key prerequisite (API key required). It doesn't explicitly mention when not to use it, but since no sibling tool covers credits, explicit alternatives aren't necessary.

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