Create agent avatar

veryfront__create_agent_avatar

Requires project.agents.write.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Can change resources.

Arguments

FieldTypeRequiredDescription and constraints
agent_idstringYesProvide the agent id. Minimum length: 1. Maximum length: 128.
configobjectNoAvatar configuration. Omit seed to generate a new avatar. With an explicit seed, omitted visual options use the existing avatar configuration if available. New agents use generator defaults.
assignbooleanNoPersist the generated avatar_url onto the agent. Defaults to false; set true to assign it to an existing agent. Default: false.
source_target_kindstringNoSource target: project or preview_branch. Defaults to project.
target_branch_idstring or nullNoPreview branch UUID, for a preview_branch target.
project_referencestringNoProject identifier or slug that scopes the tool call.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__create_agent_avatar",
    "arguments": {
      "agent_id": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
avatar_urlstringYesAPI upload URL of the generated SVG, stored as a project upload. The agent ID may be existing or prospective; the URL is persisted on the agent only when assign is true. Format: uri.

Full schemas

json
{
  "type": "object",
  "properties": {
    "agent_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[a-zA-Z0-9_-]+$",
      "description": "Provide the agent id."
    },
    "config": {
      "type": "object",
      "properties": {
        "seed": {
          "type": "string",
          "minLength": 1,
          "maxLength": 128,
          "description": "Provide the seed."
        },
        "archetype": {
          "type": "string",
          "enum": [
            "upright",
            "slumped",
            "alert",
            "profile",
            "leaning",
            "crouched",
            "tall",
            "spread",
            "happy",
            "sad",
            "angry",
            "surprised",
            "sleepy",
            "curious"
          ],
          "description": "Provide the archetype."
        },
        "texture": {
          "type": "string",
          "pattern": "^(?:[0-9]|none)$",
          "description": "Provide the texture."
        },
        "color": {
          "type": "string",
          "pattern": "^#[0-9a-fA-F]{6}$",
          "description": "Provide the color."
        },
        "shape": {
          "type": "string",
          "enum": [
            "snircle",
            "circle",
            "square"
          ],
          "description": "Provide the shape."
        },
        "matrix": {
          "type": "string",
          "pattern": "^[012]{16}$",
          "description": "Provide the matrix."
        }
      },
      "additionalProperties": false,
      "description": "Avatar configuration. Omit `seed` to generate a new avatar. With an explicit seed, omitted visual options use the existing avatar configuration if available. New agents use generator defaults."
    },
    "assign": {
      "type": "boolean",
      "description": "Persist the generated avatar_url onto the agent. Defaults to false; set true to assign it to an existing agent.",
      "default": false
    },
    "source_target_kind": {
      "type": "string",
      "description": "Source target: project or preview_branch. Defaults to project."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Preview branch UUID, for a preview_branch target."
    },
    "project_reference": {
      "type": "string",
      "description": "Project identifier or slug that scopes the tool call."
    }
  },
  "required": [
    "agent_id"
  ],
  "additionalProperties": false,
  "description": "Arguments for the create_agent_avatar tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "avatar_url": {
      "type": "string",
      "format": "uri",
      "description": "API upload URL of the generated SVG, stored as a project upload. The agent ID may be existing or prospective; the URL is persisted on the agent only when `assign` is true."
    }
  },
  "required": [
    "avatar_url"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the create_agent_avatar tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}