Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_usage_limit

Read-onlyIdempotent

Retrieve a usage-limit policy by ID, optionally with usage counters or archived status. If the ID is unknown, call list_usage_limits first.

Instructions

Get one cumulative usage-limit policy by id. Use list_usage_limits first when the id is unknown. Optionally include per-value usage counters and retrieve archived policies; scheduled reset timestamps are returned when present.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUsage-limit policy UUID
statusNoInclude an archived policy by status
include_usageNoInclude per-value usage counters

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.11.5
    • changedInput schema / properties / id / description
      Previous value: -"The unique identifier of the usage limit"New value: +"Usage-limit policy UUID"
    • addedInput schema / properties / id / minLength
      Added value: +1
    • addedInput schema / properties / include_usage
      Added value: +{
+  "description": "Include per-value usage counters",
+  "type": "boolean"
+}
    • addedInput schema / properties / status
      Added value: +{
+  "description": "Include an archived policy by status",
+  "enum": [
+    "active",
+    "archived"
+  ],
+  "type": "string"
+}
  2. Addedv1.0.1
  3. Removed
  4. First observed

TDQS

A4.7/5.0
Behavior4/5

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

The annotations already establish read-only, idempotent, non-destructive behavior, so the description is not solely responsible for safety disclosure. The description adds useful behavioral context beyond the schema by noting that 'scheduled reset timestamps are returned when present' and that archived policies can be retrieved via status.

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 carry all essential information with no filler. The core purpose is front-loaded, and the optional parameter behaviors are summarized concisely without redundancy.

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?

The tool is simple, has an output schema, and is fully covered by rich annotations describing it as safe and idempotent. The description covers the primary lookup action, the fallback list call, and the optional behaviors, so nothing an agent needs to correctly invoke it is missing.

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 description coverage is 100%, so the baseline is 3. The description adds extra meaning by explaining 'include per-value usage counters' for include_usage and 'retrieve archived policies' for status, which clarifies the purpose of those parameters beyond the schema field names.

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?

The description states a specific verb and resource: 'Get one cumulative usage-limit policy by id.' It clearly distinguishes this from sibling tools like 'list_usage_limits' and 'get_rate_limit' by emphasizing 'cumulative usage-limit policy' and a single-id lookup.

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?

Usage guidance is explicit: 'Use list_usage_limits first when the id is unknown' tells the agent exactly when to choose an alternative. It also clarifies when to use the optional parameters, such as including usage counters or retrieving archived policies.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools