Skip to main content
Glama
Claude ATEM MCP
by La8Grt8

Set Upstream Keyer Mask

atem_set_usk_mask
Idempotent

Sets an upstream keyer's screen-space mask to clip a DVE overlay to a specific output-frame region, hiding everything outside the defined rectangle.

Instructions

Set the screen-space mask (clip region) for an upstream keyer. This defines an absolute rectangle on the output frame — anything outside is hidden.

Use this to clip a DVE overlay to a specific region of the screen (e.g., one cell of a grid layout).

The coordinate system:

  • Left/Right: -16000 to +16000 (left edge to right edge of frame)

  • Top/Bottom: -9000 to +9000 (bottom edge to top edge of frame)

  • Default (full frame): maskLeft=-16000, maskRight=16000, maskTop=9000, maskBottom=-9000

Example — clip to left-third, top-half of frame: maskEnabled=true, maskLeft=-16000, maskRight=-5333, maskTop=9000, maskBottom=0

Args:

  • me (number, optional): Mix Effect bus (default: 0)

  • usk (number): Upstream keyer number (0-based)

  • maskEnabled (boolean, optional): Enable/disable the mask

  • maskTop (number, optional): Top edge (-9000 to 9000)

  • maskBottom (number, optional): Bottom edge (-9000 to 9000)

  • maskLeft (number, optional): Left edge (-16000 to 16000)

  • maskRight (number, optional): Right edge (-16000 to 16000)

Input Schema

NameRequiredDescriptionDefault
meNoMix Effect bus
uskYesUpstream keyer number (0-based)
maskTopNoTop edge of visible region
maskLeftNoLeft edge of visible region
maskRightNoRight edge of visible region
maskBottomNoBottom edge of visible region
maskEnabledNoEnable mask clipping

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.5.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare the write/idempotent/non-destructive profile, and the description adds real context: the coordinate space is absolute screen space, outside the rectangle is hidden, and the default is full frame. It does not say whether omitted edge values are reset to default or left unchanged, nor how maskEnabled=false interacts with stored coordinates.

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?

Purpose, use case, coordinate system, and example are front-loaded and earn their place. The trailing 'Args:' block restates every schema parameter description verbatim at 100% coverage, which is redundant bulk an agent does not need.

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 7-parameter mutation tool with no output schema and annotations covering the safety profile, the description supplies everything needed to construct a correct call: ranges with frame-relative meaning, the full-frame default, and a concrete example. Return values are not needed since the call is idempotent and the effect is described.

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 baseline is 3, but the description goes beyond the schema by mapping values to frame edges ('left edge to right edge of frame'), stating the full-frame default set, and giving a worked example combination. It doesn't clarify what happens to edges left unspecified on a partial update, which is the remaining ambiguity.

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 ('Set the screen-space mask (clip region) for an upstream keyer') and immediately defines what the mask is ('an absolute rectangle on the output frame'). This clearly separates it from siblings like atem_set_usk_dve or atem_set_usk_sources, which configure other aspects of the same keyer.

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?

'Use this to clip a DVE overlay to a specific region of the screen (e.g., one cell of a grid layout)' gives a concrete use case and the intent behind the tool. It stops short of naming when NOT to use it or pointing to a specific alternative sibling (e.g., DVE position/scale vs. mask), so it lands at clear-context-without-exclusions.

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