Get Event Log Files

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

Annotations already indicate read-only and idempotent. The description adds useful behavioral details like return limits (20 rows per file, 3 files per call) and the requirement for Event Monitoring add-on or Agentforce debug logs, which go beyond annotation info.

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 well-structured: purpose sentence, event type list, return behavior, and requirements. The list is a bit long but each item is useful, and the text stays focused without fluff.

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 output schema, the description covers return format and limits, plus prerequisites. It could mention how to handle more than 3 files or pagination, but the core needs are met.

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 parameters, but the description enriches eventType by listing common values and clarifies the effect of limit (rows per file and files per call). This adds meaningful context beyond the schema descriptions.

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 it queries EventLogFile for detailed activity logs, listing common event types and distinguishing it from other logging tools. The verb 'queries' and resource 'EventLogFile' are specific and unambiguous.

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 usage context for security monitoring and performance analysis, and lists event type examples that help the agent decide when to use it. It doesn't explicitly exclude alternatives but clearly implies the intended use case.

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