HELIX Docs
CLI & AI toolsMCP tool reference

Devices

Create, validate and test interactive devices.

MCP server version 0.2.16-helix3.209. Your agent also receives each tool's description and schema directly from the server, which is always the authority for the version you run.

create_device

[Experimental] RETURNS A COMMAND, NOT DATA. This tool hands you a helix … command string to RUN yourself — it executes nothing and returns no results. The answer is in that command’s output. The only Device authoring entrypoint. Prepares the Creator CLI command that wraps an existing GLB in a declarative helix.device/1 project. Devices are MCP/CLI-authored; there is intentionally no website workbench. After running it, edit the generated device.json through normal agent file tools, then call validate_device and test_device.

ArgumentTypeRequiredDescription
directorystringyesAbsolute path for the new Device project
idstringyesStable lowercase Device slug (min length 3, max length 50)
titlestringyesPlayer-facing Device title (min length 1, max length 80)
modelstringyesAbsolute path to the source GLB
template"standing-desk" | "clock" | "television"yesStarting behavior/state contract. Television includes a permissioned Screen/App, universal text input, audio playback, and typed power/volume/audio ports.

test_device

[Experimental] RETURNS A COMMAND, NOT DATA. This tool hands you a helix … command string to RUN yourself — it executes nothing and returns no results. The answer is in that command’s output. Prepare the Creator CLI Device simulation command. Use mode=both before publication: the exact same self-contained Device definition is exercised as an owned Item Instance and as a World-owned package instance; single covers every control/graph path and durable remount, multiplayer uses two independent clients against one authority state and refuses divergence.

ArgumentTypeRequiredDescription
directorystringyesAbsolute Device project directory or device.json path
mode"single" | "multiplayer" | "both"noDefault both
jsonbooleannoReturn machine-readable test receipts

validate_device

[Experimental] RETURNS A COMMAND, NOT DATA. This tool hands you a helix … command string to RUN yourself — it executes nothing and returns no results. The answer is in that command’s output. Prepare the Creator CLI validation command for a Device project. It fails closed on malformed definitions, invalid GLB bytes, missing named-node bindings, invalid typed state or Universal Action Surface controls, undeclared capabilities, and missing Home/World compatibility.

ArgumentTypeRequiredDescription
directorystringyesAbsolute Device project directory or device.json path
jsonbooleannoReturn a machine-readable validation report

On this page