create_barcode

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

With no annotations provided, the description discloses the key side effect: 'Saves the file and returns the path.' It also specifies PNG output. It does not cover overwrite behavior or error cases, but the core behavior is transparent.

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?

Three sentences, front-loaded with the core purpose, and no wasted words. It balances examples and behavior disclosure efficiently.

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 5 parameters, and the description covers the main action and return value. However, the parameter naming mismatch and omission of output directory/file name options mean the agent may not correctly invoke all parameters, especially since there is no output schema to clarify return values.

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 covers text, barcodeType, and hideText, but uses camelCase names that do not match the schema's snake_case properties (e.g., barcodeType vs barcode_type, hideText vs hide_text). It omits output_dir and output_file_name entirely, leaving 2 of 5 parameters unexplained. Since schema description coverage is 0%, this is a significant gap.

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 a specific action: 'Create a standalone barcode or QR code image (PNG)'. It identifies the resource (barcode/QR image) and distinguishes from sibling tools like add_barcode_to_pdf by using the word 'standalone'.

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 when to use this tool (when a standalone image is needed) and contrasts with adding barcodes to PDFs. It does not explicitly name alternatives or exclusions, but the context is clear enough for an agent to select it appropriately.

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