tdmcp

Create keyer

create_keyer

Composite a keyed subject over any background in TouchDesigner using chroma, luma, or RGB keying, with adjustable tolerance and softness for clean edges.

Instructions

Composite a keyed performer, logo, or any source over a background visual — the green-screen / chroma-key / matte tool for installations and live camera work. Creates a self-contained baseCOMP under parent_path that holds the full chain: source (Select TOP or test card) → key stage → composite → Null TOP output. Three key_type modes: 'chroma' (Chroma Key TOP, keys on Hue/Sat/Val range — best for green/blue-screen), 'luma' (Level TOP threshold + Matte TOP — keys by brightness), 'rgb' (RGB Key TOP, keys on R/G/B channel ranges — best for a solid background colour). key_color sets the target colour to remove (chroma/rgb modes); tolerance widens the key range; softness feathers the edge. With a source the footage is pulled in via a Select TOP (so it can live in another container); without one, a constant green test card is used so the chain builds and previews standalone. With a background the composited result is placed over it; without one, a diagonal ramp is used. Tolerance/Softness/KeyColor controls are exposed on the container. Output is a Null TOP. Returns a summary with the container path, created node paths, exposed controls, any node errors, warnings, and an inline preview image.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "create_keyer"
  }
}

Input Schema

Name	Required	Description	Default
`name`	No	Name for the keyer COMP.	keyer
`source`	No	TOP to pull the key FROM (e.g. a camera/live source). Omit → a built-in test source.
`key_type`	No	chroma: green/blue-screen (Chroma Key TOP, keys on Hue+Sat+Val range); luma: brightness key (Level TOP + Matte TOP, keys on luminance); rgb: key a specific RGB color (RGB Key TOP, keys on R/G/B channel ranges).	chroma
`softness`	No	Edge softness/feather.
`key_color`	No	(chroma/rgb) Hex color to key out.	#00ff00
`tolerance`	No	Key tolerance/range.
`background`	No	TOP to composite the keyed result OVER. Omit → a built-in test background.
`resolution`	No	Output resolution [w,h].
`parent_path`	No	Where to build it.	/project1

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.13.1Aug 2, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Beyond the annotations (readOnlyHint=false, destructiveHint=false), the description discloses the full chain creation ('source (Select TOP or test card) → key stage → composite → Null TOP output'), the exposed controls on the container, and the return summary with 'node errors, warnings, and an inline preview image'. This is rich behavioral context beyond what annotations provide.

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?

Every sentence contributes distinct information: purpose, chain structure, mode comparisons, parameter roles, and return behavior. It is dense but not bloated, and it is front-loaded with the main verb and resource.

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 no output schema, the description compensates by explicitly detailing return values (container path, created node paths, exposed controls, errors, warnings, inline preview). It also covers optional inputs and the built output topology, making it complete for a complex creation tool.

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 the parameters are already described. The description adds workflow-level meaning, such as 'key_color sets the target colour to remove (chroma/rgb modes)' and the fallback test card when no source is given, which helps the agent understand parameter relationships and optional behaviors.

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 opens with 'Composite a keyed performer, logo, or any source over a background visual' and explicitly labels it as 'the green-screen / chroma-key / matte tool'. This is a specific verb+resource that distinguishes it from generic create_* tools, and it further details the three key_type modes to eliminate ambiguity.

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 description provides context ('for installations and live camera work') and explains conditional behavior (with/without a source or background). However, it does not explicitly name alternatives or state when not to use this tool, though the context makes the intended use clear.

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

Deploy Server