Skip to main content
Glama

upscale image

upscale_image
Destructive

Upscale an existing image using a catalog model that supports upscale_image. Use get_model_catalog to choose a supported model and its settings. Returns a tracked task and playable result when complete.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "sourceMediaId": "<sourceMediaId>",
      "model": "<model>"
    },
    "name": "upscale_image"
  }
}

Input Schema

NameRequiredDescriptionDefault
modelYesActive model ID supporting this operation. Use get_model_catalog.
promptNoEdit or enhancement instructions.
maxCostUsdNoMaximum charge for each output. Checked against authoritative pricing before generation.
resolutionNo
aspectRatioNo
endFrameUrlNo
mediaInputsNoNamed media slots from get_model_catalog, for example reference_image_uri or mask_url.
scaleFactorNoUpscaling multiplier when supported by the selected model.
sparkTaskIdNoOriginating Spark task for library history and recovery.
workspaceIdNo
modelVariantNoVariant value from get_model_catalog variantSelector.options, such as high for Flare quality. Uses the catalog default when omitted.
outputFormatNoOutput format when supported by the selected model.
generateAudioNoExplicitly enable or disable generated video audio, when supported.
modelSettingsNoModel-specific controls using keys and options from get_model_catalog inputConstraints.slots or variantSelector.
sourceMediaIdYesCompleted workspace source media. The original is preserved.
idempotencyKeyNoStable request key. Retries with the same key reuse the existing output and do not start another paid generation.
sourceImageUrlNoPublic HTTP(S) source image/start-frame URL. Use mediaId for workspace images.
sourceVideoUrlNoPublic HTTP(S) source-video URL.
endFrameMediaIdNoWorkspace image for the final frame, when supported by the selected model.
referenceImagesNoImages to guide generation. Use labels such as person or product and refer to them as @person or @product in the prompt. Each item accepts a workspace mediaId or a public HTTP(S) URL.
sourceImageMediaIdNoWorkspace image to use as the source image/start frame.
sourceVideoMediaIdNoWorkspace video to edit or transform, when supported by the selected model.

Output Schema

NameRequiredDescriptionDefault
dataNo
errorNo
successYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / properties / data / anyOf
      Previous value: -[
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "aspectRatio": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "downloadUrl": {
      -        "anyOf": [
      -          {
      -            "format": "uri",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "durationMs": {
      -        "type": [
      -          "number",
      -          "null"
      -        ]
      -      },
      -      "error": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "imageUrl": {
      -        "anyOf": [
      -          {
      -            "format": "uri",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "mediaId": {
      -        "type": "string"
      -      },
      -      "model": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "playableUrl": {
      -        "anyOf": [
      -          {
      -            "format": "uri",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "posterUrl": {
      -        "anyOf": [
      -          {
      -            "format": "uri",
      -            "type": "string"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "progress": {
      -        "anyOf": [
      -          {
      -            "maximum": 1,
      -            "minimum": 0,
      -            "type": "number"
      -          },
      -          {
      -            "type": "null"
      -          }
      -        ]
      -      },
      -      "progressLabel": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "prompt": {
      -        "type": [
      -          "string",
      -          "null"
      -        ]
      -      },
      -      "status": {
      -        "enum": [
      -          "queued",
      -          "generating",
      -          "completed",
      -          "failed"
      -        ],
      -        "type": "string"
      -      },
      -      "type": {
      -        "enum": [
      -          "image",
      -          "video",
      -          "audio"
      -        ],
      -        "type": "string"
      -      },
      -      "viewUrl": {
      -        "format": "uri",
      -        "type": "string"
      -      },
      -      "workspaceId": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "workspaceId",
      -      "mediaId",
      -      "type",
      -      "status",
      -      "progress",
      -      "progressLabel",
      -      "playableUrl",
      -      "imageUrl",
      -      "posterUrl",
      -      "downloadUrl",
      -      "viewUrl",
      -      "durationMs",
      -      "model",
      -      "aspectRatio",
      -      "prompt",
      -      "error"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "additionalProperties": false,
      -    "properties": {
      -      "activeIndex": {
      -        "minimum": 0,
      -        "type": "integer"
      -      },
      -      "items": {
      -        "items": {
      -          "$ref": "#/properties/data/anyOf/0"
      -        },
      -        "maxItems": 8,
      -        "minItems": 1,
      -        "type": "array"
      -      }
      -    },
      -    "required": [
      -      "items",
      -      "activeIndex"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "aspectRatio": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "downloadUrl": {
      +        "anyOf": [
      +          {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "durationMs": {
      +        "type": [
      +          "number",
      +          "null"
      +        ]
      +      },
      +      "elapsedSeconds": {
      +        "anyOf": [
      +          {
      +            "minimum": 0,
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "error": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "heartbeatAgeSeconds": {
      +        "anyOf": [
      +          {
      +            "minimum": 0,
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "height": {
      +        "anyOf": [
      +          {
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "imageUrl": {
      +        "anyOf": [
      +          {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "lastHeartbeatAt": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "mediaId": {
      +        "type": "string"
      +      },
      +      "model": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "playableUrl": {
      +        "anyOf": [
      +          {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "posterUrl": {
      +        "anyOf": [
      +          {
      +            "format": "uri",
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "progress": {
      +        "anyOf": [
      +          {
      +            "maximum": 1,
      +            "minimum": 0,
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "progressLabel": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "prompt": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "requestedAspectRatio": {
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "status": {
      +        "enum": [
      +          "queued",
      +          "generating",
      +          "completed",
      +          "failed"
      +        ],
      +        "type": "string"
      +      },
      +      "type": {
      +        "enum": [
      +          "image",
      +          "video",
      +          "audio"
      +        ],
      +        "type": "string"
      +      },
      +      "viewUrl": {
      +        "format": "uri",
      +        "type": "string"
      +      },
      +      "width": {
      +        "anyOf": [
      +          {
      +            "exclusiveMinimum": 0,
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "workspaceId": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "workspaceId",
      +      "mediaId",
      +      "type",
      +      "status",
      +      "progress",
      +      "progressLabel",
      +      "playableUrl",
      +      "imageUrl",
      +      "posterUrl",
      +      "downloadUrl",
      +      "viewUrl",
      +      "durationMs",
      +      "model",
      +      "aspectRatio",
      +      "prompt",
      +      "error"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "additionalProperties": false,
      +    "properties": {
      +      "activeIndex": {
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "items": {
      +        "items": {
      +          "$ref": "#/properties/data/anyOf/0"
      +        },
      +        "maxItems": 8,
      +        "minItems": 1,
      +        "type": "array"
      +      }
      +    },
      +    "required": [
      +      "items",
      +      "activeIndex"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Changed2 schema fields changed
    • changedInput schema / properties / modelSettings / description
      Previous value: -"Model-specific controls using keys and options from get_model_catalog inputConstraints.slots."New value: +"Model-specific controls using keys and options from get_model_catalog inputConstraints.slots or variantSelector."
    • addedInput schema / properties / modelVariant
      Added value: +{
      +  "description": "Variant value from get_model_catalog variantSelector.options, such as high for Flare quality. Uses the catalog default when omitted.",
      +  "minLength": 1,
      +  "type": "string"
      +}
  3. First observed

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare destructiveHint=true, openWorldHint=true and idempotentHint=false, so the safety profile is known. The description adds real context the annotations do not convey — that the call creates a tracked task and yields a playable result on completion. However it never mentions that this is a paid generation subject to maxCostUsd, nor what the destructiveHint means in practice for the source asset.

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?

Three short sentences with the action front-loaded, followed by the model-selection dependency and the return behavior. No filler or redundant restatement of the title; slightly more compactness is possible but there is no wasted clause.

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 22-parameter tool with nested objects and an output schema, the description covers the essential decision points: what it does, which model source to consult, and what the response form is. The rich schema and existing output schema carry the remaining parameter and return-value detail, so the omission of cost/pricing behavior is the main residual 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 82%, so the schema already explains nearly every one of the 22 parameters, including the model/catalog linkage and media inputs. The description only reinforces the catalog dependency and adds nothing about scaleFactor, modelSettings, or idempotencyKey semantics beyond what the schema states. Baseline 3 applies.

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?

States a specific verb and resource ("Upscale an existing image") and scopes it to catalog models supporting the upscale_image operation, which implicitly separates it from non-upscale generation tools. It never names a sibling operation such as upscale_video or edit_image to draw the boundary explicitly, so an agent still infers the alternative space.

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 only usage direction is the prerequisite "Use get_model_catalog to choose a supported model and its settings," which is genuinely useful routing. There is no statement of when to prefer this over edit_image, render_image, or upscale_video, and no exclusions or cost/permission context for choosing it in the first place.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.