coolify_create_private_key

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

With no annotations, the description must fully disclose behavior. It only states the creation action but does not explain side effects (e.g., behavior on duplicate name, key validation, persistence, or return value). The '[WRITE]' prefix adds minimal transparency. Critical behavioral traits such as error conditions or idempotency are omitted.

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 with a useful '[WRITE]' prefix. Every word carries meaning and there is no redundancy. It is appropriately sized and front-loaded.

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 tool's complexity (3 parameters, no output schema, no annotations), the description is insufficient. It does not explain expected return values, potential failure modes (e.g., duplicate name, invalid key format), or pre-conditions such as the key being unique. The agent lacks critical context to handle the tool robustly.

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 the baseline is 3. The description adds context that the key is used for server/application authentication, which complements the schema parameter descriptions. However, it does not elaborate on specific parameters beyond the schema.

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 action ('Create') and the resource ('SSH private key') and its purpose ('for server/application authentication'). The '[WRITE]' prefix explicitly marks it as a write operation. It is distinct from sibling tools like 'coolify_update_private_key' and 'coolify_delete_private_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 provides no guidance on when to use this tool versus alternatives. For example, it does not mention that this is for adding a new key before associating it with a server, nor does it differentiate it from 'coolify_update_private_key' or 'coolify_delete_private_key'. No prerequisites or exclusions are given.

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