Create Reusable UI Mascot
create_mascotCreate a new reusable SVG App mascot/character for a product UI, SaaS app, website, design system, onboarding flow, empty state, help surface, or brand moment.
Use when the user wants a consistent character that can appear across multiple screens and later be reused in different poses, emotions, actions, or states.
Before calling, read svgapp.conf.json from the project root and pass artStyleId and colorPaletteId from that file when available.
Generation is asynchronous. This tool returns imageUrl and assetUrl immediately; they serve a frontend placeholder while pending and redirect to the final image when ready. Poll get_generation_status until completed before downloading the final image. After the base mascot is completed, call generate_mascot_pose for UI-specific poses; most UIs should embed a pose rather than the neutral base mascot.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"description": "<description>",
"artStyleId": "<artStyleId>"
},
"name": "create_mascot"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Optional short mascot name. Omit to let SVG App generate a name. | |
| workspace | No | Optional workspace id or slug from list_workspaces. Defaults to the user's personal workspace. Use the same workspace for every call in a workflow, because generations, mascots, and palettes belong to one workspace. | |
| artStyleId | Yes | Art style id from svgapp.conf.json. If the config file is missing, call init_svgapp_config first. | |
| aspectRatio | No | Optional output aspect ratio. Use 1:1 for reusable mascots, 4:3 or 3:4 for UI empty states, and 16:9/9:16 only when the layout needs it. | |
| description | Yes | Detailed character description. Include species/object/personality, product domain, visual style constraints, and any brand traits. Example: 'A friendly rounded fox mascot for a B2B analytics dashboard, curious and helpful, clean vector style.' | |
| colorPaletteId | No | Optional color palette id from svgapp.conf.json. Pass it when the generated mascot should match the app or brand colors. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | Current async state. If pending, poll get_generation_status. If completed, call get_generated_asset. | |
| assetUrl | No | Embeddable asset URL for the generation, matching imageUrl for images and videoUrl for animations. It can be used immediately while polling continues. | |
| canvasId | No | Underlying SVG App canvas id when the generation produced an image. Kept for UI integration and background removal. | |
| imageUrl | No | Embeddable image URL. It is returned immediately, serves a frontend placeholder while pending, and redirects to the final image when ready. | |
| mimeType | No | MIME type of the final asset when known, for example image/png or video/mp4. | |
| videoUrl | No | Embeddable video URL for animation generations. It is returned immediately, serves a frontend placeholder video while pending, and redirects to the final transparent WebM video when ready. | |
| nextAction | Yes | The exact next MCP action the model/client should take for this generation. | |
| animationId | No | Underlying SVG App video generation id when the generation produced an animation. | |
| resourceUri | No | Optional MCP resource URI for clients that explicitly choose to read resources. Do not rely on resources for polling. | |
| generationId | Yes | Pass this exact id to get_generation_status until status is completed. The returned asset URL can be used immediately. |