Expand description
On-screen indicator for agent activity.
The MCP server reports each desktop action to the
computer-use-linux-indicator overlay as one JSON datagram on a socket in
$XDG_RUNTIME_DIR. The overlay draws a software cursor that glides to the
target, keycaps for key presses, an edge glow and a status pill. The server
starts the overlay on the first action. Set COMPUTER_USE_LINUX_INDICATOR=0
to turn it off.
Every server keeps the overlay out of its screen captures, even with its
own indicator disabled, because one overlay serves all agents in the
session. For the length of a capture the server holds a shared lock on
capture_lock_path, and the overlay draws nothing while anyone holds it.
The kernel drops the lock of a server that dies, so a crash cannot freeze
the overlay. capture: begin and end datagrams make the overlay react
at once; it answers begin with CAPTURE_REPLY_SHOWN or
CAPTURE_REPLY_EMPTY, so a capture waits for the compositor only when
something was on screen.
Structs§
- Indicator
Event - One overlay update.
Enums§
- Capture
- A server starting or finishing a screen capture.
Constants§
- CAPTURE_
REPLY_ EMPTY - Reply to
capture: beginwhen nothing was on screen. - CAPTURE_
REPLY_ SHOWN - Reply to
capture: beginwhen the overlay had something on screen. - GLIDE
- How long the overlay cursor takes to reach a target. Pointer actions wait this long so the cursor lands before the real input happens.
- HIDE_
SETTLE - Time for the compositor to drop overlay surfaces before a capture.
- INDICATOR_
BINARY - Overlay binary name, resolved next to the server binary or on
PATH. - SOCKET_
NAME - Socket file name inside
$XDG_RUNTIME_DIR.
Functions§
- agent_
display_ name - Maps an MCP
clientInfoto the name shown on screen. - capture_
lock_ path - Lock file held shared by every server for the length of a capture.
- gnome_
indicator_ state - State of the activity renderer in the verified GNOME Shell extension.
- hide_
gnome_ indicator - Hides the GNOME indicator and reports whether compositor settling is needed. An absent or older extension cannot show an indicator.
- is_
gnome_ session - Whether the session uses the GNOME Shell renderer.
- show_
gnome_ indicator - Updates the indicator in the verified GNOME Shell extension. The age keeps a capture resume from extending the idle deadline.
- socket_
path - Path of the overlay socket, or
NonewithoutXDG_RUNTIME_DIR.