Skip to main content
Glama
Sign In
premiere-pro-mcp

premiere-pro-mcp

by matt-j-penny
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

Add Custom Metadata Field

add_custom_metadata_field

Defines a new custom metadata field in the project schema without setting per-item values; use metadata value or Project Metadata XML tools to populate item data.

Instructions

Add a custom metadata field to the project's metadata schema. This creates a schema/column definition only; it does not set a per-item value. Use set_metadata field_name/value or complete Project Metadata XML with readback to update a value.

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": {
      "field_name": "<field_name>",
      "field_label": "<field_label>",
      "field_type": "<field_type>"
    },
    "name": "add_custom_metadata_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
field_nameYesInternal name for the metadata field
field_typeYesType of the field: 0 = Integer, 1 = Real, 2 = String, 3 = Boolean
field_labelYesDisplay label for the field
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

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=false and openWorldHint=false, so the safety profile is known; the description adds the genuinely useful clarification that the write creates a schema/column definition rather than an item value. It does not cover what happens when a field_name already exists (duplicate vs. error) or any permission prerequisites, which matters for a non-idempotent mutation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, no filler, and the API-critical distinction (schema definition vs. value) is front-loaded ahead of the routing advice. Nothing could be removed without losing information.

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?

With an output schema present and 100% schema coverage, the description only needs to convey purpose, side-effect scope and routing, all of which it does. It stops short of addressing failure modes such as an already-existing field_name, which a caller would reasonably want to know before adding.

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 field_type enum mapping and the lengthy idempotency_key semantics, is documented in the schema itself. The description adds no parameter-level meaning beyond referencing field_name/value in a sibling's context, so the baseline of 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?

States a specific verb and resource ("Add a custom metadata field to the project's metadata schema") and immediately scopes it: "creates a schema/column definition only; it does not set a per-item value." That sentence alone separates it from set_metadata and attach_custom_property without opening either schema.

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?

Names both the exclusion (this does not set values) and the alternative route ("Use set_metadata field_name/value or complete Project Metadata XML with readback to update a value"), so an agent knows which sibling to pick for the value-setting case. The only soft spot is that the XML-with-readback path is described tersely, but the primary alternative is explicit.

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