Skip to main content
Glama
kumoproductions

mcp-aftereffects

by kumoproductions
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Render frame

ae_render_frame

Render After Effects frames to PNG for visual verification of edits. Capture one frame or several times in one call, with optional contact sheets and analysis to catch off-frame elements.

Instructions

Render one or more frames to PNG. Use to visually verify edits. The agent's 'eyes' — pair with mutations for a visual feedback loop. Headless and deterministic. Pass time for one frame, or times for several in ONE call (motion checks): files land at _.png and are listed in frames. contactSheet tiles every frame into one labelled PNG (_sheet.png) so a motion check is one image; analyze measures each capture (uniform edge bands = black bars / transparent margins, content bounds, coverage) so off-frame elements and letterboxing are caught numerically. In color-managed projects (workingSpace != None) the capture applies AE's own display transform via a transient OCIO Display Transform adjustment layer, and the PNG comes back viewer-accurate and sRGB-tagged. Where that layer cannot be used — read-only mode, an AE without the OCIO effect, or a failed capture calibration — the result falls back to a pure-math ACES conversion or to raw values with an explicit colorWarning; check colorPipeline / colorWarning on the response.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
timeNoTime in seconds to render. Give exactly one of `time` or `times`.
timesNoSeveral times in seconds, rendered in ONE call. Files are written as <outPath stem>_<index><ext> and reported in `frames` (index-aligned).
analyzeNoMeasure each capture: uniform bands at every edge (width + transparent/color — black bars, letterboxing, empty margins), the bounding box of non-background pixels, coverage, mean RGB. Reported per frame as `analysis` (measured on the capture before color conversion).
outPathYesAbsolute path to write the PNG. Parent directory is created if missing. With `times`, used as the naming stem for every frame.
instanceNoAfter Effects instance to address for this call, when several are running (AfterFX.exe -m): an instance id (its AE_MCP_INSTANCE at launch, or the `name` given to instance.start) or the name of the project file it has open. Omit to use this server's default (AE_MCP_INSTANCE, else the single live instance). ae_context and ae_do instance.list show what is live.
colorManagedNo'auto' (default): detect the working space and return a viewer-accurate, 8-bit sRGB-tagged PNG. 'off': raw legacy output (16-bit, untagged, working-space values — dark/wrong-looking in color-managed projects).
compNameOrIdYesComposition name or numeric item id.
contactSheetNoTile all rendered frames into ONE labelled PNG (#index + time above each tile). Pass {} for defaults.
useDisplayStartTimeNoIf true, times are interpreted relative to comp.displayStartTime. Default false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv0.3.1
    • addedInput schema / properties / analyze
      Added value: +{
+  "description": "Measure each capture: uniform bands at every edge (width + transparent/color — black bars, letterboxing, empty margins), the bounding box of non-background pixels, coverage, mean RGB. Reported per frame as `analysis` (measured on the capture before color conversion).",
+  "type": "boolean"
+}
    • removedInput schema / properties / compNameOrId / anyOf
      Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "number"
-  }
-]
    • addedInput schema / properties / compNameOrId / type
      Added value: +[
+  "string",
+  "number"
+]
    • addedInput schema / properties / contactSheet
      Added value: +{
+  "description": "Tile all rendered frames into ONE labelled PNG (#index + time above each tile). Pass {} for defaults.",
+  "properties": {
+    "columns": {
+      "description": "Tiles per row (default ceil(sqrt(n))).",
+      "exclusiveMinimum": 0,
+      "maximum": 9007199254740991,
+      "type": "integer"
+    },
+    "outPath": {
+      "description": "Sheet path (default <outPath stem>_sheet.png).",
+      "type": "string"
+    },
+    "thumbWidth": {
+      "description": "Tile width in px, never upscaled (default 480).",
+      "maximum": 2048,
+      "minimum": 16,
+      "type": "integer"
+    }
+  },
+  "type": "object"
+}
    • addedInput schema / properties / instance
      Added value: +{
+  "description": "After Effects instance to address for this call, when several are running (AfterFX.exe -m): an instance id (its AE_MCP_INSTANCE at launch, or the `name` given to instance.start) or the name of the project file it has open. Omit to use this server's default (AE_MCP_INSTANCE, else the single live instance). ae_context and ae_do instance.list show what is live.",
+  "type": "string"
+}
    • changedInput schema / properties / outPath / description
      Previous value: -"Absolute path to write the PNG. Parent directory is created if missing."New value: +"Absolute path to write the PNG. Parent directory is created if missing. With `times`, used as the naming stem for every frame."
    • changedInput schema / properties / time / description
      Previous value: -"Time in seconds to render."New value: +"Time in seconds to render. Give exactly one of `time` or `times`."
    • addedInput schema / properties / times
      Added value: +{
+  "description": "Several times in seconds, rendered in ONE call. Files are written as <outPath stem>_<index><ext> and reported in `frames` (index-aligned).",
+  "items": {
+    "minimum": 0,
+    "type": "number"
+  },
+  "maxItems": 32,
+  "minItems": 1,
+  "type": "array"
+}
    • changedInput schema / properties / useDisplayStartTime / description
      Previous value: -"If true, `time` is interpreted relative to comp.displayStartTime. Default false."New value: +"If true, times are interpreted relative to comp.displayStartTime. Default false."
    • changedInput schema / required
      Previous value: -[
-  "compNameOrId",
-  "time",
-  "outPath"
-]New value: +[
+  "compNameOrId",
+  "outPath"
+]
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only declare destructiveHint=false, so the description carries the behavioral load and does it well: headless, deterministic, per-frame file naming, contact-sheet output, numeric analysis, and a detailed color-management escalation path including fallbacks and an explicit colorWarning. This is exactly what an agent needs to interpret a surprising PNG.

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 purpose and usage in the first two sentences, then parameter and color behavior. It is long and the color-managed paragraph is dense, but each sentence carries operational information rather than 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?

With 9 parameters, nested contactSheet, and no output schema, the description fills the gap by naming the response fields (frames, analysis, colorPipeline, colorWarning) and their interpretation. Nothing an agent needs to call or read the result correctly is missing.

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 100%, so baseline is 3, but the description adds interpretive meaning the schema lacks: `times` is a single-call motion check with index-aligned files, `analyze` is measured before color conversion, and the fallback pipeline is surfaced via colorPipeline/colorWarning. It mostly restates a few parameters, so not a 5.

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?

Opens with a specific verb and resource ('Render one or more frames to PNG') and frames the tool's role ('the agent's eyes') so it is immediately distinguishable from every sibling, none of which capture imagery. An agent can place it 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?

Gives clear when-to-use guidance — visually verify edits, pair with mutations for a feedback loop, motion checks via `times` — which selects the right mode of call. It stops short of naming alternatives or explicit when-not-to-use conditions, but no sibling competes for this job.

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

Deploy Server

Other Tools