# hypruse

hypruse lets an AI agent inspect and control a Hyprland desktop through MCP. Use it to interact with windows and graphical apps from an agent.

- MCP server · `type=mcp` · Claude Code, Codex, Cursor, GitHub Copilot, Windsurf (Devin Desktop), Cline, Zed, Gemini CLI · ★ 37
- Author: IlyasKhallouki
- License: MIT · policy=link-only · description only; the file stays with the author
- Source: https://github.com/IlyasKhallouki/hypruse
- Updated: 2026-10-19
- HTML: https://affpapa.org/en/nevibecode/mcp/hypruse

## What it does

hypruse connects an MCP client to a Hyprland desktop. The `desktop` tool reports monitors, workspaces and windows; `screenshot` and `zoom` provide visual context, while `ui` reads controls exposed through an app’s accessibility tree. Hyprland IPC handles window and workspace operations.

The server can also click controls, enter text and start apps. It uses Wayland input, `wtype` for keyboard events and `grim` for screenshots. `click_ui` targets a control by its accessible name or a number from `marks`; if a name matches multiple controls, it returns the choices instead of guessing.

Hyprland is required. The `ui` tool depends on an app exposing accessibility information, and drawing numbered marks requires ImageMagick. In apps without that accessibility tree, the agent has to rely on screenshots.

## Requirements
- Needs: Python and uv (commands run via uvx)
- Environment variables: `HYPRUSE_SCREENSHOT_MODE`, `HYPRUSE_READONLY`, `HYPRUSE_CONFINE`, `HYPRUSE_AUTH_GUARD`, `HYPRUSE_STRICT`, `HYPRUSE_MARK`, `HYPRUSE_CLIPBOARD`, `HYPRUSE_JOURNAL`, `HYPRUSE_JOURNAL_MAX_BYTES`, `HYPRUSE_JOURNAL_TEXT` — keys and tokens: ask the human for the values, never commit them or put them in shared files.

## Install

### Claude Code (native platform)

**Platform CLI**
```bash
claude mcp add --env HYPRUSE_SCREENSHOT_MODE=<HYPRUSE_SCREENSHOT_MODE> --env HYPRUSE_READONLY=<HYPRUSE_READONLY> --env HYPRUSE_CONFINE=<HYPRUSE_CONFINE> --env HYPRUSE_AUTH_GUARD=<HYPRUSE_AUTH_GUARD> --env HYPRUSE_STRICT=<HYPRUSE_STRICT> --transport stdio hypruse -- uvx hypruse
```
Replace <…> with your own values. 6 more environment variables are in the server README. uvx runs the command named after the package; if the README names another one, use uvx --from hypruse <command>

### Codex

**Platform CLI**
```bash
codex mcp add hypruse --env HYPRUSE_SCREENSHOT_MODE=<HYPRUSE_SCREENSHOT_MODE> --env HYPRUSE_READONLY=<HYPRUSE_READONLY> --env HYPRUSE_CONFINE=<HYPRUSE_CONFINE> --env HYPRUSE_AUTH_GUARD=<HYPRUSE_AUTH_GUARD> --env HYPRUSE_STRICT=<HYPRUSE_STRICT> -- uvx hypruse
```
Replace <…> with your own values. 6 more environment variables are in the server README. uvx runs the command named after the package; if the README names another one, use uvx --from hypruse <command>

### Cursor

**Config file**
File `.cursor/mcp.json`:
```json
{
    "mcpServers": {
        "hypruse": {
            "command": "uvx",
            "args": [
                "hypruse"
            ],
            "env": {
                "HYPRUSE_SCREENSHOT_MODE": "<HYPRUSE_SCREENSHOT_MODE>",
                "HYPRUSE_READONLY": "<HYPRUSE_READONLY>",
                "HYPRUSE_CONFINE": "<HYPRUSE_CONFINE>",
                "HYPRUSE_AUTH_GUARD": "<HYPRUSE_AUTH_GUARD>",
                "HYPRUSE_STRICT": "<HYPRUSE_STRICT>"
            }
        }
    }
}
```
Replace <…> with your own values. 6 more environment variables are in the server README. uvx runs the command named after the package; if the README names another one, use uvx --from hypruse <command>

### GitHub Copilot

**Config file**
File `.vscode/mcp.json`:
```json
{
    "servers": {
        "hypruse": {
            "type": "stdio",
            "command": "uvx",
            "args": [
                "hypruse"
            ],
            "env": {
                "HYPRUSE_SCREENSHOT_MODE": "<HYPRUSE_SCREENSHOT_MODE>",
                "HYPRUSE_READONLY": "<HYPRUSE_READONLY>",
                "HYPRUSE_CONFINE": "<HYPRUSE_CONFINE>",
                "HYPRUSE_AUTH_GUARD": "<HYPRUSE_AUTH_GUARD>",
                "HYPRUSE_STRICT": "<HYPRUSE_STRICT>"
            }
        }
    }
}
```
Replace <…> with your own values. 6 more environment variables are in the server README. uvx runs the command named after the package; if the README names another one, use uvx --from hypruse <command>

### Gemini CLI

**Platform CLI**
```bash
gemini mcp add -e HYPRUSE_SCREENSHOT_MODE=<HYPRUSE_SCREENSHOT_MODE> -e HYPRUSE_READONLY=<HYPRUSE_READONLY> -e HYPRUSE_CONFINE=<HYPRUSE_CONFINE> -e HYPRUSE_AUTH_GUARD=<HYPRUSE_AUTH_GUARD> -e HYPRUSE_STRICT=<HYPRUSE_STRICT> hypruse uvx hypruse
```
Replace <…> with your own values. 6 more environment variables are in the server README. uvx runs the command named after the package; if the README names another one, use uvx --from hypruse <command>

## When to use it
- inspect Hyprland windows and workspaces
- locate a control by its accessible name
- click a button in a graphical app
- enter text into an application window
- capture a screen or a selected region

## Example prompts
- Show the open windows and active workspace.
- Find the save button in this window and click it.
- Take a screenshot, then enter text in the open window.

## Similar
- [REA](https://affpapa.org/en/nevibecode/mcp/rea.md) — MCP server · ★ 386989
- [GitHub](https://affpapa.org/en/nevibecode/mcp/github.md) — MCP server · ★ 33918
- [World Monitor](https://affpapa.org/en/nevibecode/mcp/world-monitor.md) — MCP server · ★ 89408
- [Netdata](https://affpapa.org/en/nevibecode/mcp/netdata.md) — MCP server · ★ 81115
- [Front-End Checklist](https://affpapa.org/en/nevibecode/mcp/front-end-checklist.md) — MCP server · ★ 74559
- [Scrapling MCP Server](https://affpapa.org/en/nevibecode/mcp/scrapling-mcp-server.md) — MCP server · ★ 89433

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md