Skip to main content
Glama

CueFrame

by ai.cueframe
OverviewDiscussionsAdmin

Get Composition

get_composition
Read-only

READ BACK a composition as JSON — the edit itself: tracks, clips, card HTML, reframe segments, captions, markers, format. This is what create_render encodes, so it is also what you hand to validate_composition (which needs a full inline composition body), what you diff after an edit, and what you archive/share so someone else can re-render the SAME video. Read-only and free. Authoring stays op-based (apply_composition) — do not round-trip this object back as a write. A composition too large to fit one MCP result degrades to a STRUCTURAL SUMMARY (every track and clip still listed; card html and caption words elided as lengths) with a header saying so — read it over REST if you need the verbatim body. Defaults to the project's ACTIVE composition; pass compositionId to read a specific one (the same id apply_composition takes as composition_id, and preview_frame / create_render take as compositionId) so an A/B variant can be read back, not just written. Pass includeDependencies="true" on a v1 guarded endpoint to read composition_id, revision and dependency tokens. With componentExecutionVersions=["3","4"], this envelope also returns expectedBrandIdentity from the persisted project authority; carry it unchanged into the matching negotiated write. Preserve those observed tokens when authoring; never refresh the basis to hide a conflict.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesprojectId (path).
compositionIdNoRead a SPECIFIC composition instead of the project's active one. Omit it and the active composition is returned. Pairs with `composition_id` on the apply op: an edit you can make to a second composition is one you can read back.
includeDependenciesNoReturn the immutable composition identity, project revision and shared v1 dependency expectations alongside the composition.
componentExecutionVersionsNoThe component execution versions this reader accepts, one parameter per version: 3, or 3 and 4 (native placements). Absent readers accept only the historical protocol.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / componentExecutionVersions / anyOf
      Added value: +[
+  {
+    "const": "3",
+    "type": "string"
+  },
+  {
+    "items": false,
+    "maxItems": 2,
+    "minItems": 2,
+    "prefixItems": [
+      {
+        "const": "3",
+        "type": "string"
+      },
+      {
+        "const": "4",
+        "type": "string"
+      }
+    ],
+    "type": "array"
+  }
+]
    • removedInput schema / properties / componentExecutionVersions / const
      Removed value: -"3"
    • changedInput schema / properties / componentExecutionVersions / description
      Previous value: -"Explicit accepted saved component execution protocol. Absent readers accept only the historical protocol."New value: +"The component execution versions this reader accepts, one parameter per version: 3, or 3 and 4 (native placements). Absent readers accept only the historical protocol."
    • removedInput schema / properties / componentExecutionVersions / type
      Removed value: -"string"
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, yet the description adds real context: 'free', the oversize-degradation behavior to a STRUCTURAL SUMMARY with a header, the REST fallback, and the dependency/brand-identity tokens returned on guarded endpoints. Minor redundancy ('Read-only') with readOnlyHint, but the degradation contract and token guidance are genuine behavioral disclosure.

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?

The core purpose is front-loaded in the first clause, and most sentences carry distinct, actionable information. The token-preservation advisory ('never refresh the basis to hide a conflict') is useful but skews toward authoring guidance on a read tool, and the paragraph is dense enough that a reader must parse heavily."

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?

No output schema exists, so the description rightly carries the return-value burden: it enumerates the composition's contents and describes the degraded summary shape and its header. Given four parameters and the cross-tool identity mapping, an agent has enough to call it and interpret the result correctly.

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. The description goes beyond the schema by tying compositionId to the same identity used as composition_id on apply and compositionId on preview_frame/create_render, and by explaining the v1 guarded-endpoint semantics of includeDependencies and the expectedBrandIdentity returned with componentExecutionVersions. That is meaningful incremental semantics, though partly duplicative of the already-decent schema descriptions.

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?

Opens with a specific verb+resource ('READ BACK a composition as JSON') and enumerates exactly what that object contains (tracks, clips, card HTML, reframe segments, captions, markers, format). It explicitly positions itself against siblings — the object create_render encodes, the body validate_composition needs, and the thing that is NOT the op-based write path (apply_composition). An agent can distinguish it from list_compositions, apply_composition, and validate_composition without opening a 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?

States concrete use cases (feed validate_composition, diff after an edit, archive/share for re-render) and an explicit exclusion — 'Authoring stays op-based (apply_composition) — do not round-trip this object back as a write.' It also names the alternative reader path (REST) for oversized reads. When-to-use, when-not-to-use, and alternatives are all present.

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

All CueFrame toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources