pbs_snapshot_notes_set

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

No annotations are provided, so the description carries full burden. It discloses that it is a mutation, dry-run behavior, reads current notes before planning, marks plan incomplete on failure, and does not affect backup data. Revert method is also mentioned. This is good transparency.

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 concise at around 6 sentences, but it is somewhat scattered with separate sections (CAPTURE, revert, endpoint). It is front-loaded with purpose and is not overly verbose.

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 8 parameters (5 required) and an output schema, the description covers purpose, behavior, and dry-run, but does not explain all parameters or describe the response. It is adequate but could be more thorough.

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 low (13%), but the description adds some context: it mentions 'confirm=True to execute' and lists parameter names (backup-type, backup-id, backup-time) and store. However, it does not explain ns, backup_type, backup_id, backup_time, or notes details. 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?

The description clearly states the tool's purpose: 'annotate a PBS snapshot with notes'. It is distinct from sibling tools like pbs_snapshot_delete and pbs_snapshot_protected_set, which deal with deletion and protection, not notes.

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 explains that the tool is a mutation with dry-run by default, and that confirm=True is needed to execute. It also notes it does not affect backup data or retention. However, it does not explicitly compare against alternatives or state when not to use.

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