GetWhereUsed

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

The description includes '[read-only]' to indicate safety and states it returns a list of referencing objects with details. Since no annotations exist, the description provides key behavioral information, though it could specify scope (e.g., inactive objects, depth).

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, no fluff. Front-loads the read-only indicator and core purpose. 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?

While no output schema exists, the description compensates by specifying return content (list with types and packages). It lacks prerequisites or edge cases, but for a read-only tool, it is adequate.

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 covers all three parameters with descriptions (100% coverage). The description does not add meaning beyond the schema; it lists object types in general but not per parameter.

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?

Description clearly states the tool finds where-used references for ABAP objects, listing examples (classes, interfaces, etc.) and specifies output (list with types and packages). It is distinct from sibling tools.

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 finding cross-references, but does not explicitly state when to use this tool versus alternatives among the many 'Get' siblings. No exclusions or context provided.

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