Skip to main content
Glama

Generate animation

generate_animation
DestructiveIdempotent

Start a paid asynchronous animation. Requires a prior quote_id or an explicit max_credits limit and an idempotency key. Credits may be charged once production begins.

Input Schema

NameRequiredDescriptionDefault
requestYesExact user-approved request; keep unchanged across retries.
quote_idNoFresh approved quote. At least quote_id or max_credits is required; both are allowed.
max_creditsNoUser-approved per-operation credit cap. Never silently increase it; this is not a multi-task budget.
idempotency_keyYesPersist per logical generation; reuse with the same OAuth client and user after a timeout.

Output Schema

NameRequiredDescriptionDefault
idYesPersist this task ID immediately after create; poll it instead of creating again.
errorNoTask failure details, independently of any usable outputs.
stageNoCurrent pipeline stage when available.
objectYesPublic task resource type.
statusYessucceeded, failed, and cancelled are terminal; cancelling is not terminal.
creditsYesQuoted, reserved, and charged credit states.
outputsNoAvailable assets, including partial outputs on failed/cancelled tasks. Always inspect them at a terminal state.
metadataNoCaller-provided metadata.
progressYesFraction from 0 to 1, not a completion-time estimate.
created_atYesUTC acceptance timestamp.
started_atNoUTC production start when known.
finished_atNoUTC terminal timestamp when known.
resolved_exportNoPersisted FPS sampling summary shared with the quote and manifest; null for legacy tasks.
normalized_inputNoNormalized public input; may contain private prompts or image references. Do not log wholesale.
cancellation_reasonNoStable reason when cancellation is unavailable: TASK_TERMINAL, CANCELLATION_PENDING, CANCELLATION_NOT_CONFIRMED, or GENERATION_ALREADY_SUBMITTED.
cancellation_allowedNoWhether a cancellation request can currently be accepted. Remote cancellation still needs confirmation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedOutput schema / properties / cancellation_allowed
      Added value: +{
      +  "default": false,
      +  "description": "Whether a cancellation request can currently be accepted. Remote cancellation still needs confirmation.",
      +  "title": "Cancellation Allowed",
      +  "type": "boolean",
      +  "x-description-zh": "当前是否允许受理取消请求;远端取消仍须确认。"
      +}
    • addedOutput schema / properties / cancellation_reason
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Stable reason when cancellation is unavailable: TASK_TERMINAL, CANCELLATION_PENDING, CANCELLATION_NOT_CONFIRMED, or GENERATION_ALREADY_SUBMITTED.",
      +  "title": "Cancellation Reason",
      +  "x-description-zh": "不可取消的稳定原因:TASK_TERMINAL、CANCELLATION_PENDING、CANCELLATION_NOT_CONFIRMED 或 GENERATION_ALREADY_SUBMITTED。"
      +}
  2. Changed1 schema field changed
    • changedInput schema / $defs / ExportOptions / properties / output_formats / items / enum
      Previous value: -[
      -  "clip_video",
      -  "webm_alpha",
      -  "prores_4444",
      -  "frames_zip",
      -  "spritesheet",
      -  "spritesheet_json",
      -  "unity_meta",
      -  "unity_pack",
      -  "godot_pack",
      -  "unreal_paper2d_pack",
      -  "cocos_creator_pack",
      -  "construct3_pack"
      -]New value: +[
      +  "clip_video",
      +  "webm_alpha",
      +  "prores_4444",
      +  "gif",
      +  "frames_zip",
      +  "spritesheet",
      +  "spritesheet_json",
      +  "unity_meta",
      +  "unity_pack",
      +  "godot_pack",
      +  "unreal_paper2d_pack",
      +  "cocos_creator_pack",
      +  "construct3_pack"
      +]
  3. Changed1 schema field changed
    • changedInput schema / $defs / ExportOptions / properties / output_formats / items / enum
      Previous value: -[
      -  "clip_video",
      -  "webm_alpha",
      -  "prores_4444",
      -  "frames_zip",
      -  "spritesheet",
      -  "spritesheet_json",
      -  "unity_meta",
      -  "unity_pack",
      -  "godot_pack",
      -  "unreal_paper2d_pack",
      -  "cocos_creator_pack"
      -]New value: +[
      +  "clip_video",
      +  "webm_alpha",
      +  "prores_4444",
      +  "frames_zip",
      +  "spritesheet",
      +  "spritesheet_json",
      +  "unity_meta",
      +  "unity_pack",
      +  "godot_pack",
      +  "unreal_paper2d_pack",
      +  "cocos_creator_pack",
      +  "construct3_pack"
      +]
  4. Changed19 schema fields changed
    • addedInput schema / $defs / AnimationCreateRequest / properties / export / default / fps
      Added value: +null
    • addedInput schema / $defs / ExportOptions / properties / fps
      Added value: +{
      +  "anyOf": [
      +    {
      +      "exclusiveMinimum": 0,
      +      "maximum": 60,
      +      "type": "number"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Source-speed sampling frequency, without interpolation. Independent exports only; requires spritesheet and spritesheet_json. A short final frame preserves the selection duration.",
      +  "title": "Fps",
      +  "x-description-zh": "按源视频原速采样,不补帧;仅用于独立导出,需 spritesheet 和 spritesheet_json;短尾帧保留选区总时长。"
      +}
    • addedInput schema / $defs / ExportOptions / properties / frame_count / anyOf
      Added value: +[
      +  {
      +    "maximum": 240,
      +    "minimum": 1,
      +    "type": "integer"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / $defs / ExportOptions / properties / frame_count / default
      Previous value: -24New value: +null
    • changedInput schema / $defs / ExportOptions / properties / frame_count / description
      Previous value: -"Number of frames sampled over the selected interval, not an FPS field."New value: +"Legacy uniform frame count, mutually exclusive with fps. When both are omitted, uses 24 frames."
    • removedInput schema / $defs / ExportOptions / properties / frame_count / maximum
      Removed value: -240
    • removedInput schema / $defs / ExportOptions / properties / frame_count / minimum
      Removed value: -1
    • removedInput schema / $defs / ExportOptions / properties / frame_count / type
      Removed value: -"integer"
    • changedInput schema / $defs / ExportOptions / properties / frame_count / x-description-zh
      Previous value: -"在选段内采样的帧数,不是 FPS 参数。"New value: +"旧版等间隔帧数,与 fps 互斥;两者均省略时使用 24 帧。"
    • changedInput schema / $defs / ExportOptions / properties / output_formats / description
      Previous value: -"Requested asset formats; defaults to spritesheet. Duplicates are removed. Metadata needs its matching texture."New value: +"Requested asset formats; defaults to spritesheet in frame_count mode, or spritesheet plus spritesheet_json in FPS mode. Duplicates are removed. Metadata needs its matching texture."
    • changedInput schema / $defs / ExportOptions / properties / output_formats / x-description-zh
      Previous value: -"请求的资产格式;默认 spritesheet,重复项会去重,元数据需配套纹理。"New value: +"请求的资产格式;帧数模式默认 spritesheet,FPS 模式默认 spritesheet 加 spritesheet_json。重复项会去重,元数据需配套纹理。"
    • addedOutput schema / $defs / AssetResponse / properties / media
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/MediaResponse"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Whitelisted measured video metadata. Unknown fields are null; non-video assets return null.",
      +  "x-description-zh": "白名单内的实测视频信息,未知字段为 null;非视频资产为 null。"
      +}
    • addedOutput schema / $defs / ExportWarning
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "code": {
      +      "title": "Code",
      +      "type": "string"
      +    },
      +    "details": {
      +      "additionalProperties": true,
      +      "default": {},
      +      "title": "Details",
      +      "type": "object"
      +    },
      +    "message": {
      +      "title": "Message",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "code",
      +    "message"
      +  ],
      +  "title": "ExportWarning",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / MediaResponse
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "duration_seconds": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Playable video duration measured from presentation timestamps; never provider-requested duration.",
      +      "title": "Duration Seconds",
      +      "x-description-zh": "根据呈现时间戳测得的可播放视频时长,不使用供应商请求时长。"
      +    },
      +    "fps": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Measured average source frame rate; use presentation timestamps for VFR selection.",
      +      "title": "Fps",
      +      "x-description-zh": "实测源平均帧率;可变帧率选帧仍依据呈现时间戳。"
      +    },
      +    "frame_count": {
      +      "anyOf": [
      +        {
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Decoded source frame count, or null when unknown.",
      +      "title": "Frame Count",
      +      "x-description-zh": "解码源帧数,未知为 null。"
      +    },
      +    "height": {
      +      "anyOf": [
      +        {
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Displayed video height in pixels, accounting for rotation.",
      +      "title": "Height",
      +      "x-description-zh": "考虑旋转后的显示高度,单位像素。"
      +    },
      +    "width": {
      +      "anyOf": [
      +        {
      +          "type": "integer"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Displayed video width in pixels, accounting for rotation.",
      +      "title": "Width",
      +      "x-description-zh": "考虑旋转后的显示宽度,单位像素。"
      +    }
      +  },
      +  "title": "MediaResponse",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / ResolvedExport
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "duration_ms": {
      +      "description": "Sum of manifest frame durations in milliseconds.",
      +      "title": "Duration Ms",
      +      "type": "integer",
      +      "x-description-zh": "Manifest 逐帧时长的毫秒总和。"
      +    },
      +    "fps": {
      +      "description": "Target sampling frequency; never recalculated as frame_count / duration.",
      +      "title": "Fps",
      +      "type": "number",
      +      "x-description-zh": "目标采样频率,不按帧数除以时长重新计算。"
      +    },
      +    "frame_count": {
      +      "description": "Number of samples strictly before the selected end.",
      +      "title": "Frame Count",
      +      "type": "integer",
      +      "x-description-zh": "严格位于选区终点前的采样帧数。"
      +    },
      +    "selection": {
      +      "$ref": "#/$defs/Selection",
      +      "description": "Resolved source interval; full uses measured playable duration.",
      +      "x-description-zh": "实际源区间,full 使用实测可播放时长。"
      +    },
      +    "warnings": {
      +      "default": [],
      +      "description": "Sampling warnings, including repeated source frames without interpolation.",
      +      "items": {
      +        "$ref": "#/$defs/ExportWarning"
      +      },
      +      "title": "Warnings",
      +      "type": "array",
      +      "x-description-zh": "采样警告,包含未补帧而重复采到源帧的情况。"
      +    }
      +  },
      +  "required": [
      +    "selection",
      +    "fps",
      +    "frame_count",
      +    "duration_ms"
      +  ],
      +  "title": "ResolvedExport",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / Selection
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "duration_seconds": {
      +      "anyOf": [
      +        {
      +          "exclusiveMinimum": 0,
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ],
      +      "default": null,
      +      "description": "Required when mode=range; positive interval length in seconds.",
      +      "title": "Duration Seconds",
      +      "x-description-zh": "mode=range 时必填,选段时长秒数必须为正。"
      +    },
      +    "mode": {
      +      "default": "full",
      +      "description": "full uses the complete source; range requires duration_seconds.",
      +      "enum": [
      +        "full",
      +        "range"
      +      ],
      +      "title": "Mode",
      +      "type": "string",
      +      "x-description-zh": "full 使用完整来源;range 必须提供 duration_seconds。"
      +    },
      +    "start_seconds": {
      +      "default": 0,
      +      "description": "Range start in seconds from the source beginning.",
      +      "minimum": 0,
      +      "title": "Start Seconds",
      +      "type": "number",
      +      "x-description-zh": "相对源视频起点的选段开始秒数。"
      +    }
      +  },
      +  "title": "Selection",
      +  "type": "object"
      +}
    • addedOutput schema / $defs / TaskError / properties / details
      Added value: +{
      +  "additionalProperties": true,
      +  "default": {},
      +  "description": "Public error details, without private storage or provider values.",
      +  "title": "Details",
      +  "type": "object",
      +  "x-description-zh": "公开错误详情,不含私有存储或供应商值。"
      +}
    • addedOutput schema / $defs / TaskError / properties / param
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Related public parameter when available.",
      +  "title": "Param",
      +  "x-description-zh": "可用时提供相关公开参数。"
      +}
    • addedOutput schema / properties / resolved_export
      Added value: +{
      +  "anyOf": [
      +    {
      +      "$ref": "#/$defs/ResolvedExport"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Persisted FPS sampling summary shared with the quote and manifest; null for legacy tasks.",
      +  "x-description-zh": "持久化的 FPS 采样摘要,与报价、Manifest 一致;历史任务为 null。"
      +}
  5. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, but the description adds billing consequences the annotations cannot convey: credits 'may be charged once production begins', i.e. cost is incurred after a point of no return. That is meaningful context for a costly operation, though it omits how to observe completion (polling get_animation).

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?

Three sentences, no filler, with the cost/payment signal placed first so an agent sees the risk before the parameter requirements. Everything in the description earns its place.

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 destructive, paid, async operation with a fully described schema and an output schema, the description covers cost timing, preconditions, and idempotency. The one gap is that it doesn't say the result is retrieved later via get_animation, leaving the async workflow implicit.

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%, so quote_id, max_credits, idempotency_key and request are already documented in detail. The description restates the quote/max_credits either-or requirement and idempotency key presence but adds no syntax or format detail beyond the schema, so 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 ('Start a paid asynchronous animation') with the cost and async traits front-loaded, which cleanly separates it from sibling generators like generate_video and from quote_animation/export_animation. An agent knows exactly what action this performs 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?

The precondition 'Requires a prior quote_id or an explicit max_credits limit and an idempotency key' effectively routes an agent to quote_animation first. It never names the sibling tool or states when not to use this one (e.g., use preview_video for a cheap check), so it stops short of full explicit alternatives guidance.

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.

Resources