@uix-ui/icons-mcp 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +50 -0
- package/README.md +50 -2
- package/icons.search.json +1 -0
- package/package.json +1 -6
- package/server.mjs +200 -0
- package/styles.json +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
UIX Icons licence
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 UIX Icons
|
|
4
|
+
|
|
5
|
+
This repository and its packages carry two licences. Which one applies
|
|
6
|
+
depends on the style of the icon.
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
1. Free styles: MIT
|
|
10
|
+
|
|
11
|
+
The icons in the Regular Rounded, Regular Sharp and Solid styles (the
|
|
12
|
+
"Free Styles"), and the data files that list their names, synonyms and tags,
|
|
13
|
+
are released under the MIT License.
|
|
14
|
+
|
|
15
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
16
|
+
of the Free Styles and associated documentation files (the "Software"), to
|
|
17
|
+
deal in the Software without restriction, including without limitation the
|
|
18
|
+
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
19
|
+
sell copies of the Software, and to permit persons to whom the Software is
|
|
20
|
+
furnished to do so, subject to the following conditions:
|
|
21
|
+
|
|
22
|
+
The above copyright notice and this permission notice shall be included in
|
|
23
|
+
all copies or substantial portions of the Software.
|
|
24
|
+
|
|
25
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
26
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
27
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
28
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
29
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
30
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
31
|
+
SOFTWARE.
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
2. Pro styles: proprietary
|
|
35
|
+
|
|
36
|
+
Every other style (the Thin, Light and Bold weights in rounded and sharp,
|
|
37
|
+
Duotone, Twotone, Bulk, Gradient, Glass and Tile) is proprietary. It is not
|
|
38
|
+
open source and is not covered by the MIT License above.
|
|
39
|
+
|
|
40
|
+
The Pro styles are licensed only to active Pro subscribers, under the terms
|
|
41
|
+
published on the license page of the UIX Icons website. Without an active Pro
|
|
42
|
+
subscription you have no right to use, copy, modify, publish, distribute or
|
|
43
|
+
sublicense the Pro styles. A subscriber may not share a licence key or
|
|
44
|
+
account, or redistribute the Pro styles, on any terms.
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
3. Name and mark
|
|
48
|
+
|
|
49
|
+
This licence does not grant any right to the UIX Icons name or the Swash
|
|
50
|
+
mark.
|
package/README.md
CHANGED
|
@@ -1,3 +1,51 @@
|
|
|
1
|
-
#
|
|
1
|
+
# UIX Icons for AI assistants (MCP)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The largest library of unique modern icons. Free and open source.
|
|
4
|
+
|
|
5
|
+
This MCP server lets an AI assistant pick a real UIX icon by its exact name, then fetch it as SVG, a React (JSX) component or a URL. The assistant searches first and only uses names the search returns, so it never invents an icon that does not exist.
|
|
6
|
+
|
|
7
|
+
## Add it
|
|
8
|
+
|
|
9
|
+
Claude Code:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
claude mcp add uix-icons -- npx -y @uix-ui/icons-mcp
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Claude Desktop, Cursor and other clients (`mcpServers` in the client config):
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"uix-icons": {
|
|
21
|
+
"command": "npx",
|
|
22
|
+
"args": ["-y", "@uix-ui/icons-mcp"],
|
|
23
|
+
"env": { "UIX_LICENSE_KEY": "UIX-XXXX-XXXX-XXXX-XXXX" }
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
`UIX_LICENSE_KEY` is only needed for the Pro styles. Leave it out to use the free styles.
|
|
30
|
+
|
|
31
|
+
## Tools
|
|
32
|
+
|
|
33
|
+
| Tool | What it does |
|
|
34
|
+
|---|---|
|
|
35
|
+
| `search_icons({query, style?, limit?})` | Finds icons by meaning (name, synonyms, tags). Returns real names, best match first. |
|
|
36
|
+
| `get_icon({name, style?, format?, size?, color?})` | Returns one icon. `format` is `svg` (default), `jsx` or `url`. `size` is 8 to 512 px, `color` any CSS color. |
|
|
37
|
+
| `list_icon_styles()` | Lists the style ids with their tier, `free` or `pro`. |
|
|
38
|
+
|
|
39
|
+
Only names returned by `search_icons` exist. A name that is not in the library is refused with the closest real names.
|
|
40
|
+
|
|
41
|
+
## Settings
|
|
42
|
+
|
|
43
|
+
| Variable | Meaning |
|
|
44
|
+
|---|---|
|
|
45
|
+
| `UIX_LICENSE_KEY` | UIX Pro license key. Pro styles are fetched from `https://icons.pagestro.com/api/icon/<style>/<name>.svg`, which checks the key against the UIX Pro subscription. |
|
|
46
|
+
| `UIX_ICONS_DIR` | A folder with `svg/<style>/<name>.svg` and `search/icons.search.json`, from `node src/publish.mjs build`. With it the free styles work offline. Without it they are fetched from the site. |
|
|
47
|
+
| `UIX_ICONS_ORIGIN` | The site to fetch from. Default `https://icons.pagestro.com`. |
|
|
48
|
+
|
|
49
|
+
## License
|
|
50
|
+
|
|
51
|
+
MIT for this server and the free styles (Regular Rounded, Regular Sharp, Solid). The Pro styles are a paid subscription.
|