iqms_workorders_post_production

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

No annotations provided, so description carries full burden. It states it posts quantities, implying a write operation, but lacks details on side effects (e.g., status changes, permissions needed, idempotency). The credential requirement is minimal behavioral context.

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?

Very short at one sentence, but it is under-specified rather than concise. Important information is omitted, so brevity is not a virtue here.

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 5 parameters, 2 required, no output schema, and no annotations, the description is severely incomplete. It does not explain what the tool returns, error conditions, or workflow context (e.g., when to post production relative to other operations).

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?

With 20% schema description coverage, the description should add meaning to parameters. It mentions 'made / scrapped' hinting at quantities, but does not elaborate on any of the 5 parameters, their constraints, or relationships. Missing critical info for correct invocation.

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 it posts production quantities against a work order, using verbs 'post' and 'made/scrapped'. The tool's purpose is distinct from siblings like iqms_workorders_create or iqms_workorders_list, though it does not explicitly contrast with them.

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?

No guidance on when to use this tool versus alternatives. The only extra info is 'Requires WebAPI credentials', which is a prerequisite, not usage context. No mention of scenarios or exclusions.

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