dokploy_backup

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

No annotations exist, so description carries full burden. It explains parameter mappings and action semantics (e.g., manualBackup types), but does not disclose potential side effects (e.g., remove is destructive, no warning). Lacks details on auth or rate limits, but covers basic behavior.

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 well-structured with colons separating actions and parameters, and is front-loaded with 'Manage backups.' However, it is somewhat dense and could be slightly more concise by breaking into bullet points.

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?

Covers all six actions with detailed parameter requirements, including edge cases for compose stacks. Missing output/return value descriptions (no output schema), but the tool complexity (19 params, 6 actions) demands comprehensive coverage, which is mostly achieved.

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 only 16%, but the description adds rich meaning: it explains how databaseType determines which ID parameter to use (postgres→postgresId, etc.), and clarifies compose stack usage. This compensates heavily for the schema's lack of 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 it manages backups, and enumerates specific actions (create, get, update, remove, listFiles, manualBackup) with distinct parameter requirements, effectively distinguishing from sibling tools like dokploy_database or dokploy_compose.

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?

Provides explicit guidance per action (e.g., create requires schedule+prefix+destinationId+database+databaseType, with databaseType-specific ID mapping). Includes special cases like compose stack backups. No alternative tools mentioned, but the context of sibling tools is sufficiently distinct.

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