jlcpcb_tdp_order_detail

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

With no annotations, the description carries full burden but only discloses that API credentials are required and that it is an official 3D-printing API. It does not describe response format, rate limits, or error behavior, though the read-only nature is implied.

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?

The description is front-loaded and uses only 17 words to convey the domain, action, input, and credential requirement—every word serves a purpose.

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 single-parameter lookup tool, the description adequately conveys the input and purpose, but could optionally mention what kind of details are returned or provide links to related tools to be fully context-rich.

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% with a clear description for batch_num, and the tool description repeats the need for a batch number without adding semantic detail 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?

The description uses a specific verb ('get') and resource ('3D-printing order's details') along with the required batch number, clearly distinguishing it from sibling tools like jlcpcb_tdp_order_list (list) and jlcpcb_pcb_get_order_detail (PCB domain).

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 description implies usage when you have a batch number and need order details, and specifies the 3D-printing domain, but it does not explicitly mention alternatives or exclusions, such as using jlcpcb_tdp_order_list for a list of orders.

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