list_services

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

With no annotations, the description carries the full burden. It discloses the matching semantics (substring on name/title) and implies a read-only catalog lookup, but says nothing about whether results are environment-scoped, case sensitivity, default result caps, or what happens when the search term is empty.

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 short sentences with zero padding, leading with the core action and following with the one behavioral preference. Nothing is wasted.

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?

An output schema exists so return-value explanation is unnecessary, and the tool is simple. Still, the description omits environment context and leaves two of three parameters undocumented, which is a meaningful gap for an agent operating in a multi-environment SAP toolset.

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 0%, so the description must compensate for all three parameters. It only clarifies 'search' as a name/title substring match; 'limit' and 'offset' are left entirely undefined in both schema and description, and their interaction with the 'prefer search over paging' advice is unstated.

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 and resource: search the Gateway catalog for OData services, with the matching dimension (name/title substring) spelled out. It is clearly distinct from siblings such as get_service_metadata or query_entity, though it never acknowledges the name's 'list' framing versus its search behavior.

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?

'Prefer a search term over paging' gives genuine usage guidance for choosing between parameters. However, there is no guidance on when to call this versus get_service_metadata or query_entity, nor whether an environment must be selected first given the presence of list_environments/switch_environment siblings.

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