Skip to main content
Glama

Get Keyframes

get_keyframes
Read-onlyIdempotent

Retrieve all keyframes for a specific effect property on a clip, including each key's time in seconds from the clip start and native media ticks, so you can inspect and plan keyframe edits.

Instructions

Get all keyframes for a specific effect property on a clip. Each key's time is in seconds from the clip's start; mediaSeconds is Premiere's stored media time. mediaTicks returns each native key time as a tick string.

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": {
      "node_id": "<node_id>",
      "effect_name": "<effect_name>",
      "property_name": "<property_name>"
    },
    "name": "get_keyframes"
  }
}

Input Schema

NameRequiredDescriptionDefault
node_idYesNode ID of the clip
effect_nameYesDisplay name of the effect
property_nameYesDisplay name of the property
property_indexNoOptional property index from get_effect_properties; required when property_name is duplicated.
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

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint/idempotent/non-destructive, so the safety profile is covered. The description adds genuinely non-obvious semantics: time values are seconds relative to clip start, mediaSeconds is Premiere's stored media time, and mediaTicks gives native tick strings — the time-domain ambiguity is the main footgun here and it is called out.

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?

Three short sentences, zero filler, with the core purpose front-loaded and the time-domain clarifications following. Every sentence supplies information an agent would otherwise have to guess.

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 read-only getter with an output schema and full schema coverage, this is nearly sufficient; the output schema carries return shape. Minor gaps: ordering of returned keys, behavior when a property has no keyframes, and whether interpolation data is included.

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%, so the baseline is 3; the description adds no parameter-level detail beyond the scope words 'effect property on a clip'. It says nothing about property_index disambiguation or the expected_cep_target / expected_project_path guard parameters, which the schema alone must carry.

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 plus its scope: 'Get all keyframes for a specific effect property on a clip.' That is unambiguous against write-side siblings like add_keyframe or remove_keyframe, though it never names an alternative explicitly (e.g. get_value_at_time for sampling a value at a single time).

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 only implied by the name and scope; there is no statement of when to reach for this versus get_effect_properties (to find property names/index), get_value_at_time, or map_keyframe_time_domain. The 'property_index from get_effect_properties' prerequisite lives in the schema, not the description.

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