query_sales_orders

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

With no annotations, the description carries the transparency burden. It states the tool is a query and supports OData filtering/ordering, implying read-only behavior. But it does not disclose output shape, default pagination limits, or potential performance impacts of includeDetails — though some of this is covered in the schema.

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 two sentences long, front-loaded with the core purpose and followed by usage context and capability. Every sentence adds value without redundancy.

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?

The description is sufficient for a straightforward query tool: it names the inquiry, explains its intended use, and mentions key OData features. The schema provides rich parameter details, compensating for the absence of an output schema or annotations, though it could have noted default pagination behavior explicitly.

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 schema already describes all six parameters with 100% coverage, including examples and constraints. The description adds no parameter-level meaning beyond mentioning OData $filter/$orderby support, which is also in the schema, so the baseline 3 is appropriate.

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 queries Acumatica sales orders via the SO-SalesOrder generic inquiry, with a specific verb and resource. It also explicitly positions it for lists, analytics, and summaries, distinguishing it from the sibling get_sales_order tool.

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 provides clear use cases ('lists, analytics, and summaries') and notes OData $filter and $orderby support, giving context for when to use it. However, it does not explicitly name alternatives or state when not to use it, leaving a minor gap.

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