-
Notifications
You must be signed in to change notification settings - Fork 0
Tool Reference
All 53 tools. Every tool returns a JSON string: {"ok": true, ...} on success
or {"ok": false, "error": "..."} on failure. * marks required parameters.
Platform: X = cross-platform, W = Windows-only, L = Linux-only.
On Windows hwnd is an HWND; on Linux it is an X11 window id.
- Mouse & keyboard
- Shell
- Window management
- Background / unfocused targeting
- Processes
- Screenshots & images
- Screen recording
- Headless desktop — Windows
- Virtual display — Linux
- AutoHotkey
- Ephemeral WSL
- Run-as-admin & boot
No params → {ok, width, height}.
No params → {ok, x, y}.
*x, *y (screen px); duration 0–10 (default 0). → {ok, x, y}.
x, y (screen px foreground; client coords in background mode; omit to click at
cursor), button left|right|middle, clicks 1–5 (2 = double), interval,
hwnd/window_title (background target), display (Linux). Background click needs
explicit x/y. → {ok, ...} (background adds mode:"background").
start_x/start_y (omit = current), *end_x, *end_y, button, duration
(default 0.25). → {ok, end_x, end_y, button}.
*amount (+up/−down), x, y. → {ok, scrolled}.
*text, interval 0–2, hwnd/window_title (background WM_CHAR / XSendEvent),
display (Linux). → {ok, typed_chars}. For edit controls prefer win_set_control_text.
*keys list 1–6 (pyautogui names). One = single key; many = combo. e.g.
["ctrl","c"], ["alt","tab"], ["f5"]. → {ok, keys}.
*command, shell (default true), cwd, timeout 1–3600 (default 60).
→ {ok, returncode, stdout, stderr, timed_out}.
title_filter, include_empty_titles (default false). → {ok, count, windows:[{title, handle, left, top, width, height, is_minimized, is_maximized, is_active}]}.
No params → {ok, window|null}.
*x, *y, title/handle, display (Linux). → {ok, window}.
*width, *height, title/handle, display (Linux). → {ok, window}.
*action focus|minimize|maximize|restore|close, title/handle, display.
Linux maximize needs wmctrl. → {ok, action, window}.
hwnd/window_title, display. Restores + shows + foregrounds (use before a
login). → {ok, hwnd, visible:true}.
hwnd/window_title, minimize (default false), display. → {ok, hwnd, visible:false}.
See Background Targeting for the full workflow.
hwnd/window_title, display. → {ok, parent_hwnd, count, children:[{handle, class, text, left, top, width, height, visible}]} (coords relative to the parent).
*text, hwnd (the control, preferred)/window_title, display. Windows: WM_SETTEXT
(most reliable); Linux: select-all + delete + type. → {ok, target_hwnd, text_len}.
*keys list 1–6, hwnd/window_title, display. Posts keys without focus; modifier
combos unreliable via messages. → {ok, window_hwnd, keys}.
name_filter, sort_by memory|cpu|name|pid (default memory), limit 1–1000
(default 50). → {ok, count, processes:[{pid, name, username, memory_mb, cpu_percent}]}.
pid or name (kills ALL by exact name), force (default false). → {ok, killed, count}.
monitor (0=all, 1=primary, …), region [left,top,width,height], output_path,
hwnd/window_title (single-window capture — PrintWindow on Windows, ImageMagick on
Linux), client_only (default false), display (Linux). → {ok, path, width, height}.
*input_path, *left, *top, *width, *height, output_path. → {ok, path, width, height}.
fps 1–60 (default 15), monitor (default 1), region, output_path. One at a time.
→ {ok, path, fps, recording:true}.
No params → {ok, path, frames, duration_seconds}.
No params → {ok, recording, path, frames, elapsed_seconds}.
See Headless GUI.
name (default "LowLevelCUHeadless"). → {ok, name, handle, full}.
name, *command. → {ok, desktop, pid, command}.
name. → {ok, name, count, windows}.
name. → {ok, name, closed}.
name — switch the live screen to this off-screen desktop (for a login).
name — switch back to the normal desktop.
See Linux Support.
No params → {ok, display, session_type, xdotool, wmctrl, xvfb, imagemagick_import, scrot}.
display (default 99), width (1280), height (800), depth (24). Starts Xvfb.
display, *command. → {ok, display, pid, command}.
display. → {ok, display, count, windows}.
display, output_path. → {ok, path, width, height, display}.
display. Terminates apps + Xvfb.
Pass
displaytomouse_click/type_text/screenshot/win_send_keysto drive windows on a virtual display.
See AutoHotkey.
No params → {ok, installed, path?, version?, hint?}.
*code (must call ExitApp), args, timeout (default 60), exe_path. Output via
FileAppend ..., "*". → {ok, returncode, stdout, stderr, exe}.
*text, *window ("ahk_id <hwnd>", "ahk_exe app.exe", or title), control
(blank = focused), as_keys, timeout. → AHK result.
See WSL.
No params → {ok, available, version?, reason?}.
No params → {ok, count, distros:[{name, state, version, default}]}.
name (auto), rootfs_url (default latest Alpine minirootfs), clone_from,
base_tar, timeout (default 1800). → {ok, name, install_dir, source, version}.
*distro, *command, user, cwd, timeout. → {ok, distro, returncode, stdout, stderr}.
No params → {ok, count, distros}.
*name, remove_files (default true). → {ok, name, destroyed:true}.
No params → {ok, destroyed, count}.
See Run as Admin and Boot Startup.
No params → {ok, is_admin, platform}.
*command, timeout (default 120). UAC prompt if not elevated. → {ok, returncode, output, elevated_prompt}.
run_as_admin (default true), http (default true), host (127.0.0.1), port (8765).
→ {ok, task_name, run_as_admin, mode, endpoint, output}.
No params → {ok, task_name, output}.
No params → {ok, installed, details, task_name}.
lowlevel-computer-use-mcp · MIT License ·
Getting started
Reference
Features
More