Create private key

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

Annotations already indicate a write operation (readOnlyHint=false) and non-destructive (destructiveHint=false). The description adds the behavioral constraint that the private_key must be the full PEM-encoded key, which is useful beyond annotations, but does not disclose other side effects or prerequisites.

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 concise sentences front-load the purpose and provide a critical parameter detail with no wasted words.

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 the simple 3-parameter create operation and annotation coverage, the description is adequate but does not mention the return value or any caveats about the key creation process. With no output schema, a brief note about the response could improve completeness.

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 explicitly explains the required private_key parameter, noting the PEM-encoded format, which adds meaning beyond the schema. However, name and description parameters are not described, though they are self-evident from their names.

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 states 'Create a new SSH private key' with a specific verb and resource, clearly distinguishing it from sibling tools like listPrivateKeys, getPrivateKey, updatePrivateKey, and deletePrivateKey.

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 verb 'Create' implies this is for new keys, and the note about the private_key field provides input guidance. However, there is no explicit discussion of when to use this versus the update or delete alternatives, so it's only implied usage.

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