{"_id":"runeicons-mcp","_rev":"2-58f1a7b7f0da7aa233c4fb2a9d5e41ae","name":"runeicons-mcp","dist-tags":{"latest":"0.1.0"},"versions":{"0.0.0-stage":{"name":"runeicons-mcp","version":"0.0.0-stage","_id":"runeicons-mcp@0.0.0-stage","stub":true,"maintainers":[{"name":"nexvyn","email":"amangupta.ans@gmail.com"}],"dist":{"shasum":"d655988c0519ab33bb62e90b3928142cd054e4d0","tarball":"https://registry.npmjs.org/runeicons-mcp/-/runeicons-mcp-0.0.0-stage.tgz","fileCount":2,"integrity":"sha512-ZKTnucrGq+8evCzpWGcPWelGcw+Rrq3jQtqBYrn8jVh4pbXOtZPdJirrS0zNQMC+/HFnbWFLQMsBe0qbO/79MQ==","signatures":[{"sig":"MEQCIHMHJ/EvCSInplgSy5xOxkWsRCRwYtOmt3HqJQKsZrXtAiAAmV9c+t8myUeORxkIZz52LDV/OiqycfSWYab4vUcmeg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":335},"_npmUser":{"name":"nexvyn","email":"amangupta.ans@gmail.com"},"description":"Temporary package placeholder for staged publishing","directories":{}},"0.1.0":{"_id":"runeicons-mcp@0.1.0","bin":{"runeicons-mcp":"dist/index.js"},"bugs":{"url":"https://github.com/Runeicons/runeicons/issues"},"dist":{"shasum":"bb86b4883d938d64208fa4a7426eedb5b3c2bcdf","tarball":"https://registry.npmjs.org/runeicons-mcp/-/runeicons-mcp-0.1.0.tgz","fileCount":2055,"integrity":"sha512-TyU+X3NU2IVRe3BLr2qlqdKeiFwLXR2TtpoQuj5MLgRf9DwbtiZb8PlfpmeqiyreqKXg1W8Kpf/ieOBKv2mQ0Q==","signatures":[{"sig":"MEYCIQDtQy389FAJ5dB0YpmbVGObvkJa0OMhPyfX013ArU9/fAIhAOkvX0riGlcSEP+0AAolNI4hfUviSRzbw6d+7I8hJGNV","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"},{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQDPUmJvrODoArlbQr4sH3Px3Xb3o50e5FcFxrynLo8XOwIgb+jE2oMx0e63wrhw4S0Khq5y/GCi0ESdhXPyMblMKAU="}],"unpackedSize":6743193},"main":"./dist/index.js","name":"runeicons-mcp","type":"module","types":"./dist/index.d.ts","engines":{"node":">=18"},"gitHead":"cf86b11436c06f96be0fa9e1e14af6bba41e5673","license":"Apache-2.0","scripts":{"test":"bun run generate && bun test","build":"tsc -p tsconfig.json","generate":"bun scripts/generate-icons.ts","typecheck":"tsc --noEmit -p tsconfig.json","prepublishOnly":"bun run generate && bun run typecheck && bun run test && bun run build"},"version":"0.1.0","_npmUser":{"name":"nexvyn","email":"amangupta.ans@gmail.com"},"homepage":"https://runeicons.com","keywords":["mcp","modelcontextprotocol","icons","svg","runeicons","rune-icons"],"repository":{"url":"git+https://github.com/Runeicons/runeicons.git","type":"git","directory":"packages/runeicons-mcp"},"_npmVersion":"10.9.2","description":"MCP server exposing the RuneIcons library (350+ icons, 900+ variants across 5 styles) and 1,100+ third-party brand logos to AI agents: search icons and brands, resolve metadata, and get ready-to-use SVG source.","directories":{},"maintainers":[{"name":"nexvyn","email":"amangupta.ans@gmail.com"}],"_nodeVersion":"22.15.0","dependencies":{"zod":"^4.3.6","@modelcontextprotocol/sdk":"^1.31.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^6.0.3","@types/node":"^25.9.9"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/runeicons-mcp_0.1.0_1791707743534_0.09930853766250336"}}},"time":{"created":"2026-10-11T08:34:04.596Z","modified":"2026-10-11T08:35:43.890Z","0.0.0-stage":"2026-10-11T08:34:04.596Z","0.1.0":"2026-10-11T08:35:43.681Z"},"description":"MCP server exposing the RuneIcons library (350+ icons, 900+ variants across 5 styles) and 1,100+ third-party brand logos to AI agents: search icons and brands, resolve metadata, and get ready-to-use SVG source.","maintainers":[{"name":"nexvyn","email":"amangupta.ans@gmail.com"}],"readme":"# runeicons-mcp\r\n\r\nAn [MCP](https://modelcontextprotocol.io) server that gives AI agents access to the [RuneIcons](https://runeicons.com) library. It has 350+ icons and 900+ variants across five styles: normal (outline), duotone, fill, pixelated, and glass, plus 1,100+ third-party brand logos. Agents can search icons and get ready-to-use SVG source to place in your code, and look up brand logos with their usage notices.\r\n\r\nAll SVGs are bundled with the package, so the server needs no network access at runtime. Icon SVGs are returned with `stroke` and `fill` set to `currentColor`, so they can be recolored with CSS.\r\n\r\n[![License](https://img.shields.io/badge/License-Apache_2.0-7c5cff?style=flat-square)](LICENSE)\r\n\r\n## Install\r\n\r\nThe package requires Node.js 18 or later. The server runs over stdio and exposes the binary `runeicons-mcp`.\r\n\r\n```sh\r\nnpm install runeicons-mcp\r\npnpm add runeicons-mcp\r\nbun add runeicons-mcp\r\n```\r\n\r\nYou can also run it without installing. Most clients do this for you through the configuration below:\r\n\r\n```sh\r\nnpx -y runeicons-mcp\r\n```\r\n\r\n## Client configuration\r\n\r\nAdd the server to your MCP client. The examples below use `npx`, so no local install is needed. Restart the client after changing its configuration.\r\n\r\n### Claude Code\r\n\r\n```sh\r\nclaude mcp add runeicons -- npx -y runeicons-mcp\r\n```\r\n\r\n### Claude Desktop\r\n\r\nAdd this to `claude_desktop_config.json`. The file is usually at `%APPDATA%\\Claude\\claude_desktop_config.json` on Windows and `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS. If the file already has an `mcpServers` object, add the `runeicons` entry to it.\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"runeicons\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"runeicons-mcp\"]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Cursor\r\n\r\nAdd this to `.cursor/mcp.json` in your project, or to `~/.cursor/mcp.json` for all projects:\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"runeicons\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"runeicons-mcp\"]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### VS Code\r\n\r\nAdd this to `.vscode/mcp.json` in your workspace. VS Code uses the `servers` key:\r\n\r\n```json\r\n{\r\n  \"servers\": {\r\n    \"runeicons\": {\r\n      \"type\": \"stdio\",\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"runeicons-mcp\"]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Local install\r\n\r\nIf you installed the package with npm, pnpm, or bun, point the client at the built entry point instead of `npx`:\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"runeicons\": {\r\n      \"command\": \"node\",\r\n      \"args\": [\"/path/to/node_modules/runeicons-mcp/dist/index.js\"]\r\n    }\r\n  }\r\n}\r\n```\r\n\r\nWith bun, `bunx runeicons-mcp` runs the same binary in place of `npx -y runeicons-mcp`.\r\n\r\n## Tools\r\n\r\nThe server exposes six tools: three for icons (`search_icons`, `get_icon`, `list_categories`) and three for brand logos (`search_brands`, `get_brand`, `list_brand_groups`).\r\n\r\n### `search_icons`\r\n\r\nSearch the library by text, category, and style. The same icon id can appear once per style, so use `style` to get one variant. Results are ranked with exact id or name matches first.\r\n\r\n| Parameter  | Type     | Required | Description                                                                                         |\r\n| :--------- | :------- | :------- | :-------------------------------------------------------------------------------------------------- |\r\n| `query`    | `string` | No       | Up to 100 characters. Matched case-insensitively against id, name, category, and tags               |\r\n| `category` | `string` | No       | Up to 50 characters. Exact category name, for example `navigation`. See `list_categories`          |\r\n| `style`    | `string` | No       | One of `normal`, `duotone`, `fill`, `pixelated`, `glass`                                            |\r\n| `limit`    | `number` | No       | Integer from 1 to 200. Default 50                                                                   |\r\n\r\nExample call and response:\r\n\r\n```text\r\nsearch_icons { \"query\": \"arrow down left\", \"style\": \"normal\" }\r\n\r\n1 result for \"arrow down left\":\r\n\r\n- arrows-arrow-down-left - \"Arrow Down Left\" (style: normal, category: navigation)\r\n\r\nUse get_icon with an id to fetch SVG source.\r\n```\r\n\r\nIf nothing matches, the response suggests a shorter query or calling `list_categories`.\r\n\r\n### `get_icon`\r\n\r\nGet the metadata and SVG source for one icon by id. Ids come from `search_icons`, for example `arrows-arrow-down-left` or `glass-back-2`. If the id exists in several styles, the normal style is returned when available. An unknown id returns an error result that suggests calling `search_icons`.\r\n\r\n| Parameter        | Type      | Required | Description                                         |\r\n| :--------------- | :-------- | :------- | :-------------------------------------------------- |\r\n| `id`             | `string`  | Yes      | Icon id, 1 to 120 characters                        |\r\n| `includeSvg`     | `boolean` | No       | Include the full SVG source. Default `true`         |\r\n| `includeRelated` | `boolean` | No       | List the same glyph in other styles. Default `true` |\r\n\r\nExample call and response:\r\n\r\n```text\r\nget_icon { \"id\": \"arrows-arrow-down-left\" }\r\n\r\nid: arrows-arrow-down-left\r\nname: Arrow Down Left\r\nstyle: normal\r\ncategory: navigation\r\ntags: navigation, arrow, down, left\r\nviewBox: 0 0 24 24\r\nother styles: duotone (arrows-arrow-down-left), pixelated (arrows-arrow-down-left)\r\n\r\n<svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\" fill=\"none\">\r\n  <path d=\"M17 7L7 17M7 7V17H17\" stroke=\"currentColor\" stroke-width=\"2\" stroke-linecap=\"round\" stroke-linejoin=\"round\"/>\r\n</svg>\r\n```\r\n\r\nThe `other styles` line is omitted for glass icons, which have no other variants. When `includeSvg` is `false`, the SVG line is replaced by a note that says to pass `includeSvg: true`.\r\n\r\n### `list_categories`\r\n\r\nList every category with its total and per-style counts. Use a category name as the `category` filter of `search_icons`. This tool takes no parameters.\r\n\r\nExample response, from the current icon set:\r\n\r\n```text\r\nRuneIcons: 357 icons, 917 variants, across 16 categories\r\n\r\ncategory       total  normal  duotone  fill  pixelated  glass\r\n-------------------------------------------------------------\r\naccessibility     36       8       7     5          8      8\r\naction            87      20      20    18         20      9\r\ncommerce          57      15      15    10         14      3\r\ncommunication     54      12      12    10         12      8\r\ndev               55      15      15     7         15      3\r\nfeedback          72      18      18    13         18      5\r\nfiles            114      27      27    20         25     15\r\nhardware          36       8       8     8          8      4\r\nlayout            52      14      14    10         14      0\r\nmedia             56      14      13     8         13      8\r\nmetrics           26       8       8     2          8      0\r\nmisc              72       6       6     3          5     52\r\nnavigation        76      24      24     2         24      2\r\ntime              29       7       7     3          7      5\r\nusers             52      13      13     6         13      7\r\nweather           43      11      11     4         11      6\r\n```\r\n\r\n### `search_brands`\r\n\r\nSearch the brand logo library by text, group, and license tier. Each result shows the slug, name, group, and license. Results are ranked with exact slug or name matches first, then shorter names.\r\n\r\n| Parameter | Type     | Required | Description                                                                                       |\r\n| :-------- | :------- | :------- | :------------------------------------------------------------------------------------------------ |\r\n| `query`   | `string` | No       | Up to 100 characters. Matched case-insensitively against slug, name, group, and tier             |\r\n| `group`   | `string` | No       | Up to 60 characters. Exact group name, for example `AI`. See `list_brand_groups`                  |\r\n| `tier`    | `string` | No       | One of `permissive`, `attribution`, `share-alike`, `trademark-only`                               |\r\n| `limit`   | `number` | No       | Integer from 1 to 200. Default 50                                                                 |\r\n\r\nExample call and response:\r\n\r\n```text\r\nsearch_brands { \"query\": \"openai\", \"limit\": 3 }\r\n\r\n3 results for \"openai\":\r\n\r\n- openai - \"OpenAI\" (group: AI, license: MIT)\r\n- sora-openai - \"Sora (OpenAI)\" (group: AI, license: MIT)\r\n- codex-openai - \"Codex (OpenAI)\" (group: AI, license: MIT)\r\n\r\nUse get_brand with a slug to fetch the logo and its usage notice.\r\n```\r\n\r\nIf nothing matches, the response suggests a shorter query or calling `list_brand_groups`.\r\n\r\n### `get_brand`\r\n\r\nGet the metadata, official site, brand guidelines link, and SVG source for one brand logo by slug, for example `openai` or `claude-code`. The SVG is returned unaltered, so it does not use `currentColor`. The result always ends with the usage notice from [Brand logos](#brand-logos). An unknown slug returns an error result that suggests calling `search_brands`.\r\n\r\n| Parameter    | Type      | Required | Description                                      |\r\n| :----------- | :-------- | :------- | :----------------------------------------------- |\r\n| `slug`       | `string`  | Yes      | Brand slug, 1 to 120 characters                  |\r\n| `includeSvg` | `boolean` | No       | Include the full SVG source. Default `true`      |\r\n\r\nExample call and response:\r\n\r\n```text\r\nget_brand { \"slug\": \"openai\", \"includeSvg\": false }\r\n\r\nslug: openai\r\nname: OpenAI\r\ngroup: AI\r\nlicense: MIT\r\ntier: permissive\r\nofficial site: https://openai.com/\r\nbrand guidelines: https://openai.com/brand/\r\n\r\n(svg omitted - pass includeSvg: true to include it)\r\n\r\nBrand logos are other companies' trademarks, shown for identification only. They are not covered by Rune Icons' Apache 2.0 license. Follow the brand's guidelines and do not alter the logo unless they allow it.\r\n```\r\n\r\nWhen `guidelines` is not set for a brand, the `brand guidelines` line reads `none`. The `official site` line reads `none` when a brand has no site.\r\n\r\n### `list_brand_groups`\r\n\r\nList every brand group with its logo count. Use a group name as the `group` filter of `search_brands`. This tool takes no parameters.\r\n\r\nExample response, from the current brand set:\r\n\r\n```text\r\nBrand logos: 1125 logos across 14 groups\r\n\r\ngroup                    logos\r\n------------------------------\r\nAI                         170\r\nCMS & commerce               9\r\nCollaboration & social      72\r\nCrypto & web3               28\r\nDatabases                   36\r\nDesign                      79\r\nDeveloper tools            222\r\nFrameworks & libraries     205\r\nLanguages                   57\r\nMedia & entertainment       22\r\nOS, browsers & big tech     67\r\nPayments & finance          13\r\nPlatforms & services       117\r\nSecurity & identity         28\r\n```\r\n\r\n## Brand logos\r\n\r\nBrand logos are other companies' trademarks, shown for identification only. They are not covered by Rune Icons' Apache 2.0 license and each keeps its own license, listed in the `license` and `tier` fields. Follow each brand's guidelines (the `guidelines` field links to them), and do not alter a logo unless its guidelines allow it.\r\n\r\nThe `tier` field summarizes the license of each logo file: `permissive` (for example MIT or CC0), `attribution` (CC-BY, credit required), `share-alike` (CC-BY-SA), or `trademark-only`, where the file's license grants no rights to the mark itself and the logo is shown under the brand's own terms.\r\n\r\n## Development\r\n\r\nRequires [pnpm](https://pnpm.io) and [Bun](https://bun.sh). Run these from the repository root:\r\n\r\n```sh\r\npnpm install\r\npnpm --filter runeicons-mcp generate\r\npnpm --filter runeicons-mcp typecheck\r\npnpm --filter runeicons-mcp test\r\npnpm --filter runeicons-mcp build\r\n```\r\n\r\nInside `packages/runeicons-mcp`, the equivalent commands are `bun run generate`, `bun run typecheck`, `bun test`, and `bun run build`.\r\n\r\n`generate` runs `scripts/generate-icons.ts`. It reads the SVGs in the repository's `public/` directory and the brand list in `constants/brand-logos.ts`, and does four things:\r\n\r\n1. Writes `src/icons.generated.ts`, the searchable icon registry. Each entry records the id, name, style, category, tags, and asset path. It prints the total and per-style counts.\r\n2. Copies the icon SVGs into `assets/<style>/`, so the published package is self-contained.\r\n3. Writes `src/brands.generated.ts`, the brand registry. It holds metadata only (slug, name, group, site, guidelines, license, tier, and tone), with no SVG markup.\r\n4. Copies each brand logo from `public/brand-logos/` into `assets/brands/<slug>.svg`.\r\n\r\nRun `generate` after adding or renaming icons in `public/`, or after changing the brand list. `src/brands.generated.ts` and `assets/brands/` are not committed, so `test` runs `generate` first. The `prepublishOnly` script runs `generate`, `typecheck`, `test`, and `build` in that order before a publish.\r\n\r\nTo run the built server locally, build it and start the entry point over stdio:\r\n\r\n```sh\r\npnpm --filter runeicons-mcp build\r\nnode packages/runeicons-mcp/dist/index.js\r\n```\r\n\r\nSource files are in `src/`:\r\n\r\n- `src/index.ts`: the MCP server and the six tool definitions.\r\n- `src/icons.ts`: icon search, lookup, categories, and SVG helpers.\r\n- `src/icons.generated.ts`: generated icon registry (rebuilt by `generate`).\r\n- `src/brands.ts`: brand search, lookup, groups, and logo SVG helpers.\r\n- `src/brands.generated.ts`: generated brand registry (rebuilt by `generate`).\r\n\r\n## License\r\n\r\nLicensed under the [Apache License 2.0](LICENSE). Icon data and SVGs are part of [RuneIcons](https://runeicons.com). The icons are free for personal and commercial use under Apache-2.0, and no attribution is required. See the [runeicons repository](https://github.com/Runeicons/runeicons) for details. Brand logos are not covered by this license; see [Brand logos](#brand-logos).\r\n","readmeFilename":"README.md","homepage":"https://runeicons.com","keywords":["mcp","modelcontextprotocol","icons","svg","runeicons","rune-icons"],"repository":{"url":"git+https://github.com/Runeicons/runeicons.git","type":"git","directory":"packages/runeicons-mcp"},"bugs":{"url":"https://github.com/Runeicons/runeicons/issues"},"license":"Apache-2.0"}