Skip to main content
Glama

Preview Component

preview_component
Read-onlyIdempotent

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.

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": {
      "projectId": "<projectId>",
      "body": "<body>"
    },
    "name": "preview_component"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyYes
commandIdNoRetry identity. A call repeated with the same commandId returns the first result instead of acting twice.
projectIdYesprojectId (path).

Output 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. Changed10 schema fields changed
    • addedInput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "additionalProperties": {
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "properties": {},
      +    "type": "object"
      +  },
      +  "__schema1": {
      +    "const": 24,
      +    "type": "number"
      +  },
      +  "__schema2": {
      +    "const": 25,
      +    "type": "number"
      +  },
      +  "__schema3": {
      +    "const": 30,
      +    "type": "number"
      +  },
      +  "__schema4": {
      +    "const": 60,
      +    "type": "number"
      +  },
      +  "__schema5": {
      +    "maxLength": 128,
      +    "minLength": 1,
      +    "type": "string"
      +  }
      +}
    • addedInput schema / properties / body / properties / assets / $ref
      Added value: +"#/$defs/__schema0"
    • removedInput schema / properties / body / properties / assets / additionalProperties
      Removed value: -{
      -  "minLength": 1,
      -  "type": "string"
      -}
    • removedInput schema / properties / body / properties / assets / properties
      Removed value: -{}
    • removedInput schema / properties / body / properties / assets / type
      Removed value: -"object"
    • changedInput schema / properties / body / properties / fps / anyOf
      Previous value: -[
      -  {
      -    "const": 24,
      -    "type": "number"
      -  },
      -  {
      -    "const": 25,
      -    "type": "number"
      -  },
      -  {
      -    "const": 30,
      -    "type": "number"
      -  },
      -  {
      -    "const": 60,
      -    "type": "number"
      -  }
      -]New value: +[
      +  {
      +    "$ref": "#/$defs/__schema1"
      +  },
      +  {
      +    "$ref": "#/$defs/__schema2"
      +  },
      +  {
      +    "$ref": "#/$defs/__schema3"
      +  },
      +  {
      +    "$ref": "#/$defs/__schema4"
      +  }
      +]
    • addedInput schema / properties / commandId / $ref
      Added value: +"#/$defs/__schema5"
    • removedInput schema / properties / commandId / maxLength
      Removed value: -128
    • removedInput schema / properties / commandId / minLength
      Removed value: -1
    • removedInput schema / properties / commandId / type
      Removed value: -"string"
  2. Changed1 schema field changed
    • addedInput schema / properties / commandId
      Added value: +{
      +  "description": "Retry identity. A call repeated with the same commandId returns the first result instead of acting twice.",
      +  "maxLength": 128,
      +  "minLength": 1,
      +  "type": "string"
      +}
  3. Changed4 schema fields changed
    • addedInput schema / properties / body / example
      Added value: +{
      +  "componentId": "cmp_lower_third",
      +  "params": {
      +    "subtitle": "up 40%",
      +    "title": "Q3 revenue"
      +  }
      +}
    • addedInput schema / properties / body / properties / assets / properties
      Added value: +{}
    • addedInput schema / properties / body / properties / assets / propertyNames / minLength
      Added value: +1
    • addedInput schema / properties / body / properties / params / properties
      Added value: +{}
  4. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Goes well past the annotations: async job lifecycle, the wait_job follow-up contract, failure handling (admission/runtime/capability failures land on the job terminal with sanitized author-fixable messages), and idempotency keyed on the immutable render key. The idempotency-per-render-key detail refines rather than restates idempotentHint=true.

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 verb and the async contract, then progressively narrows to params vs assets and failure semantics. It is dense and jargon-heavy ("content-addressed component bundle", "verified artifact contract") but no sentence is filler.

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?

Given an output schema exists and the schema documents most body fields, the description covers everything needed to call correctly: async flow, follow-up tool, prop-vs-slot distinction, failure surface, and idempotency. Nothing material is missing for correct invocation.

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?

At 67% schema coverage, the description compensates where the schema is silent: `params` has no schema description, and the text explains it renders the mount's props, while manifest slots bind separately and reach the scene's `assets`, never params. It also clarifies that `body.componentId` selects the component, though it adds nothing for fps/width/height/durationInFrames, 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 and resource: "Queue a typed preview artifact for ONE org-installed component." The scope qualifiers (ONE, org-installed) separate it from composition-level previews like preview_frame/preview_clip without the agent needing to open a 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?

Gives explicit invocation context: it is ASYNC, returns a jobId immediately, and the agent must follow up with wait_job(kind="preview", id=jobId). It also says which body fields select the component and supply props. It stops short of naming alternatives such as preview_frame or preview_clip and when those should be preferred.

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.