Skip to main content
Glama

Create preview job

create_template_preview_job

Request an asynchronous server-side render preview image of a template draft for thumbnail generation. For interactive editing, open the authoring studio URL instead.

Instructions

Request an asynchronous server-side render preview image of a template draft for thumbnail generation. For interactive real-time visual authoring, prefer opening the authoringStudioUrl in browser.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
draftIdYesThe unique draft identifier to generate a render preview for.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
jobIdNo
statusNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.17
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "jobId": {
      +      "type": "string"
      +    },
      +    "status": {
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  2. Changed1 schema field changedv0.1.16
    • addedInput schema / properties / draftId / description
      Added value: +"The unique draft identifier to generate a render preview for."
  3. First observedv0.1.13

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare the mutation profile (readOnlyHint=false, idempotentHint=false, destructiveHint=false). The description adds the key trait the annotations cannot convey: the operation is asynchronous and produces a render job rather than a synchronous image. It omits how the job completes or is polled, but output schema exists to cover the result shape.

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?

Two sentences, both front-loaded and purposeful: the first defines the action and output, the second routes to the alternative. No filler or redundancy.

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 one-parameter job-creation tool with annotations and an output schema, the description covers purpose, async nature, and the alternative path. The only gap is guidance on how/when to poll or retrieve the finished preview, which the output schema may partially address.

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?

Single parameter with 100% schema description coverage, so the schema fully documents draftId. The description only restates that the render targets a template draft, adding no syntax or format detail beyond the schema. Baseline 3 applies.

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: 'request an asynchronous server-side render preview image of a template draft for thumbnail generation.' The scope (draft -> preview image, for thumbnails) is unambiguous, and no sibling tool covers preview rendering.

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 names the alternative path ('For interactive real-time visual authoring, prefer opening the authoringStudioUrl in browser'), which tells the agent when NOT to use this tool. It stops short of stating when this job-based tool is the right choice versus any other rendering route, but the exclusion is clear.

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