Skip to main content
Glama

get_usage

Read-only

Get usage metrics for the authenticated account. Shows verification counts, API calls, and quota usage.

ACCESS: needs a Proof account. Authenticate this client (Claude Code: /mcp → Authenticate), then call this tool again. start_login does NOT open this tool.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_usage"
  }
}

Input Schema

NameRequiredDescriptionDefault
monthsNoNumber of months of history
periodNoMonth to query in YYYY-MM format (e.g. 2026-01)

Output Schema

NameRequiredDescriptionDefault
planYes
limitYesThe plan's included verifications per month
balanceYesThe prepaid balance as `GET /me/billing/balance` reports it, without `billing_enabled` (the usage read carries that itself) or `top_up_charges`
periodsYesThe months asked for that have a record, newest first
hard_limitYes
percentageYes`current_usage` as a percentage of `limit`, rounded
is_on_trackYesnull when fewer than 5 days have passed or usage is 0
card_on_fileYes
top_channelsYes
current_usageYesVerifications, confirmations, authorizations and delegations this month, counted from the requested months' records: 0 when `period` names another month, since the current month's record is then not among them
current_periodYesThe current month, `YYYY-MM`
days_remainingYes
billing_enabledYes
projected_eom_usageYes
projection_unreliableYestrue when the projection exceeds the limit three times over
channels_with_zero_completionsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / balance / description
      Previous value: -"The prepaid balance as `GET /me/billing/balance` reports it, without `billing_enabled` (the usage read carries that itself)"New value: +"The prepaid balance as `GET /me/billing/balance` reports it, without `billing_enabled` (the usage read carries that itself) or `top_up_charges`"
  2. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "description": "Usage for the current billing period, with the months asked for",
      +  "properties": {
      +    "balance": {
      +      "additionalProperties": {},
      +      "description": "The prepaid balance as `GET /me/billing/balance` reports it, without `billing_enabled` (the usage read carries that itself)",
      +      "properties": {
      +        "auto_top_up": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "amount": {
      +              "anyOf": [
      +                {
      +                  "maximum": 9007199254740991,
      +                  "minimum": -9007199254740991,
      +                  "type": "integer"
      +                },
      +                {
      +                  "type": "null"
      +                }
      +              ]
      +            },
      +            "enabled": {
      +              "type": "boolean"
      +            },
      +            "has_payment_method": {
      +              "type": "boolean"
      +            }
      +          },
      +          "required": [
      +            "enabled",
      +            "amount",
      +            "has_payment_method"
      +          ],
      +          "type": "object"
      +        },
      +        "balance": {
      +          "additionalProperties": {},
      +          "properties": {
      +            "amount": {
      +              "maximum": 9007199254740991,
      +              "minimum": -9007199254740991,
      +              "type": "integer"
      +            },
      +            "currency": {
      +              "type": "string"
      +            },
      +            "mills": {
      +              "maximum": 9007199254740991,
      +              "minimum": -9007199254740991,
      +              "type": "integer"
      +            }
      +          },
      +          "required": [
      +            "amount",
      +            "currency",
      +            "mills"
      +          ],
      +          "type": "object"
      +        },
      +        "low_balance_threshold": {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        "top_up_amounts": {
      +          "items": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "balance",
      +        "low_balance_threshold",
      +        "top_up_amounts",
      +        "auto_top_up"
      +      ],
      +      "type": "object"
      +    },
      +    "billing_enabled": {
      +      "type": "boolean"
      +    },
      +    "card_on_file": {
      +      "type": "boolean"
      +    },
      +    "channels_with_zero_completions": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "current_period": {
      +      "description": "The current month, `YYYY-MM`",
      +      "type": "string"
      +    },
      +    "current_usage": {
      +      "description": "Verifications, confirmations, authorizations and delegations this month, counted from the requested months' records: 0 when `period` names another month, since the current month's record is then not among them",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "days_remaining": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "hard_limit": {
      +      "anyOf": [
      +        {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "is_on_track": {
      +      "description": "null when fewer than 5 days have passed or usage is 0",
      +      "type": [
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "limit": {
      +      "description": "The plan's included verifications per month",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "percentage": {
      +      "description": "`current_usage` as a percentage of `limit`, rounded",
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "periods": {
      +      "description": "The months asked for that have a record, newest first",
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "by_channel": {
      +            "additionalProperties": {
      +              "maximum": 9007199254740991,
      +              "minimum": -9007199254740991,
      +              "type": "integer"
      +            },
      +            "properties": {},
      +            "type": "object"
      +          },
      +          "by_hitl_channel": {
      +            "additionalProperties": {
      +              "maximum": 9007199254740991,
      +              "minimum": -9007199254740991,
      +              "type": "integer"
      +            },
      +            "properties": {},
      +            "type": "object"
      +          },
      +          "by_type": {
      +            "additionalProperties": {},
      +            "properties": {
      +              "domain": {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              },
      +              "email": {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              },
      +              "phone": {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              },
      +              "social": {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              },
      +              "telegram_bot": {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              },
      +              "wallet": {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              }
      +            },
      +            "required": [
      +              "phone",
      +              "email",
      +              "domain",
      +              "social",
      +              "wallet",
      +              "telegram_bot"
      +            ],
      +            "type": "object"
      +          },
      +          "period": {
      +            "type": "string"
      +          },
      +          "total_authorizations": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          "total_confirmations": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          "total_delegations": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          "total_verifications": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "period",
      +          "total_verifications",
      +          "total_confirmations",
      +          "total_authorizations",
      +          "total_delegations",
      +          "by_type",
      +          "by_channel",
      +          "by_hitl_channel"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "plan": {
      +      "type": "string"
      +    },
      +    "projected_eom_usage": {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    "projection_unreliable": {
      +      "description": "true when the projection exceeds the limit three times over",
      +      "type": "boolean"
      +    },
      +    "top_channels": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "channel": {
      +            "type": "string"
      +          },
      +          "completion_rate": {
      +            "type": "number"
      +          },
      +          "count": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "channel",
      +          "count",
      +          "completion_rate"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "plan",
      +    "limit",
      +    "billing_enabled",
      +    "card_on_file",
      +    "hard_limit",
      +    "balance",
      +    "current_period",
      +    "current_usage",
      +    "percentage",
      +    "days_remaining",
      +    "projected_eom_usage",
      +    "is_on_track",
      +    "projection_unreliable",
      +    "top_channels",
      +    "channels_with_zero_completions",
      +    "periods"
      +  ],
      +  "type": "object"
      +}
  3. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  4. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds real context beyond that: it requires a Proof account, the client must be authenticated first (with the /mcp flow named), and it explicitly warns that start_login does NOT enable this tool — a non-obvious behavioral gotcha worth the space.

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 short blocks, front-loaded with the purpose and followed by the access caveat; nothing is repeated or padded. The only cost is the slightly awkward all-caps ACCESS block, but it does make the prerequisite scannable.

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 not be explained, and the parameters are fully documented in the schema. The main non-schema risk for a tool like this — authentication failures and the start_login red herring — is called out explicitly, so nothing essential 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?

Schema description coverage is 100% and both parameters (months, period) carry their own descriptions and constraints, so the description need not restate them. It adds no meaning of its own about how months and period interact or which wins if both are supplied, leaving it at the baseline.

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 tool is defined with a specific verb and resource ("Get usage metrics for the authenticated account") and enumerates the contents: verification counts, API calls, quota usage. That is enough to distinguish it from generic account tools, though it never contrasts itself with the similarly named sibling get_api_key_usage.

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 by the word "metrics" and by the access note; there is no explicit statement of when to reach for this versus get_api_key_usage or get_platform_summary. The authentication precondition is spelled out, which is useful, but that is a prerequisite rather than when-to-use guidance.

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.