quickshell-mcp

An MCP server that runs a quickshell (QML) app and drives it.

The server starts the app inside a headless sway. It takes screenshots of windows, dumps the object tree of a window, and reads or writes QML state. The compositor supplies the display; a profile supplies the backends.

The server is app-agnostic. The profile tells it which config directory to run, which entry file to load, which backend processes to start, and which macros to offer. You give the server one profile, and the server drives that app.

Run it

nix run starts the server. It speaks MCP over stdio.

Run the counter example:

nix run ~/git/quickshell-mcp -- --profile ~/git/quickshell-mcp/examples/counter/profile.json

Point --profile at any app's profile JSON.

Related MCP server: wayland-mcp

Drive the app

You operate the app through tools. Each tool call returns a result. A refused call returns an MCP error with the message <code>: <detail>.

The loop:

1. screenshot(window_index): see the app as a PNG.

2. windows(): list the windows. tree(window_index, root_path, max_depth): map a window's visual tree. Each node reports a path (a child-index chain like 0/2/1) and its objectName.

3. find(name): get the child-index paths of nodes whose objectName is name.

4. Build a selector that names one node and one member.

5. get_property / set_property / invoke / qml_eval / macro: read or change state.

6. screenshot(window_index) again: see the result.

Selectors

A selector names one node and one member. It takes one of three forms:

• wN.prop: window N itself, then member prop. Example: w0.count. A window's own properties live here.

• wN/childpath.prop: window N, then a child-index path under its content item, then member prop. Example: w0/0/2.text.

• @objectName.prop: the first node with that objectName, then member prop. Example: @saveBtn.enabled.

find returns bare paths like 0/2/1. Turn one into a selector as wN/<path>.<prop>, or pass it to tree(root_path=...).

An @objectName selector resolves to the first match. An app that repeats a control per item suffixes the item name into the objectName (activateToggle-alpha), so each control has a unique name.

screenshot needs the window's content item to hold exactly one visual child that covers the window.

Tools

qml_eval reaches any state in the app. win(i) gives window i; app gives the app root.

Error codes

A refused call returns an MCP error. The code is one of: unresolved, no-member, not-callable, too-many-args, no-window, no-node, not-visible, zero-size, grab-refused, multi-root, partial-window, bad-payload, threw.

Profiles

A profile is a small JSON file you write for each app. --profile is required.

Every field lives in quickshell_mcp/profile.cue, with a doc-comment on each. The loader checks your profile against that schema with cue vet before boot, so a broken profile fails at start with the schema error.

The smallest profile runs a self-contained app:

{ "config_dir": "." }

config_dir is the only required field. It is absolute, or relative to the profile file. entry defaults to shell.qml.

Inside any string value, ${PROFILE_DIR}, ${CONFIG_DIR}, ${WORK}, and ${XDG_RUNTIME_DIR} expand at boot.

See examples/counter/profile.json for a macro, and examples/async-form/profile.json for a backend with a readiness gate, a seeded fixture, and env_out.

Generate a JSON Schema for your editor from the same source:

cue def --out jsonschema -e '#Profile' quickshell_mcp/profile.cue

Examples

Each example is self-contained and doubles as a test. Each ships a check.py that boots it for real and asserts the states its README documents.

python examples/check.py              # every example
python examples/check.py counter      # one of them

• counter: a tiny, self-contained QML app.

• async-form: a frontend/backend form flow with a fake backend over a unix socket, a service list, per-profile forms with validation, keyed in-flight state, and a streaming setup flow with prompts. See examples/async-form/README.md for the state tables and the selectors.

Contributing

Launch the dev-shell:

nix develop ~/git/quickshell-mcp

MCP_BACKEND_DELAY_MS passes to every backend a profile spawns. A backend that honours it slows async transitions enough to observe them between screenshots.