get_locked_inventory

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

With no annotations, the description provides basic behavioral context by specifying the API endpoint and return structure. However, it does not explicitly confirm that the operation is read-only, mention authentication needs, or describe any side effects. It covers the essential but not comprehensive behavioral details.

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 uses clear sections (【用途】, 【呼叫的 Shopline API】, 【回傳結構】) that front-load the purpose and structure. Every sentence is informative and necessary, with no wasted words.

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?

Given no output schema, the description adequately describes the return structure (total and items with fields). It covers the API endpoint and purpose. However, it omits potential details like pagination or limits, but given the tool's simplicity (zero parameters), it is largely complete.

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?

The input schema has no parameters (100% coverage), and the description adds no parameter information because there is none to add. According to guidelines, zero parameters baseline is 4. The description compensates by clarifying what the tool returns, adding value 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 explicitly states the tool retrieves a list of locked/reserved inventory items, using specific verbs and resource ('取得...庫存商品清單'). It clearly distinguishes from sibling inventory tools like get_inventory_overview or get_low_stock_alerts.

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 for analyzing SKUs with reserved quantities but does not explicitly state when to use or not use this tool versus alternatives like get_stock_by_warehouse or get_inventory_overview. No exclusions or comparisons are provided.

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