Skip to main content
Glama

update_api_key

Idempotent

Updates an API key's rate limit within the caller's permissions and tenant plan limits. Use it to change requests-per-minute settings for a specific key by its UUID.

Instructions

Update the supplied API key settings within the caller's permissions and tenant plan limits.

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": {
      "key_id": "<key_id>",
      "rate_limit_per_minute": "<rate_limit_per_minute>"
    },
    "name": "update_api_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
key_idYesUUID of the API key to update
rate_limit_per_minuteYesNew requests-per-minute limit, subject to the tenant plan

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.2.4
    • changedInput schema / properties / key_id / description
      Previous value: -"UUID da API Key a atualizar"New value: +"UUID of the API key to update"
    • changedInput schema / properties / rate_limit_per_minute / description
      Previous value: -"Novo limite de requisições por minuto (validado contra plano do tenant)"New value: +"New requests-per-minute limit, subject to the tenant plan"
    • changedInput schema / properties / rate_limit_per_minute / type
      Previous value: -"number"New value: +"integer"
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true and destructiveHint=false, so safety semantics are covered. The description adds useful context not in annotations — that changes are bounded by caller permissions and tenant plan limits — but it does not describe what happens when a requested limit exceeds the plan or whether unlisted settings are left untouched.

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?

A single front-loaded sentence with no filler or repetition. It is efficient, though its brevity comes at the cost of the usage and scope detail noted in other dimensions.

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

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With only two required parameters, no nested objects and no output schema, the description is roughly adequate to invoke the tool correctly. It omits, however, any mention that rate_limit_per_minute is effectively the sole updatable field and says nothing about failure behavior when the tenant plan is exceeded.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so both key_id and rate_limit_per_minute are fully documented in the schema, establishing a baseline of 3. The description reinforces the tenant-plan constraint on the rate limit but adds no format, range, or error semantics beyond what the schema already states.

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?

States a specific verb ("Update") plus resource ("API key settings") and scopes it to the caller's permissions and tenant plan, so the agent knows this is a mutation on an existing key. It does not explicitly distinguish itself from siblings like create_api_key or delete_api_key, but the verb/resource pairing is unambiguous enough to select it.

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

Usage Guidelines2/5

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

There is no when-to-use vs when-not guidance, no mention of prerequisites such as owning the key, and no reference to alternatives like create_api_key or delete_api_key. The word "settings" is plural while the schema exposes only rate_limit_per_minute as updatable, which could mislead an agent into expecting broader editability.

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