Skip to main content
Glama
jan3dev

Agentic AQUA

by jan3dev

qr_generate

Generate a PNG QR code for any payload, such as a Bitcoin, Liquid, or Lightning address, invoice, or URI, and return its file path. Optionally include terminal-friendly block art.

Instructions

Generate a PNG QR code for arbitrary content and return qr_code_path. Optionally includes a terminal-friendly block QR string.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesContent to encode (address, invoice, URI, or other QR payload).
filenameNoOptional PNG filename; defaults to qr_<sha256[:16]>.png.
terminalNoAlso return terminal_qr block art.
output_dirNoOptional directory for the PNG; defaults to ~/.aqua/qr.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.5.2

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It does disclose the return shape (qr_code_path, optional terminal_qr string), which is helpful, but it never states that a file is written to disk, where by default, whether an existing file at the same path is overwritten, or any permission/error behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with no filler, and the primary output (qr_code_path) is stated before the optional terminal detail. Every clause earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-parameter tool with no output schema, the description names the return value and the optional extra output, which is enough for an agent to call it correctly. It stops short of describing the file-write side effect and default location, which is the only meaningful gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters are already documented, and the baseline is 3. The description adds only a little beyond the schema by clarifying that the terminal option yields 'block QR' art, which is consistent with the schema's terminal_qr wording.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('Generate a PNG QR code') plus the scope of input ('arbitrary content'), so the agent knows exactly what the tool produces. It does not name or contrast with the obvious sibling qr_decode, but the generate/decode distinction is self-evident from the name.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use or when-not-to-use guidance and no alternative tool is named. 'For arbitrary content' describes scope rather than usage conditions, leaving the agent to infer that this is the encode-side counterpart to qr_decode.

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