lurq 0.65.1

A Rust UI toolkit with typed components, retained state, reactive signals, GPU rendering, and DevTools.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
//! The tool registry: built-in tools plus app-registered custom tools,
//! frozen at `enable_mcp` time and shared with the server thread.

use std::{future::Future, pin::Pin, sync::Arc};

use super::{McpToolCtx, Scope};

/// Built-in tools, dispatched by the drain on the event-loop thread (except
/// `Find` and `Logs`, which the server answers without an app roundtrip).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub(crate) enum BuiltinTool {
  Screenshot,
  ReadTree,
  Inspect,
  Find,
  FindById,
  FindByClass,
  Windows,
  Menu,
  Wait,
  Interact,
  Act,
  SetValue,
  Resize,
  Pointer,
  Touch,
  Logs,
  Navigate,
  FileDialogs,
  FileDialogRespond,
  ProfileStart,
  ProfileRead,
  ProfileEnd,
}

pub(crate) type SyncToolHandler =
  dyn Fn(&mut McpToolCtx<'_>, serde_json::Value) -> Result<serde_json::Value, String> + Send + Sync;

pub(crate) type AsyncToolHandler =
  dyn Fn(serde_json::Value) -> Pin<Box<dyn Future<Output = Result<serde_json::Value, String>> + Send>> + Send + Sync;

pub(crate) enum ToolKind {
  Builtin(BuiltinTool),
  /// Runs on the event-loop thread with `&mut Tree` / `&mut App` — same
  /// powers and same no-blocking constraint as event handlers.
  Sync(Arc<SyncToolHandler>),
  /// Runs on the server's tokio runtime with no tree access, for I/O-bound
  /// work. Distinct at the type level so blocking tools can't freeze the UI
  /// by accident.
  Async(Arc<AsyncToolHandler>),
}

pub(crate) struct RegisteredTool {
  pub(crate) name: String,
  pub(crate) description: String,
  pub(crate) scope: Scope,
  pub(crate) read_only: bool,
  pub(crate) input_schema: serde_json::Value,
  pub(crate) kind: ToolKind,
}

pub(crate) struct ToolRegistry {
  pub(crate) tools: Vec<RegisteredTool>,
}

impl ToolRegistry {
  pub(crate) fn find(&self, name: &str) -> Option<&RegisteredTool> {
    self.tools.iter().find(|tool| tool.name == name)
  }
}

fn schema(value: serde_json::Value) -> serde_json::Value {
  value
}

/// The `window` property shared by window-touching tools.
const WINDOW_PROP: &str =
  "Target window id or name from `lurq_windows` (default \"main\"; \"focused\" targets the focused window)";

pub(crate) fn builtin_tools(router: bool) -> Vec<RegisteredTool> {
  use serde_json::json;

  let mut tools = vec![
    RegisteredTool {
      name: "lurq_menu".into(), description: "Read the declarative application menu, ids, enabled state and accelerators. Activate with lurq_interact action menu_activate and id.".into(),
      scope: Scope::Observe, read_only: true,
      input_schema: schema(json!({"type": "object", "properties": {}})),
      kind: ToolKind::Builtin(BuiltinTool::Menu),
    },
    RegisteredTool {
      name: "lurq_screenshot".into(),
      description: "Capture a PNG screenshot of a window, a region of it, or a single element. \
                    Coordinates and sizes everywhere in this server are pixels of the returned image. \
                    Sensitive text (sensitive=true in the tree) is covered by a grey bar."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "window": { "type": "string", "description": WINDOW_PROP },
          "region": {
            "type": "object",
            "description": "Crop rectangle in screenshot pixels of the same window",
            "properties": {
              "x": { "type": "number" }, "y": { "type": "number" },
              "width": { "type": "number" }, "height": { "type": "number" }
            },
            "required": ["x", "y", "width", "height"]
          },
          "ref": { "type": "string", "description": "Crop to this element from lurq_read_tree (overrides region/window)" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::Screenshot),
    },
    RegisteredTool {
      name: "lurq_read_tree".into(),
      description: "Read a window's element tree as an indented outline. Interactive elements get \
                    stable `ref_N` handles for lurq_interact / lurq_set_value / lurq_screenshot. \
                    Bounds are `@x,y WxH` in screenshot pixels. Refs are replaced on each call — \
                    re-read after significant UI changes. Masked inputs expose only their mask and masked=true. \
                    A Canvas shows {items=N}; items the app described (bars, points, labels) are listed \
                    under it as `- role item:item-id [ref_N] \"label\" @bounds {value=\"...\"}`, and their refs \
                    work with every ref-taking tool (hover with move, click, screenshot)."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "window": { "type": "string", "description": WINDOW_PROP },
          "filter": { "type": "string", "enum": ["interactive", "all"], "description": "interactive (default): prune branches without interactive elements or text; all: every element" },
          "max_depth": { "type": "integer", "description": "Limit tree depth" },
          "max_chars": { "type": "integer", "description": "Truncate output after this many characters (default 30000)" },
          "max_items": { "type": "integer", "description": "Canvas items listed per canvas; the rest are counted (default 200)" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::ReadTree),
    },
    RegisteredTool {
      name: "lurq_inspect".into(),
      description: "Read the live Lurq UI as structured semantic nodes (role, accessible name, state, bounds and refs), without a screenshot. With query, return matching nodes and their ancestor path. Items an app described on a Canvas (bars, points, labels) are children of the canvas node with canvas_item=true and match query and role like elements. Replaces this window's refs; call lurq_act to invoke or hover a returned ref."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "window": { "type": "string", "description": WINDOW_PROP },
          "query": { "type": "string", "description": "Case-insensitive substring of accessible name, id, or class" },
          "role": { "type": "string", "description": "Optional exact semantic role, e.g. button or textbox" },
          "max_depth": { "type": "integer", "minimum": 1, "description": "Maximum tree depth (default 12 for an outline; with query or role, any depth)" },
          "max_nodes": { "type": "integer", "minimum": 1, "description": "Maximum inspected nodes of an outline (default 500); with query or role, every node is searched and this is the maximum number of matches returned (then truncated is true)" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::Inspect),
    },
    RegisteredTool {
      name: "lurq_find".into(),
      description: "Search the refs handed out by the last lurq_inspect or lurq_read_tree of each window (no app \
                    roundtrip). Case-insensitive substring match against tag, text, and attributes."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "query": { "type": "string", "description": "Substring to look for" }
        },
        "required": ["query"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::Find),
    },
    RegisteredTool {
      name: "lurq_find_by_id".into(),
      description: "Look up the element carrying an HTML-like id (set with the `.id(...)` builder) \
                    in the live tree and return a fresh actionable ref for it. Duplicate ids \
                    resolve to the first match in tree order, like the DOM. When no element has \
                    the id, canvas item ids are searched the same way."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "id": { "type": "string", "description": "The element id to look up" },
          "window": { "type": "string", "description": WINDOW_PROP }
        },
        "required": ["id"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::FindById),
    },
    RegisteredTool {
      name: "lurq_find_by_class".into(),
      description: "Look up every element carrying an HTML-like class (set with the `.class(...)`                     builder) in the live tree, in tree order, and return fresh actionable refs."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "class": { "type": "string", "description": "The class name to look up" },
          "window": { "type": "string", "description": WINDOW_PROP }
        },
        "required": ["class"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::FindByClass),
    },
    RegisteredTool {
      name: "lurq_windows".into(),
      description: "List the app's windows: id, name, title, kind, focus, whether each is minimized, maximized or full \
                    screen, size (screenshot pixels; a minimized window's client area, a sliver on Windows), and \
                    scale factor."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({ "type": "object", "properties": {} })),
      kind: ToolKind::Builtin(BuiltinTool::Windows),
    },
    RegisteredTool {
      name: "lurq_wait".into(),
      description: "Wait until the app has rendered: `frames` waits for that many presented frames, \
                    otherwise waits for render idle (no further redraws pending). Use before \
                    screenshots so captures aren't mid-animation."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "window": { "type": "string", "description": WINDOW_PROP },
          "frames": { "type": "integer", "minimum": 1, "description": "Wait for this many presented frames" },
          "timeout_ms": { "type": "integer", "description": "Give up after this long (default 10000)" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::Wait),
    },
    RegisteredTool {
      name: "lurq_interact".into(),
      description: "Drive the app with synthetic input. Actions: click, double_click, move, drag, \
                    wheel, key, type, scroll_to, request_close (vetoable window close), menu_activate (menu id), \
                    history_back / history_forward (go back or forward as Alt+arrow and the mouse's side buttons \
                    do: from the focus, or from a `ref` or `x`/`y`; the elements' on_history_back handlers, then the \
                    router; `taken` says whether something did), \
                    paste (`text` and/or `files` into the focused text input; the person's OS clipboard is never \
                    read: a synthetic Ctrl+V is refused), drag_files / drop_files (`paths` from the OS over or \
                    onto the point, as an Explorer or Finder drag; drag_files enters or moves the drag, \
                    file_drag_leave ends it without a drop). Target either a `ref` from lurq_inspect/lurq_read_tree or \
                    `x`/`y` in screenshot pixels (ref carries its window; coordinates use `window`). \
                    Held input: press / release hold a pointer `button` down across calls, key_down / key_up a \
                    key; each move while something is held is a held-button move (drags, capture) presented in \
                    exactly one frame, so send one move per call. Held Shift/Control/Alt (and Meta, on key events) \
                    modify every action in the window. Holding needs a session-based connection (protocol \
                    2025-06-18, or another version before 2026-07-28). Releasing what is not held, pressing a held \
                    button again and key_down of a held key are refused. Held input is released for the client \
                    when its session ends, the window loses focus or closes, or the server stops; results and \
                    lurq_windows report what is `held`."
        .into(),
      scope: Scope::Interact,
      read_only: false,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "action": { "type": "string", "enum": ["click", "double_click", "move", "drag", "wheel", "key", "type", "scroll_to", "request_close", "menu_activate", "history_back", "history_forward", "press", "release", "key_down", "key_up", "paste", "drag_files", "drop_files", "file_drag_leave"] },
          "id": { "type": "string", "description": "Menu item id for menu_activate" },
          "ref": { "type": "string", "description": "Element handle from lurq_read_tree" },
          "x": { "type": "number", "description": "Screenshot-pixel X (alternative to ref)" },
          "y": { "type": "number", "description": "Screenshot-pixel Y (alternative to ref)" },
          "to_x": { "type": "number", "description": "Drag end X" },
          "to_y": { "type": "number", "description": "Drag end Y" },
          "to_ref": { "type": "string", "description": "Drag end element" },
          "button": { "type": "string", "enum": ["left", "right", "middle", "back", "forward"], "description": "Pointer button for click, double_click, drag, press and release (default left); back and forward are the mouse's side buttons, which go back and forward on their release" },
          "delta_x": { "type": "number", "description": "Wheel horizontal delta" },
          "delta_y": { "type": "number", "description": "Wheel vertical delta (positive scrolls content up)" },
          "key": { "type": "string", "description": "Key name for key, key_down and key_up, e.g. Enter, Tab, Escape, ArrowDown, a, Shift, \" \" (space)" },
          "text": { "type": "string", "description": "Text for the type action, or the text a paste holds" },
          "files": { "type": "array", "items": { "type": "string" }, "description": "File paths a paste holds (as files copied in Explorer or Finder)" },
          "image": { "type": "string", "description": "Path of an image file whose pixels a paste holds (as a screenshot on the clipboard)" },
          "paths": { "type": "array", "items": { "type": "string" }, "description": "File or folder paths of drag_files and drop_files" },
          "modifiers": { "type": "array", "items": { "type": "string", "enum": ["shift", "ctrl", "alt", "meta"] } },
          "window": { "type": "string", "description": WINDOW_PROP }
        },
        "required": ["action"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::Interact),
    },
    RegisteredTool {
      name: "lurq_act".into(),
      description: "Invoke (click) or hover (move the pointer onto) a semantic element or canvas item ref from lurq_inspect without supplying coordinates. Allowed actions are listed in the ref's `actions`. Re-checks its live role and name and that it is hittable before dispatch; stale or changed refs fail."
        .into(),
      scope: Scope::Interact,
      read_only: false,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "ref": { "type": "string", "description": "Element ref from lurq_inspect" },
          "action": { "type": "string", "enum": ["invoke", "hover"], "description": "invoke clicks the element's center; hover moves the pointer there (opens hover tooltips)" }
        },
        "required": ["ref", "action"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::Act),
    },
    RegisteredTool {
      name: "lurq_set_value".into(),
      description: "Set a form control's value directly (no keystroke simulation): TextInput \
                    (string), Checkbox (boolean), Slider (number), range Slider (two numbers \
                    [low, high] set both values; one number moves the thumb nearer it), Select (option \
                    label or index). Slider values are snapped to the slider's range and step, and a \
                    range's two are put in order. Masked input replies contain the mask and masked=true, \
                    never the underlying value."
        .into(),
      scope: Scope::Interact,
      read_only: false,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "ref": { "type": "string", "description": "Form element handle from lurq_read_tree" },
          "value": { "description": "New value: string, boolean, number, or [low, high] for a range slider, depending on the control" }
        },
        "required": ["ref", "value"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::SetValue),
    },
    RegisteredTool {
      name: "lurq_resize".into(),
      description: "Resize a window's client area to `width` x `height` screenshot pixels. A minimized, maximized or \
                    full-screen window is restored to a normal window first, so this also restores a minimized \
                    window. Answers once the window has been resized, with the size it took and the modes it left \
                    (`restored_from`); fails with the window's real size when it did not take the requested one."
        .into(),
      scope: Scope::Interact,
      read_only: false,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "window": { "type": "string", "description": WINDOW_PROP },
          "width": { "type": "integer", "minimum": 1 },
          "height": { "type": "integer", "minimum": 1 }
        },
        "required": ["width", "height"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::Resize),
    },
    RegisteredTool {
      name: "lurq_touch".into(),
      description: "Play a gesture of fingers on a window, through the same path a touch screen's fingers take:                     the fingers' own events (on_touch_*), the pointer the first stands for (a tap clicks, a drag                     scrolls with momentum or drags), and the gestures (on_tap, on_long_press, on_pan, on_swipe,                     on_edge_pan, on_pinch, on_rotate, three fingers' undo/redo/copy/paste and editing menu). The                     gesture is played at once on a clock of its own, at the speed it says; what it leaves moving goes                     on in real time. Gestures: tap (`fingers` 1-5, `count` 1-3), double_tap, long_press                     (`duration_ms`, default 700), pan (`dx`/`dy` logical px, or `direction` and `distance`; rests                     before it lifts, no momentum), swipe (`direction`, `distance` default 200, `speed` px/s default                     1200, `fingers`), edge_pan (`edge` left/right/top/bottom, `distance`, `speed`; starts at the edge                     across from `x`/`y`, or its middle), pinch (`scale`, `distance` = start radius, `angle`), rotate                     (`angle` degrees, clockwise), zoom (one finger: a tap, then held and dragged; `scale`),                     three_finger_swipe (`direction` left undoes, right redoes), three_finger_pinch (`scale` below 1                     copies, above 1 pastes; a paste reads no clipboard). A three-finger tap is tap with fingers 3. `lift: false` leaves the fingers down at the end, for a screenshot; gesture `lift` lifts them.                     Target a `ref` or `x`/`y` in screenshot pixels. The app's pointer becomes coarse."
        .into(),
      scope: Scope::Interact,
      read_only: false,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "gesture": { "type": "string", "enum": ["tap", "double_tap", "long_press", "pan", "swipe", "edge_pan", "pinch", "rotate", "zoom", "three_finger_swipe", "three_finger_pinch", "lift"] },
          "lift": { "type": "boolean", "description": "false leaves the fingers down at the gesture's end, to be looked at (a loupe, a pinch half way); gesture lift lifts them" },
          "ref": { "type": "string", "description": "Element handle from lurq_inspect or lurq_read_tree: the gesture's middle" },
          "x": { "type": "number", "description": "Screenshot-pixel X (alternative to ref)" },
          "y": { "type": "number", "description": "Screenshot-pixel Y (alternative to ref)" },
          "fingers": { "type": "integer", "minimum": 1, "maximum": 5, "description": "Fingers of a tap, pan or swipe (default 1)" },
          "count": { "type": "integer", "minimum": 1, "maximum": 3, "description": "Taps in a row (default 1)" },
          "direction": { "type": "string", "enum": ["left", "right", "up", "down"], "description": "Way of a swipe or pan" },
          "distance": { "type": "number", "description": "Logical px: of a swipe, pan or edge pan; a pinch's starting radius" },
          "speed": { "type": "number", "description": "Logical px per second of a swipe, pan or edge pan" },
          "dx": { "type": "number", "description": "Pan's travel, logical px" },
          "dy": { "type": "number", "description": "Pan's travel, logical px" },
          "edge": { "type": "string", "enum": ["left", "right", "top", "bottom"] },
          "scale": { "type": "number", "description": "Pinch or zoom: the fingers' spread at the end over at the start" },
          "angle": { "type": "number", "description": "Rotation in degrees, clockwise" },
          "duration_ms": { "type": "number", "description": "Long press's rest, pinch's or rotation's time" },
          "window": { "type": "string", "description": WINDOW_PROP }
        },
        "required": ["gesture"]
      })),
      kind: ToolKind::Builtin(BuiltinTool::Touch),
    },
    RegisteredTool {
      name: "lurq_pointer".into(),
      description: "Read or set what the person points with: `fine` (a mouse, a trackpad, a pen) or `coarse` (a                     finger). Components with a touch form (the lightbox's phone viewer, the picture's phone form,                     the video player's touch form) take it while the pointer is coarse. With no arguments it                     answers the pointer, whether it is pinned and whether input moves it. `pointer` sets it, pinned                     unless `pin` is false (a pin keeps the next mouse move, an agent's too, from making it fine);                     `follow` turns following input on (which lets go of a pin) or off."
        .into(),
      scope: Scope::Interact,
      read_only: false,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "pointer": { "type": "string", "enum": ["fine", "coarse"] },
          "pin": { "type": "boolean", "description": "Keep input from moving it (default true)" },
          "follow": { "type": "boolean", "description": "Whether input moves the pointer; true lets go of a pin" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::Pointer),
    },
    RegisteredTool {
      name: "lurq_logs".into(),
      description: "Recent app log lines captured by the lurq MCP tracing layer (empty unless the \
                    app installed `lurq::mcp::log_layer()`)."
        .into(),
      scope: Scope::Observe,
      read_only: true,
      input_schema: schema(json!({
        "type": "object",
        "properties": {
          "lines": { "type": "integer", "description": "Max lines, newest last (default 200)" },
          "filter": { "type": "string", "description": "Only lines containing this substring" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::Logs),
    },
  ];

  if router {
    tools.push(RegisteredTool {
      name: "lurq_navigate".into(),
      description: "Navigate the app router: push a route path, or go back/forward. Always returns \
                    the current path. Requires the app to hand its Navigator to the MCP config. back/forward here \
                    move that router alone; lurq_interact history_back / history_forward go back as a person does, \
                    through what the page does with it first (a dialog that closes)."
        .into(),
      scope: Scope::Navigate,
      read_only: false,
      input_schema: schema(serde_json::json!({
        "type": "object",
        "properties": {
          "path": { "type": "string", "description": "Route path to push, e.g. /settings/profile" },
          "replace": { "type": "boolean", "description": "Replace the current history entry instead of pushing" },
          "back": { "type": "boolean", "description": "Go back one history entry" },
          "forward": { "type": "boolean", "description": "Go forward one history entry" }
        }
      })),
      kind: ToolKind::Builtin(BuiltinTool::Navigate),
    });
  }

  tools
}