Skip to main content
Glama

Import template image

import_template_image

Upload and attach an image to a template draft canvas for background or sample imagery. Use only during template authoring, not for general media library assets.

Instructions

Upload and attach a transient image asset specifically to a template draft canvas. Call while authoring a template draft in canvas studio to place background or sample imagery. Do NOT use for general workspace media library assets, logos, and photos (use import_image instead). Requires draft owner authorization and idempotencyKey. Idempotent: duplicate uploads with identical idempotencyKey return the existing asset. Returns created template image asset with imageId, dimensions, and public CDN preview URL.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
creatorNoOptional author or photographer attribution name.
draftIdYesThe unique template draft ID this image is attached to.
licenseNoOptional license type identifier.
fileNameYesOriginal image filename (e.g. background.jpg).
mimeTypeYesMIME type: image/jpeg | image/png | image/webp
providerYesAsset origin provider: pinterest | unsplash | pexels | user_upload | generated
sourceUrlNoOptional source URL if fetched from web.
dataBase64YesBase64-encoded image binary string.
externalIdNoOptional external asset ID from provider.
attributionNoOptional human-readable attribution string.
searchQueryNoOptional search keyword that discovered this image.
rightsStatusYesRights ownership status: rights_unknown | licensed_for_publish | user_owned | generated
idempotencyKeyYesUnique idempotency key to prevent duplicate image creation.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlNoPublic delivery URL.
imageIdNoCreated template image ID.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed14 schema fields changedv0.1.17
    • addedInput schema / properties / attribution / description
      Added value: +"Optional human-readable attribution string."
    • addedInput schema / properties / creator / description
      Added value: +"Optional author or photographer attribution name."
    • addedInput schema / properties / dataBase64 / description
      Added value: +"Base64-encoded image binary string."
    • addedInput schema / properties / draftId / description
      Added value: +"The unique template draft ID this image is attached to."
    • addedInput schema / properties / externalId / description
      Added value: +"Optional external asset ID from provider."
    • addedInput schema / properties / fileName / description
      Added value: +"Original image filename (e.g. background.jpg)."
    • addedInput schema / properties / idempotencyKey / description
      Added value: +"Unique idempotency key to prevent duplicate image creation."
    • addedInput schema / properties / license / description
      Added value: +"Optional license type identifier."
    • changedInput schema / properties / mimeType / description
      Previous value: -"image/jpeg | image/png | image/webp"New value: +"MIME type: image/jpeg | image/png | image/webp"
    • changedInput schema / properties / provider / description
      Previous value: -"pinterest | unsplash | pexels | user_upload | generated"New value: +"Asset origin provider: pinterest | unsplash | pexels | user_upload | generated"
    • changedInput schema / properties / rightsStatus / description
      Previous value: -"rights_unknown | licensed_for_publish | user_owned | generated"New value: +"Rights ownership status: rights_unknown | licensed_for_publish | user_owned | generated"
    • addedInput schema / properties / searchQuery / description
      Added value: +"Optional search keyword that discovered this image."
    • addedInput schema / properties / sourceUrl / description
      Added value: +"Optional source URL if fetched from web."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "imageId": {
      +      "description": "Created template image ID.",
      +      "type": "string"
      +    },
      +    "url": {
      +      "description": "Public delivery URL.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. First observedv0.1.13

TDQS

A3.7/5.0
Behavior1/5

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

The description asserts 'Idempotent: duplicate uploads with identical idempotencyKey return the existing asset,' but the annotations declare idempotentHint=false. Since idempotencyKey is a required argument, every call includes it, so the stated behavior directly contradicts the annotation. This is an annotation contradiction, which per the rubric scores 1 regardless of the otherwise useful auth and return-value details.

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?

Purpose is front-loaded and each sentence carries distinct information (scope, when-to-use, exclusion, auth/idempotency, return shape). The final sentence describing returned fields is partly redundant given the tool already has an output schema, so it is slightly over-long rather than wasteful.

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 13-parameter mutation tool with a full output schema and annotation coverage, the description supplies the missing routing, authorization and return-shape context. The only shortfall is that its idempotency claim conflicts with idempotentHint=false, leaving the true retry behavior ambiguous.

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% across all 13 parameters, so the schema already documents draftId, provider, rightsStatus, mimeType, etc. The description only re-references idempotencyKey and mentions auth; it adds no syntax or format detail beyond the structured fields. Baseline 3 is appropriate.

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?

States a specific verb (import/upload), a specific resource (transient image asset) and its scope (attached to a template draft canvas). It explicitly distinguishes itself from the sibling import_image, so an agent can disambiguate without opening either schema.

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?

Gives both sides: 'Call while authoring a template draft in canvas studio' and an explicit exclusion ('Do NOT use for general workspace media library assets, logos, and photos (use import_image instead)'). The alternative tool is named with the condition that selects it.

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