chimerax_rich_report

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It explicitly states that plain text fields are escaped, raw html blocks are inserted as-is, and explains the difference between external_link_target modes. It also documents overwrite behavior and the return status, giving a complete picture of side effects and trust boundaries.

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 with a leading summary sentence followed by Args and Returns sections. Despite covering 9 parameters, it remains focused and avoids fluff. Each parameter explanation is concise and meaningful, and the security-relevant notes are included without excess.

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 tool's purpose, all parameters, security behavior, and return value. For a write operation without annotations, it is quite complete. The only notable gap is the under-specified 'blocks' parameter, which prevents a perfect score. The existence of an output schema is noted, but the description still provides the essential return status.

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?

With schema description coverage at 0%, the description is the only source of parameter meaning. It explains all 9 parameters in the Args section, adding clarity about defaults, optionality, and behavior. However, 'blocks: Ordered rich content blocks' is vague and does not explain the structure or possible values of these blocks, leaving some ambiguity.

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 opens with a specific verb+resource: 'Compose a themed rich HTML report for the ChimeraX Log.' This clearly distinguishes it from sibling tools like chimerax_rich_log and chimerax_structure_report, and the title reinforces the intent.

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 clear context by specifying this is for composing a themed rich HTML report for the ChimeraX Log. It does not explicitly name alternative tools or state when not to use it, but the context is strong enough to infer its primary use. The parameter-level details also clarify behavior, such as how external links are handled.

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