Skip to main content
Glama

Opentoonz Extract Frames

opentoonz_extract_frames

Extract video frames into PNG drawings as a level for an OpenToonz scene. Set start/end, fps, max width, or frame caps to control output and avoid filling disk.

Instructions

Extract a video's frames into drawings/<level_name>.%04d.png, as a level.

How outside footage joins a scene: extract, then pass the returned paths to opentoonz_import_images_as_level. fps resamples (default keeps the source rate), start/end are seconds, and max_width downscales so a large source does not fill the workspace. max_frames caps the extraction (default 5000) so a long clip cannot fill the disk; raise it, or use start/end/fps, for more. Previous drawings for the same level are cleared first, so a shorter extract cannot leave orphaned frames.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endNo
fpsNo
startNo
videoYes
max_widthNo
workspaceYes
level_nameYes
max_framesNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.8.0

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations, the description carries full behavioral burden and does so: it discloses the destructive side effect ('Previous drawings for the same level are cleared first'), the disk-safety cap (max_frames default 5000), and that fps default preserves source rate. These are exactly the traits an agent needs to invoke safely.

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?

Front-loads the purpose in one sentence, then groups workflow, parameter tuning, and destructive caveat into tight, scannable sentences. No wasted text.

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-value explanation isn't needed, and the description covers the mutation/disk behavior and key params for a complex 8-param tool. Minor gap: workspace/level_name/video semantics are 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?

Schema coverage is 0%, so the description must compensate, and it does for fps, start/end (seconds), max_width (downscale), and max_frames (cap/default). The remaining params workspace, level_name, and video are only indirectly covered, leaving a small gap.

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+resource with output destination: extract a video's frames into drawings/<level_name>.%04d.png as a level. This distinguishes it clearly from the render tools and from opentoonz_import_images_as_level without needing 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names the downstream workflow and sibling: 'extract, then pass the returned paths to opentoonz_import_images_as_level,' and gives the condition for adjusting start/end/fps ('for more'). The agent knows both when to use it and what to do next.

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