add_reference_layer

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

Without annotations, the description explains the layer is dimmed and locked, and details parameter effects (opacity, scale_to_fit), but omits side effects, reversibility, or permission requirements.

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?

Concise with a clear introductory sentence and parameter list, though not strictly formatted as bullet points; no redundant information.

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?

Adequately covers purpose and main parameters, but lacks details on error handling, default behavior when scale_to_fit is false, and does not describe return value or side effects.

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?

The description explains 6 of 8 parameters (image_file, layer_name, opacity, scale_to_fit, x, y) adding context like 'dim it so your art stands out,' compensating for 0% schema coverage, but misses 'filename' and 'frame'.

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 adds a dimmed, locked layer for tracing a reference image, distinguishing it from other layer-adding tools like add_layer or import_image.

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 mentions excluding the layer from exports using ignore_layer, providing context for export handling, but does not explicitly compare to sibling tools like add_layer or import_image.

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