CPI API Catalog (discover entity sets & operations)

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

No annotations provided; the description only states it lists data. It does not disclose any behavioral traits such as side effects, authentication requirements, rate limits, or pagination behavior, which would be expected for full transparency.

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?

Two sentences, front-loaded with the core purpose, and no extraneous words. 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?

The tool is simple with one optional parameter, so the description is largely adequate. However, since there is no output schema, mentioning what the output looks like (e.g., list of names, endpoints) would improve completeness.

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 a single optional 'filter' parameter. The description does not add meaning beyond the schema's own description ('Optional case-insensitive substring filter'), so baseline 3 applies.

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 lists every OData entity set and function import, and explicitly distinguishes from sibling tools by naming the consumer tools (cpi_query, cpi_get_entity, etc.).

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?

Explicitly says 'Use this to discover what ... can target,' providing clear usage context. It implies using this tool before the specific query/get/invoke/write tools, though it doesn't mention when not to use or alternatives.

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