read_ui_diff_report

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

The description discloses that the tool reads and returns JSON data, implying a non-destructive read operation. However, with no annotations, it carries full burden and lacks details on error handling (e.g., if the file does not exist) or permissions. It is minimally adequate but not comprehensive.

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 a single sentence with no wasted words. It is front-loaded and immediately conveys the tool's action and subject.

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 tool is simple with one parameter and an output schema. The description covers the basic purpose but lacks workflow context—e.g., that the report path likely comes from a previous step like 'start_ui_diff_run'. It does not mention the output schema existence or how to interpret results. Adequate for a basic tool but could be more helpful.

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 0%, so the description must compensate. It adds no meaning to 'reportPath' beyond the name and type (string). The description does not specify the path format, how to obtain it, or constraints. The parameter is self-explanatory in name, but the tool description fails to provide useful context.

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 the tool reads and returns a previously generated UI diff report JSON file. The verb 'reads and returns' and resource 'previously generated UI diff report' are specific, and it is distinct from sibling tools (e.g., 'capture_mobile_screen', 'start_ui_diff_run').

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 provides no guidance on when to use this tool versus alternatives. It does not mention prerequisites (e.g., a report must already exist) or that this should be used after starting a diff run. No exclusions or workflow context are given.

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