Get Org Debug Logs

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

The description usefully discloses that files are saved locally and their paths are returned for downstream analysis. However, with only destructiveHint=false in annotations, it does not cover overwrite behavior, permissions, or rate limits.

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?

A single sentence that front-loads the core action and ends with the most important output detail: saved file paths accepted by analysis tools.

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?

The description covers the essential workflow: download logs and return file paths for analysis. With no output schema, it appropriately explains the return value; minor gaps like overwrite behavior are acceptable given the schema's parameter detail.

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 coverage is 100%, so parameter meaning is already well documented. The description reinforces the id/latest N selection and output path usage, but adds little beyond the schema.

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: download debug logs from a Salesforce org, selectable by id or newest N. It distinguishes itself from the listing sibling by focusing on download and local file paths, though it does not explicitly name the sibling.

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 implies the tool is used before analysis tools because it returns paths they accept, but it does not explicitly state when to use ids versus latest N or when to choose this over listing logs.

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