Skip to main content
Get the current user’s usage overview across the tracked usage buckets

Tool details

FieldValue
Nameget_usage
GroupUsage

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {},
  "additionalProperties": false,
  "description": "Input schema for the get_usage tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "storage": {
      "type": "object",
      "properties": {
        "used": {
          "type": "number",
          "description": "The used associated with this tool result."
        },
        "total": {
          "type": "number",
          "description": "The total associated with this tool result."
        },
        "remaining": {
          "type": "number",
          "description": "The remaining associated with this tool result."
        },
        "percent_used": {
          "type": "number",
          "description": "The percent used associated with this tool result."
        }
      },
      "required": [
        "used",
        "total",
        "remaining",
        "percent_used"
      ],
      "additionalProperties": false,
      "description": "Structured storage details associated with this tool result."
    },
    "api_calls": {
      "$ref": "#/properties/storage",
      "description": "The api calls returned by the tool."
    },
    "period_start": {
      "type": "string",
      "description": "The period start associated with this tool result."
    },
    "period_end": {
      "type": "string",
      "description": "The period end associated with this tool result."
    }
  },
  "required": [
    "storage",
    "api_calls",
    "period_start",
    "period_end"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_usage tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}