Get a Scaleway IAM SSH Key

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

Annotations already declare readOnlyHint, openWorldHint, idempotentHint true and destructiveHint false. The description adds value by specifying that the response includes the full public_key text and fingerprint, which is not captured in annotations. No contradictions with annotations.

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 of 12 words with no wasted content. It is front-loaded with the core action and immediately followed by key return details. Every word earns its place.

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?

For a simple read operation with one parameter, the description adequately states the purpose and key return fields (public_key text, fingerprint). However, it does not mention other likely fields (id, name, timestamps) nor does it explain the parameter format. The absence of an output schema increases the need for description completeness; the current description is mostly sufficient given low complexity.

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% for the only parameter ssh_key_id. The description only says 'by id', which minimally implies the parameter's role but does not explain its format (UUID), origin, or constraints. With no param descriptions in schema, the description should compensate but does not provide sufficient detail.

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 uses the specific verb 'Read' and identifies the resource 'one SSH key by id'. It further specifies what is included in the returned data (public_key text and fingerprint), clearly differentiating from sibling tools like list_ssh_keys, create_ssh_key, update_ssh_key, or delete_ssh_key.

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 that this tool is for retrieving a single SSH key by ID, but it does not explicitly state when to use it versus list_ssh_keys or other IAM get tools. No when-not or alternative guidance is provided, leaving the agent to infer usage from the verb and resource.

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