Skip to main content
Glama

Add or update an overlay

put_video_overlay
DestructiveIdempotent

Add or update one timed text, image or video overlay with none, fade, slide or pop animation. Use only existing canvas asset IDs and editable capabilities returned by the project. Read get_project_context first and pass its base_version and selected output_id. Saves a playable project; request a file separately with check_video with_download. Unsupported changes refuse without rebuilding. Preserve operation_id and exact inputs on retries. Uses the account's direct-edit allowance. Cost: Free: no credits.

Input Schema

NameRequiredDescriptionDefault
overlayYes
video_idYesThe video id from list_videos.
output_idNoOne output (a hook, a Short, a format) from check_video; the main film when left out.
base_versionNoThe version the edits are for; the current one when left out.
operation_idNoA stable ID for this request. Preserve it on retries. Use a new ID only for a deliberate new request.

Output Schema

NameRequiredDescriptionDefault
codeNo
costNo
errorNo
stateNo
statusNo
dry_runNo
messageNo
plan_idNo
style_idNo
video_idNo
availableNo
import_idNo
output_idNo
studio_urlNo
version_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, and the description adds substantive context beyond them: the edit persists as a playable project, unsupported changes are refused without partial rebuilds, operation_id must be preserved on retries, the call consumes the account's direct-edit allowance, and it costs no credits. The only gap is not spelling out what an 'update' does to unlisted properties of an existing overlay.

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?

Purpose and allowed kinds are front-loaded, then prerequisites, persistence semantics, failure behavior, retry rules, and cost in a tight sequence of short sentences. Slightly telegraphic phrasing ('Cost: Free: no credits') is dense but each sentence carries distinct information, so little is wasted.

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?

For a destructive, version-guarded mutation with an output schema present, the description covers everything an agent needs before calling: required prior tool, ID sources, concurrency token, idempotent retry protocol, refused-change behavior, and quota/cost. Return-value details are correctly omitted since an output schema exists.

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 80% and four parameters already carry descriptions, so the baseline is 3. The description goes above that by explaining the overlay kinds (text/image/video) that drive the untyped oneOf and their animation enum, and by tying base_version/output_id to get_project_context so the agent knows where those values come from.

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+resource+scope: 'Add or update one timed text, image or video overlay', and enumerates the animation types. An agent can distinguish this from remove_video_overlay by the verb, but no sibling is named explicitly, so differentiation is implicit rather than stated.

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?

Gives explicit prerequisites ('Read get_project_context first and pass its base_version and selected output_id'), constrains inputs ('Use only existing canvas asset IDs and editable capabilities returned by the project'), and routes elsewhere for the follow-on need ('request a file separately with check_video with_download'). This is clear when-to-use and when-to-use-something-else guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources