dokploy_domain

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

No annotations are provided, so the description must disclose behavioral traits. It only lists action syntax without mentioning whether operations are destructive, idempotent, or require specific permissions. No details on side effects or error conditions.

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 colon-separated snippets for each action. It is concise but dense and hard to parse quickly. Better structuring (e.g., bullet points or sections) would improve readability.

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?

With 8 actions and 15 parameters, no output schema, and no explanations for return values or behavior, the description is incomplete. For a complex multi-action tool, more detail is needed on what each action returns and under what conditions it succeeds or fails.

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 13%, but the description adds meaning by specifying which parameters are needed for each action (e.g., create requires host+applicationId|composeId(+serviceName)). However, many parameters like path, port, https, serverIp are not explained in the description, leaving gaps.

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 domains.' and lists all actions (create, list, get, update, delete, generate, canGenerateTraefikMe, validate) with parameter hints. It clearly identifies the tool as a domain manager, distinct from sibling tools managing other resources.

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 but does not offer guidance on when to use this tool versus alternatives (e.g., other dokploy tools). It implicitly covers usage per action, but lacks explicit when-to/when-not-to advice.

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