query_odata

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

With no annotations, the description carries the burden of disclosure. It adds value by naming supported OData operators and the prerequisite to list entities, but it omits details like return format, authentication, or error behavior. This is adequate but not comprehensive.

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 only two sentences, front-loaded with the tool's purpose, and every word serves a function. It avoids restating schema details and is highly efficient.

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 the tool's complexity (6 params, no output schema, no annotations), the description covers purpose, prerequisite, and supported options. However, it does not mention the response format or clearly distinguish between query_odata and query_odata_v4, leaving minor gaps.

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%, with each parameter having a detailed description. The tool description merely lists the OData options ($filter, $select, etc.) without adding new meaning beyond what the schema already provides, so it meets the baseline but adds no extra semantics.

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 any Acumatica Generic Inquiry via OData, using a specific verb and resource. It also distinguishes from sibling tools by emphasizing the generic nature and instructing to use list_odata_entities first, though it does not explicitly differentiate from query_odata_v4.

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?

Provides clear context by instructing users to call list_odata_entities first to discover valid entity names. However, it does not mention exclusions or alternative tools like query_odata_v4, so it lacks an explicit when-not-to-use statement.

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