@saastemly/undraw-mcp 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# @saastemly/undraw-mcp
+
+A **local, fully-offline MCP server** that gives AI agents the **698 open-source
+[unDraw](https://undraw.co) scene illustrations** (MIT) with keyword search,
+on-the-fly **brand recolor**, and resize — for heroes, empty states, onboarding,
+404s, pricing, and section art.
+
+It ships a prebuilt **SQLite + FTS5** index of every illustration inside the
+package and serves them in-process. **No network. No API key.** After the one-time
+`npx` download it works completely offline.
+
+Runs on plain **Node ≥20** — no Bun, no Python, no build step required.
+
+---
+
+## Quick start (npx)
+
+Add it to any MCP client. The first run downloads the package (which includes all
+illustrations) and the native SQLite dependency; every run after that is offline.
+
+**Claude Desktop / Claude Code** (`claude_desktop_config.json` or `.mcp.json`):
+
+```json
+{
+  "mcpServers": {
+    "undraw": {
+      "command": "npx",
+      "args": ["-y", "@saastemly/undraw-mcp"]
+    }
+  }
+}
+```
+
+**Claude Code CLI:**
+
+```bash
+claude mcp add undraw -- npx -y @saastemly/undraw-mcp
+```
+
+**Cursor / Windsurf / any MCP client** — same idea: command `npx`, args
+`["-y", "@saastemly/undraw-mcp"]`.
+
+Prefer a pinned global install? `npm i -g @saastemly/undraw-mcp` then use the
+`undraw-mcp` command directly.
+
+> **Requirements:** Node ≥ 20. The bundled index is small (~6 MB), so the first
+> `npx` fetch is quick.
+
+---
+
+## Tools
+
+| Tool | What it's for |
+|---|---|
+| **`search_illustrations`** | Keyword search over illustrations by slug/title. Returns matching slugs + titles. |
+| **`get_illustration`** | Return one illustration as an SVG string. Recolor its accent (`#6c63ff`) to your brand with `color`; resize with `width` (height auto-scales). Suggests alternatives on a miss. |
+| **`get_illustrations`** | Batch-fetch several illustrations (optionally recolored/resized). Returns slug→SVG and a not_found list. |
+| **`list_illustrations`** | Paginated browse of all illustrations, with an optional substring filter on slug/title. |
+
+### Design notes
+
+- **Every unDraw illustration has ONE accent color** (`#6c63ff`). Pass `color` to
+  any tool to recolor that accent to your brand — the rest of the scene stays
+  neutral, so illustrations drop into any palette.
+- **Slugs are lowercase with underscores** (e.g. `data_report`, `empty_cart`,
+  `page_not_found`).
+- SVGs are returned inline as strings, ready to write to a file or embed.
+
+---
+
+## Licensing
+
+This server is MIT-licensed. The **unDraw illustrations are also open-source and
+free** (including for commercial use) under unDraw's license — see
+[`UNDRAW_LICENSE.txt`](./UNDRAW_LICENSE.txt) and <https://undraw.co/license>.

package/UNDRAW_LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Mohd Khairi Mohd Adnan
+
+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.