Revoke API Key

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

Beyond the destructiveHint annotation, the description discloses critical behavioral consequences: permanence ('Permanently revoke'), immediate loss of access for applications, and irreversibility ('cannot be undone'). This adds substantial value beyond the bare annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three concise sentences, each earning its place: the action, the immediate effect, and the irreversibility. No wasted words or redundancy, and it is fully front-loaded with the core purpose.

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

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

For a simple one-parameter destructive operation with no output schema, the description covers all essential aspects: permanent revocation, immediate access loss, and irreversibility. It is complete and appropriately sized for the tool's complexity.

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

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

The input schema has 100% coverage for the only parameter (apiKeyId) with a clear description: 'The unique identifier of the API key to revoke.' The tool description adds no additional parameter-specific meaning, but the schema is already fully descriptive, so the baseline of 3 is appropriate.

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

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

The description clearly states the action: 'Permanently revoke an API key.' It uses a specific verb (revoke) and resource (API key), and distinguishes it from sibling tools like create_api_key and list_api_keys. The phrase 'This action cannot be undone' further clarifies the scope.

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

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

The description provides clear context for when to use this tool by stating 'Any applications using this key will immediately lose access' and 'This action cannot be undone.' This implicitly advises caution and conveys the impact, though it does not explicitly mention alternatives or when not to use it.

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