Rename a Scaleway IAM SSH Key

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

Annotations indicate destructiveHint: false and idempotentHint: true, so the description does not contradict them. The description adds clarity by explicitly stating that the key material is immutable, which is critical behavioral context not in annotations. It does not cover rate limits or authorization requirements, but the annotations already signal safe mutation.

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?

Two sentences, clear and direct. No filler. Front-loaded with the primary action, followed by important limitation. Excellent 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?

Given no output schema and 2 required params, the description is adequate. It explains the operation, the one constraint (key material immutability), and the alternative action. It misses potential side effects or confirmation of success, but given the simplicity, this is sufficient.

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. The description clarifies that 'name' is the new name and 'ssh_key_id' identifies the key. It adds value by explaining what the parameters are for, beyond the schema's basic types. However, it does not specify minimum length implications or provide examples.

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 purpose: 'Change an SSH key's name.' It specifies the verb (change) and the resource (SSH key name), and distinguishes from the sibling tool scaleway_iam_create_ssh_key and scaleway_iam_delete_ssh_key by explicitly stating that key material cannot be modified here and must be recreated separately.

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 explicitly tells when to use this tool (to change the name) and what not to do (cannot change public_key/fingerprint), directing the agent to delete and recreate for key rotation. It does not, however, mention prerequisites or alternative tools by name among siblings (e.g., scaleway_iam_get_ssh_key to fetch details).

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