Список записей коллекции

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

Annotations declare readOnlyHint, destructiveHint, idempotentHint, and openWorldHint. The description adds beyond these by detailing pagination defaults, context overflow prevention, format options, and the fact that auto_paginate is off by default. No contradictions with annotations.

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, and every sentence provides essential information. No unnecessary words or 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?

Given the tool's complexity (12 parameters, OData features, pagination, output formatting), the description covers the main behavioral aspects. It lacks explicit mention of output structure (though format parameter hints at it) and could elaborate on cursor usage, but overall it provides sufficient context for an agent.

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%, so the baseline is 3. The description provides a high-level summary of OData capabilities but does not add significant new meaning beyond the schema descriptions for individual parameters. It does not deepen understanding of any single parameter.

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 retrieves records from an OData collection with support for filtering, selecting, sorting, expand, and pagination. It distinguishes itself from siblings like bpm_get_record (single record) and bpm_search_records (search) by focusing on list retrieval with OData query options.

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 explains default pagination behavior (auto_paginate off, max_records limit) and provides guidance on when to enable auto_paginate or increase max_records. It also mentions avoiding LLM context overflow. However, it does not explicitly compare to other tools for when to use this tool versus alternatives.

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