manage_api_keys_revoke

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

Discloses the soft-delete nature (restorable), which is crucial behavioral context not found in annotations. However, with no annotations provided, the description carries the full burden and lacks details on immediate effect (does the key stop working instantly?), restoration mechanics, or prerequisite permissions.

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?

Front-loaded main action in the first sentence. Uses standard docstring format (Args/Returns) efficiently. No redundant text, though the Returns section is minimal given the lack of output schema.

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?

Appropriately complete for a single-parameter tool with no output schema. Documents the parameter, describes the soft-delete behavior, and indicates return type. Missing only advanced behavioral context like side effects or rate limits.

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?

With 0% schema description coverage, the description compensates by documenting the 'key_id' parameter as 'Key ID to revoke', adding necessary semantic meaning absent from the bare schema. Could add detail on ID format or source.

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?

Explicitly states the action (Revoke) and resource (API key). Critically distinguishes itself from the sibling 'manage_api_keys_delete' by specifying '(soft delete - can be restored)', clarifying this is reversible deactivation versus permanent removal.

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?

Impludes usage context through 'soft delete - can be restored', suggesting use when temporary revocation or future restoration is needed. However, it does not explicitly state when to prefer the sibling 'delete' operation (permanent) vs this 'revoke' (soft).

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