sap_help_semantic_search

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

With no annotations provided, the description bears the full burden of behavioral disclosure. It adds that the tool 'returns ranked results with relevance scores,' which is useful context beyond basic search, but lacks details on limitations, errors, or pagination behavior. This is adequate but not rich.

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 key differentiator ('semantic search') followed by an example and output behavior. Every sentence earns its place with no waste.

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 moderate complexity (5 simple parameters, no output schema), the description explains the return format and the core value proposition. It does not mention filtering options (product, version, language) but these are fully documented in the schema, so the description is sufficiently complete for invoking the tool 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?

The input schema covers 100% of parameters with descriptions, so the baseline is 3. The tool description adds the semantic-search context ('natural language') that aligns with the query parameter, but it does not introduce additional meaning beyond what the schema already provides for other 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 states a specific verb ('search') and resource ('SAP Help Portal') with a clear differentiator: 'AI-powered semantic search.' It contrasts with sibling tools like sap_help_search by emphasizing natural language queries, making its purpose distinct and unambiguous.

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 phrase 'Better for natural language questions' provides clear context for when to use this tool versus alternatives. However, it does not explicitly exclude cases where keyword search might be preferable or name alternatives, so it lacks full usage guidance.

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