@nodo-icons/mcp 0.0.0-stage → 0.1.0

package/LICENSE.md

@@ -0,0 +1,26 @@
+# Nodo Icons Free — MIT License
+
+This license applies only to the **Linear** style of Nodo Icons (the packages
+`@nodo-icons/react`, `@nodo-icons/vue`, `@nodo-icons/static` and every file in a
+folder or archive named `linear`). All other styles are Nodo Icons Pro and are
+licensed under the Nodo Icons Pro License Agreement (https://nodoicons.com/license/pro/), not under this license. Contact: hello@nodoicons.com
+
+Copyright (c) 2026 Davide
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,62 @@
-# Temporary Holding Version
+# @nodo-icons/mcp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Let AI agents use Nodo Icons. An MCP server (and a small CLI) that searches 5,000 icons and returns ready-to-paste SVG, React or Vue code. The Linear style is free and bundled; Pro styles work with your Pro download.
+
+## Add it to your agent
+
+**Claude Code**
+
+```bash
+claude mcp add nodo-icons -- npx -y @nodo-icons/mcp
+```
+
+**Claude Desktop, Cursor, Windsurf and other MCP clients** (`mcpServers` config):
+
+```json
+{
+  "mcpServers": {
+    "nodo-icons": { "command": "npx", "args": ["-y", "@nodo-icons/mcp"] }
+  }
+}
+```
+
+Then ask things like *"add a delete button with the Nodo trash icon"* or *"which Nodo icon fits 'export to PDF'?"*.
+
+## Tools
+
+| Tool | What it does |
+|---|---|
+| `search_icons` | Find icons by name, keyword or synonym |
+| `get_icon` | SVG, React, Vue or sprite code for one icon, in any style |
+| `list_styles` | The ten styles and which are free or Pro |
+| `list_categories` | Categories with icon counts |
+
+## Nodo Icons Pro
+
+With a Pro license, unzip the Pro download and point the server at it to get SVGs in every style:
+
+```json
+{ "command": "npx", "args": ["-y", "@nodo-icons/mcp"], "env": { "NODO_PRO_DIR": "/path/to/nodo-icons-pro" } }
+```
+
+React and Vue packages for the Pro styles are not released yet: for a Pro style, `get_icon` returns its SVG (from your Pro download), ready to paste or wrap in a component.
+
+## CLI
+
+```bash
+npx @nodo-icons/mcp search credit card
+npx @nodo-icons/mcp get credit-card --format react
+npx @nodo-icons/mcp get home --format svg --size 20 --color "#0a84ff"
+```
+
+### Switch a shadcn/ui (or any lucide-react) project to Nodo
+
+```bash
+npx @nodo-icons/mcp migrate-lucide ./src --dry   # preview
+npx @nodo-icons/mcp migrate-lucide ./src         # rewrite imports, JSX stays the same
+npm install @nodo-icons/react
+```
+
+License: MIT (code and Linear icons). Pro styles are not included.
+
+Docs: https://nodoicons.com/docs/ · Support: support@nodoicons.com