List ZFS Snapshots

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

The annotations already declare readOnlyHint=true, so the description does not need to restate that. It adds valuable behavioral context by noting that the tool 'Works across TrueNAS versions (the underlying API differs; this tool picks the right one automatically),' which is beyond the annotations and helps the agent trust the tool's compatibility.

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 three sentences, front-loaded with the core purpose, and every sentence earns its place: what it lists, how to handle scale, and cross-version compatibility. No redundancy or filler.

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 provides enough context for a list tool: purpose, usage guidance, and compatibility note. With a full output schema and read-only annotations, nothing critical is missing for the agent to invoke it correctly.

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?

The input schema has 100% coverage with descriptive parameter definitions (e.g., 'Maximum snapshots to return' for limit, 'Only snapshots of this dataset' for dataset). The description only reinforces the dataset filter and pagination advice without adding new syntax or format information, so it meets the schema-driven baseline.

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 uses a specific verb ('List') and a resource ('ZFS snapshots') and adds detail about the returned fields ('creation time and space used'), clearly distinguishing it from sibling tools that list other TrueNAS 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 gives clear context for when to use the tool ('Systems often have thousands of snapshots') and instructs to 'filter by dataset and paginate,' which serves as usage guidance. It does not explicitly exclude alternatives, but the sibling tools are distinct resources, so no exclusion is necessary.

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