iqms_quality_create_ncr

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

With no annotations, the description should disclose behavior (e.g., creating records, side effects). It only states credential requirements, leaving the agent unaware of mutations or consequences.

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?

While very short (10 words), it sacrifices necessary detail for brevity. The description is under-specified and does not effectively convey the tool's purpose or constraints.

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 and 4 undocumented parameters, the description fails to provide complete guidance for usage. It omits return values, error handling, and parameter meanings.

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 description coverage is 0%, and the description adds no meaning to parameters. The four parameters (item_number, work_order_id, description, reported_by) are not explained, making their roles unclear.

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 uses 'Open' which is ambiguous for a creation tool. The name suggests creation, but 'Open' could imply viewing an existing record. It provides a general sense of what it does but lacks specificity.

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?

Only mentions 'Requires WebAPI credentials' as a prerequisite. No guidance on when to use this tool versus siblings like 'iqms_quality_ncrs' or other workflow tools.

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