list_artboards: List Canvas Artboards

Retrieve all artboards on the DesignJS canvas with their IDs, names, world coordinates, and dimensions for use with scoped tool calls.

The list_artboards tool returns metadata for every artboard currently on the canvas. The response gives you each artboard’s ID, name, position in canvas world coordinates, and dimensions — everything you need to scope other tools like get_tree, get_screenshot, get_html, and get_css to a specific frame.

Call list_artboards at the start of any multi-artboard workflow to discover what exists before creating new frames or directing your agent to work on a specific screen.

Parameters

list_artboards takes no parameters. Pass an empty object as arguments.

Response

artboards · object[] · required

An array of ArtboardData objects, one for each artboard on the canvas. Returns an empty array if no artboards exist.

Show ArtboardData properties

id · string · required

Unique identifier for this artboard. Pass to get_tree, get_screenshot, get_html, or get_css as the artboardId parameter to scope those tools to this frame.

name · string · required

The display name shown in the editor layers panel.

x · number · required

Horizontal position of the artboard’s top-left corner in canvas world coordinates.

y · number · required

Vertical position of the artboard’s top-left corner in canvas world coordinates.

width · number · required

Width of the artboard in pixels.

height · number · required

Height of the artboard in pixels.

Example

request

{
  "method": "tools/call",
  "params": {
    "name": "list_artboards",
    "arguments": {}
  }
}

After calling list_artboards, you can iterate the returned IDs and call get_screenshot on each one to capture a visual snapshot of every screen in your design — useful for generating a design review summary.

Artboard IDs are stable for the lifetime of the canvas session. They are regenerated if the canvas file is deleted and recreated, but persist through save/load cycles within the same .designjs.json file.