Skip to main content
Glama

Read a code in a local image

abox_code_read

Decode QR codes and barcodes from local images and save parsed data to a JSON report without exposing payload text or opening links.

Instructions

Scan a still local JPEG, PNG or WebP for one QR code or supported linear barcode using the website readers. Write decoded text and parsed fields only into a new local JSON report. Tool results contain found/symbology and geometry, never payload text or URLs; links are never opened. A no-code image produces a found:false report. Requires a local browser.

Input Schema

NameRequiredDescriptionDefault
thoroughNo
input_pathYesAbsolute local filesystem path. URLs and network shares are refused.
output_pathYesAbsolute local filesystem path. URLs and network shares are refused.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.9.0

TDQS

A4.4/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: payload text is never returned in tool results (only found/symbology/geometry), decoded data is written to a new local JSON report, links are never opened, and a local browser is required. This is exactly the kind of privacy and side-effect disclosure annotations can't convey, and it is consistent with readOnlyHint=false given the report write.

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

Conciseness4/5

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

Dense but front-loaded: the read action comes first, followed by result/output semantics and the browser prerequisite. The opening sentence is long with many clauses, but no sentence is filler.

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

Completeness5/5

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

With no output schema, the description correctly carries the return-value burden by explaining found/symbology/geometry versus payload-in-JSON, plus the no-code case. An agent has everything needed to decide to call it and interpret results.

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 coverage is 67%, and the description reinforces the input_path/output_path local-only constraint without adding syntax detail. The third parameter, 'thorough' (boolean, default true), is neither described in the schema nor referenced in the description, leaving a real behavioral knob undocumented.

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

Purpose5/5

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

States a specific verb and resource ('Scan a still local JPEG, PNG or WebP for one QR code or supported linear barcode') and names the output artifact. It is clearly distinguishable from the generation siblings abox_qr_generate and abox_barcode_generate, which produce rather than read codes.

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

Usage Guidelines4/5

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

Gives clear qualifying context: still images only (JPEG/PNG/WebP), one code per image, local browser required, and the outcome for a no-code image. It does not explicitly name an alternative tool or state exclusions beyond the local-file requirement, so it falls short of a 5.

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