Skip to main content
Glama

Get design preview

get_design_preview
Read-onlyIdempotent

Get the rendered preview images of an existing design, by design id (the number returned by compose_design, or the key from a /designs/ URL). A single design returns one image; a carousel returns every slide in order. Use it to see a design before editing or scheduling it.

A carousel, or a design without a stored preview, is rendered on request. Read-only: the design and the brand kit are not changed.

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": {
      "workspace_key": "<workspace_key>",
      "design_id": "<design_id>"
    },
    "name": "get_design_preview"
  }
}

Input Schema

NameRequiredDescriptionDefault
design_idYesThe design id (numeric, from compose_design) or its /designs/<key> key.
workspace_keyYesKey of the workspace to act in. Call list_workspaces to see the workspaces you have access to and their keys.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the description's job is lighter; it adds genuinely new behavior: carousel designs return every slide in order, and designs without a stored preview are rendered on request (an implicit latency/cost signal). The 'design and the brand kit are not changed' sentence mostly echoes the annotations but scopes the guarantee to the brand kit, which is slight added value.

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?

Front-loaded with purpose and id sourcing, then behavior, then safety. Every sentence contributes, though the 'single design returns one image; a carousel returns every slide' duplication could be tightened.

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?

With no output schema, the description usefully explains the return shape (one image per design, ordered slides per carousel). It stops short of saying what form the images take (URLs vs. inline data) or any size/expiry behavior, which leaves a small gap for an image-returning tool.

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 coverage is 100% and both parameters are documented, so the baseline of 3 applies. The description's note that design_id may be the number from compose_design or the /designs/<key> key is helpful but largely duplicates the schema's own parameter description, adding little beyond it.

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 and resource ('Get the rendered preview images of an existing design') plus the identifier semantics, which cleanly separates it from mutation siblings like compose_design and set_design_text. An agent can identify the tool without opening the schema.

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?

'Use it to see a design before editing or scheduling it' gives a concrete usage context, and the design_id sentence routes the agent to where the id comes from (compose_design output or a /designs/<key> URL). No explicit when-not or named alternative comparing to get_generated_image/get_generated_post, which keeps it from a 5.

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.