search_unreal_api

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

With no annotations, the description carries the full burden. It discloses that the tool returns matching entries from the API index and supports partial matching and regex for the query. It does not mention potential side effects or limitations, but for a read-oriented search tool these are less critical.

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 four short, efficient segments: purpose, return behavior, usage guideline, and parameter explanation. It is front-loaded with the action and target, with zero wasted words.

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?

For a one-parameter search tool with an output schema, the description covers purpose, usage guidance, and parameter semantics. It does not need to explain return values because an output schema exists. The complexity is low, and the description fully satisfies the context.

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 describes query only as a string with no explanation. The description's Args section says it is a 'Search query (supports partial matching and regex),' which provides meaningful semantics and compensates for the 0% schema description coverage.

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 a specific action ('Search') with a defined target ('Unreal Python API') and scope ('by class or function name'). It also distinguishes from sibling detail-lookup tools by positioning itself as the name-discovery step, saying 'Use this to find the correct class/function name before getting detailed documentation.'

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?

It provides explicit guidance on when to use this tool: 'before getting detailed documentation.' This implies it is a precursor to sibling detail tools like get_class_overview or get_member_info. It does not explicitly name alternatives, but the workflow context is clear.

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