dokploy_deployment

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

No annotations are provided, and the description only notes a limitation (no per-deployment log retrieval). It does not disclose behavioral traits such as destructive nature (killProcess), authentication needs, rate limits, or side effects, leaving a significant gap.

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 extremely concise—two sentences with no wasted words. It front-loads the purpose, then lists parameter-action mappings, and ends with a critical note about log retrieval limitations.

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 complexity (7 parameters, no output schema, low schema coverage), the description lacks details on return values, error conditions, and the operational semantics of 'killProcess'. The log note adds value but does not fully cover behavioral context.

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 low (29%), but the description adds meaning by mapping parameters to actions (e.g., 'list: applicationId|composeId|serverId|type+id') and clarifying valid resource types for the 'type' parameter. This compensates for the sparse schema descriptions.

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 with explicit actions ('list', 'killProcess') and how each action uses parameters. It distinguishes itself from siblings by noting that log retrieval is not available here, pointing to alternative tools.

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 guidance on when to use the tool (for listing or killing deployments) and when not to (for per-deployment logs), referring to alternative endpoints like dokploy_application and *.readLogs.

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