Search in-game events

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

With no annotations provided, the description carries the full burden. It uses non-mutating verbs like 'search' and 'show', implying a read-only operation. However, it does not disclose any potential limitations, pagination, or how results are ordered beyond 'in order'. It adds some context about payload arguments but is not rich in behavioral details.

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 two sentences with no fluff. It front-loads the core purpose and immediately follows with a practical use case. Every word earns its place, making it highly concise and well-structured.

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 search tool with no output schema, the description adequately explains what the tool does and shows a key output detail: 'payload arguments in order'. It does not describe the full return format or how 'limit' and 'flavor' affect results, but given the tool's simplicity and schema coverage, it is reasonably complete.

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 schema covers 67% of parameters with descriptions for 'query' and 'flavor'. The description reinforces that the query is an 'event name or fragment' but does not add details for the 'limit' parameter, which lacks a description. Overall, it adds little beyond the schema, but does not conflict with it, earning a baseline score.

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 the events an addon can register with frame:RegisterEvent' and adds the distinct feature of 'show each event's payload arguments in order'. This distinguishes it from sibling tools like wow_api_search or wow_api_type_search by focusing specifically on events and their payloads.

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 gives a clear usage context: 'Use this whenever writing an OnEvent handler, so the argument list matches what the client sends.' This tells the agent when to use it, though it does not explicitly mention alternatives or when not to use it. It provides a clear 'when' but lacks 'when-not'.

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