snapshot_list

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

No annotations provided; description starts with [READ] stating read-only intent. However, it does not disclose auth requirements, rate limits, return format, or potential side effects (though none expected). Basic transparency but missing details.

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: two sentences plus Args lines. Front-loaded with [READ] and purpose. Every sentence adds value without 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?

No output schema, and description does not mention return format (e.g., list of snapshot names, IDs, timestamps). For a listing tool, this is a notable gap. With low complexity, more completeness expected.

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 meaning by specifying 'dataset' as a dataset path (e.g., 'tank/data') and 'target' as a TrueNAS target name from config, which is beyond the schema. However, 'target' is vaguely described, and schema coverage is 0%, so only partial compensation.

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 'List ZFS snapshots' with optional dataset filter, using a specific verb and resource. It distinguishes from siblings (snapshot_create, snapshot_delete) by starting with [READ] and emphasizing listing over mutation.

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 explains optional dataset filter but does not explicitly state when to use this tool vs. alternatives. No mention of prerequisites, exclusions, or when not to use. Adequate but could be improved.

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