qrcode

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

No annotations are provided, so the description carries the full burden. It discloses that the tool saves a JPEG file, states the output directory default behavior ($HOMEBOX_LABEL_DIR or current directory), and mentions the return value (saved file path). This provides a clear picture of side effects and expected behavior beyond what the schema offers.

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 three concise sentences, front-loaded with the main purpose. Every sentence adds value—purpose, alternative guidance, and output details—without redundancy or fluff.

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?

For a tool with only 2 parameters and no output schema, the description is complete. It covers the file format, output location, return value, and an important alternative tool. No critical information is missing for the agent to make an informed selection and invocation.

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%, but the description compensates by explaining both parameters: `data` is described as arbitrary (e.g., a deep link), and `out_dir` is explained with its default resolution logic. This adds significant meaning beyond the raw schema definitions, making the tool easy to invoke correctly.

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's purpose: 'Save a raw QR-code JPEG encoding arbitrary data'. It specifies the action (save), the output format (JPEG), and the content (arbitrary data), and differentiates from the sibling tool generate_label by noting that generate_label adds a readable name for tote labels.

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 explicit usage guidance: 'For tote labels prefer generate_label (adds the readable name)'. This tells the agent when not to use this tool and suggests a specific alternative. The phrase 'arbitrary data' implies a general-purpose use case, effectively covering when to use qrcode.

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