pbs_group_notes_set

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

With no annotations, description covers mutation nature, risk level, dry-run behavior (captures notes for revert), synchronous execution, null return, and config requirement. Lacks explicit permission details but otherwise thorough.

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?

Compact yet informative, uses structured sections (MUTATION, RISK_LOW, etc.). Slightly dense but no superfluous content. Effective front-loading.

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 tool complexity (mutation, dry-run, multi-target) and presence of output schema, description covers behavior, return format, and requirements. Missing error scenarios but still reasonably complete.

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% (baseline 3). Description adds value by explaining dry-run behavior for confirm, namespace omission, and multi-target config for proximo_target. Slight redundancy with schema but adds nuance.

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 explicitly states 'set the notes body for a backup GROUP' and distinguishes from pbs_snapshot_notes_set. Clear verb and resource identification with sibling differentiation.

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?

Provides context: dry-run default, confirm to execute, requires PROXIMO_PBS_* config, and differentiates from snapshot tool. Does not explicitly exclude other scenarios but gives sufficient guidance.

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