Skip to content

Commit 76bd1cb

Browse files
committed
update README
1 parent d3d7eed commit 76bd1cb

1 file changed

Lines changed: 18 additions & 28 deletions

File tree

README.md

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ A Model Context Protocol (MCP) server for integrating [Omarchy](https://omarchy.
77
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.
88

99
With this MCP server, AI assistants can:
10-
- List available themes (built-in and custom/extra themes)
10+
- List themes with flexible filtering (installed, available, built-in, removable)
11+
- Query the currently active theme
1112
- Switch between installed themes
1213
- Preview theme images before applying them
1314
- Install new themes from GitHub repositories
14-
- Uninstall themes
15+
- Remove installed extra themes
1516
- Rotate background images
16-
- Query the currently active theme
1717

1818
## Installation
1919

@@ -95,21 +95,22 @@ For development, you can run this server using `uv`:
9595

9696
### omarchy_theme_list
9797

98-
Lists installed Omarchy themes.
98+
Lists Omarchy themes with flexible filtering options.
9999

100100
**Parameters:**
101101
- `filter` (optional): Filter themes by type
102-
- `"ALL"` (default) - All installed themes
102+
- `"INSTALLED"` (default) - All installed themes
103+
- `"ALL"` - All available themes (installed and not installed)
104+
- `"CURRENT"` - Only the currently active theme
103105
- `"BUILT_IN"` - Only built-in themes
104-
- `"EXTRA"` - Only custom/extra themes
105-
106-
**Returns:** List of theme names, one per line
107-
108-
### omarchy_theme_current
109-
110-
Gets the currently active theme.
106+
- `"CAN_REMOVE"` - Only installed extra themes that can be removed
107+
- `"CAN_INSTALL"` - Only themes available for installation
108+
- `scheme` (optional): Filter by color scheme
109+
- `"ANY"` (default) - All color schemes
110+
- `"LIGHT"` - Light themed only
111+
- `"DARK"` - Dark themed only
111112

112-
**Returns:** Current theme name
113+
**Returns:** List of theme names with status indicators (current, built-in, installed)
113114

114115
### omarchy_theme_set
115116

@@ -126,17 +127,6 @@ Rotates to the next background image in the current theme.
126127

127128
**Returns:** The new background image
128129

129-
### omarchy_extra_themes_to_install
130-
131-
Lists available extra themes that can be installed from GitHub.
132-
133-
**Parameters:**
134-
- `scheme` (optional): Filter by color scheme
135-
- `"DARK"` (default) - Dark themed extras
136-
- `"LIGHT"` - Light themed extras
137-
138-
**Returns:** List of installable theme names
139-
140130
### omarchy_preview_theme
141131

142132
Downloads and returns a preview image for a theme without applying it.
@@ -146,18 +136,18 @@ Downloads and returns a preview image for a theme without applying it.
146136

147137
**Returns:** Theme preview image
148138

149-
### omarchy_install_extra_theme
139+
### omarchy_install_theme
150140

151-
Installs a new extra/community theme from its GitHub repository.
141+
Installs a new extra/community theme from its GitHub repository. Installing a theme automatically sets it as the current theme.
152142

153143
**Parameters:**
154144
- `name` (required): Theme name to install
155145

156146
**Returns:** Theme preview image after installation
157147

158-
### omarchy_uninstall_extra_theme
148+
### omarchy_remove_theme
159149

160-
Uninstalls a previously installed extra/community theme.
150+
Uninstalls a previously installed extra/community theme. Built-in themes cannot be removed.
161151

162152
**Parameters:**
163153
- `name` (required): Theme name to uninstall

0 commit comments

Comments
 (0)