dokploy_environment

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

No annotations provided; description lists actions but omits behavioral details such as side effects (e.g., permanency of remove), required permissions, or error conditions. For a multi-action tool, this is insufficient.

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?

Extremely concise: one introductory sentence and a bullet-style list of actions with required parameters. Every word adds value with 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?

For a tool with 5 parameters and no output schema, description covers action-parameter mappings but lacks details on return values, error handling, and field constraints for update. Adequate but not exhaustive.

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?

Description adds mapping of actions to parameters (e.g., create: projectId+name), which schema lacks entirely. However, 'fields' in update is vague, and the 'description' parameter is not explained, 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?

Description clearly states it manages project environments, listing all supported actions with their required parameters. This distinguishes it from sibling tools like dokploy_project or dokploy_application.

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 explicitly maps each action (create, get, list, update, remove, duplicate) to required parameters, providing clear context for when to use each. However, it does not mention when to use alternatives or exclude cases.

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