Skip to main content
Glama

Validate QuokkaPix result manifest

validate_result_manifest

Validate a quokkapix-result.json manifest against an official recipe or custom QA contract to verify status, file counts, formats, dimensions, sizes, and metadata.

Instructions

Validate an existing quokkapix-result.json manifest against an official recipe or custom QA contract. Use this after process_images/process_with_settings or when inspecting a previous run. It checks status, file counts, formats, dimensions, size limits, ZIP entry metadata and marketplace QA metadata; it does not read image pixels or upload files.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
recipeNoOptional custom recipe with expectedResult.qa. Used instead of recipeId when provided.
manifestYesQuokkaPix result manifest returned by getResultManifest() or saved as quokkapix-result.json.
recipeIdNoOptional official recipe id whose expectedResult.qa contract should be used.
ruleProfileIdNoOptional sourced platform rule profile id. The profile is returned beside the QA report for agent audit trails.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changedv0.3.4
    • addedInput schema / properties / ruleProfileId
      Added value: +{
      +  "description": "Optional sourced platform rule profile id. The profile is returned beside the QA report for agent audit trails.",
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. Changed8 schema fields changedv0.3.1
    • addedInput schema / properties / manifest / description
      Added value: +"QuokkaPix result manifest returned by getResultManifest() or saved as quokkapix-result.json."
    • addedInput schema / properties / manifest / properties
      Added value: +{
      +  "errorCode": {
      +    "anyOf": [
      +      {
      +        "type": "string"
      +      },
      +      {
      +        "type": "null"
      +      }
      +    ],
      +    "description": "Stable error code when the run failed or was cancelled."
      +  },
      +  "mode": {
      +    "description": "Run mode reported by QuokkaPix.",
      +    "enum": [
      +      "single",
      +      "batch"
      +    ],
      +    "type": "string"
      +  },
      +  "outputs": {
      +    "description": "Detailed output entries.",
      +    "items": {
      +      "additionalProperties": {},
      +      "description": "One output file or ZIP entry from quokkapix-result.json.",
      +      "properties": {
      +        "format": {
      +          "description": "Output format such as webp, jpg, png, pdf or zip.",
      +          "type": "string"
      +        },
      +        "outputHeight": {
      +          "description": "Output image height in pixels.",
      +          "type": "number"
      +        },
      +        "outputName": {
      +          "description": "Output file or ZIP entry name.",
      +          "type": "string"
      +        },
      +        "outputWidth": {
      +          "description": "Output image width in pixels.",
      +          "type": "number"
      +        },
      +        "sizeBytes": {
      +          "description": "Output byte size when available.",
      +          "type": "number"
      +        },
      +        "sourceHeight": {
      +          "description": "Original image height in pixels.",
      +          "type": "number"
      +        },
      +        "sourceName": {
      +          "description": "Original input file name when available.",
      +          "type": "string"
      +        },
      +        "sourceWidth": {
      +          "description": "Original image width in pixels.",
      +          "type": "number"
      +        },
      +        "warnings": {
      +          "description": "Warnings for this output entry.",
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "processingMs": {
      +    "description": "Processing time in milliseconds when available.",
      +    "type": "number"
      +  },
      +  "source": {
      +    "additionalProperties": {},
      +    "description": "Source file summary.",
      +    "properties": {
      +      "count": {
      +        "description": "Number of source files.",
      +        "type": "number"
      +      },
      +      "totalBytes": {
      +        "description": "Total input bytes when available.",
      +        "type": "number"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "status": {
      +    "description": "Terminal status, expected to be done for a successful run.",
      +    "type": "string"
      +  },
      +  "success": {
      +    "description": "Whether QuokkaPix considered the run successful.",
      +    "type": "boolean"
      +  },
      +  "tool": {
      +    "description": "QuokkaPix tool/workflow that produced the output.",
      +    "type": "string"
      +  },
      +  "warnings": {
      +    "description": "Run-level warnings.",
      +    "items": {
      +      "type": "string"
      +    },
      +    "type": "array"
      +  }
      +}
    • removedInput schema / properties / manifest / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
    • addedInput schema / properties / recipe / description
      Added value: +"Optional custom recipe with expectedResult.qa. Used instead of recipeId when provided."
    • 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: +"Optional official recipe id whose expectedResult.qa contract should be used."
  3. First observedv0.3.0

TDQS

A4.4/5.0
Behavior4/5

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

No annotations provided, so the description carries the burden. It transparently lists what checks are performed (status, file counts, formats, etc.) and explicitly states what it does not do (read pixels or upload files), which is sufficient for a validation tool.

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?

The description is two sentences, front-loaded with the purpose, and every sentence contributes meaning without redundancy.

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 validation tool with 4 parameters and no output schema, the description covers the key aspects: what it validates, when to use, and its limitations. It omits explanation of the optional ruleProfileId parameter, but overall it is adequate.

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?

Schema coverage is 100%, baseline is 3. The description adds value by contextualizing parameters (e.g., 'official recipe or custom QA contract') beyond the schema, though it does not detail all parameters individually.

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 explicitly states the action (validate) and the resource (quokkapix-result.json manifest), and mentions it is used after specific sibling tools (process_images/process_with_settings), clearly distinguishing its role.

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?

The description provides clear usage context: 'Use this after process_images/process_with_settings or when inspecting a previous run.' It also states what the tool does not do, setting expectations, but does not explicitly list when not to use it.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/quokkapix/quokkapix-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server