dokploy_ssh_key

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

No annotations are provided, so the description carries full burden. It only mentions that organizationId is resolved automatically. There is no disclosure of side effects, error behavior, authentication needs, or rate limits, which is insufficient for a tool with multiple write operations.

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 concise and well-structured: a single-line summary followed by a compact listing of actions with their parameters. No redundant or extraneous information.

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 (multiple actions, 8 params, no output schema), the description covers action-parameter mapping and auto-resolved orgId. However, it lacks details on return values, error handling, and behavior for each action, which are needed for full 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?

The input schema has 8 parameters with only 2 descriptions (25% coverage). The description compensates by mapping which parameters are required for each action, adding significant meaning beyond the raw schema. However, it does not explain the semantics of individual parameters like name or description.

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 starts with 'Manage SSH keys' and lists distinct actions (create, list, get, update, remove, generate), clearly specifying the resource and operations. It differentiates from sibling tools which cover other domains like applications or backups.

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 action-specific parameter requirements (e.g., 'create: name+privateKey+publicKey, description?'), but does not explain when to use each action or compare to other tools. Usage guidance is implied but not explicit.

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