Skip to main content

Canvas Tools — Edit

These tools create, wire, update, rearrange, or remove components on your Grasshopper canvas, or manipulate GhJSON and GhPatch documents.

You stay in control of every canvas change

Whenever a tool proposes changes to your active canvas, SmartHopper opens the canvas change review dialog so you can inspect and approve the changes before they apply. Every applied change is recorded in Grasshopper's undo history (Ctrl+Z). On the MCP Server, canvas-editing tools remain hidden unless Allow Editing is enabled.

Placing, updating, and working with GhJSON​

ToolWhat it does
gh_putPlaces or updates components on the active canvas from a GhJSON document or .ghjson file. Preserves supplied pivot coordinates, automatically lays out new pivotless components relative to connected fixed neighbors (placing disconnected parts below existing work), and updates existing canvas objects in place when their instanceGuid matches.
gh_generateUses AI to generate a valid GhJSON definition from a natural-language description (without placing it on the canvas).
gh_generate_and_place_on_canvasGenerates a GhJSON definition from a prompt and places it on the canvas in a single step.
show_ghjsonDisplays a validated GhJSON definition as an interactive card in the chat window, complete with a collapsible JSON preview, a copy button, and a one-click Place on canvas action.
gh_diffCompares two GhJSON documents and returns a .ghpatch diff describing added, removed, and modified components, connections, and groups.
gh_mergeCombines two GhJSON documents into one (the target document takes priority on GUID conflicts).
gh_patch_validateValidates the structure of a .ghpatch document before applying it.
gh_patch_applyApplies a .ghpatch diff to a base GhJSON document in memory (verifying the base checksum).

Wiring components and setting values​

ToolWhat it does
gh_connectConnects an output parameter of one component to an input parameter of another (reports noop if that wire already exists).
gh_disconnectRemoves a wire between two parameters (reports noop if no wire existed between them).
gh_smart_connectGiven a set of component GUIDs and a plain-language goal, uses AI to determine and create the appropriate connections between them.
gh_set_valueSets the value of an existing canvas object in place — a Number Slider, Boolean Toggle, Panel, Scribble, Value List selection, standalone parameter, or a component's input parameter default — and re-schedules the downstream solution.
button_clickTriggers a momentary press on one or more Grasshopper Button components by GUID.
gh_runRe-runs (recomputes) specified components by pulsing their lock state on the UI thread so Grasshopper schedules a clean solution.

Arranging, grouping, and selecting components​

ToolWhat it does
gh_moveMoves components on the canvas to absolute coordinates or by a relative (x, y) offset.
gh_tidy_up / gh_tidy_up_selectedRearranges specified or currently selected components into a clean left-to-right grid following their wire connections.
gh_group / gh_group_selectedCreates a named, optionally colored visual group around specified or currently selected components.
gh_selectSelects the specified components on the Grasshopper canvas.

Controlling preview, lock state, and removing components​

ToolWhat it does
gh_component_toggle_previewShows or hides the Rhino viewport geometry preview for specified components by GUID.
gh_component_show_preview_selected / gh_component_hide_preview_selectedShows or hides geometry preview for the currently selected components.
gh_component_toggle_lockLocks (disables) or unlocks (enables) specified components by GUID.
gh_component_lock_selected / gh_component_unlock_selectedLocks or unlocks the currently selected components.
gh_removeRemoves the specified components from the canvas (after review; undoable with Ctrl+Z).
gh_clearClears the canvas while preserving locked or protected components (such as an active MCP Server component).