Skip to main content
Glama
CodesWhat

portkey-admin-mcp

by CodesWhat
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_rate_limit

Read-onlyIdempotent

Retrieve a specific rate-limit policy by ID to view its conditions, grouping, unit, value, target, scope, and status. Include archived status to access soft-deleted policies.

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

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

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. 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"
+}
  2. Addedv1.0.1
  3. Removed
  4. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, and non-destructive behavior. The description adds value by revealing the response contents (current conditions, grouping, unit, value, target, scope, status) and by clarifying the archived-status behavior for soft-deleted policies, without contradicting any annotations.

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 compact sentences deliver the core operation, the fields returned, and the important archived-status usage note. Every sentence earns its place and key information is front-loaded.

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?

For a simple read-only retrieval with two parameters, full schema coverage, rich annotations, and an output schema, the description is complete. It adds the only missing operational nuance (archived policy retrieval), and nothing else is needed for correct invocation.

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 the schema already defines both parameters. The description enhances the 'status' parameter by explaining that 'archived' is needed to retrieve soft-deleted policies, providing context beyond the enum definition.

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 uses a specific verb ('Get') and resource ('one rate-limit policy by id'), and lists the fields returned, making the tool's purpose precise. It distinguishes itself from list_rate_limits by emphasizing retrieval of a single item by id, and from get_usage_limit by clearly naming 'rate-limit policy'.

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?

The description gives clear operational guidance by noting to pass 'archived' status when retrieving a soft-deleted policy. It does not explicitly name alternatives or exclusions, but the context makes it evident this is for fetching one specific policy rather than listing all.

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