Skip to main content
Glama

Get plan usage

get_usage
Read-onlyIdempotent

This calendar month's course views against the plan's allowance, plus what any excess costs at the published rate. Paid plans keep serving past the allowance and bill the excess; the sandbox has no overage rate (null) and stops serving at its limit.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
overYesViews beyond the allowance. Zero when inside it.
planYes
usedYesBillable course views so far this calendar month.
limitYesViews the plan includes each month.
periodEndYesEnd of this month's usage period (exclusive), ISO 8601 in UTC.
periodStartYesStart of this month's usage period, ISO 8601 in UTC.
overageCentsYesWhat the extra views cost at the published rate, in cents.
ratePer1kOverageYesPublished price in dollars per 1,000 extra views, or null where extra views are not sold.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / limit / description
      Previous value: -"Views the plan includes each month. Null means the plan is uncapped."New value: +"Views the plan includes each month."
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare the safe read-only/idempotent profile, so the description's job is to add domain behavior - and it does, explaining that paid plans keep serving past the allowance and bill the excess while the sandbox has no overage rate and stops serving entirely. That is genuinely useful operational context an agent could not derive from the structured fields. It stops short of covering freshness/latency or auth requirements.

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 primary metric and then the consequential billing/serving behavior. Every clause earns its place, though the '(null)' aside is a small detour into output-shape detail that the output schema already covers.

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?

With zero parameters and an output schema present, the description need not document return values; it instead supplies exactly the missing context about how the number behaves across plan types. Nothing an agent needs to call and interpret this tool is absent.

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 no parameter semantics for the description to carry; the baseline of 4 applies. The parenthetical '(null)' even pre-explains an output field for the sandbox case.

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?

The description states a specific resource and metric: this calendar month's course views measured against the plan allowance, plus the cost of excess. That is concrete enough to distinguish it from list/get tools for courses, identities or certificates. It does not, however, differentiate itself from the nearby get_overview or get_workspace_info siblings, so the agent must infer the boundary.

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: a zero-argument, read-only tool whose purpose is self-evident from the name and description. There is no explicit 'use this when you need X' statement and no pointer to the closest alternative (get_overview) that might also report plan-level information.

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