Query Records

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

With zero annotations provided, the description carries full behavioral disclosure burden but offers minimal detail. While 'Query' implies a read-only operation, the description doesn't confirm safety, disclose default limits (though maxRecords default is in schema), mention pagination behavior, or explain that OData syntax errors will cause failures.

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 at six words with no filler. The single sentence efficiently conveys the core mechanism. However, given the tool's complexity (4 parameters, OData syntax requirements, multiple siblings), this brevity borders on under-specification rather than optimal information density.

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 identifies the OData querying paradigm, which is essential context. However, given the absence of annotations and the presence of many specialized retrieval alternatives, it inadequately contextualizes when this generic query tool is appropriate. The output schema covers return values, but operational scope remains under-explained.

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 description coverage is 100%, establishing a baseline of 3. The description mentions 'OData filter expression' which aligns with the filter parameter, but adds no semantic detail beyond the schema for entityNamePlural, maxRecords, or environment parameters.

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 records and specifies the OData filter mechanism. However, it fails to distinguish from the sibling 'get-record' tool (likely for single-record retrieval by ID) or clarify that this returns multiple records, which is implied by the entityNamePlural parameter but not stated.

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 guidance provided on when to use this generic query tool versus the many specific 'get-*' siblings (e.g., get-flows, get-solutions). No mention of prerequisites, performance considerations for large datasets, or when to prefer specific entity getters over this flexible but potentially slower query method.

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