revoke_api_key

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It discloses immediate effect ('loses access right away'), irreversibility ('Cannot be undone'), and the risk of self-disruption (current session key). This is substantial behavioral transparency beyond just saying 'revoke'.

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 sentences, each serving a distinct purpose: the action, the consequence, and the warning. It is front-loaded with the primary action and avoids any repetition or filler.

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?

The tool has one well-documented parameter and no output schema. The description covers the action, the immediate effect on existing users, irreversibility, and the need for user confirmation. Nothing essential is missing for an agent to invoke this tool safely and correctly.

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?

Schema description coverage is 100% for the single id parameter, and the property description 'API key id, from list_api_keys' already provides the necessary semantic meaning. The tool description does not add any additional parameter-specific context, so the baseline of 3 applies.

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 tool's function: 'Revoke an API key immediately.' It uses a specific verb (revoke) and resource (API key), and the following sentence clarifies the scope of the action. It is distinct from sibling tools like create_api_key and list_api_keys because it focuses on the revocation action.

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 use (revoking a key) and includes an important caution: 'Cannot be undone - confirm with the user before calling this, especially if it might be the key currently in use for this very session.' This gives a concrete condition for when to pause, though it does not explicitly name alternative tools or state when not to use it beyond needing user confirmation.

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