api_keys_revoke

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

With no annotations, description must disclose behavior. It clearly states 'Permanently revoke' and 'Irreversible', highlighting destructive nature. However, it omits details like required authentication, error handling if key not found, or side effects on active sessions.

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?

Extremely concise with two short sentences. Front-loaded with the core action. No unnecessary words.

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?

Given the irreversible nature and no output schema or annotations, the description is too brief. It lacks information about success/failure responses, error conditions, or confirmation steps. Leaves gaps for a critical operation.

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 covers the single required parameter 'keyId' with description. The tool description adds emphasis on irreversibility but no additional semantic context for the parameter beyond what schema provides.

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?

Description clearly states the action (revoke) and resource (API key), distinguishing it from sibling tools like api_keys_list, api_keys_create, and api_keys_rotate. The word 'Permanently' and 'Irreversible' add specificity.

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?

No explicit guidance on when to use this tool versus alternatives (e.g., rotate vs revoke). No prerequisites or conditions like key must exist or be active.

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