catia_set_batch_mode

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

Annotations already declare idempotentHint=true and readOnlyHint=false. The description adds behavioral details beyond annotations: it changes state (suspend/resume) and warns about the persistent side effect of a frozen-looking viewport if left on. This helps the agent understand the toggle's non-ephemeral nature and the need to reset it.

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?

Three sentences, each earning its place: the first states the purpose, the second explains the benefit, and the third provides a critical warning. The most important information is front-loaded, and there is no wasted text or repetition.

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?

For a simple one-parameter toggle with no output schema, the description covers what, why, when, and a warning. It doesn't mention error conditions or return values, which are not expected for such a tool. The warning about turning it off is crucial for correct usage and is included, making the description sufficient for an agent to call it safely.

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?

The schema already describes the single boolean parameter well ('True to suspend refresh and alerts, False to restore'), with 100% coverage. The description adds meaning by explaining that turning it on makes long sequences faster and stops prompts, giving the agent a clear rationale for setting true vs false. This is a bonus over the schema, not a redundancy.

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 verb 'Suspend or resume' with a specific resource (CATIA's screen refresh and file-alert dialogs). It distinguishes this tool from siblings by focusing on batch mode toggling, which is unique among the many modeling tools listed. There is no ambiguity about the tool's function.

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 context on when to use it: 'long sequences of modelling calls' and explains the benefit (faster execution, stops modal prompts from blocking automation). It also includes a critical caution: 'Always turn it back off when you are done, or the user is left with a frozen-looking viewport.' However, it doesn't explicitly name alternative tools or situations where it should not be used, so it's strong but not exhaustive.

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