analyze_events

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

Discloses output details (event names, parameters, etc.) and pagination support. Lacks mention of side effects or permission requirements, but tool is read-only analysis. No annotations to contradict.

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?

Concise, uses few sentences, front-loaded with purpose. Could be slightly more structured but effective.

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 no annotations and presence of output schema, description covers purpose, usage, and pagination. Missing error handling or performance details but adequate for a code analysis tool.

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?

Description does not describe input parameters beyond mentioning 'path' implicitly and 'supports pagination'. Schema has detailed parameter descriptions but coverage is 0% in description; description adds minimal value to parameter understanding.

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 analyzes event definitions across project or specific contract. Distinguishes from sibling tools like analyze_modifiers or analyze_low_level_calls by focusing on events.

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?

Explicitly states when to use (understanding events, indexed parameters, auditing logging) and what not to do (does not find emissions). Suggests alternative action (search source code).

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