remotion_get_component_schema
Retrieve detailed schema for video components including properties, variants, animations, and usage examples to understand component structure and implementation requirements.
Instructions
Get detailed schema for a specific component.
Returns the complete schema including all properties, variants, animations,
and usage examples for a single component.
Args:
component_name: Name of the component (e.g., "LowerThird", "TitleScene")
Returns:
JSON object with component schema and examples
Example:
schema = await remotion_get_component_schema(component_name="LowerThird")
# Returns full schema for lower third component including all variantsInput Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| component_name | Yes |
Implementation Reference
- src/chuk_motion/server.py:145-170 (handler)The main handler function for the 'remotion_get_component_schema' tool, decorated with @mcp.tool for automatic registration in the MCP server. It retrieves the detailed schema (as JSON) for a specified Remotion component from the COMPONENT_REGISTRY and returns it as a string. Handles missing components with an error message.
@mcp.tool # type: ignore[arg-type] async def remotion_get_component_schema(component_name: str) -> str: """ Get detailed schema for a specific component. Returns the complete schema including all properties, variants, animations, and usage examples for a single component. Args: component_name: Name of the component (e.g., "LowerThird", "TitleScene") Returns: JSON object with component schema and examples Example: schema = await remotion_get_component_schema(component_name="LowerThird") # Returns full schema for lower third component including all variants """ def _get_schema(): if component_name not in COMPONENT_REGISTRY: return json.dumps({"error": f"Component '{component_name}' not found"}) return json.dumps(COMPONENT_REGISTRY[component_name], indent=2) return await asyncio.get_event_loop().run_in_executor(None, _get_schema)