Skip to main content
Glama

Get credit balances

get_credit_balances
Read-onlyIdempotent

Current credit balances for a workspace: credits (used across Rank Tracker, citations, AI Visibility, Lead Finder and Competition Analysis) and SMS credits.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "workspace_id": "<workspace_id>"
    },
    "name": "get_credit_balances"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspace_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and closed-world, so the safety profile is covered. The description adds useful domain context by listing the product areas credits are shared across (Rank Tracker, citations, AI Visibility, Lead Finder, Competition Analysis), which helps interpret the number. It still says nothing about whether querying consumes credits, what happens for exhausted balances, or permissions.

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

Conciseness4/5

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

A single sentence with zero filler, and the core resource is front-loaded. It reads as a noun phrase rather than a statement of action, which is slightly less directive than an imperative phrasing would be.

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?

With no output schema, the description carries the burden of describing return values; it does name both balance types but says nothing about units, formatting, or whether anything else is returned. For a one-parameter read tool this is mostly adequate but not fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is one required parameter, workspace_id, with 0% schema description coverage, and the description never mentions it or explains which workspace's balances are returned. A UUID named workspace_id is largely self-evident, so this is a modest gap rather than a fatal one, but the description does not compensate for the coverage deficit.

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?

The description names a specific resource (current credit balances for a workspace) and enumerates the two balances returned, credits and SMS credits. It is clearly distinct from every sibling tool, none of which deal with balances, though it omits an explicit verb.

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 only implied: an agent can infer this is the way to check remaining credits before triggering scans, citations, or other billable requests, but the description never states that. No alternatives or preconditions are mentioned, which is acceptable only because no sibling covers this resource.

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