Skip to main content
Glama

Check Credits

check_credits
Read-onlyIdempotent

Read the selected workspace's credit balance, action prices, free Brand creations, and payment status. This check does not spend credits or change the subscription.

Brand creation, Brand edits, Briefs, and Reviews spend credits when credit_costs lists a nonzero price for them. Prices vary by workspace, so use this workspace's credit_costs when quoting them. free_brand_creations counts Brand creations that won't spend credits. Selected-model AI Gateway image, video, audio, and SVG pricing depends on the model and request; neither the balance nor credit_costs establishes that price or the model's availability.

subscription_paused is present (true) when a past_due plan actually blocks access — the last payment failed, so plan credits are on hold until payment is completed. Credits remain spendable.

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": "check_credits"
  }
}

Input Schema

NameRequiredDescriptionDefault
llm_modelNoThe model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics.
workspace_idYesWorkspace whose balance and action prices to read. Use its ID from list_workspaces; call list_workspaces first if the intended workspace has not been identified.

Output Schema

NameRequiredDescriptionDefault
balanceYesRemaining workspace credits. Read unlimited and subscription_paused alongside this value; balance alone does not establish whether an operation can run.
unlimitedYesWhether the workspace has unlimited credits. This does not establish selected-model generation pricing or availability.
credit_costsYesCredits each action costs this workspace. 0 means the action is free right now. Selected-model generations are priced per request and aren't listed.
workspace_idYesWorkspace ID that was checked.
workspace_nameYesWorkspace name.
pricing_versionYesThe workspace's pricing version. Credit amounts are comparable only within one version.
subscription_pausedNoPresent only when a failed payment blocks plan access. It can appear even when top-up credits leave the balance positive.
free_brand_creationsYesBrand creations the workspace can still make without spending credits
message_for_assistantNoContext, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the description's 'does not spend credits or change the subscription' mainly reinforces that. It goes further, though, by defining semantics the annotations cannot: what free_brand_creations counts, what subscription_paused=true actually means for access, and the explicit caveat that neither balance nor credit_costs establishes per-model AI Gateway pricing or availability.

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?

Front-loaded with the purpose sentence, then grouped into pricing caveats and payment-status semantics; each sentence carries information. Slightly padded by the redundant 'does not spend credits' clause and an awkward mid-sentence line break in the last paragraph, but no true waste.

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?

For a read-only two-parameter tool with a full input schema and an output schema, this is essentially complete: it covers what is returned, how to interpret pricing, and the paused-subscription edge case. It stops short of describing how the balance is scoped or refreshed, and partly re-explains output fields the output schema already defines.

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 description coverage is 100%, so both workspace_id and llm_model are already fully documented in the schema, including the 'omit or pass unknown' escape hatch. The description adds only the phrase 'selected workspace' and nothing about workspace_id sourcing or the analytics-only nature of llm_model, so baseline 3 applies.

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?

Names a specific verb ('Read') and resource ('the selected workspace's credit balance') and enumerates exactly what is returned: action prices, free Brand creations, payment status. This is clearly distinguishable from siblings like get_account or list_workspaces, which do not deal with credit pricing.

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?

It provides usage guidance for the *output* ('use this workspace's credit_costs when quoting them', 'Prices vary by workspace'), and the schema directs the agent to list_workspaces first. But there is no explicit statement of when to call this versus alternatives, nor any exclusion condition — the agent must infer the selection context.

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