Skip to main content
Glama

Preview Component

preview_component
Idempotent

Queue a typed preview artifact for ONE org-installed component — ASYNC: returns a jobId immediately; then wait_job(kind="preview", id=jobId). The preview and production compositor consume the same content-addressed component bundle and verified artifact contract. body.componentId selects the component; pass body.params to render it with props (the mount's params); declared manifest slots are bound separately and reach the scene's assets, never params. Admission/runtime/capability failures land on the job terminal with sanitized author-fixable messages. Idempotent per immutable render key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYes
projectIdYesprojectId (path).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoJob family, e.g. `verify` | `preview` | `brand_kit_extract`.
jobIdNoPoll GET /v1/jobs/{jobId} / wait_job until terminal.
jobKeyNoDeterministic identity of the work (content hash of every input the result depends on). Re-enqueueing the same key returns the same job while it runs; a failed key revives as a fresh attempt.
statusNorunning on a fresh/deduped enqueue; succeeded when an identical request already completed. Cancelled is part of the shared status vocabulary; identical cancelled work revives to running.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare the safety profile (readOnlyHint=false, idempotentHint=true), and the description adds real behavioral context: async job semantics, that failures 'land on the job terminal with sanitized author-fixable messages,' and idempotency 'per immutable render key.' It stops short of auth/rate-limit or timing 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?

Front-loaded with the core verb and async contract, and every sentence carries non-obvious information (slot binding, failure terminal, idempotency). It is dense and slightly long, but not padded.

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?

An output schema exists, so return values need not be explained, and the description does cover input semantics, async flow, failure modes, and idempotency. It is complete for a job-queueing tool, with only sibling differentiation left implicit.

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?

With 50% schema coverage, the description compensates by explaining `body.componentId` selects the component, `body.params` renders props, and manifest slots bind to `assets` and 'never params' — a distinction the schema does not make. It does not cover the numeric fps/width/height/durationInFrames params, which the schema already documents.

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 ('Queue a typed preview artifact') and resource ('ONE org-installed component'), and its 'preview ... component' framing distinguishes it from sibling preview tools like preview_card, preview_clip, and preview_frame.

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?

Explicitly describes the async workflow — 'returns a jobId immediately; then wait_job(kind="preview", id=jobId)' — so the agent knows the required follow-up call. It does not, however, name when to prefer it over the sibling preview_* tools or state exclusions.

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.