ddev_snapshot

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

With no annotations, the description must carry the full burden of behavioral disclosure. It mentions the storage location (.ddev/db_snapshots) and the -y flag to skip confirmation, which provides some safety context. However, it does not disclose that 'cleanup' is destructive (deleting snapshots) or that 'restore' overwrites the current database, which are significant behavioral traits for an agent to know.

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 densely packed but well-organized, front-loading the core purpose and then listing actions and flags. It includes a usage line and pointers to help commands, with no redundant or filler sentences.

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's complexity (six parameters, four actions, no output schema), the description covers all actions and key flags, and references 'ddev help snapshot' for full options. It does not describe output format or fully clarify projectPath usage, but it is otherwise adequate for an agent to execute the main workflows.

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 100%, so the baseline is 3. The description adds meaningful semantics by clarifying that 'name' is for create, 'snapshotName' is for restore, and that '--latest' can substitute for a snapshot name. This goes beyond the schema's generic descriptions and guides correct parameter usage.

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 opens with 'Create, list, restore, or cleanup database snapshots', clearly specifying the verb and resource. It further distinguishes the tool by noting snapshots are stored in .ddev/db_snapshots, which separates it from sibling database tools like import/export.

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 instructions, e.g., 'Restore with action=restore and snapshotName; use ddev snapshot restore --latest for latest.' It also lists all actions and flags, giving clear context for each. It does not explicitly exclude any sibling tools, but the multi-action scope makes internal guidance sufficient.

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