dokploy_deployment

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

With no annotations, the description must reveal behavioral traits. It discloses that log retrieval is not supported via this tool, but does not elaborate on the destructive nature of 'killProcess', permissions required, or potential side effects.

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 very concise: two sentences with no redundant information. It front-loads the purpose and then provides concrete usage guidance, followed by a caveat about log retrieval.

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 has 7 parameters, no output schema, and includes a destructive action, the description is adequate but not fully complete. It explains how to use parameters but does not clarify return types for list or killProcess, or confirm if killProcess is irreversible.

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 only 29%, but the description compensates by mapping the 'action' parameter to specific required parameters (e.g., for 'list' it indicates need for applicationId, composeId, etc.). This adds meaningful context 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 tool manages deployments and lists specific actions (list, killProcess) with required parameters. It distinguishes itself from sibling tools by noting that log retrieval is not available here, referring to other tools for that purpose.

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 explicit context for when to use this tool, including parameter combinations for each action. It also mentions alternatives for log retrieval, guiding the agent to use dokploy_application or service-scoped endpoints instead.

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