list_odata_v4_entities

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

No annotations are provided, so the description carries the full burden. It implies a read-only listing operation and provides useful context about the content (raw DAC tables) and the output names. However, it does not explicitly state that it is non-mutating, nor does it disclose possible pagination, rate limits, or return structure beyond the implication that entity set names are returned. This is adequate for a simple list tool but not richly transparent.

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, front-loaded with the core purpose, followed by a meaningful contrast and a direct usage pointer. Every sentence adds value—no filler, tautology, or redundant restatement.

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 zero-parameter, no-output-schema listing tool, the description covers purpose, sibling differentiation, and downstream usage. It includes concrete examples (SOOrder, BAccount, InventoryItem, GLTran) to anchor expectations. It does not detail the exact return format or mention potential large result sizes, but given the simplicity, it is sufficiently complete for selection and invocation.

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 tool has zero parameters, so the baseline is 4. The description adds no parameter-specific detail because none exist, and the input schema is empty, so there is nothing missing. It correctly tells the agent the tool requires no configuration.

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 ('List') and resource ('OData v4 DAC entity sets exposed by Acumatica'), and explicitly distinguishes itself from list_odata_entities by clarifying that it exposes raw DAC tables rather than Generic Inquiries. This makes its purpose unambiguous and differentiates it from a close sibling 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 guidance: it contrasts with list_odata_entities (Generic Inquiries) and explains that the returned names should be used with query_odata_v4. This tells the agent exactly when to choose this tool and what to do with its output, effectively naming the alternative and follow-up.

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