jlcpcb_pcb_get_order_detail

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

With no annotations, the description carries the full burden of behavioral disclosure. It adds the useful requirement of API credentials, which is a significant operational constraint. However, it does not mention read-only status, error handling, or the shape of the returned data, leaving some behavioral ambiguities for a simple getter.

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 brief and front-loaded with the tool's core purpose ('Official PCB API'). The single sentence is efficient, though the credential requirement could be integrated more seamlessly. No unnecessary words or repetition.

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?

Although the tool is simple with one parameter, the absence of an output schema and the lack of any mention of what the returned order detail contains leaves the description somewhat incomplete. The sibling context helps disambiguate but does not substitute for describing the return value or typical response behavior.

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%, so the schema already documents the batch_num parameter with a description. The tool description merely repeats 'by batch number' without adding syntax, format details, or examples, placing it at the baseline score of 3.

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 clearly states the verb 'get', the resource 'order details', and the unique identifier 'batch number'. This distinguishes it from sibling tools like jlcpcb_pcb_get_audit_info and jlcpcb_pcb_get_wip_process, which focus on different PCB order aspects.

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 need order details by batch number, but it does not explicitly state when to prefer this over alternatives such as jlcpcb_tdp_order_detail or other order-related tools. No exclusions or alternate tool references are provided.

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