Skip to main content
Glama

get_rate_limit

Read-onlyIdempotent

Retrieve a rate-limit policy by UUID to inspect its conditions, scope, target, and status; pass archived status to view 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "get_rate_limit"
  }
}

Input Schema

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

Output Schema

NameRequiredDescriptionDefault
okYesCall succeeded
dataNoSuccess payload
errorNoFailure details

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changedv0.16.5
    • changedOutput schema / properties / data / description
      Previous value: -"Structured success payload when ok is true"New value: +"Success payload"
    • changedOutput schema / properties / error / description
      Previous value: -"Structured error payload when ok is false"New value: +"Failure details"
    • changedOutput schema / properties / error / properties / details / description
      Previous value: -"Optional structured error details"New value: +"Extra error details"
    • changedOutput schema / properties / error / properties / message / description
      Previous value: -"Human-readable error message"New value: +"Error message"
    • changedOutput schema / properties / ok / description
      Previous value: -"Whether the tool call succeeded and returned structured data"New value: +"Call succeeded"
  2. 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"
  3. 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"
      +}
  4. Addedv1.0.1
  5. Removed
  6. First observed

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so safety is covered structurally. The description adds the genuinely useful non-obvious behavior that soft-deleted policies are only visible when status=archived, which is beyond the annotations. It stops short of describing errors for missing IDs or whether the status parameter is ignored for active records.

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, zero filler. The primary operation is front-loaded and the archived-status caveat follows as a short conditional.

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 and annotations cover the safety profile, so the description only needs to frame retrieval scope and the archived-status rule, both of which it does. Minor gap: no note on behavior when the id does not exist or belongs to a different scope.

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 baseline is 3, and the description goes further by explaining the significance of the status parameter for archived/soft-deleted policies, which is the non-obvious piece. The id parameter's format is already in the schema, so nothing is lost.

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") and even enumerates what the returned record contains (conditions, grouping, unit, value, target, scope, status). This clearly distinguishes it from list_rate_limits and the update/create/delete siblings.

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

Usage Guidelines3/5

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

Implies retrieval-by-id usage and adds one conditional instruction: pass archived status when retrieving a soft-deleted policy. It does not explicitly point to list_rate_limits for discovery or state when this tool should be preferred over it, so guidance is present but requires modest inference.

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