Skip to main content
Glama

revoke_api_key

Revoke one of the caller's API keys by uuid, so it stops authenticating at once. Use it to retire a leaked or unused key; find the uuid with list_api_keys. Repeating the call on an already revoked key returns the same result. Requires the api_keys:revoke scope.

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_uuid": "<key_uuid>"
    },
    "name": "revoke_api_key"
  }
}

Input Schema

NameRequiredDescriptionDefault
key_uuidYesPublic UUID of the key to revoke, as returned by create_api_key or list_api_keys.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses immediate effect ('stops authenticating at once'), idempotency on repeat calls, and the required api_keys:revoke scope. It stops short of saying the revocation is permanent/irreversible (i.e., that a replacement key must be created), which for a destructive write with zero annotation coverage would be worth stating.

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?

Three short sentences, front-loaded with the action and its effect, then discovery, then idempotency and scope. Every sentence earns its place with no redundancy.

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?

For a one-parameter mutation tool with no annotations and no output schema, the description covers effect, idempotency, discovery path, and auth scope. The one remaining gap is what a successful call returns (only hinted at via 'returns the same result'), which matters slightly more given there is no output schema.

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 description coverage is 100% and the single key_uuid parameter is already documented with its source (create_api_key or list_api_keys). The description adds a little navigation ('find the uuid with list_api_keys') but no format or validation detail beyond the schema, so baseline 3 applies.

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 ('Revoke one of the caller's API keys by uuid') plus the effect ('stops authenticating at once'). It is clearly distinguishable from siblings like create_api_key and list_api_keys without opening the schema.

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

Usage Guidelines5/5

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

Names the use case ('retire a leaked or unused key') and routes the agent to the sibling that supplies the required input ('find the uuid with list_api_keys'). The prerequisite scope is also stated, so nothing about when/how to invoke is left to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources