parse_edi_endpoint_v1_logistics_edi_parse_post

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

No annotations are provided, so the description carries the full burden. It responsibly discloses the 5-credit cost and the current 850-optimization limitation, setting expectation about scope. However, it does not disclose behavior on malformed/non-850 input, failure modes, or output shape, which would matter for a parsing tool with no annotation safety profile.

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 short, dense sentences with zero waste. The purpose is front-loaded, followed by the optimization caveat and the cost disclosure. 'Costs 5 credits' is an extra detail but genuinely useful for a billing-qualified endpoint and earns its place.

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?

With no output schema present, the description does not describe the structure of the returned JSON, which an agent might want when deciding to call this tool. However, the single parameter is fully covered by the schema and the tool's scope is clearly stated. Adequate but the missing return-shape guidance is a gap.

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 100% and the single parameter 'raw_edi' is already fully described in the schema ('Raw ANSI X12 EDI string to parse'). The description adds no new meaning beyond what the schema provides, so the high-coverage baseline of 3 applies. No extra format or validation detail is given.

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 ('Parses'), a precise resource ('raw ANSI X12 EDI string'), and a clear output ('structured JSON'). It also names the document type (850 Purchase Order) which distinguishes this from the many other parse siblings (parse_bank_statement, parse_xml_flatten, parse_trade_history). Purpose is unambiguous.

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 note 'Currently optimized for 850 (Purchase Order) documents' gives useful context about when this tool is best suited, implying it may underperform on other EDI document types. However, it does not name any alternative tools for non-850 EDI or explicitly state when NOT to use it, leaving routing to inference.

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