kingdee_query_inventory

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

Annotations indicate readOnlyHint=true and no destruction, which the description supports. It additionally describes return format (JSON string with fields) and default filtering, adding value beyond annotations. No contradictions.

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 concise: two paragraphs with purpose, filter examples, and return format. Every sentence is informative and front-loaded.

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 simple query tool with output schema, the description covers essential aspects: what it queries, how to filter, and output format. It could mention pagination behavior, but the parameters are self-explanatory.

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 description provides practical examples for filter_string and lists default fields, adding meaning beyond the schema's descriptions. It compensates for undocumented parameters like start_row and limit by showing default values in 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 clearly states the tool's purpose: querying immediate inventory quantities from the STK_Inventory table. It provides specific filter examples and distinguishes from other query tools by naming the source table and focusing on inventory.

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 offers usage context through filter examples and default behavior, but does not explicitly guide when to use this tool versus sibling query tools like kingdee_query_materials or kingdee_query_stock_bills.

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