Skip to main content
Glama

Add audio overlay

add_audio_overlay

Add an audio overlay (mp3/m4a/wav/ogg) scheduled at a frame-aligned start. The asset must already be uploaded (upload_audio, create_upload_link, or the editor); pass the upload's returned filename, and its name as the track's label. 30 fps; convert seconds with frames = round(s * 30). Plays in the editor preview and is mixed into the MP4 export.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
gainNoLinear gain 0..2. Default 1.
nameNoOptional label people see on the track: pass the upload's returned `name`.
endFrameNoOptional end frame; omit to play the asset's full natural length from startFrame.
filenameYesThe stored audio filename an upload returned.
projectIdYesOpaque project id (a v4 UUID, from list_projects/create_project). Selects which existing project this call mutates.
startFrameYesFrame at which the overlay starts (0-indexed, 30 fps).
fadeInFramesNoLinear fade-in length in frames. Default 0.
fadeOutFramesNoLinear fade-out length in frames. Default 0.
sourceLayerIdNoOptional video layer element id ("video.<id>") to weld this overlay to. When set, the editor renders the overlay as a waveform footer on that clip and drags it with the clip instead of showing a standalone bottom row.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesWhether the call succeeded.
dataNoThe payload, shaped by the tool.
noteNoWhat to do next when not ready.
errorNoWhy it failed.
statusNoFor cache-backed readers: whether the answer was ready.
editorUrlNoOpens this project in the editor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / filename / description
      Previous value: -"Audio asset filename in the project's assets bucket."New value: +"The stored audio filename an upload returned."
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "Optional label people see on the track: pass the upload's returned `name`.",
      +  "type": "string"
      +}
  2. Changed2 schema fields changed
    • removedInput schema / properties / anonymousToken
      Removed value: -{
      -  "description": "The token create_anonymous_account returned. This connection has no Morpha key, so every call carries it.",
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "filename",
      -  "startFrame",
      -  "projectId",
      -  "anonymousToken"
      -]New value: +[
      +  "filename",
      +  "startFrame",
      +  "projectId"
      +]
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "description": "The result envelope every Morpha tool returns.",
      +  "properties": {
      +    "data": {
      +      "description": "The payload, shaped by the tool.",
      +      "type": [
      +        "object",
      +        "array",
      +        "string",
      +        "number",
      +        "boolean",
      +        "null"
      +      ]
      +    },
      +    "editorUrl": {
      +      "description": "Opens this project in the editor.",
      +      "type": "string"
      +    },
      +    "error": {
      +      "description": "Why it failed.",
      +      "type": "string"
      +    },
      +    "note": {
      +      "description": "What to do next when not ready.",
      +      "type": "string"
      +    },
      +    "ok": {
      +      "description": "Whether the call succeeded.",
      +      "type": "boolean"
      +    },
      +    "status": {
      +      "description": "For cache-backed readers: whether the answer was ready.",
      +      "enum": [
      +        "ready",
      +        "not-ready"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "ok"
      +  ],
      +  "type": "object"
      +}
  4. Changed2 schema fields changed
    • addedInput schema / properties / anonymousToken
      Added value: +{
      +  "description": "The token create_anonymous_account returned. This connection has no Morpha key, so every call carries it.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "filename",
      -  "startFrame",
      -  "projectId"
      -]New value: +[
      +  "filename",
      +  "startFrame",
      +  "projectId",
      +  "anonymousToken"
      +]
  5. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already indicate readOnlyHint=false and destructiveHint=false, so the mutation intent is known. The description adds valuable behavioral context: the overlay plays in the editor preview and is mixed into the MP4 export, and frames are computed at 30 fps with round(s * 30). It does not contradict any annotation.

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?

Four tightly packed sentences cover formats, prerequisites, parameter mapping, frame conversion, and export/preview behavior without redundancy. The most important action and constraint are front-loaded.

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?

Given the output schema exists and the input schema covers all parameters at 100%, the description is nearly complete for a 9-parameter mutation. It explains asset prerequisites, timing model, and rendering impact, though it could have briefly noted that modifying an existing overlay belongs to update_audio_overlay.

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, but the description adds meaningful parameter nuance: filename comes from an upload response, name is used as the track label, and seconds should be converted with frames = round(s * 30). This goes beyond the schema's field 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?

States a specific verb and resource ('Add an audio overlay') and immediately distinguishes the operation with supported formats and frame-aligned scheduling. This clearly differentiates it from siblings like update_audio_overlay and remove_audio_overlay.

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

Usage Guidelines4/5

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

Provides clear prerequisite context: the asset must already be uploaded via upload_audio, create_upload_link, or the editor. It tells the agent to pass the upload's returned filename and name as the track label, but it does not explicitly contrast this with update/remove alternatives.

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