Tools Reference

The Virse MCP Skill exposes 25 tools that your agent can call. This is the complete reference for all available operations.


Account

get_account

Get current user info (username, email) and CU balance per organization. For team orgs, also shows your member budget usage.

Parameters: none


Workspace

list_workspaces

List all workspaces the user has access to. Returns space_id, canvas_id, and organization context for each.

Parameters: none

create_workspace

Create a new workspace and its associated canvas.

Param
Type
Required
Description

name

string

yes

Workspace name

description

string

no

Workspace description

visibility

string

no

private (default) or public

organization_id

string

no

Organization to create under (defaults to personal org)

update_workspace

Update workspace name, description, or visibility.

Param
Type
Required
Description

space_id

string

yes

Space UUID to update

name

string

no

New name

description

string

no

New description

visibility

string

no

private or public


Canvas

get_canvas

Get a lightweight overview of a canvas — element summaries with outgoing connections, plus group summaries.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID (from list_workspaces)

group_id

string

no

Filter by group short ID / UUID

element_type

string

no

Filter by type: image or text

include_group_detail

boolean

no

Append detailed group info (default false)

get_element

Get one element's full details by short ID or UUID, plus one-hop incoming/outgoing neighbors.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

id

string

yes

Element short ID or full UUID

trace_connections

Traverse workflow connections from one element.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

id

string

yes

Origin element short ID or UUID

direction

string

no

upstream, downstream, or both

depth

integer

no

Traversal depth (default 1, max 5)

create_element

Create a new element (image or text node) on the canvas.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

element_type

string

yes

image or text

position_x

number

yes

X coordinate

position_y

number

yes

Y coordinate

size_width

number

no

Width in px (default 200)

size_height

number

no

Height in px (default 200)

artifact_version_id

string

no

Image artifact version ID

asset_id

string

no

Image asset ID

text

string

no

Text content (for text elements)

fontSize

number

no

Font size (default 50)

textAlign

string

no

left, center (default), right

verticalAlign

string

no

top, middle (default), bottom

z_index

integer

no

Layer order (higher = front)

title

string

no

Element title

circle-info

Text wraps automatically within the element width. At the default fontSize of 50, a 300x80 box fits roughly 6 lowercase, 5 uppercase, or 4 CJK characters per line.

update_element

Update an element — move, resize, or modify content.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

element_id

string

yes

Element short ID or UUID

position_x

number

no

New X

position_y

number

no

New Y

size_width

number

no

New width

size_height

number

no

New height

rotation

number

no

Rotation in degrees

text

string

no

New text content

fontSize

number

no

Font size

textAlign

string

no

left, center, right

verticalAlign

string

no

top, middle, bottom

z_index

integer

no

Layer order

title

string

no

New title

artifact_version_id

string

no

New image artifact

asset_id

string

no

New image asset

delete_element

Delete an element from the canvas.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

element_id

string

yes

Element short ID or UUID

circle-exclamation

create_edge

Create a directed edge between two elements.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

source_element_id

string

yes

Source element short ID or UUID

target_element_id

string

yes

Target element short ID or UUID

delete_edge

Delete an edge.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

edge_id

string

yes

Edge UUID

circle-exclamation

Groups

create_group

Create a group by bundling elements. Bounding box is computed automatically.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

element_ids

string[]

yes

Element short IDs / UUIDs to include

title

string

no

Group title

delete_group

Delete a group. Member elements are not deleted — only the grouping is removed.

Param
Type
Required
Description

canvas_id

string

yes

Canvas UUID

group_id

string

yes

Group short ID or UUID

circle-exclamation

Image Generation & Upload

generate_image

Generate an AI image and place it on the canvas. A placeholder element appears immediately while the image generates in the background.

When using asset_id for image-to-image generation, edges are automatically created from each source element to the new element.

Param
Type
Required
Description

prompt

string

yes

Image generation prompt

model

string

yes

Model ID (use list_image_models to see options)

space_id

string

yes

Space ID

canvas_id

string

yes

Canvas UUID

position_x

number

yes

X coordinate

position_y

number

yes

Y coordinate

width

integer

no

Image width in px

height

integer

no

Image height in px

aspect_ratio

string

no

1:1, 16:9, 9:16, 4:3, 3:4

resolution

string

no

0.5K, 1K, 2K, 3K, 4K (availability varies by model)

num_images

integer

no

Number of images (default 1)

asset_id

string or string[]

no

Reference image(s) for image-to-image (max 10)

size_width

number

no

Placeholder width (default 512)

size_height

number

no

Placeholder height (default 512)

upload_image

Upload an image from a URL to a workspace or asset folder.

Param
Type
Required
Description

image_url

string

yes

Public image URL

space_id

string

no

Target workspace ID

folder_id

string

no

Target asset folder UUID

filename

string

no

Filename (default: upload.png)

canvas_id

string

no

Canvas UUID (for placement)

position_x

number

no

X coordinate for placement

position_y

number

no

Y coordinate for placement

size_width

number

no

Element width (default 512)

size_height

number

no

Element height (default 512)

list_image_models

List all supported AI image generation models with providers, supported operations, aspect ratios, and max resolution.

Parameters: none

get_upload_token

Generate a reusable upload token for local file uploads via the HTTP multipart endpoint. The token is bound to your IP, expires after 1 hour, and can be reused for multiple uploads.

Parameters: none

Local file upload example:


Search & Assets

search_images

Search the Virse image library by query. Supports pagination.

Param
Type
Required
Description

query

string

yes

Search query

limit

integer

no

Results to return (default 10, max 50)

page_token

string

no

Token for next page

get_asset_detail

Get details of an artifact version (generation prompt, model, parameters, status) or the full text content of a text asset. At least one parameter is required.

Param
Type
Required
Description

artifact_version_id

string

no

Artifact version ID (for image generation details)

asset_id

string

no

Text asset ID (for full text content)


Asset Folders

create_asset_folder

Create a new folder for organizing images.

Param
Type
Required
Description

name

string

yes

Folder name

description

string

no

Description

visibility

string

no

private (default) or public

list_asset_folders

List all asset folders the user has access to.

Parameters: none

list_asset_folder_images

List images in an asset folder with pagination.

Param
Type
Required
Description

folder_id

string

yes

Asset folder UUID

limit

integer

no

Max images (default 50)

offset

integer

no

Pagination offset (default 0)

add_image_to_asset_folder

Add an existing image to an asset folder (zero-copy link). Idempotent — calling it twice has no effect.

Param
Type
Required
Description

asset_id

string

yes

Image asset UUID

folder_id

string

yes

Asset folder UUID

remove_image_from_asset_folder

Remove an image from an asset folder. This unlinks the image — it does not delete the original.

Param
Type
Required
Description

asset_id

string

yes

Image asset UUID

folder_id

string

yes

Asset folder UUID

circle-exclamation

Last updated