Skip to main content
Glama
quokkapix

quokkapix-mcp

Official
by quokkapix
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Local

Validate QuokkaPix image recipe

validate_recipe

Check a custom QuokkaPix recipe for validity before processing images. Confirms required fields, mode, tool, steps, and maxFiles.

Instructions

Validate a custom QuokkaPix recipe before using process_images. Use this when an agent generated its own recipe JSON and needs to confirm that id, applySettings.mode, applySettings.tool, optional structured steps and requires.maxFiles are valid. This is a preflight check only and does not open a browser or process files.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
recipeYesCustom QuokkaPix recipe object. Use validate_recipe before process_images when generating this dynamically.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.3.1
    • addedInput schema / properties / recipe / description
      Added value: +"Custom QuokkaPix recipe object. Use validate_recipe before process_images when generating this dynamically."
    • 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"
+]
  2. First observedv0.3.0

TDQS

A4.2/5.0
Behavior3/5

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

No annotations are provided, so the description must carry the full burden. It discloses that this is a non-destructive, safe operation ('preflight check only, does not open browser or process files'). However, it does not detail the validation error format, side effects, or exact behavior on invalid input. Given no annotations, a score of 3 is appropriate—adequate but not exhaustive.

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 sentences only, both front-loaded with key information. No redundant phrases. Every sentence adds value: the first states the purpose and the second provides usage context and differentiation.

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?

Given the tool's complexity (1 parameter, 100% schema coverage, no output schema), the description is complete enough. It explains the tool's role in the workflow (validate before process_images). It could be improved by hinting at the return value (e.g., success/failure), but that is not required since there is no output schema. Score 4 reflects minor 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 the baseline is 3. The description adds contextual value by listing key fields it validates (id, applySettings.mode/tool, steps, requires.maxFiles), but the schema already covers these. No additional syntax or format details beyond the schema. Score 3 per guidelines.

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?

The description uses the specific verb 'Validate' and the resource 'custom QuokkaPix recipe'. It distinguishes from sibling tools like process_images by stating it is a preflight check that does not process files. It lists the exact fields validated (id, applySettings.mode/tool, steps, requires.maxFiles), making the purpose clear and distinct.

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

Usage Guidelines5/5

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

Explicitly states when to use: 'when an agent generated its own recipe JSON and needs to confirm...' and implies when not to use (e.g., for known-good recipes). It clarifies it is a preflight check only and does not open a browser or process files, which helps the agent decide when to call it vs. process_images.

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

Deploy Server

Other Tools