Search ABAP Object Lines

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

Annotations already declare readOnlyHint=true, destructiveHint=false. The description adds behavioral details: scope (active main source and enhancements), separate reading of class includes, and a 10-object limit for wildcards. This adds value beyond annotations without contradiction.

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?

Three sentences with key information front-loaded. No redundant phrasing, but certain constraints (wildcard limit, class includes) could be integrated more smoothly. Still concise for the content provided.

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 description covers basic search capability and a few constraints, but omits pagination (maxResults, startIndex), contextLines, and connectionId. With no output schema and 8 parameters, more detail is needed for full understanding.

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. It implicitly covers 'searchTerm' (literal/regex), 'objectName' (wildcard), and 'maxObjects' (up to 10), but fails to explain isRegexp, maxResults, startIndex, contextLines, or connectionId. For 8 parameters, this is insufficient.

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 searches literal text or regex in active main source and enhancements, with constraints on class includes and wildcard object names. It distinguishes from sibling tools like 'get_abap_object_lines' and 'find_where_used' by specifying a search operation.

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?

Usage is implied for text/regex searches in ABAP source code, but no explicit comparison or when-not-to-use guidance is provided. Sibling tools are not mentioned, so the agent must infer context.

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