iqms_workorders_create

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

With no annotations, the description carries the full burden. It discloses a specific error ('Returns DriverNotConfiguredError') and a prerequisite, but does not mention other behavioral aspects such as side effects (e.g., state changes) or other possible error conditions. This is adequate but not comprehensive.

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 very short (two sentences) and each sentence adds value: purpose and then prerequisites/error. There is no unnecessary text. It could be slightly more organized but is 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?

Given no output schema, the description should explain return values. It only mentions one error, ignoring typical outputs for a create operation (e.g., created work order ID). It also lacks parameter guidance and context on using the tool alongside other work order tools.

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 input schema has 5 parameters with only 20% description coverage (due_date has 'ISO date'). The description does not mention any parameters by name or provide context for their values. Thus, it adds no meaning beyond the schema, failing to compensate for low schema coverage.

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 'Create a new work order,' which is a specific verb+resource. The tool name itself is descriptive, and among sibling tools (list, get, post_production), it is obvious that this is the creation function. However, it does not explicitly state when to choose this over alternatives.

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 mentions the prerequisite 'Requires WebAPI credentials (licensed module)' and an error condition. This gives some guidance on when to use, but it lacks explicit when-not-to-use instructions or comparisons with other tools like iqms_workorders_post_production.

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