pbs_job_update

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

Labels as MUTATION, explains dry-run behavior and execution safety with confirm flag. Discloses that it captures current config on dry-run. No annotations exist, so description carries full burden; it adequately conveys behavioral traits.

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?

Two concise sentences, front-loaded with 'MUTATION:', no fluff. Could include brief param descriptions but remains efficient.

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?

Covers main behavioral aspects (mutation, dry-run, config requirement) but lacks thorough parameter explanations for 7 parameters. Output schema exists, so return values are covered elsewhere, but for a tool of this complexity, more parameter detail would improve completeness.

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 description coverage is only 14% (only proximo_target has a description). The tool description only explains job_type values and confirm usage. Other critical parameters like job_id, ns, comment, schedule are not described, leaving the agent without clarity on their purpose.

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?

Clearly states 'update a PBS scheduled job', specifying the resource and action. Includes job_type values (sync|verify|prune) which distinguishes from sibling tools like pbs_job_create, pbs_job_delete, pbs_job_run.

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 explicit usage pattern: dry-run by default, confirm=True to execute. Mentions prerequisite 'Needs PROXIMO_PBS_* config'. Does not explicitly state when not to use or contrast with alternatives, but gives clear instructions.

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