Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/open-pencil/open-pencil/llms.txt

Use this file to discover all available pages before exploring further.

get_selection

Get details about currently selected nodes.
Returns
object
Returns an object with a selection array containing all selected node details.

get_page_tree

Get the node tree of the current page. Returns all nodes with hierarchy, types, positions, and sizes.
Returns
object
Returns an object with page (name) and children (array of node trees).

get_node

Get detailed properties of a node by ID.
id
string
required
Node ID
Returns
object
Returns the complete node object with all properties, or an error if not found.

find_nodes

Find nodes by name pattern and/or type.
name
string
Name substring to match (case-insensitive)
type
string
Node type filter. Options: FRAME, RECTANGLE, ELLIPSE, TEXT, LINE, STAR, POLYGON, SECTION, GROUP, COMPONENT, INSTANCE, VECTOR
Returns
object
Returns an object with count and nodes array containing matching node summaries.

node_bounds

Get absolute bounding box of a node.
id
string
required
Node ID
Returns
object
Returns the node ID and its absoluteBoundingBox coordinates.

node_children

Get direct children of a node.
id
string
required
Node ID
Returns
object
Returns an object with the node id and children array containing child node summaries (id, name, type).

node_tree

Get a node tree with types and hierarchy.
id
string
required
Node ID
depth
number
Max depth (default: unlimited)
Returns
object
Returns a recursive tree structure with id, name, type, and children.

node_ancestors

Get the ancestor chain from a node to the page root.
id
string
required
Node ID
depth
number
Max depth to traverse
Returns
object
Returns an object with the node id and ancestors array (from parent to root).

node_bindings

Get variable bindings for a node.
id
string
required
Node ID
Returns
object
Returns the node id and its boundVariables object.

list_pages

List all pages in the document.
Returns
object
Returns an object with current page name and pages array containing page summaries.

list_variables

List all design variables (colors, numbers, strings, booleans).
type
string
Filter by variable type. Options: COLOR, FLOAT, STRING, BOOLEAN
Returns
object
Returns an object with count and variables array.

list_collections

List all variable collections.
Returns
object
Returns an object with count and collections array.

get_variable

Get a variable by ID.
id
string
required
Variable ID
Returns
object
Returns the variable object, or an error if not found.

find_variables

Find variables by name pattern.
query
string
required
Name substring (case-insensitive)
type
string
Filter by type. Options: COLOR, FLOAT, STRING, BOOLEAN
Returns
object
Returns an object with count and variables array.

get_collection

Get a variable collection by ID.
id
string
required
Collection ID
Returns
object
Returns the collection object, or an error if not found.

path_get

Get vector path data of a node.
id
string
required
Node ID
Returns
object
Returns the node id and its vectorNetwork data, or an error if the node has no vector data.