Skip to main content
Glama

Nopaque TotalPath

Get Workspace Usage

getWorkspaceUsage
Read-onlyIdempotent

Get the current usage and entitlement snapshot for your workspace: subscription tier, free-minute pool balances (testing/loadTesting/mapping/s2s/s2stest), purchased-pack balances, current-period consumption, and remaining LLM-enrichment tokens. Use this to check whether you have enough capacity before kicking off an expensive job. Returns 404 cross-workspace.

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": {
      "workspaceId": "<workspaceId>"
    },
    "name": "getWorkspaceUsage"
  }
}

Input Schema

NameRequiredDescriptionDefault
workspaceIdYesWorkspace identifier. Must match the workspace the api-key was issued for.

Output Schema

NameRequiredDescriptionDefault
poolsYes
tokensYes
workspaceIdYes
currentPeriodEndNoISO8601 timestamp when the current billing period ends. Free-tier pools reset at this time.
subscriptionTierYes

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, idempotentHint and non-destructive, so the safety profile is covered. The description adds context the annotations cannot: it is a point-in-time snapshot, and a cross-workspace call returns 404, which tells the agent how failure manifests. It does not mention auth scoping or consistency lag, but the essentials are present.

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?

Purpose leads, the field enumeration follows, then the use case, then the error behavior last. The list of five minute pools is long but each name carries information an agent would otherwise have to guess. No filler sentences, though the enumeration is dense enough to slow scanning slightly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return structure need not be explained, and the description still names the salient fields an agent would care about. For a single-parameter read tool with full annotation coverage, nothing needed to invoke it correctly or interpret success/failure is missing.

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?

One required parameter at 100% schema description coverage, so the schema already explains workspaceId and the api-key match constraint. The description adds only the indirect cross-workspace 404 behavior, which is consistent with the schema but not additional parameter-level meaning. 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?

States a specific verb and resource ('Get the current usage and entitlement snapshot for your workspace') and enumerates exactly what the snapshot contains: subscription tier, five free-minute pools, purchased packs, period consumption, LLM-enrichment tokens. An agent can distinguish this from getWorkspaceUsageThisPeriod and getUsageBySource without opening either schema.

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?

Gives an explicit decision context: 'Use this to check whether you have enough capacity before kicking off an expensive job.' That is real when-to-use guidance rather than an implied purpose. It stops short of naming the sibling period/source tools as alternatives for historical or per-source breakdowns.

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.