Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/trycua/cua/llms.txt

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

Lume ships a built-in Model Context Protocol (MCP) stdio server that exposes VM management operations as tools consumable by AI agents and MCP-compatible clients. Tool names use snake_case.

Starting the MCP server

Start the server with lume serve --mcp:
lume serve --mcp
MCP clients discover the live tool list automatically from the server. Always use client-side tool discovery to ensure the tool schemas match the installed Lume version. The tools documented here reflect Lume 0.5.3.

Available tools

The MCP server exposes tools for the full VM lifecycle. The lume_resize_disk tool is documented in detail below. All other tools follow the same pattern — clients should discover their exact schemas at runtime.

lume_resize_disk

Grow a stopped VM’s disk to a new total size. The operation is increase-only — you cannot shrink a disk.
The VM must be stopped before resizing. macOS resizing preserves the paired RecoveryOS partition and expands the main APFS container. Linux resizing increases the image only — you must grow the partition and filesystem inside the guest separately.
name
string
required
Name of the VM whose disk will be resized.
disk_size
string
required
New total disk size as a human-readable string, e.g. 120GB. Must be greater than the current disk size.
storage
string
Named storage location or direct path to the VM. Uses the default location if omitted.
no_backup
boolean
default:"false"
Skip the macOS rollback copy before resizing. Cannot be true at the same time as keep_backup.
keep_backup
boolean
default:"false"
Keep the rollback files on the host after a successful resize. Cannot be true at the same time as no_backup.
dry_run
boolean
default:"false"
Validate and print the resize plan without modifying the disk. Useful for checking minimum size requirements before committing.
Constraints:
  • no_backup and keep_backup are mutually exclusive.
  • The default rollback copy requires enough free host space for the RecoveryOS data and copy-on-write metadata.
  • The first macOS resize must leave enough room to relocate RecoveryOS without overlapping its old location. Lume reports the minimum accepted total size.
  • FileVault-encrypted macOS guests are not supported.
  • The host must run the same or a newer macOS version than the guest.

VM lifecycle tools

The following tools are available but their schemas are version-specific. Use MCP client-side tool discovery to get the exact parameter schemas for your installed version.
Tool namePurpose
lume_list_vmsList all virtual machines managed by Lume.
lume_get_vmGet detailed information about a specific VM.
lume_create_vmCreate a new virtual machine.
lume_run_vmStart a stopped virtual machine.
lume_stop_vmStop a running virtual machine.
lume_delete_vmDelete a VM and its associated files.
lume_clone_vmClone an existing VM to a new name.
lume_execExecute a command in a VM via SSH.
check_for_updateCheck whether a newer Lume release is available.
The check_for_update tool makes a read-only request to GitHub Releases. Its response is cached for up to 20 hours. It is not affected by the telemetry enable/disable setting.

Telemetry and the MCP server

Lume records a lume_mcp_session_started event when the stdio MCP server starts, and a lume_mcp_tool_completed event for each tool invocation. These events include only allowlisted, bounded properties — no tool arguments or results are recorded. See Telemetry and privacy for the full schema.

Build docs developers (and LLMs) love