pbs_datastore_update

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

No annotations provided, so description bears full burden. It discloses mutation type, dry-run default, capture-and-plan behavior, failure handling, cluster-wide impact of gc/prune schedules, and no rollback primitive. This is thorough, though the smoke-confirm note could be clearer.

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?

Front-loaded with purpose and dry-run info. Uses clear bullet-like structure. The PUT endpoint line and smoke-confirm note are slightly extraneous but not wasteful. Could be trimmed slightly, but overall well-organized.

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 7 parameters, no annotations, and presence of output schema, the description covers behavioral nuances, usage, and parameter effects sufficiently. It doesn't explain return values (handled by output schema). Comprehensive enough for agent decision-making.

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%, so parameters are already described. The description adds value by explaining cluster-wide impact of gc_schedule and prune_schedule, and notes the hyphenated vs underscored parameter naming convention. This extra context justifies a 4.

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: 'update PBS datastore configuration' with a dry-run default. It distinguishes itself from sibling tools pbs_datastore_get (inspect) and pbs_datastore_delete (remove), providing specific verb+resource+context.

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?

Explicit guidance is given: dry-run by default, use confirm=True to execute, and alternative tools for inspection or deletion are mentioned. Also advises reverting by re-applying captured config, which helps decide when to use this tool.

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