snapshot_create

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

With no annotations, the description carries the transparency burden. It includes a '[WRITE]' tag, states the side effect (creates a snapshot), and notes that dry_run avoids creation and 'without an undo token', implying normal runs may produce an undo token. It does not mention permissions or error handling, but the provided context is meaningful.

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 compact and well-structured. It starts with a one-line purpose, then an inverse note, a usage hint, and a clear parameter list. Every sentence earns its place with no fluff or repetition.

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?

The description covers all parameters and gives essential behavioral context (dry_run, undo token, inverse). It does not describe return values, but no output schema exists, so that is not required. It also omits prerequisites like dataset existence, but the overall guidance is sufficient for an agent to select and invoke the tool.

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 0%, so the description fully compensates. It explains each parameter with examples (dataset: 'tank/data', name: 'manual-2026-06-28'), clarifies dry_run behavior, and specifies target as 'TrueNAS target name from config'. This adds significant meaning beyond the schema.

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 'Create a ZFS snapshot' with the exact naming format 'dataset@name'. It is a specific verb+resource and distinguishes itself from sibling tools by naming the inverse operation (snapshot_delete).

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?

It explicitly names the inverse tool and gives usage guidance for dry_run ('Pass dry_run=True to preview'). It does not list alternative tools for other scenarios, but the create/delete relationship is clear and adequate for the tool's purpose.

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