Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_usage_limit

Read-onlyIdempotent

Retrieve a cumulative usage-limit policy by UUID, optionally including per-value counters or archived policies. Use list_usage_limits first when the ID is unknown.

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

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

Output 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. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. 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"
+}
  3. Addedv1.0.1
  4. Removed
  5. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is low; the description still adds real context by noting that usage counters and archived policies are opt-in and that reset timestamps appear only when present. This tells the agent the response shape can vary by request, which annotations don't cover.

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?

Three short sentences, front-loaded with the core action and with the sibling routing immediately after. Slight density in the final sentence but no filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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 needn't be explained, and the description covers the notable variations (counters, archived, reset timestamps). Nothing an agent needs before calling is missing, though eligibility or scoping (workspace-level policies) is unmentioned.

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 coverage is 100%, so baseline is 3, but the description adds intent-level meaning to the two optional parameters – include_usage yields per-value counters and status reaches archived policies – rather than just restating field names. The id parameter's UUID nature is left to the schema, which is fine.

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 and resource ('Get one cumulative usage-limit policy by id'), which also disambiguates it from the adjacent get_rate_limit and list_usage_limits siblings. An agent can pick this tool without opening the schema.

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

Usage Guidelines4/5

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

Explicitly routes the agent to list_usage_limits when the id is unknown, which is the main decision point for this family. It doesn't say anything about when to prefer get_rate_limit or when a policy fetch is unnecessary, so it stops short of full when/when-not guidance.

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