Search the CDS model (CAP)

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds context that the search is fuzzy and operates on a compiled unified model including relationships and annotations. This adds value without contradicting annotations, though no further behavioral details like pagination or auth are disclosed.

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-loads the core action and scope, includes a helpful example, and contains no filler or redundant information.

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 100% schema coverage, an output schema, and annotations covering read-only/idempotent behavior, the description is complete for a search tool. It explains what is searched, enumerates kinds, and gives an example, so an agent has what it needs to call it correctly.

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%, so the baseline is 3. The description adds a concrete example (searchModel(projectPath, 'Books', 'entity')) and enumerates the kind values, giving extra meaning beyond the schema's own descriptions.

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 states a specific verb ('Performs fuzzy searches') and a specific resource ('names of definitions from the compiled CDS model'), and it enumerates the definition kinds covered. This clearly distinguishes it from sibling tools like search_docs and query_cap_data by scope.

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 implies usage for searching CDS model definitions and provides an example, but it does not explicitly mention when to use this tool versus alternatives such as search_docs or query_cap_data. No exclusions or when-not-to-use guidance is given.

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