Check that a QR design will scan
qr_scan_checkRun the print check on a design before it goes to the printer: the engine renders it and decodes it under 13 simulated conditions (small print, distance, blur, dim light, low contrast, glare, noise, rotation) and returns the same report the builder's scan panel shows, plus the minimum print size at table, wall and street distance. Call it after qr_generate when the result is going to be printed. fileFormat/outputWidth/outputHeight are ignored: the check renders its own bitmap.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"content": "<content>"
},
"name": "qr_scan_check"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Optional caption rendered below the QR (e.g. a slogan). | |
| content | Yes | The text or URL the QR will encode. Required. | |
| logoUrl | No | Public HTTPS URL of a logo image to embed at the center. | |
| eccLevel | No | Error-correction level (L=7%, M=15%, Q=25%, H=30%). Higher levels survive more damage but are denser. | |
| frameText | No | Label inside the frame, max 40 characters, any language (e.g. "Scan me", "View the menu"). Defaults to "Scan me". | |
| fileFormat | No | Output format. Defaults to "png". | |
| frameColor | No | Frame colour in hex, also the label background. Defaults to "#000000". | |
| frameStyle | No | Call-to-action frame around the whole QR with a short label. Never covers the QR or its quiet zone. | |
| moduleShape | No | Shape of the small modules in the QR matrix. | |
| outputWidth | No | Output width in pixels (raster) or viewport units (svg). 64-4096. | |
| outputHeight | No | Output height in pixels (raster) or viewport units (svg). 64-4096. | |
| primaryColor | No | Foreground/module color in hex (e.g. "#000000" or "#0a84ff"). | |
| frameTextColor | No | Frame label colour in hex. Defaults to "#FFFFFF". | |
| backgroundColor | No | Background color in hex (e.g. "#ffffff"). Use "transparent" for no background. | |
| additionalConfig | No | Escape hatch: any other QrConfig field the engine accepts (gradient stops, dot rotation, etc.). Merged on top of the structured fields above. | |
| finderInnerShape | No | Shape of the inner dot of the three corner finder patterns. | |
| finderOuterShape | No | Shape of the outer ring of the three corner finder patterns. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| grade | Yes | Print-readiness grade of the design. | |
| sizes | Yes | ||
| version | Yes | QR version (symbol size). | |
| elapsedMs | No | How long the simulated scan took. | |
| conditions | Yes | ||
| designScore | No | Static design score (0-100) from the engine's scannability rules. | |
| resolutions | No | How small the modules can get and still be read: one step per tested size, largest first. | |
| engineAdjusts | No | True when the engine had to strengthen the design (its scan fallback) for the returned file to read back, so the file differs from the exact request. | |
| symbolModules | Yes | Modules per side of the symbol. | |
| designWarnings | No | QrConfig fields the static rules flagged. | |
| smallestModulePx | No | Smallest module in the rendered bitmap, in pixels. |