Skip to main content
Glama

get_usage

get_usage

Get current API usage and quota status

Returns the current period's API guide usage (guides created through the API or MCP), quota limit, remaining count and the renewal date. Aligned on the Stripe subscription billing cycle, or on the calendar month (UTC) for a Conqueror account without a subscription. Does not consume credits. enforced tells whether the quota is enforced on the current window: when true, a guide creation through the API or MCP that would exceed the limit is refused with HTTP 402 (see POST /api/v1/guides). When false (any plan other than Conqueror, a billing cycle that started before the refusal went live, or a Conqueror subscription in payment recovery, counted over the last 30 days with no reset date), the figures are informational only and nothing is refused on quota grounds. upgrade_url is the absolute link to the "Priority and API volume" add-on (the same as details.upgrade_url of the 402), absent when the add-on cannot raise the quota (already at its highest volume, or account without a subscription to add it to).

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and delivers: it discloses that the call is free ("Does not consume credits"), explains the `enforced` flag including the exact failure mode (HTTP 402 on guide creation exceeding the limit) and the precise conditions under which it is informational only, and explains when `upgrade_url` is absent. What is missing is any auth/permission requirement or rate-limit context, which keeps this short of a 5.

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 structured around the returned fields. It is dense and the `enforced` paragraph is long, but with no output schema each of those sentences documents an otherwise-invisible return value, so most of the length earns its place.

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?

There is no output schema, no annotations, and no parameters, so the description is the only source of return-value and behavioral information — and it covers the fields, the billing-window alignment, the 402 consequence, and the upgrade link. It is close to complete; the absence of any mention of auth or where these figures come from is a minor residual gap.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline is 4. No input semantics are needed or missing.

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?

States a specific verb+resource ("Get current API usage and quota status") and immediately clarifies scope: guide usage created through the API or MCP, quota limit, remaining count, renewal date. It is clearly a read-only status tool, but it never names the adjacent siblings it could be confused with (get_credits, get_credit_ledger, get_tokens_usage), so the agent must infer the boundary itself.

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: the note that it "does not consume credits" signals a safe, freely-callable status check, and the 402 context implies you check it to understand refusal conditions. However, there is no explicit when-to-use statement and no routing away from get_credits / get_credit_ledger / get_tokens_usage, which all sound like overlapping usage tools.

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