Skip to main content
Glama

Usage summary

spicrawl_usage_summary
Read-onlyIdempotent

A compact current-period summary of your org's usage (totals as of now, from the daily rollup). No parameters. Use for a quick 'how much have I used so far'; use spicrawl_usage for a windowed breakdown. Requires the read scope.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
planNo
periodNoThe window, as a half-open range of UTC days.
creditsNoMetered usage against the plan's included credits. Micro-credits: 1 credit = 1000000.
metricsNoEvery billed metric for the period.
warningsNoCaveats the numbers would otherwise hide.
allowanceNoThe monthly allowance the API enforces. Omitted when it cannot be read (warnings says so).
usage_as_ofNoWhen the newest rollup row in the window was written; null when the window is empty.
unattributedNoMetric name -> quantity. credits are micro-credits (1 credit = 1000000), engine_ms milliseconds, bytes_* bytes, the rest counts.
stale_secondsNoAge of usage_as_of in seconds; null when the window is empty. A large value means the rollup is behind.
period_elapsed_daysNoWhole days of the period elapsed; use it to pace consumption.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": true,
      +  "properties": {
      +    "allowance": {
      +      "additionalProperties": true,
      +      "description": "The monthly allowance the API enforces. Omitted when it cannot be read (warnings says so).",
      +      "properties": {
      +        "limit_credits": {
      +          "type": "number"
      +        },
      +        "limit_micro": {
      +          "type": "number"
      +        },
      +        "limit_source": {
      +          "description": "'default' or 'override'.",
      +          "type": "string"
      +        },
      +        "remaining_micro": {
      +          "description": "Credits left under the monthly limit: the number to show.",
      +          "type": "number"
      +        },
      +        "resets_at": {
      +          "description": "When the allowance is restored in full.",
      +          "type": "string"
      +        },
      +        "unlimited": {
      +          "type": "boolean"
      +        },
      +        "used_micro": {
      +          "description": "Spent plus credits held for in-flight work.",
      +          "type": "number"
      +        },
      +        "window_start": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "credits": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": true,
      +          "properties": {
      +            "included_micro": {
      +              "type": "number"
      +            },
      +            "overage_micro": {
      +              "type": "number"
      +            },
      +            "overage_micro_cents_per_credit": {
      +              "type": "number"
      +            },
      +            "remaining_micro": {
      +              "type": "number"
      +            },
      +            "used_basis_points": {
      +              "description": "Used / included in basis points (10000 = 100%); null when nothing is included.",
      +              "type": [
      +                "number",
      +                "null"
      +              ]
      +            },
      +            "used_micro": {
      +              "description": "Credits spent so far, from the usage rollup; excludes credits held for in-flight work.",
      +              "type": "number"
      +            }
      +          },
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Metered usage against the plan's included credits. Micro-credits: 1 credit = 1000000."
      +    },
      +    "metrics": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": {
      +            "type": "number"
      +          },
      +          "type": "object"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "description": "Every billed metric for the period."
      +    },
      +    "period": {
      +      "additionalProperties": true,
      +      "description": "The window, as a half-open range of UTC days.",
      +      "properties": {
      +        "bounds": {
      +          "description": "Always '[start, end)'.",
      +          "type": "string"
      +        },
      +        "days": {
      +          "type": "number"
      +        },
      +        "end": {
      +          "description": "End UTC day, EXCLUSIVE (YYYY-MM-DD).",
      +          "type": "string"
      +        },
      +        "start": {
      +          "description": "First UTC day, inclusive (YYYY-MM-DD).",
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "period_elapsed_days": {
      +      "description": "Whole days of the period elapsed; use it to pace consumption.",
      +      "type": "number"
      +    },
      +    "plan": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "code": {
      +          "type": "string"
      +        },
      +        "name": {
      +          "type": "string"
      +        },
      +        "period_source": {
      +          "description": "'subscription' (billing period) or 'allowance_month'.",
      +          "type": "string"
      +        },
      +        "subscription_status": {
      +          "description": "'none' when no subscription covers now (the free plan).",
      +          "type": "string"
      +        },
      +        "version": {
      +          "type": "number"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "stale_seconds": {
      +      "description": "Age of usage_as_of in seconds; null when the window is empty. A large value means the rollup is behind.",
      +      "type": [
      +        "number",
      +        "null"
      +      ]
      +    },
      +    "unattributed": {
      +      "$ref": "#/properties/metrics",
      +      "description": "Metric name -> quantity. credits are micro-credits (1 credit = 1000000), engine_ms milliseconds, bytes_* bytes, the rest counts."
      +    },
      +    "usage_as_of": {
      +      "description": "When the newest rollup row in the window was written; null when the window is empty.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "warnings": {
      +      "description": "Caveats the numbers would otherwise hide.",
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive, and closed-world behavior. The description adds two things annotations cannot: the auth requirement ('Requires the `read` scope') and the data-freshness caveat implied by 'from the daily rollup' (totals are rolled-up, not real-time). Missing only a note on lag magnitude or pagination, so not a full 5.

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 sentences, front-loaded with what the tool returns, followed by the routing guidance and the auth prerequisite. No filler; every clause carries information.

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 values need no prose. With annotations covering safety and the description covering scope, freshness source, alternative routing, and auth scope, an agent has everything needed to call this correctly.

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?

Zero parameters, so the baseline is 4. The description explicitly confirms 'No parameters', which matches the empty schema and prevents an agent from hunting for filter options.

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+resource+scope: a current-period, org-level usage summary sourced from the daily rollup. It explicitly distinguishes itself from the sibling spicrawl_usage by naming it and the axis of difference (compact current totals vs. windowed breakdown).

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

Usage Guidelines5/5

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

Gives an explicit when-to-use ('quick how much have I used so far') and names the alternative tool plus the condition that selects it ('use spicrawl_usage for a windowed breakdown'). No inference required.

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