Video Add Text

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

WRITEffmpeg.video_add_text

• Contract tier: agent_ready
• Risk: write
• Catalog version: 2026-07-12.3
• Descriptor hash: 828a4afe3bb9bba1dc50ccdebb0774977ded36fb785ded44b1e176ea5388e9ef

Use this to render a bounded text overlay on a staged video with approved font, color, box, and position controls. It creates a queued output asset and never accepts raw FFmpeg filter expressions.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ffmpeg-video-add-text-example",
  "method": "tools/call",
  "params": {
    "name": "ffmpeg.video_add_text",
    "arguments": {
      "asset_id": "asset_id_123",
      "text": "text_example",
      "position": "",
      "priority": "",
      "box_color": "",
      "font_name": "",
      "font_size": "",
      "font_color": "",
      "font_asset_id": "",
      "background_box": ""
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [
    "asset_id",
    "text"
  ],
  "properties": {
    "text": {
      "type": "string",
      "description": "Text content to render, bounded by the server's maximum character limit."
    },
    "asset_id": {
      "type": "string",
      "description": "Stable ID of one staged FFmpeg media asset."
    },
    "position": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Approved overlay or caption position name."
    },
    "priority": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional queue priority configured by the server, such as urgent or batch."
    },
    "box_color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe FFmpeg color used for the text background box."
    },
    "font_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Allowlisted server font filename or name."
    },
    "font_size": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Font size in pixels within configured minimum and maximum bounds."
    },
    "font_color": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe FFmpeg color used for text."
    },
    "font_asset_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "Optional staged font asset ID used by the overlay renderer."
    },
    "background_box": {
      "anyOf": [
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "When true, render a box behind overlay text."
    },
    "box_border_width": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "description": "Background-box padding/border width in pixels within server limits."
    }
  },
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "required": [
    "job_id",
    "cache_hit"
  ],
  "properties": {
    "job_id": {
      "type": "string",
      "description": "Stable ID used with the job readback tools."
    },
    "cache_hit": {
      "type": "boolean",
      "description": "Whether a matching completed result was reused."
    },
    "output_asset_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Completed output asset IDs when immediately available from cache."
    }
  },
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ffmpeg-video-add-text-example",
  "method": "tools/call",
  "params": {
    "name": "ffmpeg.video_add_text",
    "arguments": {
      "asset_id": "asset_id_123",
      "text": "text_example",
      "position": "",
      "priority": "",
      "box_color": "",
      "font_name": "",
      "font_size": "",
      "font_color": "",
      "font_asset_id": "",
      "background_box": ""
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ffmpeg-video-add-text-example",
  "method": "tools/call",
  "params": {
    "name": "ffmpeg.video_add_text",
    "arguments": {
      "asset_id": "asset_id_123",
      "text": "text_example",
      "position": "",
      "priority": "",
      "box_color": "",
      "font_name": "",
      "font_size": "",
      "font_color": "",
      "font_asset_id": "",
      "background_box": ""
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ffmpeg-video-add-text-example",
  "method": "tools/call",
  "params": {
    "name": "ffmpeg.video_add_text",
    "arguments": {
      "asset_id": "asset_id_123",
      "text": "text_example",
      "position": "",
      "priority": "",
      "box_color": "",
      "font_name": "",
      "font_size": "",
      "font_color": "",
      "font_asset_id": "",
      "background_box": ""
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ffmpeg.video_add_text executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}