pbs_traffic_control_upsert

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

With no annotations provided, the description fully covers behavioral aspects: it is a mutation with create/update detection, dry-run capability, risks of throttling backups, and no rollback primitive. It also mentions the underlying HTTP methods (POST/PUT) and dispatches accordingly.

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 well-structured with clear sections: purpose, behavior, risks, usage, and API details. It is slightly verbose but every sentence contributes value. Front-loads key information (mutation, dry-run). Could be more concise without losing clarity.

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 the complexity (10 parameters, mutation, create/update logic) and absence of annotations, the description covers all necessary aspects: purpose, usage guidelines, behavioral risks, and parameter hints. It also references sibling tools and provides smoke-test advice. The presence of an output schema reduces the need to describe return values.

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 the baseline is 3. The description adds brief context about rate-in/rate-out and other param names but does not significantly extend beyond the schema's own descriptions. The warning about too-low rates is helpful but not parameter-specific enough to raise the score.

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 it is a mutation tool for creating or updating PBS traffic-control rules, specifying bandwidth-limit rules. It distinguishes itself from siblings like pbs_traffic_controls_list and pbs_traffic_control_delete by mentioning them explicitly. The verb 'upsert' and resource 'traffic-control rule' are well-defined.

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 gives explicit guidance: dry-run by default, confirm=True to execute. It recommends using pbs_traffic_controls_list to see existing rules first, and mentions pbs_traffic_control_delete as alternative for removal. This helps the agent decide when to use this tool vs siblings.

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