Skip to main content
Glama

Set Sequence Pixel Aspect Ratio

set_sequence_pixel_aspect_ratio

Changes the active sequence's pixel aspect ratio to values such as square or DV pixels, returning a capability error when the legacy host has no writable setting.

Instructions

Change the pixel aspect ratio of the active sequence, or return a capability error when the legacy host does not expose a writable setting.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "ratio": "<ratio>"
    },
    "name": "set_sequence_pixel_aspect_ratio"
  }
}

Input Schema

NameRequiredDescriptionDefault
ratioYesPixel aspect ratio string (for example '1.0' for square pixels or '1.4222' for 16:9 DV).
idempotency_keyNoOptional client-chosen key (1-128 chars of A-Z a-z 0-9 . _ : -) for this intended edit. Pass a fresh key per edit and reuse it only when retrying that same edit, for example after a client-side timeout. A repeat with the same tool, key and arguments is not run again: while the first call is running it fails with IDEMPOTENCY_IN_PROGRESS (poll get_last_operations); after it finished it returns the original outcome marked replayed. A definite failure with nothing applied (receipt outcome not_applied) may be retried with the same key. Reusing a key with different arguments fails with IDEMPOTENCY_KEY_REUSED. Scoped to this MCP session (the stdio server process, or the HTTP server process when Streamable HTTP is stateless per request) and held in memory only (200 keys, 1 hour); it does not survive a restart or reconnect. Read-only invocations are never deduplicated.
expected_cep_targetNoOptional reviewed CEP sequence/clip identity and exact tick ranges. Checked before every generated command; UXP refuses this CEP-only guard.
expected_project_pathNoOptional absolute saved-project path. Every generated CEP command refuses before its body when the active project differs or is unsaved. UXP commands refuse this CEP-only guard; local-only tools do not inspect Premiere. Omit to keep existing behavior.

Output Schema

NameRequiredDescriptionDefault
okYesWhether the tool completed successfully.
dataNoTool-specific result data when ok is true; on failure, diagnostic detail when the tool provides it.
toolYesThe registered MCP tool name.
errorNoFailure detail when ok is false.
receiptNoVersioned common mutation receipt; success never implies rendered verification.
idempotencyNoPresent when idempotency_key deduplicated this call: replayed is true when the original outcome was returned instead of running again.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.30.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare this as a non-read-only, non-destructive mutation, and the description adds genuinely useful context: on a legacy host it fails with a capability error rather than silently no-opping. It does not say whether the change is undoable, whether the sequence must be saved, or that changes are verified against the identity guards before execution, which matters for a mutation.

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?

A single front-loaded sentence containing the action and the failure mode, with no filler. It is arguably too terse for the tool's guard-parameter complexity, but nothing in it is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present and 100% parameter coverage the description need not restate return values, but for a mutation carrying nested identity guards (expected_cep_target, expected_project_path) and an idempotency key, the description never hints that the edit is precondition-checked or how retries behave. Adequate at the surface level; thin relative to the tool's actual complexity.

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 description coverage is 100%, including the ratio format examples and the full idempotency_key and expected_cep_target contracts, so the schema carries the semantics. The description adds nothing about any of the four parameters, so the baseline of 3 applies.

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?

"Change the pixel aspect ratio of the active sequence" is a specific verb plus resource plus scope (active sequence), so an agent can identify the operation immediately and distinguish it from read-side siblings like get_sequence_settings. It never names the closest alternative, set_override_pixel_aspect_ratio, so the sequence-vs-override distinction must be inferred.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied by "of the active sequence" and by the fallback clause describing the legacy-host case, but there is no explicit when-to-use / when-not-to-use guidance and no reference to the override variant or to the sequence needing to be active first. The agent must reason about alternatives from sibling names alone.

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