Skip to main content
Glama

Process local images with QuokkaPix

process_images

Process local images using QuokkaPix recipes; receive an exact quote before paid processing, then retry with the quoted product token to complete.

Instructions

Process local image files through the QuokkaPix browser app using an official recipeId or a full custom recipe. Source files stay local. Without unlockToken, the browser returns an exact quote after ZIP expansion/PDF inspection and before paid processing. Retry the unchanged call with the quoted product token.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appUrlNoOptional QuokkaPix app URL. Defaults to https://quokkapix.com/#agent=1. For safety, only quokkapix.com, localhost and 127.0.0.1 are accepted unless QUOKKAPIX_ALLOW_CUSTOM_APP_URL=1 is set.
recipeNoCustom recipe object. Provide either recipeId or recipe.
headlessNoRun Chromium headless. Defaults to true unless debugging.
recipeIdNoOfficial recipe id from list_recipes. Provide either recipeId or recipe.
outputDirYesLocal directory where the adapter writes the downloaded output and quokkapix-result.json.
timeoutMsNoMaximum processing timeout in milliseconds. Use a larger value for background AI or large batches.
inputFilesYesLocal Image, supported ZIP or PDF paths uploaded through the browser file input. Actual expanded files/pages determine the quote.
unlockTokenNoOptional product-specific x402 unlock token. Omit it to receive the browser-authoritative quote before paid processing.
watermarkLogoFileNoOptional local logo/image file for QuokkaPix logo watermark workflows.
backgroundImageFileNoOptional local image file for QuokkaPix background replacement workflows.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.6.1
    • changedInput schema / properties / inputFiles / description
      Previous value: -"Local source image files to upload through the browser file input. Agent batches up to 5 files are free; the paid batch limit is 50."New value: +"Local Image, supported ZIP or PDF paths uploaded through the browser file input. Actual expanded files/pages determine the quote."
    • changedInput schema / properties / unlockToken / description
      Previous value: -"Optional x402 unlock token for paid agent batch/scenario runs above 5 files. Obtain it outside this adapter."New value: +"Optional product-specific x402 unlock token. Omit it to receive the browser-authoritative quote before paid processing."
  2. Changed2 schema fields changedv0.3.2
    • changedInput schema / properties / inputFiles / description
      Previous value: -"Local source image files to upload through the browser file input. Maximum paid batch size is 50."New value: +"Local source image files to upload through the browser file input. Agent batches up to 5 files are free; the paid batch limit is 50."
    • changedInput schema / properties / unlockToken / description
      Previous value: -"Optional x402 unlock token for paid agent batch/scenario runs. Obtain it outside this adapter."New value: +"Optional x402 unlock token for paid agent batch/scenario runs above 5 files. Obtain it outside this adapter."
  3. Changed14 schema fields changedv0.3.1
    • addedInput schema / properties / appUrl / description
      Added value: +"Optional QuokkaPix app URL. Defaults to https://quokkapix.com/#agent=1. For safety, only quokkapix.com, localhost and 127.0.0.1 are accepted unless QUOKKAPIX_ALLOW_CUSTOM_APP_URL=1 is set."
    • addedInput schema / properties / backgroundImageFile / description
      Added value: +"Optional local image file for QuokkaPix background replacement workflows."
    • addedInput schema / properties / headless / description
      Added value: +"Run Chromium headless. Defaults to true unless debugging."
    • addedInput schema / properties / inputFiles / description
      Added value: +"Local source image files to upload through the browser file input. Maximum paid batch size is 50."
    • addedInput schema / properties / inputFiles / items / description
      Added value: +"Absolute or client-relative local file path readable by the MCP process. Do not pass remote URLs here."
    • addedInput schema / properties / outputDir / description
      Added value: +"Local directory where the adapter writes the downloaded output and quokkapix-result.json."
    • addedInput schema / properties / recipe / description
      Added value: +"Custom recipe object. Provide either recipeId or recipe."
    • addedInput schema / properties / recipe / properties
      Added value: +{
      +  "applySettings": {
      +    "additionalProperties": {},
      +    "description": "QuokkaPix settings applied before processing starts.",
      +    "properties": {
      +      "mode": {
      +        "description": "Use single for one image or batch for multiple images.",
      +        "enum": [
      +          "single",
      +          "batch"
      +        ],
      +        "type": "string"
      +      },
      +      "steps": {
      +        "description": "Optional ordered scenario steps. Prefer [{ tool, settings }] for custom multi-step workflows.",
      +        "items": {
      +          "anyOf": [
      +            {
      +              "description": "Simple QuokkaPix tool id step, for example resize, background, compress or watermark.",
      +              "minLength": 1,
      +              "type": "string"
      +            },
      +            {
      +              "description": "Structured scenario step with a tool id and per-step settings.",
      +              "properties": {
      +                "settings": {
      +                  "additionalProperties": {},
      +                  "description": "Settings for this step using the same keys accepted by window.QuokkaPixAgent.applySettings.",
      +                  "propertyNames": {
      +                    "type": "string"
      +                  },
      +                  "type": "object"
      +                },
      +                "tool": {
      +                  "description": "QuokkaPix tool id for this scenario step, for example resize, background, compress or watermark.",
      +                  "minLength": 1,
      +                  "type": "string"
      +                }
      +              },
      +              "required": [
      +                "tool"
      +              ],
      +              "type": "object"
      +            }
      +          ],
      +          "description": "One step in a QuokkaPix scenario workflow."
      +        },
      +        "type": "array"
      +      },
      +      "tool": {
      +        "description": "QuokkaPix editor tool id, such as resize, crop, rotate, convert, compress, metadata, background, watermark, effects, rename, pdf, favicon or constructor.",
      +        "minLength": 1,
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "description": {
      +    "description": "Short explanation of what the recipe prepares.",
      +    "type": "string"
      +  },
      +  "expectedResult": {
      +    "additionalProperties": {},
      +    "description": "Expected output and QA contract.",
      +    "properties": {
      +      "output": {
      +        "description": "Expected output type, for example zip, image, pdf or json.",
      +        "type": "string"
      +      },
      +      "qa": {
      +        "additionalProperties": {},
      +        "description": "Machine-readable QA checks for the result manifest.",
      +        "properties": {
      +          "allowedFormats": {
      +            "description": "Allowed output formats for every manifest output entry.",
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          },
      +          "expectedFormat": {
      +            "description": "Required output format, for example webp, jpg, png, pdf or zip.",
      +            "type": "string"
      +          },
      +          "expectedHeight": {
      +            "description": "Exact expected output height in pixels.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "expectedMinOutputs": {
      +            "description": "Minimum number of output entries expected.",
      +            "maximum": 9007199254740991,
      +            "minimum": 1,
      +            "type": "integer"
      +          },
      +          "expectedOutputKind": {
      +            "description": "Expected high-level output kind for QA checks.",
      +            "enum": [
      +              "single",
      +              "batch",
      +              "zip",
      +              "pdf",
      +              "metadata-report",
      +              "icon-pack"
      +            ],
      +            "type": "string"
      +          },
      +          "expectedWidth": {
      +            "description": "Exact expected output width in pixels.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "marketplace": {
      +            "description": "Marketplace profile name used for human-readable QA context.",
      +            "enum": [
      +              "shopify",
      +              "amazon",
      +              "google-merchant"
      +            ],
      +            "type": "string"
      +          },
      +          "maxHeight": {
      +            "description": "Maximum allowed output height in pixels.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "maxOutputKB": {
      +            "description": "Recommended maximum output size per non-archive file.",
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          "maxWidth": {
      +            "description": "Maximum allowed output width in pixels.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "minHeight": {
      +            "description": "Minimum recommended output height in pixels.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "minWidth": {
      +            "description": "Minimum recommended output width in pixels.",
      +            "exclusiveMinimum": 0,
      +            "maximum": 9007199254740991,
      +            "type": "integer"
      +          },
      +          "requireSquare": {
      +            "description": "Require square output dimensions when true.",
      +            "type": "boolean"
      +          },
      +          "visualChecks": {
      +            "description": "Visual checks requested by a recipe. Current validator reports these as metadata-only limitations.",
      +            "items": {
      +              "type": "string"
      +            },
      +            "type": "array"
      +          }
      +        },
      +        "type": "object"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "id": {
      +    "description": "Stable recipe id, for example shopify_product_pack.",
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "requires": {
      +    "additionalProperties": {},
      +    "description": "Recipe requirements such as maxFiles and payment policy.",
      +    "properties": {
      +      "maxFiles": {
      +        "description": "Maximum files allowed by this recipe.",
      +        "maximum": 50,
      +        "minimum": 1,
      +        "type": "integer"
      +      },
      +      "payment": {
      +        "description": "Whether the recipe normally needs a paid batch/scenario unlock.",
      +        "type": "boolean"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "title": {
      +    "description": "Human-readable recipe title.",
      +    "type": "string"
      +  }
      +}
    • removedInput schema / properties / recipe / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • addedInput schema / properties / recipe / required
      Added value: +[
      +  "id",
      +  "applySettings"
      +]
    • addedInput schema / properties / recipeId / description
      Added value: +"Official recipe id from list_recipes. Provide either recipeId or recipe."
    • addedInput schema / properties / timeoutMs / description
      Added value: +"Maximum processing timeout in milliseconds. Use a larger value for background AI or large batches."
    • addedInput schema / properties / unlockToken / description
      Added value: +"Optional x402 unlock token for paid agent batch/scenario runs. Obtain it outside this adapter."
    • addedInput schema / properties / watermarkLogoFile / description
      Added value: +"Optional local logo/image file for QuokkaPix logo watermark workflows."
  4. First observedv0.3.0

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral disclosure burden. It does well by revealing that source files stay local, that the browser returns a quote after ZIP/PDF inspection before paid processing, and that the call must be retried with the quoted token. It does not detail output-side effects like writing to outputDir, but the schema partially covers that.

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?

Three sentences with no filler. The primary action is front-loaded, and the critical unlockToken workflow is explained compactly without duplicating schema content.

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 complex, payment-gated tool with no output schema and no annotations, the description provides a workable mental model of the quote-then-retry interaction and the local-file constraint. It does not explain every parameter, but the rich schema already documents those details sufficiently.

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

Parameters4/5

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

The input schema has 100% coverage, so the baseline is 3. The description adds meaningful semantics by explaining the unlockToken quote workflow and the relationship between recipeId and custom recipe, which supplements rather than repeats the schema.

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 uses a specific verb ('Process') and a clear resource ('local image files through the QuokkaPix browser app'), and it names the two recipe modes. It clearly separates image processing from video siblings, though it does not explicitly contrast with process_with_settings.

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

Usage Guidelines3/5

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

The description implies usage for local image workflows and provides useful operational guidance for the quote-then-retry flow, but it does not explicitly state when to choose this tool over process_with_settings or other alternatives. The usage context is implied by 'local image files' and the recipe-based flow rather than stated as a direct comparison.

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