Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_rate_limit

Read-onlyIdempotent

Retrieve a rate-limit policy by UUID to inspect its conditions, grouping, unit, value, target, scope, and status. Include archived status to fetch a soft-deleted policy.

Instructions

Get one rate-limit policy by id, including current conditions, grouping, unit, value, target, scope, and status. Pass archived status when retrieving a soft-deleted policy.

Input Schema

NameRequiredDescriptionDefault
idYesRate-limit policy UUID
statusNoInclude an archived policy by status

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. Changed3 schema fields changedv0.11.5
    • changedInput schema / properties / id / description
      Previous value: -"The unique identifier of the rate limit"New value: +"Rate-limit policy UUID"
    • addedInput schema / properties / id / minLength
      Added value: +1
    • 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.5/5.0
Behavior4/5

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

Annotations already declare this as read-only, idempotent, and non-destructive. The description adds useful context by naming the included policy fields and explaining how archived soft-deleted policies are retrieved, without describing permissions or error behavior.

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 short sentences, front-loaded with the core purpose and followed by the only special retrieval condition. The field list is dense but useful and no sentence is wasted.

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?

Given the rich annotations, complete schema, and presence of an output schema, the description provides everything needed to select and invoke this simple read tool correctly. The soft-deleted-policy caveat covers the only non-obvious behavior.

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 complete, so the schema already defines both parameters. The description adds meaning beyond the schema by clarifying that status=archived is specifically for retrieving a soft-deleted policy, not just any archived status.

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 rate-limit policy by id. It also enumerates the information returned, making the tool clearly distinct from list_rate_limits and mutation siblings such as update_rate_limit.

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?

Clearly establishes this as a single-policy lookup by id. The archived-status instruction gives useful conditional guidance for soft-deleted policies, though it does not explicitly name alternatives like list_rate_limits.

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