Skip to main content

Machine tools (MCP)

Generated content. This page is produced by cargo run --bin gen_docs (src-tauri/src/bin/gen_docs/) reading the live rmcp::ToolRouter this crate's MCP server actually registers (McpServer::tool_router_* in src-tauri/src/mcp/), via ToolRouter::list_all(), re-run on every docs-site build. Do not hand-edit it: fix the generator or the source it reads instead.

Each tool below is a thin wrapper over the identical operation the HTTP and gRPC APIs expose: same underlying MaslowService method, same effect on the machine, just a different transport. The See also line under each tool cross-references the other two surfaces, found by matching the tool's name against the real HTTP route table and the compiled proto descriptor (not a hand-maintained mapping, so it can't point at the wrong route).

calibrate

Run the Maslow anchor calibration routine. The machine will physically move the sled through the calibration grid; this can take several minutes.

See also: gRPC MachineService.Calibrate

No parameters.

comply

Put the Maslow belts into a compliant, low-tension state for manual handling. The machine will physically release belt tension.

See also: gRPC MachineService.Comply

No parameters.

connect

Connect to the machine over its WebSocket control channel. Must be called before any other machine action; does not itself move anything.

See also: gRPC MachineService.Connect

ParameterTypeRequiredDescription
hoststringyesHostname or IP address of the machine, e.g. "maslow.local" or "192.168.1.50".

disconnect

Disconnect from the machine's WebSocket control channel.

See also: gRPC MachineService.Disconnect

No parameters.

e_stop

Trigger the latching Maslow belt emergency stop ($ESTOP). The machine will immediately halt all belt motion; use for safety-critical stops.

See also: gRPC MachineService.EStop

No parameters.

extend

Extend the Maslow belts out to the frame corners. The machine will physically pay out all four belts.

See also: gRPC MachineService.Extend

No parameters.

get_action_policy

Get which machine actions are currently allowed, reconciled from the FluidNC state, the Maslow calibration state, and whether a job is streaming. Read-only; check this before calling a motion or belt action.

See also: HTTP GET /v1/machines/default/actionPolicy · gRPC MachineService.GetActionPolicy

No parameters.

get_firmware_version

Get the FluidNC firmware version reported by the machine at the given host. Read-only network probe; does not require an active connection.

See also: gRPC MachineService.GetFirmwareVersion

ParameterTypeRequiredDescription
hoststringyesHostname or IP address of the machine.

get_machine_status

Get the machine's last known GRBL/FluidNC status report (state, position, feed, overrides). Read-only: returns the most recently observed status rather than querying the machine directly.

See also: HTTP GET /v1/machines/default · gRPC MachineService.GetMachineStatus

No parameters.

get_snapshot

Get an aggregate snapshot of everything currently known about the machine (status, action policy, Maslow telemetry, anchors, config entries) in one call. Read-only; prefer this over polling individual getters when full context is needed.

See also: gRPC MachineService.GetSnapshot

No parameters.

hold

Feed-hold the machine (realtime pause). The machine will physically stop in place; call resume to continue.

See also: gRPC MachineService.Hold

No parameters.

home

Home the machine ($H). The machine will physically move to find its reference position.

See also: gRPC MachineService.Home

No parameters.

jog

Jog the machine by a relative distance in millimeters at the given feed rate. The machine will physically move.

See also: gRPC MachineService.Jog

ParameterTypeRequiredDescription
dxnumbernoRelative distance to move on X, in millimeters.
dynumbernoRelative distance to move on Y, in millimeters.
dznumbernoRelative distance to move on Z, in millimeters.
feednumberyesFeed rate for the jog move, in millimeters per minute.

ping_machine

Test whether a machine is reachable at the given host and fetch basic firmware info. Read-only network probe; does not require an active connection.

See also: gRPC MachineService.PingMachine

ParameterTypeRequiredDescription
hoststringyesHostname or IP address of the machine.

resume

Resume the machine from a feed-hold. The machine will physically resume its previous motion.

See also: gRPC MachineService.Resume

No parameters.

retract

Retract the Maslow belts. The machine will physically wind in all four belts; this is also the universal recovery action from a stuck calibration state.

See also: gRPC MachineService.Retract

No parameters.

save_config

Persist the machine's current runtime configuration to flash so it survives a reboot.

See also: gRPC MachineService.SaveConfig

No parameters.

send_line

Send a raw G-code or $-command line to the machine. The machine will physically act on whatever the line instructs; use with care since this bypasses the higher-level action tools' intent.

See also: gRPC MachineService.SendLine

ParameterTypeRequiredDescription
linestringyesRaw G-code or $-command line to send to the machine.

send_realtime

Send a single raw realtime control byte to the machine (e.g. 24 / 0x18 to soft-reset). Out-of-band and takes effect immediately, even mid-job.

See also: gRPC MachineService.SendRealtime

ParameterTypeRequiredDescription
byteintegeryesSingle realtime byte to send (0-255), e.g. 24 (0x18) for the soft-reset.

stop

Stop the current Maslow belt operation ($STOP). Halts belt motion but does not reset the FluidNC controller or the Maslow calibration state machine.

See also: gRPC MachineService.Stop

No parameters.

take_slack

Take up slack in the Maslow belts to apply cutting tension. The machine will physically move the sled.

See also: gRPC MachineService.TakeSlack

No parameters.

unlock

Unlock the machine from an alarm state ($X). Does not itself cause motion, but re-enables motion commands.

See also: gRPC MachineService.Unlock

No parameters.

write_setting

Write a single FluidNC configuration setting to the machine's runtime config. This changes machine behavior (e.g. steps-per-mm, work area size) and does not persist across reboot unless save_config is also called.

See also: gRPC MachineService.WriteSetting

ParameterTypeRequiredDescription
pathstringyesFull FluidNC config path, e.g. "axes/x/steps_per_mm" or "Maslow_Scale_X".
valuestringyesNew value to write, as a string.

zero

Zero the given axes at the machine's current position (sets the work coordinate offset). Does not cause motion, but changes how subsequent positions are reported.

See also: gRPC MachineService.Zero

ParameterTypeRequiredDescription
axesarray of stringnoAxis letters to zero, e.g. ["X", "Y"]. Empty means the default X+Y zero.