Skip to main content
Glama

get_api_usage

Read-only

Retrieve Linked API usage statistics. Date range must not exceed 30 days.

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": {
      "start": "<start>",
      "end": "<end>"
    },
    "name": "get_api_usage"
  }
}

Input Schema

NameRequiredDescriptionDefault
endYesEnd date for the statistics period in ISO 8601 format (e.g., '2024-01-30T00:00:00Z')
startYesStart date for the statistics period in ISO 8601 format (e.g., '2024-01-01T00:00:00Z')

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds the non-obvious 30-day window cap, which is real behavioral context, but says nothing about granularity, timezone, pagination, or what the statistics contain.

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

Conciseness5/5

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

Two short sentences, the purpose first and the hard limitation second. Nothing is redundant and nothing could be trimmed without losing information.

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 two-parameter read-only tool with full schema coverage and no output schema, the description covers purpose, parameters, and the key execution constraint. Only the shape of the returned statistics and timezone/granularity semantics are left unaddressed.

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?

Schema coverage is 100%, so both ISO 8601 parameters are already documented and the baseline would be 3. The description adds a cross-parameter constraint (the interval between start and end must not exceed 30 days) that appears nowhere in the schema, which is genuine added meaning.

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 ('Retrieve') and resource ('Linked API usage statistics'), so the agent knows this returns consumption data. It does not, however, distinguish itself from the adjacent sibling admin_get_limits_usage, which plausibly returns overlapping usage numbers.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use or when-not-to-use guidance and no named alternative, despite admin_get_limits_usage and retrieve_performance sitting in the same family. The only guidance-like element is the 30-day cap, which is a hard constraint rather than a selection rule.

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.