Skip to main content
Glama

Cancel animation

cancel_animation
DestructiveIdempotent

Best-effort cancellation of an owned animation. Work already in production may not stop and credits already charged are not refunded.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
animation_idYesOwned task the user has asked to cancel.

Output Schema

TableJSON 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • 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。"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

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

The description goes beyond annotations by disclosing that cancellation is best-effort, that in-production work may not stop, and that credits are non-refundable. These are critical behavioral caveats that add significant context beyond the destructiveHint and idempotentHint annotations.

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, front-loaded with the purpose and followed by essential caveats. Every sentence earns its place; no filler or redundancy.

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?

For a simple cancellation tool with one parameter, the description covers the essential behavioral aspects (best-effort, non-refundable) and there is an output schema available. Nothing an agent needs to correctly invoke the tool is missing.

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 description coverage is 100% and the schema already explains the animation_id parameter as 'Owned task the user has asked to cancel.' The tool description adds no additional parameter semantics, so the baseline of 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?

The description states a specific verb ('cancel') and resource ('an owned animation'), and the qualifier 'owned' clarifies scope, distinguishing it from cancel_animation_export and cancel_video_generation. It clearly defines what the tool does.

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?

It provides clear context (cancels an animation) but does not explicitly mention when not to use it or point to alternatives like cancel_animation_export. The sibling names imply differentiation, but the description itself lacks explicit routing 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