dokploy_server

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

Without annotations, description fails to disclose side effects, required permissions, or safety info for actions like create, update, remove. It only lists parameter requirements, not behavioral traits.

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?

Single sentence with clear structure using colons and slashes. Every piece of information is relevant, no redundancy.

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 12 parameters and 8 actions, the description lacks critical context: no return value info, no explanation of parameters like 'dataPoints', no behavioral details. Annotations missing compound this deficiency.

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 very low (8%). The description adds value by mapping actions to specific required parameters (e.g., 'create: name+ipAddress+port+username+sshKeyId+serverType'), but does not explain individual parameter meanings 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?

Description clearly states 'Manage servers' and enumerates all actions (list, get, create, update, remove, count, publicIp, getMetrics) with their respective parameters. The tool name and sibling differentiation are clear since siblings are different entities.

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?

Description provides no guidance on when to use this tool versus alternatives, nor when to choose one action over another. It only lists actions without context or exclusions.

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