cloud_update_ssh_key

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

No annotations are provided, and the description only states the action without disclosing side effects, such as whether the change affects existing servers using the key, permissions required, or any irreversible consequences. This is a significant gap for a mutation tool.

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 a single sentence, which is concise, but it omits important contextual information. While brevity is valued, the tool's definition is under-specified, reducing its effectiveness. It could be more informative without sacrificing conciseness.

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?

Despite having an output schema, the description fails to address prerequisites, immediate effects, or error conditions. With no annotations and minimal parameter explanation, the tool definition is incomplete for an agent to confidently invoke the tool.

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 0%, so the description must compensate. It lists the updatable fields ('name or labels') but does not explain the data types (string, object) or the required ssh_key_id parameter. The description adds minimal value beyond the schema, leaving users to infer parameter details.

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 verb 'Update' and the resource 'SSH key', and specifies the modifiable fields (name or labels). It distinguishes from sibling tools like cloud_create_ssh_key, cloud_delete_ssh_key, and cloud_get_ssh_key, making the tool's purpose unambiguous.

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 implies usage for modifying existing SSH keys but provides no explicit guidance on when to use it versus alternatives (e.g., recreating the key) or prerequisites (e.g., the key must exist). The context is minimally adequate but lacks proactive direction.

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