Skip to main content
Glama

get_usage

Read-only

The workspace's Managed-AI scan allowance for the current billing period — the numbers Settings → Billing shows: tier, checks included, carried over from earlier periods, used and remaining (checks are weighted, so a premium engine counts for more than one), overage so far and its price per check in the workspace's billing currency, the fair-use ceiling, checks run on the workspace's own provider keys (BYOK, not counted against the allowance) with byokCost.estimateUsd, an ESTIMATE in USD of what those checks cost on the workspace's own provider bills (each scan at the provider's list price when it ran, plus search fees; prices last checked byokCost.pricesLastChecked, the day a weekly check of each provider's pricing page last found every price equal to our table, else byokCost.pricesAsOf, the day the table was last reviewed by hand; over byokCost.scansCosted of them, byokCost.scansTypical of those priced from a typical scan because no token count was recorded; null when none can be priced; managed checks never carry a provider cost), where this period's managed checks were started (checksBySurface: app, scheduled scan, this MCP connector, automation), this month's assistant messages on Managed AI by where they were started (assistantMessages.bySurface: app, copies = monthly report copies' summaries, mcp, automation, email = AI summaries rewritten before a report email went out), and when the period resets. Check it before suggesting more prompts, engines or passes per prompt. If the workspace isn't on a metered Managed-AI tier, it says so and returns no allowance figures rather than zeros.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered; the description adds substantial context beyond that – weighted check accounting, BYOK scans excluded from the allowance, ESTIMATE caveats with null handling, and the non-metered-tier behavior that returns no figures rather than zeros. It does not cover auth requirements or freshness/rate-limit behavior beyond pricesLastChecked.

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

Conciseness3/5

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

Purpose is front-loaded, and every clause carries information, but the entire body is a single run-on sentence packed with nested parentheticals that is hard to parse. Detail is appropriate given no output schema, yet the structure is not disciplined.

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 no output schema, the description carries the full burden of explaining returns and does so exhaustively – allowance numbers, BYOK estimate fields, checksBySurface, assistantMessages.bySurface, reset timing, and the non-metered edge case. It is complete for the tool's shape, though the density makes it harder to use than a structured enumeration would be.

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 the baseline is 4. The description explains scoping implicitly (current billing period, current workspace) rather than through inputs, and there is nothing in the schema left to clarify.

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?

Opens with a specific verb+resource+scope: "The workspace's Managed-AI scan allowance for the current billing period." An agent can immediately distinguish this billing/quota tool from the metric-oriented siblings (get_ai_visibility_metrics, get_insights), and the follow-on enumeration of what the payload contains reinforces the unique purpose.

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?

Provides an explicit workflow trigger: "Check it before suggesting more prompts, engines or passes per prompt," plus the fallback condition for non-metered tiers. It does not name an alternative sibling or state when NOT to call it, 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.

Resources