Skip to main content
Glama

uploadImage

Upload an image

Uploads an image for use in pass templates or per-pass strip overrides. Send as multipart form data with a purpose field and a file field containing the PNG image.

Upload behaviour by purpose:

  • strip — accumulates. Each upload creates a new image; the returned id can be passed as strip_image_id on POST /v1/passes or PATCH /v1/passes/{id} to give individual passes their own banner. Previous strip images are NOT deleted — manage them via DELETE /v1/images/{id} when no longer referenced.

  • All other purposes (icon, logo, thumbnail, background, footer, and all _2x/_3x variants) — replace-on-upload. Uploading a new image of the same purpose deletes the previous one from storage and DB. These are app-wide template assets, not per-pass.

Scope: images:manage

Maps to OpenAPI operationId uploadImage — POST /manage-images.

Same PassFast HTTP API, billing, and rate limits. Do not invent other paths.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
purposeYesThe intended use of the image. `strip` uploads accumulate (for per-pass `strip_image_id` overrides); all other purposes replace existing uploads of the same purpose for the app.
filenameNoOptional filename sent with the multipart upload.
x_app_idNoOverride X-App-Id for this call. Omit the connection header by default; set it only for multi-app orgs.
file_base64YesBase64-encoded file bytes. Maps to the OpenAPI multipart `file` field — same uploadImage (or equivalent) endpoint, not a new API.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / x_app_id / description
      Previous value: -"Override X-App-Id for this call. Defaults to the MCP connection header."New value: +"Override X-App-Id for this call. Omit the connection header by default; set it only for multi-app orgs."
  2. First observed

TDQS

A3.7/5.0
Behavior1/5

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

The description thoroughly discloses that non-strip uploads replace and delete previous images from storage and DB, while strip uploads accumulate. This directly contradicts the annotation destructiveHint=false, which signals a non-destructive operation. Because the description contradicts an annotation, the score is capped at 1 per the rubric.

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 appropriately detailed for a complex tool, with bolded purpose categories and bullets. Every sentence earns its place, explaining behavior, lifecycle, scope, and endpoint mapping without excessive filler. The only trivial redundancy is the title-like first line 'Upload an image.'

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite no output schema, the description covers endpoint mapping, required multipart fields, purpose-specific behavior, deletion side effects, scope (images:manage), billing/rate limits, and the returned id for strip usage. An agent has enough context to invoke the tool correctly and interpret the result.

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 schema already documents purpose, file_base64, filename, and x_app_id. The description mostly restates the schema's purpose semantics (strip accumulates, others replace) and adds only minor reinforcement about multipart encoding. This meets the baseline but does not materially expand on the schema.

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 names the resource (image), its use cases (pass templates or per-pass strip overrides), and maps to a concrete endpoint/operationId (POST /manage-images, uploadImage). It clearly differentiates from sibling upload* tools like uploadCertificate and uploadGoogleCredentials by specifying images and their purposes.

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?

It explicitly states when to use the tool: for pass template assets or per-pass strip overrides, and gives detailed purpose-by-purpose behavior. It does not explicitly list exclusions such as 'do not use for certificates or credentials,' but the image scope and operation mapping make the boundary clear enough.

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.