Skip to main content
Glama

Check usage and credits

get_usage
Read-onlyIdempotent

Returns the account's credits used, included and remaining, when they reset, the plan, a billing link, and the daily reading allowance that saved and tracked-ad reads draw on. For checking the balance before paid work, or after a read reports that the allowance is used up.

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_usage"
  }
}

Input Schema

NameRequiredDescriptionDefault
brand_idNoOptional brand id from list_brands: reports the reading allowance of that brand's workspace. Defaults to the current workspace.
response_formatNoOutput format: text (default) or json. table is not available for this tool.

Output Schema

NameRequiredDescriptionDefault
profileNoprofile value in this response.
allowanceNoFree daily ad-return allowance for this workspace, resetting at midnight UTC.
resets_atNoISO timestamp when the allowance or credits reset.
billing_urlNobilling url value in this response.
reset_at_msNoreset at ms value in this response.
credits_usedNocredits used value in this response.
balance_creditsNobalance credits value in this response.
included_creditsNoincluded credits value in this response.
credits_remainingNocredits remaining value in this response.
reading_allowanceNoFree daily ad-return allowance for this workspace, resetting at midnight UTC.
monthly_generation_countNomonthly generation count value in this response.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / brand_id / description
      Previous value: -"Pass a brand to see the allowance its workspace uses. Defaults to your current workspace."New value: +"Optional brand id from list_brands: reports the reading allowance of that brand's workspace. Defaults to the current workspace."
    • changedInput schema / properties / response_format / description
      Previous value: -"Output format: text or json for capped research examples; table is available only for tracked rival rows."New value: +"Output format: text (default) or json. table is not available for this tool."
  2. Changed4 schema fields changed
    • changedOutput schema / properties / allowance / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "description": "Daily scanned-row allowance for this workspace, resetting at midnight UTC.",
      -    "properties": {
      -      "daily_limit": {
      -        "description": "Maximum scanned rows allowed per UTC day.",
      -        "type": "number"
      -      },
      -      "remaining": {
      -        "description": "Scanned rows still available today.",
      -        "type": "number"
      -      },
      -      "resets_at": {
      -        "description": "ISO timestamp when the allowance or credits reset.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "daily_limit",
      -      "remaining",
      -      "resets_at"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "description": "Free daily ad-return allowance for this workspace, resetting at midnight UTC.",
      +    "properties": {
      +      "daily_limit": {
      +        "description": "Maximum free ad examples returned per UTC day.",
      +        "type": "number"
      +      },
      +      "remaining": {
      +        "description": "Free ad examples still available today.",
      +        "type": "number"
      +      },
      +      "resets_at": {
      +        "description": "ISO timestamp when the allowance or credits reset.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "daily_limit",
      +      "remaining",
      +      "resets_at"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / allowance / description
      Previous value: -"Daily scanned-row allowance for this workspace, resetting at midnight UTC."New value: +"Free daily ad-return allowance for this workspace, resetting at midnight UTC."
    • changedOutput schema / properties / reading_allowance / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "description": "Daily scanned-row allowance for this workspace, resetting at midnight UTC.",
      -    "properties": {
      -      "daily_limit": {
      -        "description": "Maximum scanned rows allowed per UTC day.",
      -        "type": "number"
      -      },
      -      "remaining": {
      -        "description": "Scanned rows still available today.",
      -        "type": "number"
      -      },
      -      "resets_at": {
      -        "description": "ISO timestamp when the allowance or credits reset.",
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "daily_limit",
      -      "remaining",
      -      "resets_at"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "description": "Free daily ad-return allowance for this workspace, resetting at midnight UTC.",
      +    "properties": {
      +      "daily_limit": {
      +        "description": "Maximum free ad examples returned per UTC day.",
      +        "type": "number"
      +      },
      +      "remaining": {
      +        "description": "Free ad examples still available today.",
      +        "type": "number"
      +      },
      +      "resets_at": {
      +        "description": "ISO timestamp when the allowance or credits reset.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "daily_limit",
      +      "remaining",
      +      "resets_at"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedOutput schema / properties / reading_allowance / description
      Previous value: -"Daily scanned-row allowance for this workspace, resetting at midnight UTC."New value: +"Free daily ad-return allowance for this workspace, resetting at midnight UTC."
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description adds genuine value beyond that by explaining the reading-allowance concept that saved and tracked-ad reads draw on, which explains why this tool matters operationally. It stops short of 5 because it says nothing about rate limits, auth, or failure modes.

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?

Two sentences, front-loaded with the returned data and followed by the usage trigger — no filler. The first sentence is long and enumerates eight fields, which is dense but justified since it defines scope precisely.

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?

With an output schema present, the description need not explain return values, and with full schema coverage the parameters are self-documenting. What remains is adequately covered: purpose, contents, and call timing are all stated, leaving only minor gaps like multi-workspace behavior that the schema's brand_id note already handles.

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 parameters (brand_id and response_format) are already fully documented in the schema, and 0 are required. The description adds no parameter-level meaning beyond that, so the 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?

The description names a specific verb (returns) and enumerates the exact resource set: credits used, included and remaining, reset timing, plan, billing link, and the daily reading allowance. An agent can tell immediately this is a read-only usage/credits reporting tool, distinct from data-retrieval siblings like get_ad or list_brands.

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?

It gives two concrete triggers: checking the balance before paid work, and calling after a read reports the allowance is exhausted. That is clear when-to-use guidance, but it names no explicit alternative tool or when-not-to-call condition, so it stops short of a 5.

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.