solidworks_batch

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

Beyond annotations, it discloses ordering guarantees, stop-at-first-error behavior, reporting of completed steps, and that earlier mutations remain applied, explicitly denying rollback semantics.

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 compact sentences front-load the purpose, then provide the reference syntax and the essential caveat. There is no filler or redundant detail.

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 ordering, error behavior, side-effect persistence, and result referencing. With an output schema present it need not detail return shape, but background semantics and action meanings are not explained.

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?

Adds meaning by explaining the {$result:'step_id',path:['value','$ref']} reference syntax for id/target/value, but does not explain the background parameter or the action enum values call/get/set.

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?

States a clear, specific purpose: execute ordered API steps without interleaving. It distinguishes batch execution from single-step API calls and clarifies that it is not a rollback transaction.

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?

Implies use for ordered/dependent steps and cautions against assuming rollback, but does not explicitly contrast with alternatives such as solidworks_api or solidworks_array or state when to prefer this batch variant.

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