Skip to main content
Searches product names and brands for a product or brand the person named, and returns up to 3 matches. Each result carries the person’s match_score for their scan. A completed scan is required (run_id and access_token). Without one the tool returns scan_required. No prices, stock or retailer links are returned. Allowance: 3 lookups per scan. A lookup that finds nothing is not counted. When the allowance is spent the tool succeeds with products: [] and entitlement.upgrade_required: true, so check that field before saying nothing matched. Common errors: scan_required, scan_not_ready, not_found, catalog_unavailable, rate_limited.

Input

Sent as params.arguments of tools/call. Unknown keys are rejected with invalid_input.
string
required
A product or brand name the person asked about. At least two characters.Max length 60.
string
The person’s completed scan. Required unless this deployment allows anonymous lookups.Format uuid.
string
Pattern ^[a-f0-9]{64}$.

Output

Returned as structuredContent, and as the same object serialised in content[0].text. On failure the result has isError: true and an error body instead.
object[]
required
Max 3 items.
boolean
required
object
required
string
required