Get Apex Log Summary

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

Annotations already cover the safety profile (readOnlyHint=true, openWorldHint=false), so the description focuses on content. It meaningfully discloses what the agent will receive, including diagnostic details like governor limit consumption per namespace, log completeness, and the failure cause. It stops short of noting any limitations such as behavior on truncated/incomplete logs or path errors.

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?

Front-loaded with the verb and resource, then a tight enumeration where each item adds real information about the output. The list is long but not padded; only the trailing 'Best for a quick overview' is slightly soft.

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?

With no output schema, the description must stand in for the return shape, and it does so thoroughly across time breakdown, limits, completeness, and errors. Only minor gaps remain, such as expected log state or failure behavior on an unreadable path.

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?

There is a single parameter with 100% schema description coverage ('Absolute path'), so the schema already carries the burden. The description adds nothing about the path format, expected file type, or consequences of an invalid path, so the baseline of 3 applies.

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?

States a specific verb and resource ('Get a high-level summary of an Apex debug log') and enumerates exactly what the summary contains: duration, category breakdown, governor limits, completeness, exceptions/flow errors, and termination cause. That scope clearly separates it from sibling log tools like apexlog_search_events or apexlog_list_org_logs, though no sibling is named explicitly.

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?

'Best for a quick overview' implies when to reach for it, but no alternative is named and no condition for when NOT to use it is given (e.g., when you need raw event-level detail, use apexlog_search_events). Usage is only implied.

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