|
| 1 | +--- |
| 2 | +title: Omarchy MCP |
| 3 | +description: Omarchy MCP enables AI assistants to manage themes in Omarchy |
| 4 | +--- |
| 5 | + |
| 6 | +A Model Context Protocol (MCP) server for integrating [Omarchy](https://omarchy.org) desktop environment theme management with AI assistants like Claude. |
| 7 | + |
| 8 | +<iframe |
| 9 | + width="560" |
| 10 | + height="315" |
| 11 | + src="https://www.youtube.com/embed/eV17C0cJz00" |
| 12 | + title="YouTube video player" |
| 13 | + frameBorder="0" |
| 14 | + allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" |
| 15 | + allowFullScreen |
| 16 | +></iframe> |
| 17 | + |
| 18 | +[Youtube Video](https://youtu.be/eV17C0cJz00?si=eGDeEL2d6KLddGBj) |
| 19 | + |
| 20 | +## Overview |
| 21 | + |
| 22 | +Omarchy MCP enables AI assistants to manage themes in Omarchy - a Linux desktop environment that supports extensive theme customization including color schemes, backgrounds, and UI elements. |
| 23 | + |
| 24 | +<Screenshot src="/img/mcp/omarchy-mcp/tools_omarchy_theme_list.webp" /> |
| 25 | + |
| 26 | +With this MCP server, AI assistants can: |
| 27 | +- List themes with flexible filtering (installed, available, built-in, removable) |
| 28 | +- Query the currently active theme |
| 29 | +- Switch between installed themes |
| 30 | +- Preview theme images before applying them |
| 31 | +- Install new themes from GitHub repositories |
| 32 | +- Remove installed extra themes |
| 33 | +- Rotate background images |
| 34 | + |
| 35 | +## Installation |
| 36 | + |
| 37 | +### Using in llms .py |
| 38 | + |
| 39 | +Paste server configuration into [llms .py MCP Servers](/docs/mcp/fast_mcp): |
| 40 | + |
| 41 | +Name: `omarchy-mcp` |
| 42 | + |
| 43 | +```json |
| 44 | +{ |
| 45 | + "description": "Manage Omarchy Desktop Themes", |
| 46 | + "command": "uvx", |
| 47 | + "args": [ |
| 48 | + "omarchy-mcp" |
| 49 | + ] |
| 50 | +} |
| 51 | +``` |
| 52 | + |
| 53 | +### Claude Desktop |
| 54 | + |
| 55 | +Add to your Claude Desktop configuration file: |
| 56 | + |
| 57 | +```json |
| 58 | +{ |
| 59 | + "mcpServers": { |
| 60 | + "omarchy": { |
| 61 | + "description": "Manage Omarchy Desktop Themes", |
| 62 | + "command": "uvx", |
| 63 | + "args": [ |
| 64 | + "omarchy-mcp" |
| 65 | + ] |
| 66 | + } |
| 67 | + } |
| 68 | +} |
| 69 | +``` |
| 70 | + |
| 71 | +### Development Server |
| 72 | + |
| 73 | +For development, you can run this server using `uv`: |
| 74 | + |
| 75 | +```json |
| 76 | +{ |
| 77 | + "mcpServers": { |
| 78 | + { |
| 79 | + "command": "uv", |
| 80 | + "args": [ |
| 81 | + "run", |
| 82 | + "--directory", |
| 83 | + "/path/to/ServiceStack/omarchy-mcp", |
| 84 | + "omarchy-mcp" |
| 85 | + ] |
| 86 | + } |
| 87 | + } |
| 88 | +} |
| 89 | +{ |
| 90 | + "command": "uv", |
| 91 | + "args": [ |
| 92 | + "run", |
| 93 | + "--directory", |
| 94 | + "/home/mythz/src/ServiceStack/omarchy-mcp", |
| 95 | + "omarchy-mcp" |
| 96 | + ] |
| 97 | +} |
| 98 | +``` |
| 99 | + |
| 100 | +## System Prompt |
| 101 | + |
| 102 | +You can make your AI a more pleasant and personable Omarchy assistant by configuring it with a custom system prompt. The linked system prompt below creates "Archy" - a friendly, conversational assistant that knows Omarchy well and responds naturally to voice commands. |
| 103 | + |
| 104 | +**[system-prompt.txt](https://github.com/ServiceStack/omarchy-mcp/blob/main/src/omarchy_mcp/system-prompt.txt)** |
| 105 | + |
| 106 | +## Available Tools |
| 107 | + |
| 108 | +### `omarchy_theme_list` |
| 109 | + |
| 110 | +Lists Omarchy themes with flexible filtering options. |
| 111 | + |
| 112 | +**Parameters:** |
| 113 | +- `filter` (optional): Filter themes by type |
| 114 | + - `"INSTALLED"` (default) - All installed themes |
| 115 | + - `"ALL"` - All available themes (installed and not installed) |
| 116 | + - `"CURRENT"` - Only the currently active theme |
| 117 | + - `"BUILT_IN"` - Only built-in themes |
| 118 | + - `"CAN_REMOVE"` - Only installed extra themes that can be removed |
| 119 | + - `"CAN_INSTALL"` - Only themes available for installation |
| 120 | +- `scheme` (optional): Filter by color scheme |
| 121 | + - `"ANY"` (default) - All color schemes |
| 122 | + - `"LIGHT"` - Light themed only |
| 123 | + - `"DARK"` - Dark themed only |
| 124 | + |
| 125 | +**Returns:** List of theme names with status indicators (current, built-in, installed) |
| 126 | + |
| 127 | +### `omarchy_theme_set` |
| 128 | + |
| 129 | +Applies a theme to the Omarchy desktop. |
| 130 | + |
| 131 | +**Parameters:** |
| 132 | +- `theme` (required): Theme name to apply (supports partial/case-insensitive matching) |
| 133 | + |
| 134 | +**Returns:** Preview image of the applied theme |
| 135 | + |
| 136 | +### `omarchy_theme_bg_next` |
| 137 | + |
| 138 | +Rotates to the next background image in the current theme. |
| 139 | + |
| 140 | +**Returns:** The new background image |
| 141 | + |
| 142 | +### `omarchy_preview_theme` |
| 143 | + |
| 144 | +Downloads and returns a preview image for a theme without applying it. |
| 145 | + |
| 146 | +**Parameters:** |
| 147 | +- `name` (required): Theme name (supports partial/case-insensitive matching) |
| 148 | + |
| 149 | +**Returns:** Theme preview image |
| 150 | + |
| 151 | +### `omarchy_install_theme` |
| 152 | + |
| 153 | +Installs a new extra/community theme from its GitHub repository. Installing a theme automatically sets it as the current theme. |
| 154 | + |
| 155 | +**Parameters:** |
| 156 | +- `name` (required): Theme name to install |
| 157 | + |
| 158 | +**Returns:** Theme preview image after installation |
| 159 | + |
| 160 | +### `omarchy_remove_theme` |
| 161 | +Uninstalls a previously installed extra/community theme. Built-in themes cannot be removed. |
| 162 | + |
| 163 | +**Parameters:** |
| 164 | +- `name` (required): Theme name to uninstall |
| 165 | + |
| 166 | +**Returns:** Status message |
| 167 | + |
| 168 | +## Theme Matching |
| 169 | + |
| 170 | +Theme names support flexible matching: |
| 171 | +- **Case-insensitive**: "tokyo night", "TOKYO NIGHT", and "Tokyo Night" all match |
| 172 | +- **Partial matching**: "tokyo" matches "Tokyo Night" |
| 173 | +- **Punctuation-insensitive**: "tokyo-night", "tokyo_night", and "tokyonight" all match |
| 174 | + |
| 175 | +## Requirements |
| 176 | + |
| 177 | +- **Python**: 3.10, 3.11, or 3.12 |
| 178 | +- **Omarchy**: Must be installed on the system |
| 179 | +- **Linux**: With Wayland display server |
| 180 | + |
| 181 | +### Dependencies |
| 182 | + |
| 183 | +- `fastmcp>=0.1.0` - MCP server framework |
| 184 | +- `aiohttp` - Async HTTP client for downloading preview images |
| 185 | + |
| 186 | +## Built-in Themes |
| 187 | + |
| 188 | +Omarchy comes with 14 built-in themes: |
| 189 | +- Tokyo Night |
| 190 | +- Catppuccin |
| 191 | +- Ethereal |
| 192 | +- Everforest |
| 193 | +- Gruvbox |
| 194 | +- Hackerman |
| 195 | +- Osaka Jade |
| 196 | +- Kanagawa |
| 197 | +- Nord |
| 198 | +- Matte Black |
| 199 | +- Ristretto |
| 200 | +- Flexoki Light |
| 201 | +- Rose Pine |
| 202 | +- Catppuccin Latte |
| 203 | + |
| 204 | +## Extra Themes |
| 205 | + |
| 206 | +Over 100 additional community themes are available for installation, including various color schemes for both dark and light preferences. |
0 commit comments