Skip to main content
Glama

light

Idempotent

Sets a video shot's illumination using presets, ambient color and level, or individual sources; returns the result as one undoable step.

Instructions

Light a shot: a lighting preset (the style's moods), and/or the ambient colour and level, and single lights. Any hand change makes it a custom look. Ids must come from the current style: call library to see them (a wrong id is refused with the valid list). Returns the lighting. One undo step for the person. To change the light over time, use keys (scene:light or light:).

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": "light"
  }
}

Input Schema

NameRequiredDescriptionDefault
shotNoThe shot's id (from get_project). Left out: the shot on screen.
levelNoAmbient level, 0 to 1.2.
presetNoLighting preset id (library lights).
ambientNoAmbient colour, "#RRGGBB".
add_lightNoAdd one light.
change_lightNoChange one light.
remove_lightNoLight id to remove.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed19 schema fields changedv0.1.2
    • addedInput schema / properties / add_light / description
      Added value: +"Add one light."
    • addedInput schema / properties / add_light / properties / color / description
      Added value: +"Light colour, \"#RRGGBB\"."
    • addedInput schema / properties / add_light / properties / flicker / description
      Added value: +"true: flickers like fire."
    • addedInput schema / properties / add_light / properties / intensity / description
      Added value: +"0 to 4."
    • addedInput schema / properties / add_light / properties / x / description
      Added value: +"-14 to 14 across."
    • addedInput schema / properties / add_light / properties / y / description
      Added value: +"0 to 12 height."
    • addedInput schema / properties / add_light / properties / z / description
      Added value: +"-8 to 10, near (+) / far (-)."
    • changedInput schema / properties / ambient / description
      Previous value: -"\"#RRGGBB\"."New value: +"Ambient colour, \"#RRGGBB\"."
    • addedInput schema / properties / change_light / description
      Added value: +"Change one light."
    • addedInput schema / properties / change_light / properties / color / description
      Added value: +"Light colour, \"#RRGGBB\"."
    • addedInput schema / properties / change_light / properties / flicker / description
      Added value: +"true: flickers like fire."
    • addedInput schema / properties / change_light / properties / id / description
      Added value: +"Light id from get_shot."
    • addedInput schema / properties / change_light / properties / intensity / description
      Added value: +"0 to 4."
    • addedInput schema / properties / change_light / properties / x / description
      Added value: +"-14 to 14 across."
    • addedInput schema / properties / change_light / properties / y / description
      Added value: +"0 to 12 height."
    • addedInput schema / properties / change_light / properties / z / description
      Added value: +"-8 to 10."
    • addedInput schema / properties / level / description
      Added value: +"Ambient level, 0 to 1.2."
    • addedInput schema / properties / preset / description
      Added value: +"Lighting preset id (library lights)."
    • changedInput schema / properties / remove_light / description
      Previous value: -"Light id."New value: +"Light id to remove."
  2. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare the mutation/safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=true), so the description only needs to add context — and it does: invalid ids are refused with the valid list, the call returns the lighting, and the change collapses into one undo step. The state consequence ('Any hand change makes it a custom look') is a genuinely useful side effect. It stops short of saying whether existing lights are replaced or merged when a preset is applied.

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 the core action and then the prerequisites, alternatives, and side effects; nearly every clause carries information. The telegraphed style ('a lighting preset (the style's moods)', 'and/or ... and single lights') costs some readability without adding much.

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?

For a 7-parameter, nested-object mutation with no output schema, the definition covers the essentials: what is set, where ids come from, failure behavior, return value ('Returns the lighting'), undo scope, and the sibling to use for time-varying light. Only the merge-vs-replace semantics when applying a preset remain unstated.

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; the description still adds meaning by grouping the params into preset vs. ambient colour/level vs. single lights (add/change/remove), and by imposing a cross-parameter constraint the schema never states: ids must come from the current style and a wrong id is rejected with the valid list.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Light a shot') and enumerates the three things it controls: a preset, ambient colour/level, and individual lights. The parenthetical '(the style's moods)' and the compressed 'and/or ... and single lights' phrasing make it slightly cryptic, but an agent can tell this sets shot lighting and that it is not the same as animating it.

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?

Explicitly routes to siblings: 'call library to see them' for preset/light ids, and 'To change the light over time, use keys (scene:light or light:<id>)' for the animation case. It lacks a stated when-not for the static case, but the main fork in usage is covered.

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