Create work order

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

Beyond the annotations, it discloses the created status (Open), issuer (signed-in user), recipient (project's customer), that there are no line items, that nobody is notified, and that the order is returned on success. This is rich mutational context the annotations do not carry.

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?

Front-loaded with the outcome, but the second sentence re-states subject, description and dates already given in the first, wasting space. It is efficient in tone but contains noticeable redundancy.

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 create tool with annotations covering safety and no output schema, the description supplies the full behavioral picture plus a return-value note ('Returns the saved order'). Nothing an agent needs to invoke it correctly is missing.

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 coverage is 80% and already documents project_id, subject, description, and date defaults/format. The description names the same fields but adds no syntax or constraint detail beyond the schema, so it sits at the baseline.

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 specific verb (Creates) and resource (work order) with the resulting status (Open) and key fields, and distinguishes the operation from the large create_* sibling set. An agent can tell exactly what it produces without opening the schema.

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?

Routes the agent to update_work_order_status for advancing status and clarifies that sending to the customer 'stays a step in the app', implicitly steering away from any send tool. No explicit when-not guidance, but the lifecycle context is clear.

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