add_example

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

No annotations provided, so description is the sole source. It states the tool adds an image and returns an ID, but does not disclose side effects (e.g., overwrites, storage limits), authentication needs, or error conditions. Basic operation only.

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 bullet list in docstring format. Each parameter has a short line. Could be more compact, but no extraneous text. Front-loaded purpose sentence is clear.

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?

Covers all 5 parameters and return value. Lacks details on error handling, duplicate handling, size limits, or integration with the example library. Adequate but not comprehensive.

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 0% schema description coverage, the Args section adds meaningful context (e.g., 'Written description of what the image shows' for 'description', 'Diagram type — process or conops' for 'image_type'). However, details like path formats or accepted image types are missing, limiting full semantic clarity.

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 'Add a reference image to the example library,' providing a specific verb and resource. It differentiates from siblings 'generate_proposal_image' and 'get_version' by focusing on adding an image to a library rather than generating or retrieving.

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?

No guidance on when to use this tool versus alternatives. It lacks context about prerequisites, constraints, or situations where other tools might be more appropriate.

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