Live: connect
live_connectConnect to a running Inkscape instance to enable live operations. Transport selection affects tool availability.
Instructions
Connect to a running Inkscape over the best-ranked available transport (enables live).
When to use: starting a live session before any other live_* tool. To probe first use
check_live_support; to tear down use live_disconnect.
Key params: prefer selects the profile. read (default) is the best READ-capable transport
(extension-socket primary; full selection/inspect surface) but is MODAL on the socket bridge —
the GUI freezes for the session. no_freeze drives the GUI WITHOUT freezing (Linux DBus path): the export-based active-doc read, live_render_view, live_set_viewport, and
live_apply_to_selection are no-freeze; selection-id reads (live_get_selection /
live_inspect_selection) and live_insert_svg / live_set_selected_text are NOT available
over DBus and stay modal. Requires the master gate (INKSCAPE_MCP_LIVE_ENABLED). With no
transport available it fails cleanly without affecting headless tools.
Return shape: LiveSession — the chosen transport, active document, and connection state.
Example: live_connect(prefer="no_freeze")
Risk class: medium (establishes a transport; read-only thereafter).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| prefer | No | read |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | No | Clean human-readable status notes. | |
| enabled | Yes | Whether live mode is permitted (master gate, X1). | |
| connected | Yes | Whether a live transport is currently attached. | |
| transport | No | Active transport name, if connected. | |
| connected_at | No | UTC ISO-8601 connect timestamp. | |
| active_document | No | Identity of the live document at connect time. | |
| available_transports | No | Transports reported available on this host right now. |