Skip to main content
Glama

update_rate_limit

Destructive

Modify a rate-limit policy by ID to change its name, reset unit, limit value, or non-empty conditions; type, target, and grouping remain fixed after creation.

Instructions

Update a rate-limit policy's name, unit, value, or non-empty conditions by id. The public contract does not allow changing its type, target, or grouping after creation.

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": "update_rate_limit"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesRate-limit policy UUID
nameNoReplacement display name
unitNoReplacement reset interval
valueNoReplacement maximum
conditionsNoReplacement conditions

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. Changed9 schema fields changedv0.11.5
    • addedInput schema / properties / conditions
      Added value: +{
      +  "description": "Replacement conditions",
      +  "items": {
      +    "properties": {
      +      "excludes": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "minItems": 1,
      +            "type": "array"
      +          }
      +        ],
      +        "description": "Values to exclude"
      +      },
      +      "key": {
      +        "description": "Match key such as api_key, virtual_key, provider, config, prompt, model, endpoint_type, mcp_server, mcp_tool, workspace_id, or metadata.*",
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "value": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "items": {
      +              "type": "string"
      +            },
      +            "minItems": 1,
      +            "type": "array"
      +          }
      +        ],
      +        "description": "One value or several OR-matched values; use * for wildcard matching"
      +      }
      +    },
      +    "required": [
      +      "key",
      +      "value"
      +    ],
      +    "type": "object"
      +  },
      +  "minItems": 1,
      +  "type": "array"
      +}
    • 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
    • changedInput schema / properties / name / description
      Previous value: -"New name for the rate limit"New value: +"Replacement display name"
    • changedInput schema / properties / unit / description
      Previous value: -"New time unit: 'rpm' (per minute), 'rph' (per hour), or 'rpd' (per day)"New value: +"Replacement reset interval"
    • changedInput schema / properties / unit / enum
      Previous value: -[
      -  "rpm",
      -  "rph",
      -  "rpd"
      -]New value: +[
      +  "rpm",
      +  "rph",
      +  "rpd",
      +  "rpw"
      +]
    • changedInput schema / properties / value / description
      Previous value: -"New maximum allowed value per unit"New value: +"Replacement maximum"
    • removedInput schema / properties / value / exclusiveMinimum
      Removed value: -0
    • addedInput schema / properties / value / minimum
      Added value: +0
  4. Addedv1.0.1
  5. Removed
  6. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=false, and openWorldHint=true, so the safety profile is carried. The description adds real value beyond that by disclosing the immutability contract — type, target, and grouping are frozen after creation — which is not in the annotations or schema. It does not disclose whether omitted fields are preserved or cleared, nor whether conditions are replaced wholesale.

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, both earning their place: the first states the operation and mutable surface, the second front-loads the key constraint. No filler, no restatement of the title.

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?

With an output schema present, return values need not be explained, and the safety annotations cover the destructive profile, so the description is nearly complete. The remaining gap is update semantics — whether unspecified fields are left untouched or reset — which matters for a destructive call on a 5-parameter tool.

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 lifts it by mapping the parameter set to the allowed mutation surface and explicitly excluding non-parameters (type, target, grouping) that an agent might otherwise try to pass. It still leaves the partial-update semantics of omitted parameters unstated.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb ('Update') and resource ('a rate-limit policy'), and enumerates the mutable fields (name, unit, value, conditions) keyed by id. It is unambiguous about what the tool does, but it never names a sibling (e.g. create_rate_limit, update_usage_limit) to sharpen the boundary for an agent choosing between similar update tools.

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?

It effectively states a when-not condition: type, target, and grouping cannot be changed after creation, which implicitly points an agent elsewhere. However, it stops short of saying what to do instead (delete and recreate, or use another tool), and gives no guidance on when to prefer this over update_usage_limit or the peripheral update_* siblings.

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