Skip to main content
Glama

Set Override Pixel Aspect Ratio

set_override_pixel_aspect_ratio

Override a project item’s pixel aspect ratio using numerator and denominator values, then read it back to verify the change.

Instructions

Override the pixel aspect ratio of a project item and read it back

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": {
      "item_id": "<item_id>",
      "numerator": "<numerator>",
      "denominator": "<denominator>"
    },
    "name": "set_override_pixel_aspect_ratio"
  }
}

Input Schema

NameRequiredDescriptionDefault
item_idYesNode ID or name of the project item, or the sequence ID of a sequence
numeratorYesPAR numerator (e.g., 1 for square pixels)
denominatorYesPAR denominator (e.g., 1 for square pixels)
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 a non-read-only, non-destructive, non-idempotent mutation, and the schema covers the idempotency key and the expected_cep_target/expected_project_path guards in detail. The only behavioral value the description adds is "read it back," indicating the tool returns the effective value after writing; it says nothing about what happens on an unsaved or mismatched project, which is the real operational risk here.

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 with no filler; the verb and target come first. It is efficient, though the trailing "and read it back" is slightly clunky and could be folded into the main clause.

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?

This is a 6-parameter mutation with nested identity guards and an output schema, so an agent needs enough to act safely. The description is far too thin: it never warns that the CEP guard fields will cause a refusal on project mismatch, that the idempotency key is scoped to the session and memory only, or what happens when item_id names a sequence rather than an item.

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% and every parameter, including the nested guard objects, is documented inline, so the baseline of 3 applies. The description adds no meaning beyond the schema and does not mention numerator/denominator, the idempotency key, or the review guards.

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: "Override the pixel aspect ratio of a project item." The scope word "project item" also implicitly distinguishes it from the sibling set_sequence_pixel_aspect_ratio, but the description never names that sibling, so the differentiation is left to inference.

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

Usage Guidelines2/5

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

There is no when-to-use, when-not-to-use, or prerequisite guidance. Nothing tells the agent when to reach for this over set_sequence_pixel_aspect_ratio or set_footage_interpretation, both of which plausibly affect pixel geometry.

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