Skip to main content
Glama

set_allow_cinematic_control

DestructiveIdempotent

Set whether the active level editor viewport can be controlled by cinematic tools like Sequencer for sequence previews. Blocks or allows cinematic possession for the current editor session.

Instructions

Set whether the active level editor viewport (the focused one, else the first) may be possessed by cinematic tools such as Sequencer to preview sequences (FEditorViewportClient::SetAllowCinematicControl). It sets the given value rather than toggling; it lasts for this editor session, nothing is saved or undoable, and no viewport is an error. allows_cinematic_control is read back from the viewport. Read the flag without changing it with get_allow_cinematic_control.

Returns: { applied: bool, requested: bool, allows_cinematic_control: bool }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
allowYesTrue to allow cinematic control, false to block it

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare destructiveHint=true, idempotentHint=true and readOnlyHint=false, and the description adds context the annotations cannot: the change is session-scoped, is not saved and is not undoable, the value is read back from the viewport, and the no-viewport case is an error. That is exactly the persistence/error detail an agent needs before mutating editor state.

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 scope, with persistence and error caveats following; no filler sentences. The opening sentence is dense with semicolon-joined clauses, which costs a little readability but nothing is wasted.

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?

No output schema exists, and the description compensates by spelling out the returned shape ({ applied, requested, allows_cinematic_control }), along with target selection, persistence, and error behavior. An agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the single boolean 'allow' is already described as true/false in the schema. The description touches the same semantics ('sets the given value rather than toggling') but adds no new syntax or format detail beyond what the schema provides, so the baseline 3 applies.

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?

Names a specific verb and resource (set whether the active level editor viewport may be possessed by cinematic tools), pins down the exact target (the focused viewport, else the first), and cites the underlying API (FEditorViewportClient::SetAllowCinematicControl). It also names its read-only sibling get_allow_cinematic_control, which lets an agent separate it from the surrounding rig/animation set_* tools.

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 states it sets rather than toggles, points to get_allow_cinematic_control for reading without mutation, and gives the failure condition ('no viewport is an error'). Both the when-to-use and the alternative are spelled out.

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