Query R365 OData Entity

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. The description adds behavioral details: it uses OData protocol, default top=100, max=1000, and pagination via skip. 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?

Extremely concise: one sentence for purpose, followed by a bullet-list of arguments. No redundant information. Every sentence adds value.

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 6-parameter read-only query tool with no output schema, the description covers all param semantics, defaults, and protocol (OData). It doesn't describe the return format, but OData implicitly provides structured JSON responses. Slight gap but acceptable.

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 only 17% (entity description). The description adds meaning to all params: entity as 'OData view name', filter as '$filter expression', select as '$select comma-separated fields', orderby as '$orderby expression', and specifies defaults and bounds for top and skip. This significantly compensates for the schema gap.

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: 'Run a read-only OData query against any R365 entity.' This specific verb+resource combination distinguishes it from siblings like r365_list_entities (lists entities) and r365_get_transactions (specific transaction queries).

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?

No explicit guidance on when to use this tool versus alternatives like r365_get_transactions or r365_list_locations. The description implies it's for generic OData queries but doesn't specify use cases or exclusions.

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