Skip to main content
Glama

setAspectRatio

Set the export shape to 16:9, 9:16, 1:1, 4:5, auto, or a source clip ratio so videos fit X, YouTube, stories, shorts, or square feeds. Annotations keep their place and shape.

Instructions

Set the shape of the exported video: 16:9 for X, YouTube or a slide, 9:16 for a vertical story or short, 1:1 or 4:5 for a square feed, auto to follow the recording, or one of the clips' own shapes (getCurrentDocument's settingsContext.originalAspectRatios). Annotations on the frame keep their place and shape. The same as setEditorSettings with aspectRatio alone.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdNoThe project to act on, from listProjects. Omit it only for the project open in the OpenScreen editor, which works only while the app runs.
aspectRatioYes"auto", one of 16:9, 9:16, 1:1, 4:3, 4:5, 16:10, 10:16, or a token from getCurrentDocument's settingsContext.originalAspectRatios.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and destructiveHint=false, so the safety profile is covered. The description adds genuinely useful behavioral context beyond that: 'Annotations on the frame keep their place and shape,' disclosing that existing overlay content is preserved when the ratio changes. It stops short of stating whether the change is immediate or undoable.

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-loads the core action, then packs value-mapping and sibling equivalence into two tight sentences. The enumeration is long but every entry carries decision-relevant information for picking a ratio.

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 2-param, no-output-schema mutation tool with annotations covering safety, the description covers purpose, valid inputs, cross-tool equivalence, and preservation behavior. Minor gaps remain (immediacy of effect, undo, permission requirements) but nothing blocks correct invocation.

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 adds meaning beyond the schema by explaining what each ratio value is for (16:9 = X/YouTube/slide, auto = follow recording) and by clarifying that a token from getCurrentDocument's settingsContext.originalAspectRatios is a valid input.

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+resource ('Set the shape of the exported video') and enumerates the value space, so the agent immediately knows this is an aspect-ratio setter. It also explicitly relates itself to the sibling setEditorSettings ('The same as setEditorSettings with aspectRatio alone'), disambiguating it from that tool.

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 concrete usage guidance by mapping each value to an intent (16:9 for X/YouTube/slide, 9:16 for vertical story/short, 1:1 or 4:5 for square feed, auto to follow the recording). Lacks explicit when-not-to-use guidance, but the setEditorSettings equivalence tells the agent the two can be used interchangeably.

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