Create draft freight order

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

Discloses key behaviors: it creates a draft (not purchase), returns shipment_order_id, and can update existing drafts. Annotations already provide read/write and destructiveness info; description adds context about the return value and update capability.

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 sentences, no wasted words. Front-loaded with the main action 'Create a draft freight order'. Every sentence adds distinct information: action, non-purchase, return value, update capability.

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 complex tool with 11 parameters, nested objects, and no output schema, the description is minimal but sufficient given thorough schema descriptions. It clarifies the draft nature and update path, though it omits details like date/time format requirements (handled by schema).

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 has 100% coverage with descriptions. The description adds value by explaining that 'shipment_order_id' can be passed to update an existing draft, tying the parameter to the tool's dual behavior (create/update). This contextualizes the parameter beyond the schema.

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 the verb 'Create' and the resource 'draft freight order', with scope 'visible on the Open Orders page'. Distinguishes from purchasing by saying 'Does not purchase'. Differentiates from siblings like 'deftship_ship_freight' and other create tools.

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?

Explicitly says when to use (create draft) and mentions update via 'shipment_order_id'. Implies when not to use ('Does not purchase') referencing purchase tools like 'deftship_ship_freight'. Could be more direct about alternatives.

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