stefanoamorelli/hyprmcp

https://github.com/user-attachments/assets/b4fc1d26-ec04-451a-b7c9-7f87b44d9c9e
A lightweight, unofficial Model Context Protocol (MCP) server that exposes all the functionality of hyprctl—the command-line interface for the Hyprland Wayland compositor—to language models.
This server enables natural language interfaces to query and control Hyprland's window management, layouts, inputs, and more.
> Note: This project is experimental and in beta.
## 🚀 Quick Start
### 1. Clone the repository
bash
git clone https://github.com/stefanoamorelli/hyprmcp.git
cd hyprmcp
### 2. Grab your HYPRLANDINSTANCESIGNATURE
bash
echo $HYPRLANDINSTANCESIGNATURE
### 3. Install the server in your MCP client
For example, in Claude Desktop, modify the ~/.config/Claude/claudedesktopconfig.json file as follows:
json
"Hyperland MCP Server": {
"command": "uv",
"args": [
"run",
"--with",
"mcp[cli]",
"--with",
"subprocess",
"mcp",
"run",
" /hyprmcp/hyprmcp/server.py"
],
"env": {
"PYTHONPATH": " /hyprmcp",
"HYPRLANDINSTANCESIGNATURE": " "
},
## 🧰 Available Tools
| Tool Name | Description |
| runhyprctlcommand | Executes arbitrary hyprctl commands. |
| getversion | Retrieves the Hyprland version and build info. |
| listmonitors | Lists all connected monitors and properties. |
| listworkspaces | Lists all active workspaces. |
| listclients | Lists all windows and their properties. |
| listdevices | Lists all connected input devices. |
| getactivewindow | Shows the currently active window details. |
| listlayers | Displays all layers in the compositor. |
| getsplash | Retrieves the current random splash message. |
| dispatchcommand | Dispatches a command to Hyprland. |
| setkeyword | Dynamically sets a configuration keyword. |
| reloadconfig | Forces a reload of the Hyprland config file. |
| enterkillmode | Enables kill mode to terminate windows by click. |
These tools allow language models to interact with Hyprland's features seamlessly.
## 💡 Example Usage
User Prompt: "Switch to workspace 2."
MCP Server Action: Executes hyprctl dispatch workspace 2.
User Prompt: "What is the current active window?"
MCP Server Action: Executes hyprctl activewindow -j and returns the details.