Create SSH Key

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

Annotations indicate it is write and not destructive. The description adds context: private key is stored in a hidden field and redacted in summaries, and folder/organization/collection scoping is supported. This goes beyond the schema and 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?

Three sentences, each serving a distinct purpose: what the tool does, when to use it, and behavioral details. No fluff, information is front-loaded in the first sentence.

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 good coverage of purpose and behavior, the description lacks any mention of return values or success/failure indications. Since there is no output schema, this leaves the agent uncertain about what to expect after creation.

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 coverage is 100%, so baseline is 3. The description adds value by noting private key handling (hidden, redacted) and scoping, which are not detailed in the schema descriptions. This enhances understanding of how parameters are used.

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 verb 'Create' and specific resource 'SSH key object' and distinguishes from siblings by stating 'not a login or payment card'. This clearly identifies the tool's purpose among many create-* tools.

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 says 'Use this when you need a public/private key pair plus optional fingerprint or comment' and contrasts with 'not a login or payment card'. While it doesn't cover all siblings, it provides clear the intended use case.

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