Skip to content
Back to search

svgmaker-mcp

Model Context Protocol server for SVGMaker - AI-powered SVG generation and editing. Seamlessly integrate SVG creation into AI workflows.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/GenWaveLLC/svgmaker-mcp with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/GenWaveLLC/svgmaker-mcp'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/genwavellc--svgmaker-mcp/badge.svg)](/listings/genwavellc--svgmaker-mcp)

HTML

<a href="/listings/genwavellc--svgmaker-mcp"><img src="/api/listings/genwavellc--svgmaker-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

# Using npm
npm install @genwave/svgmaker-mcp

# Using yarn
yarn add @genwave/svgmaker-mcp

Basic Setup

1. Create .env file:

SVGMAKER_API_KEY="your_api_key_here"

2. Start the server:

npx svgmaker-mcp

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 1,068 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # SVGMaker MCP Server
  2. A powerful MCP server for generating, editing, and converting SVG images using SVGMaker API.
  3. [![Website](https://img.shields.io/badge/Website-SVGMaker.io-blue)](https://svgmaker.io)
  4. [![npm version](https://img.shields.io/npm/v/@genwave/svgmaker-mcp.svg)](https://www.npmjs.com/package/@genwave/svgmaker-mcp)
  5. [![License](https://img.shields.io/npm/l/@genwave/svgmaker-mcp.svg)](https://github.com/GenWaveLLC/svgmaker-mcp/blob/main/LICENSE)
  6. [![Build Status](https://img.shields.io/github/actions/workflow/status/GenWaveLLC/svgmaker-mcp/ci.yml?branch=main)](https://github.com/GenWaveLLC/svgmaker-mcp/actions)
  7. [![npm downloads](https://img.shields.io/npm/dm/@genwave/svgmaker-mcp.svg)](https://www.npmjs.com/package/@genwave/svgmaker-mcp)
  8. ## 🎨 MCP Server in Action
  9. ![MCP Capabilities Demo](docs/mcp-capabilities-demo.svg)
  10. *This very illustration came to life through our own SVGMaker MCP server—a living example of AI assistants and vector graphics working in perfect harmony via the Model Context Protocol.*
  11. ## 🌟 Highlights
  12. - **🎨 AI-Powered SVG Generation**: Create SVGs from text descriptions
  13. - **✏️ Smart SVG Editing**: Edit existing SVGs with natural language
  14. - **🖼️ Raster Mode**: Skip vectorization and get a quick PNG instead of SVG
  15. - **🔄 Image-to-SVG Conversion**: Convert any image to scalable SVG
  16. - **🪄 Background Removal**: Isolate the foreground subject and get a clean SVG with transparency
  17. - **👁️ Inline Image Preview**: Preview generations and gallery items directly in chat
  18. - **🔒 Secure File Operations**: Built-in path validation and security
  19. - **⚡ Real-Time Progress**: Live updates during operations
  20. - **📝 Type Safety**: Full TypeScript support with type definitions
  21. ## 📋 Table of Contents
  22. - [Requirements](#-requirements)
  23. - [Installation](#-installation)
  24. - [Quick Start](#-quick-start)
  25. - [LLM Integrations](#-llm-integrations)
  26. - [Available Tools](#️-available-tools)
  27. - [Configuration](#️-configuration)
  28. - [Development](#-development)
  29. - [Contributing](#-contributing)
  30. ## 💻 Requirements
  31. - Node.js: Minimum version 20.9.0
  32. ```bash
  33. node --version # Should be >= v20.9.0
  34. ```
  35. - npm: Minimum version 7.0.0
  36. ```bash
  37. npm --version # Should be >= 7.0.0
  38. ```
  39. - Operating Systems:
  40. - Linux (Ubuntu 20.04+, CentOS 8+)
  41. - macOS (10.15+)
  42. - Windows (10+)
  43. - SVGMaker API key ([Get one here](https://svgmaker.io/account))
  44. ## 📦 Package Structure
  45. ```
  46. @genwave/svgmaker-mcp/
  47. ├── build/ # Compiled JavaScript files
  48. ├── docs/ # Documentation
  49. │ └── api/ # API documentation
  50. ├── src/ # Source TypeScript files
  51. │ ├── tools/ # MCP tool implementations
  52. │ ├── services/ # API integration
  53. │ └── utils/ # Utility functions
  54. └── types/ # TypeScript declarations
  55. ```
  56. ## 🚀 Installation
  57. ```bash
  58. # Using npm
  59. npm install @genwave/svgmaker-mcp
  60. # Using yarn
  61. yarn add @genwave/svgmaker-mcp
  62. ```
  63. ### Basic Setup
  64. 1. Create .env file:
  65. ```bash
  66. SVGMAKER_API_KEY="your_api_key_here"
  67. ```
  68. 2. Start the server:
  69. ```bash
  70. npx svgmaker-mcp
  71. ```
  72. ## 🔌 LLM Integrations
  73. Every client below can run the server two ways:
  74. - **stdio** — the server runs on your machine with your API key. Local file paths work, and `output_path` saves the result to disk.
  75. - **HTTPS** — the server runs in the cloud at `https://mcp.svgmaker.io/mcp` and you sign in through the browser. The cloud server cannot see your disk, so `output_path` is not offered and results come back as hosted SVGMaker URLs. Local files must go through [`svgmaker_upload`](#svgmaker_upload) first.
  76. The example prompts in each section are given in both shapes. Use the one that matches your setup.
  77. ### 🔌 Claude Desktop
  78. 1. Add to `claude_desktop_config.json`.
  79. **stdio (API key):**
  80. ```json
  81. {
  82. "mcpServers": {
  83. "svgmaker": {
  84. "command": "npx",
  85. "args": ["@genwave/svgmaker-mcp"],
  86. "transport": "stdio",
  87. "env": {
  88. "SVGMAKER_API_KEY": "your_api_key_here"
  89. }
  90. }
  91. }
  92. }
  93. ```
  94. **HTTPS (OAuth browser login — no API key):**
  95. Claude Desktop connects to remote servers from the UI, not from the config file: **Settings → Connectors → Add custom connector**, then enter `https://mcp.svgmaker.io/mcp` and complete the browser login.
  96. 2. Example usage in Claude Desktop:
  97. **stdio (API key):**
  98. ```
  99. Generate an SVG of a minimalist mountain landscape:
  100. <mcp>
  101. {
  102. "server": "svgmaker",
  103. "tool": "svgmaker_generate",
  104. "arguments": {
  105. "prompt": "Minimalist mountain landscape with sun",
  106. "output_path": "./landscape.svg",
  107. "quality": "high",
  108. "aspectRatio": "landscape"
  109. }
  110. }
  111. </mcp>
  112. ```
  113. **HTTPS (OAuth browser login — no API key):**
  114. ```
  115. Generate an SVG of a minimalist mountain landscape and give me the hosted URL:
  116. <mcp>
  117. {
  118. "server": "svgmaker",
  119. "tool": "svgmaker_generate",
  120. "arguments": {
  121. "prompt": "Minimalist mountain landscape with sun",
  122. "quality": "high",
  123. "aspectRatio": "landscape"
  124. }
  125. }
  126. </mcp>
  127. ```
  128. ### 🔌 Claude Code
  129. 1. Add the server with the Claude Code CLI.
  130. **stdio (API key):**
  131. ```bash
  132. claude mcp add svgmaker --env SVGMAKER_API_KEY=your_api_key_here -- npx -y @genwave/svgmaker-mcp
  133. ```
  134. **HTTPS (OAuth browser login — no API key):**
  135. ```bash
  136. claude mcp add --transport http svgmaker https://mcp.svgmaker.io/mcp
  137. ```
  138. Then run `/mcp` inside Claude Code, select **svgmaker**, and complete the browser login.
  139. 2. Example usage in Claude Code:
  140. **stdio (API key):**
  141. ```
  142. Generate an SVG of a minimalist mountain landscape and save it to ./landscape.svg
  143. ```
  144. **HTTPS (OAuth browser login — no API key):**
  145. ```
  146. Generate an SVG of a minimalist mountain landscape and give me the hosted URL of the result
  147. ```
  148. ### 🔌 Cursor
  149. [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=svgmaker&config=eyJ0eXBlIjoibG9jYWwiLCJjb21tYW5kIjoibnB4IEBnZW53YXZlL3N2Z21ha2VyLW1jcCIsInRyYW5zcG9ydCI6InN0ZGlvIiwiZW52Ijp7IlNWR01BS0VSX0FQSV9LRVkiOiJ5b3VyX2FwaV9rZXlfaGVyZSJ9fQ%3D%3D)
  150. Or configure manually:
  151. 1. Configure in cursor settings.
  152. **stdio (API key):**
  153. ```json
  154. {
  155. "mcpServers": {
  156. "svgmaker": {
  157. "type": "local",
  158. "command": "npx",
  159. "args": ["@genwave/svgmaker-mcp"],
  160. "transport": "stdio",
  161. "env": {
  162. "SVGMAKER_API_KEY": "your_api_key_here"
  163. }
  164. }
  165. }
  166. }
  167. ```
  168. **HTTPS (OAuth browser login — no API key):**
  169. ```json
  170. {
  171. "mcpServers": {
  172. "svgmaker": {
  173. "url": "https://mcp.svgmaker.io/mcp"
  174. }
  175. }
  176. }
  177. ```
  178. 2. Example usage in Cursor:
  179. **stdio (API key):**
  180. ```
  181. Use svgmaker to edit the logo.svg file and make it more modern:
  182. <mcp>
  183. {
  184. "server": "svgmaker",
  185. "tool": "svgmaker_edit",
  186. "arguments": {
  187. "input": "./logo.svg",
  188. "prompt": "Make it more modern and minimalist",
  189. "output_path": "./modern_logo.svg",
  190. "quality": "high"
  191. }
  192. }
  193. </mcp>
  194. ```
  195. **HTTPS (OAuth browser login — no API key):**
  196. ```
  197. Use svgmaker to modernize the logo, then give me the hosted URL:
  198. <mcp>
  199. {
  200. "server": "svgmaker",
  201. "tool": "svgmaker_edit",
  202. "arguments": {
  203. "input": "https://example.com/logo.svg",
  204. "prompt": "Make it more modern and minimalist",
  205. "quality": "high"
  206. }
  207. }
  208. </mcp>
  209. ```
  210. For a logo that only exists on your machine, call `svgmaker_upload` first and pass the returned `upl_…` id as `input`.
  211. ### 🔌 Visual Studio Code
  212. [<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20SVGMaker%20MCP&color=0098FF">](https://insiders.vscode.dev/redirect/mcp/install?name=svgmaker&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apiKey%22%2C%22description%22%3A%22SVGMaker%20API%20Key%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40genwave%2Fsvgmaker-mcp%22%5D%2C%22env%22%3A%7B%22SVGMAKER_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D)
  213. Or configure manually:
  214. 1. Configure in settings.json.
  215. **stdio (API key):**
  216. ```json
  217. {
  218. "servers": {
  219. "svgmaker": {
  220. "type": "stdio",
  221. "command": "npx",
  222. "args": ["-y", "@genwave/svgmaker-mcp"],
  223. "env": {
  224. "SVGMAKER_API_KEY": "<your_api_key>"
  225. }
  226. }
  227. }
  228. }
  229. ```
  230. **HTTPS (OAuth browser login — no API key):**
  231. ```json
  232. {
  233. "servers": {
  234. "svgmaker": {
  235. "type": "http",
  236. "url": "https://mcp.svgmaker.io/mcp"
  237. }
  238. }
  239. }
  240. ```
  241. 2. Example usage in VS Code:
  242. **stdio (API key):**
  243. ```
  244. Generate a new icon for my app:
  245. <mcp>
  246. {
  247. "server": "svgmaker",
  248. "tool": "svgmaker_generate",
  249. "arguments": {
  250. "prompt": "Modern app icon with abstract geometric shapes",
  251. "output_path": "./assets/icon.svg",
  252. "quality": "high",
  253. "aspectRatio": "square"
  254. }
  255. }
  256. </mcp>
  257. ```
  258. **HTTPS (OAuth browser login — no API key):**
  259. ```
  260. Generate a new icon for my app and give me the hosted URL:
  261. <mcp>
  262. {
  263. "server": "svgmaker",
  264. "tool": "svgmaker_generate",
  265. "arguments": {
  266. "prompt": "Modern app icon with abstract geometric shapes",
  267. "quality": "high",
  268. "aspectRatio": "square"
  269. }
  270. }
  271. </mcp>
  272. ```
  273. ### 🔌 WindSurf
  274. 1. Configure in `~/.codeium/windsurf/mcp_config.json`.
  275. **stdio (API key):**
  276. ```json
  277. {
  278. "mcpServers": {
  279. "svgmaker": {
  280. "command": "npx",
  281. "args": ["-y", "@genwave/svgmaker-mcp"],
  282. "env": {
  283. "SVGMAKER_API_KEY": "<your_api_key>"
  284. }
  285. }
  286. }
  287. }
  288. ```
  289. **HTTPS (OAuth browser login — no API key):**
  290. ```json
  291. {
  292. "mcpServers": {
  293. "svgmaker": {
  294. "serverUrl": "https://mcp.svgmaker.io/mcp"
  295. }
  296. }
  297. }
  298. ```
  299. 2. Example usage in WindSurf:
  300. **stdio (API key):**
  301. ```
  302. Convert the company logo to SVG:
  303. <mcp>
  304. {
  305. "server": "svgmaker",
  306. "tool": "svgmaker_convert",
  307. "arguments": {
  308. "input": "./branding/logo.png",
  309. "output_path": "./branding/vector_logo.svg"
  310. }
  311. }
  312. </mcp>
  313. ```
  314. **HTTPS (OAuth browser login — no API key):**
  315. ```
  316. Upload ./branding/logo.png with svgmaker_upload, then convert it to SVG:
  317. <mcp>
  318. {
  319. "server": "svgmaker",
  320. "tool": "svgmaker_convert",
  321. "arguments": {
  322. "input": "upl_2f1c8a4e-6b3d-4c9a-8e7f-0a1b2c3d4e5f"
  323. }
  324. }
  325. </mcp>
  326. ```
  327. ### 🔌 Zed
  328. 1. Configure in settings.
  329. **stdio (API key):**
  330. ```json
  331. {
  332. "context_servers": {
  333. "svgmaker": {
  334. "command": {
  335. "path": "npx",
  336. "args": ["-y", "@genwave/svgmaker-mcp"],
  337. "env": {
  338. "SVGMAKER_API_KEY": "<your_api_key>"
  339. }
  340. },
  341. "settings": {}
  342. }
  343. }
  344. }
  345. ```
  346. **HTTPS (OAuth browser login — no API key):**
  347. ```json
  348. {
  349. "context_servers": {
  350. "svgmaker": {
  351. "url": "https://mcp.svgmaker.io/mcp"
  352. }
  353. }
  354. }
  355. ```
  356. You can also add it from the UI: **Settings → AI → General → MCP Servers → Add Server → Add Remote MCP Server**.
  357. 2. Example usage in Zed:
  358. **stdio (API key):**
  359. ```
  360. Edit an existing SVG file:
  361. <mcp>
  362. {
  363. "server": "svgmaker",
  364. "tool": "svgmaker_edit",
  365. "arguments": {
  366. "input": "./diagrams/flowchart.svg",
  367. "prompt": "Add rounded corners and smooth gradients",
  368. "output_path": "./diagrams/enhanced_flowchart.svg",
  369. "quality": "high"
  370. }
  371. }
  372. </mcp>
  373. ```
  374. **HTTPS (OAuth browser login — no API key):**
  375. ```
  376. Edit one of my earlier generations and give me the hosted URL:
  377. <mcp>
  378. {
  379. "server": "svgmaker",
  380. "tool": "svgmaker_edit",
  381. "arguments": {
  382. "input": "gen_abc123",
  383. "prompt": "Add rounded corners and smooth gradients",
  384. "quality": "high"
  385. }
  386. }
  387. </mcp>
  388. ```
  389. ### 🔌 Codex
  390. 1. Add the server with the Codex CLI.
  391. **stdio (API key):**
  392. ```bash
  393. codex mcp add svgmaker --env SVGMAKER_API_KEY=your_api_key_here -- npx -y @genwave/svgmaker-mcp
  394. ```
  395. **HTTPS (OAuth browser login — no API key):**
  396. ```bash
  397. codex mcp add svgmaker --url https://mcp.svgmaker.io/mcp
  398. ```
  399. 2. Example usage in Codex:
  400. **stdio (API key):**
  401. ```
  402. Generate an SVG of a minimalist mountain landscape and save it to ./landscape.svg:
  403. <mcp>
  404. {
  405. "server": "svgmaker",
  406. "tool": "svgmaker_generate",
  407. "arguments": {
  408. "prompt": "Minimalist mountain landscape with sun",
  409. "output_path": "./landscape.svg",
  410. "quality": "high",
  411. "aspectRatio": "landscape"
  412. }
  413. }
  414. </mcp>
  415. ```
  416. **HTTPS (OAuth browser login — no API key):**
  417. ```
  418. Generate an SVG of a minimalist mountain landscape and give me the hosted URL:
  419. <mcp>
  420. {
  421. "server": "svgmaker",
  422. "tool": "svgmaker_generate",
  423. "arguments": {
  424. "prompt": "Minimalist mountain landscape with sun",
  425. "quality": "high",
  426. "aspectRatio": "landscape"
  427. }
  428. }
  429. </mcp>
  430. ```
  431. ## 🛠️ Available Tools
  432. Unless a block is marked otherwise, the JSON examples below show the **stdio** call shape. Over HTTPS, drop `output_path` — it is not part of the schema there — and use the hosted URL that comes back in the result.
  433. ### Image input and output by transport
  434. `svgmaker_edit`, `svgmaker_convert` and `svgmaker_remove_background` take their image from a single `input` parameter. What `input` may contain depends on how the server is running.
  435. | `input` value | stdio (local server) | HTTPS (`mcp.svgmaker.io`) |
  436. |---------------|----------------------|---------------------------|
  437. | `/Users/me/panda.png`, `file:///Users/me/panda.png` | ✅ read from disk | ❌ the server is in the cloud and cannot see your disk — call `svgmaker_upload` first |
  438. | `https://example.com/logo.png` | ✅ | ✅ |
  439. | `upl_2f1c8a4e…` (upload id from `svgmaker_upload`) | ✅ | ✅ |
  440. | `gen_abc123` (generation or gallery id) | ✅ `svgmaker_edit` and `svgmaker_remove_background` only | ✅ same |
  441. `svgmaker_convert` does not accept generation ids: the API would vectorize a downscaled preview of an SVG you already own, so the result is strictly worse than what you started with. Convert takes a file path, an `https://` URL or an upload id.
  442. For a URL the MCP server never downloads the image — it hands the URL to the SVGMaker API, which fetches it. A generation id is passed through as-is and resolved server-side.
  443. Output follows the same split:
  444. | | stdio | HTTPS |
  445. |---|---|---|
  446. | `output_path` | ✅ offered — the file is written to that path | not offered at all: the parameter is absent from the tool schema, because the cloud server has no access to your disk |
  447. | result when `output_path` is not used | hosted SVGMaker URL returned | hosted SVGMaker URL returned |
  448. Over HTTPS the server never advertises a parameter it cannot honour. A stale client that still sends `output_path` is rejected with an error that points it at the hosted URL, so no credits are lost.
  449. `svgmaker_preview` is likewise not offered over HTTPS — it reads local disk. Use `svgmaker_generations_preview` or `svgmaker_gallery_preview` instead.
  450. `input_path` is still accepted on all three tools as an alias for `input`, and `generation_id` on `svgmaker_edit` and `svgmaker_remove_background`, so existing configurations keep working. Supply exactly one source. Prefer `input` in new code — the aliases stay only for compatibility.
  451. ### svgmaker_upload
  452. **HTTPS transport only** — it does not appear in the tool list over stdio, where local paths already work directly.
  453. Mints a short-lived upload URL so a local file can be used with the cloud server. No bytes pass through the MCP server; your agent performs the upload itself.
  454. ```json
  455. {
  456. "filename": "panda.png"
  457. }
  458. ```
  459. | Parameter | Type | Description |
  460. |-----------|------|-------------|
  461. | `filename` | string | Required. Name including extension, e.g. `panda.png`. Kept for reporting only — the stored object name is generated server-side and the image type is detected from the file bytes. |
  462. The response returns `upload_url` and `expires_in`. POST the file there as multipart form data:
  463. ```bash
  464. curl -X POST -F "file=@/Users/me/panda.png" "<upload_url>"
  465. ```
  466. **Your agent must be able to run a shell command to finish this step.** Clients with a terminal — Claude Code, Cursor, VS Code, WindSurf, Zed, Codex — can run the `curl` themselves. Claude Desktop connected over HTTPS has no shell, so it cannot complete the upload; use an `https://` image URL or a generation id there instead.
  467. The response carries the upload id:
  468. ```json
  469. { "success": true, "data": { "upload_id": "upl_2f1c8a4e-6b3d-4c9a-8e7f-0a1b2c3d4e5f" } }
  470. ```
  471. Pass that id as `input` to `svgmaker_edit`, `svgmaker_convert` or `svgmaker_remove_background`.
  472. The upload URL expires after 5 minutes and works once. Files over 25 MB are rejected, as is anything whose bytes are not a supported image. Uploads cost no credits, are private, and are swept after 24 hours.
  473. ### svgmaker_generate
  474. Generate SVG images from text prompts. Supports style parameters for fine-grained control over the output.
  475. **stdio:**
  476. ```json
  477. {
  478. "prompt": "A minimalist mountain landscape with sun",
  479. "output_path": "/path/to/landscape.svg",
  480. "quality": "medium",
  481. "style": "flat",
  482. "color_mode": "few_colors",
  483. "composition": "full_scene",
  484. "background": "transparent"
  485. }
  486. ```
  487. **HTTPS** — no `output_path`; the result is a hosted SVGMaker URL:
  488. ```json
  489. {
  490. "prompt": "A minimalist mountain landscape with sun",
  491. "quality": "medium",
  492. "style": "flat",
  493. "color_mode": "few_colors",
  494. "composition": "full_scene",
  495. "background": "transparent"
  496. }
  497. ```
  498. **Raster mode** — set `raster: true` to skip vectorization and get a PNG instead of an SVG. Over stdio, use a `.png` extension for `output_path`; over HTTPS the PNG comes back as a hosted URL. Cannot be combined with `storage` (raster results are temporary).
  499. ```json
  500. {
  501. "prompt": "A minimalist mountain landscape with sun",
  502. "output_path": "/path/to/landscape.png",
  503. "quality": "medium",
  504. "raster": true
  505. }
  506. ```
  507. | Parameter | Type | Description |
  508. |-----------|------|-------------|
  509. | `raster` | boolean | When true, returns a raster PNG instead of SVG (skips vectorization). Over stdio, use a `.png` output path. Cannot be used with `storage`. |
  510. | `storage` | boolean | When true, stores the generated image permanently in cloud storage. Cannot be used with `raster`. Defaults to true when `raster` is not set. |
  511. #### Style parameters (generate & edit)
  512. All parameters below are optional and shared by `svgmaker_generate` and `svgmaker_edit`. Only specify the ones the user explicitly requests.
  513. | Parameter | Values | Default | Description |
  514. |-----------|--------|---------|-------------|
  515. | `quality` | `low`, `medium`, `high` | `medium` | Detail level vs. speed. `high` forces a square aspect ratio. |
  516. | `aspectRatio` | `square`, `portrait`, `landscape` | auto (by quality) | Output shape. Ignored when `quality` is `high` (forced square). |
  517. | `background` | `auto`, `transparent`, `opaque` | `auto` | Background style. `transparent` is good for overlays. |
  518. | `style` | `flat`, `line_art`, `engraving`, `linocut`, `silhouette`, `isometric`, `cartoon`, `ghibli` | — | Art style. |
  519. | `color_mode` | `full_color`, `monochrome`, `few_colors` | `full_color` | Color scheme. |
  520. | `image_complexity` | `icon`, `illustration`, `scene` | — | Level of detail in the composition. |
  521. | `composition` | `centered_object`, `repeating_pattern`, `full_scene`, `objects_in_grid` | — | Layout arrangement. |
  522. | `text_style` | `only_title`, `embedded_text` | — | How text is handled in the design. |
  523. ### svgmaker_edit
  524. Edit existing SVGs or images with natural language. Supports the same style parameters as generate. `input` accepts a local file path, an `https://` URL, an `upl_` upload id, or a generation ID (works for both your own generations and public gallery items) — see the [input matrix](#image-input-and-output-by-transport).
  525. **stdio:**
  526. ```json
  527. {
  528. "input": "/path/to/input.svg",
  529. "prompt": "Add a gradient background and make it more vibrant",
  530. "output_path": "/path/to/enhanced.svg",
  531. "quality": "high",
  532. "style": "cartoon",
  533. "background": "opaque"
  534. }
  535. ```
  536. **HTTPS** — the source is a generation ID, an `https://` URL or an `upl_` upload id, and the result is a hosted URL:
  537. ```json
  538. {
  539. "input": "gen_abc123",
  540. "prompt": "Add a gradient background and make it more vibrant",
  541. "quality": "high"
  542. }
  543. ```
  544. This shape works over stdio too, when you do not want a local file:
  545. ```json
  546. {
  547. "input": "gen_abc123",
  548. "prompt": "Make the background blue"
  549. }
  550. ```
  551. **Raster mode** — like generate, set `raster: true` to get a PNG instead of an SVG. Over stdio, use a `.png` extension for `output_path`. Cannot be combined with `storage`.
  552. ```json
  553. {
  554. "input": "/path/to/input.svg",
  555. "prompt": "Make it more vibrant",
  556. "output_path": "/path/to/edited.png",
  557. "raster": true
  558. }
  559. ```
  560. | Parameter | Type | Description |
  561. |-----------|------|-------------|
  562. | `input` | string | Image source: local file path (stdio only), `https://` URL, `upl_` upload id, or generation ID. Required. |
  563. | `input_path` | string | Accepted alias for `input`, restricted to a local file path. |
  564. | `generation_id` | string | Accepted alias for `input`, restricted to a generation or gallery ID. |
  565. | `raster` | boolean | When true, returns a raster PNG instead of SVG (skips vectorization). Over stdio, use a `.png` output path. Cannot be used with `storage`. |
  566. | `storage` | boolean | When true, stores the edited image permanently in cloud storage. Cannot be used with `raster`. Defaults to true when `raster` is not set. |
  567. ### svgmaker_convert
  568. Convert raster images to SVG using AI-powered vectorization. `input` accepts a local file path, an `https://` URL or an `upl_` upload id — see the [input matrix](#image-input-and-output-by-transport). Generation ids are rejected, because converting one would re-vectorize a downscaled preview of an SVG you already have.
  569. **stdio:**
  570. ```json
  571. {
  572. "input": "/path/to/image.png",
  573. "output_path": "/path/to/vector.svg"
  574. }
  575. ```
  576. **HTTPS** — no `output_path`, and the source is a URL or an upload id:
  577. ```json
  578. {
  579. "input": "https://example.com/logo.png"
  580. }
  581. ```
  582. | Parameter | Type | Description |
  583. |-----------|------|-------------|
  584. | `input` | string | Image source: local file path (stdio only), `https://` URL, or `upl_` upload id. Generation IDs are not accepted. Required. |
  585. | `input_path` | string | Accepted alias for `input`, restricted to a local file path. |
  586. | `output_path` | string | **stdio only** — not offered over HTTPS. Optional absolute path (must end in `.svg`) to save the result. When omitted, a hosted URL is returned instead. |
  587. ### svgmaker_remove_background
  588. Remove the background from an image and get the result as a clean SVG with transparency. The AI isolates the foreground subject, removes the background, and vectorizes the result. Accepts raster formats (PNG, JPEG, WebP, GIF, TIFF, AVIF) and SVG. `input` accepts a local file path, an `https://` URL, an `upl_` upload id, or a generation ID — see the [input matrix](#image-input-and-output-by-transport).
  589. **stdio** — provide an `output_path` (with a `.svg` extension) to save the SVG locally:
  590. ```json
  591. {
  592. "input": "/path/to/photo.png",
  593. "output_path": "/path/to/cutout.svg"
  594. }
  595. ```
  596. **HTTPS** — `output_path` is not offered; the result comes back as a SVGMaker-hosted URL. Omitting it over stdio does the same:
  597. ```json
  598. {
  599. "input": "gen_abc123"
  600. }
  601. ```
  602. | Parameter | Type | Description |
  603. |-----------|------|-------------|
  604. | `input` | string | Image source: local file path (stdio only), `https://` URL, `upl_` upload id, or generation ID. Required. |
  605. | `input_path` | string | Accepted alias for `input`, restricted to a local file path. |
  606. | `generation_id` | string | Accepted alias for `input`, restricted to a generation or gallery ID. |
  607. | `output_path` | string | **stdio only** — not offered over HTTPS. Optional absolute path (must end in `.svg`) to save the result. When omitted, a hosted URL is returned instead. |
  608. | `storage` | boolean | When true, stores the resulting SVG permanently in cloud storage (appears in your generations). When false, a temporary hosted URL is returned. Defaults to true. |
  609. ### svgmaker_account_info
  610. Get account information including email, display name, account type, and available credits. No parameters required.
  611. ```json
  612. {}
  613. ```
  614. ### svgmaker_account_usage
  615. Get API usage statistics with optional date filtering.
  616. ```json
  617. {
  618. "days": 30
  619. }
  620. ```
  621. Or use a date range:
  622. ```json
  623. {
  624. "start": "2026-01-01",
  625. "end": "2026-01-31"
  626. }
  627. ```
  628. ### svgmaker_generations_list
  629. List your SVG generations with optional filtering and pagination.
  630. ```json
  631. {
  632. "page": 1,
  633. "limit": 20,
  634. "type": "generate",
  635. "query": "mountain"
  636. }
  637. ```
  638. ### svgmaker_generations_get
  639. Get detailed information about a specific generation.
  640. ```json
  641. {
  642. "generation_id": "gen_abc123"
  643. }
  644. ```
  645. ### svgmaker_generations_delete
  646. Delete a generation and its associated files. Requires a paid account.
  647. ```json
  648. {
  649. "generation_id": "gen_abc123"
  650. }
  651. ```
  652. ### svgmaker_generations_share
  653. Share a generation by making it publicly accessible.
  654. ```json
  655. {
  656. "generation_id": "gen_abc123"
  657. }
  658. ```
  659. ### svgmaker_generations_download
  660. Download a generation in various formats. Requires a paid account.
  661. **stdio** — `output_path` saves the file locally:
  662. ```json
  663. {
  664. "generation_id": "gen_abc123",
  665. "output_path": "/path/to/output.svg",
  666. "format": "svg"
  667. }
  668. ```
  669. **HTTPS** — `output_path` is not offered; the tool returns a hosted download URL:
  670. ```json
  671. {
  672. "generation_id": "gen_abc123",
  673. "format": "svg"
  674. }
  675. ```
  676. ### svgmaker_generations_preview
  677. Preview a generation by returning the image directly in the chat context as a PNG image. The LLM can see and describe the image, enabling follow-up edits.
  678. ```json
  679. {
  680. "generation_id": "gen_abc123"
  681. }
  682. ```
  683. ### svgmaker_gallery_list
  684. Browse the public SVGMaker gallery with optional filtering and pagination.
  685. ```json
  686. {
  687. "page": 1,
  688. "limit": 20,
  689. "type": "generate",
  690. "query": "landscape",
  691. "pro": "true"
  692. }
  693. ```
  694. ### svgmaker_gallery_get
  695. Get detailed information about a specific gallery item.
  696. ```json
  697. {
  698. "generation_id": "gal_abc123"
  699. }
  700. ```
  701. ### svgmaker_gallery_download
  702. Download a gallery item in various formats. Costs 1 credit for SVG formats, 0 credits for WebP/PNG.
  703. **stdio** — `output_path` saves the file locally:
  704. ```json
  705. {
  706. "generation_id": "gal_abc123",
  707. "output_path": "/path/to/output.svg",
  708. "format": "svg"
  709. }
  710. ```
  711. **HTTPS** — `output_path` is not offered; the tool returns a hosted download URL:
  712. ```json
  713. {
  714. "generation_id": "gal_abc123",
  715. "format": "svg"
  716. }
  717. ```
  718. ### svgmaker_gallery_preview
  719. Preview a gallery item by returning the image directly in the chat context as a PNG image.
  720. ```json
  721. {
  722. "generation_id": "gal_abc123"
  723. }
  724. ```
  725. ### svgmaker_preview
  726. **stdio transport only** — this tool is not offered over HTTPS at all, because it reads local disk and the cloud server cannot see your files. Over HTTPS use [`svgmaker_generations_preview`](#svgmaker_generations_preview) or [`svgmaker_gallery_preview`](#svgmaker_gallery_preview), which take an id instead of a path.
  727. Preview a local image file by returning it directly in the chat context. Supports PNG, SVG, WebP, and SVGZ formats.
  728. ```json
  729. {
  730. "input": "/path/to/image.svg"
  731. }
  732. ```
  733. | Parameter | Type | Description |
  734. |-----------|------|-------------|
  735. | `input` | string | Absolute path to the local image file. Required. |
  736. | `file_path` | string | Accepted alias for `input`. Supply exactly one of the two. |
  737. ## ⚙️ Configuration
  738. ### Environment Variables
  739. | Variable | Description | Required | Default |
  740. |----------|-------------|----------|---------|
  741. | `SVGMAKER_API_KEY` | Your SVGMaker API key | ✅ Yes | - |
  742. | `SVGMAKER_RATE_LIMIT_RPM` | API rate limit (requests per minute) | ❌ No | 2 |
  743. | `SVGMAKER_BASE_URL` | Custom SVGMaker API base URL | ❌ No | `https://api.svgmaker.io` |
  744. | `SVGMAKER_DEBUG` | Enable debug logging | ❌ No | `false` |
  745. ### Debug Logging
  746. The server includes comprehensive logging for debugging and monitoring:
  747. **Enable Logging:**
  748. ```bash
  749. # Enable debug logging
  750. SVGMAKER_DEBUG=true npx @genwave/svgmaker-mcp
  751. # Or set NODE_ENV to development
  752. NODE_ENV=development npx @genwave/svgmaker-mcp
  753. ```
  754. **Log Files Location:**
  755. - **macOS/Linux**: `~/.cache/svgmaker-mcp/logs/`
  756. - **Windows**: `%LOCALAPPDATA%/svgmaker-mcp/logs/`
  757. - **Fallback**: `./logs/` (in project directory)
  758. **Log File Format:**
  759. ```
  760. mcp-debug-2025-06-04T10-30-45-123Z.log
  761. ```
  762. ## 🔍 Development
  763. ### Local Setup
  764. 1. Clone and install dependencies:
  765. ```bash
  766. npm install
  767. ```
  768. 2. Create .env file with your API key
  769. ```bash
  770. SVGMAKER_API_KEY="your_api_key_here"
  771. ```
  772. 3. Run in development mode:
  773. ```bash
  774. npm run dev
  775. ```
  776. ### Testing
  777. Use the MCP Inspector for testing:
  778. ```bash
  779. npx @modelcontextprotocol/inspector node build/index.js
  780. ```
  781. ### CI/CD Workflow
  782. This project uses GitHub Actions for continuous integration and deployment:
  783. 1. **Continuous Integration**
  784. - Runs on every push to main branch and pull requests
  785. - Performs linting, type checking, and building
  786. - Ensures code quality and consistency
  787. 2. **Bumping the Version**
  788. - For a patch version (bug fixes):
  789. ```bash
  790. npm run version:patch
  791. ```
  792. - For a minor version (new features):
  793. ```bash
  794. npm run version:minor
  795. ```
  796. - For a major version (breaking changes):
  797. ```bash
  798. npm run version:major
  799. ```
  800. 3. **Publishing**
  801. - Automatically publishes to npm when the version bump is merged to `main`
  802. ## 🔐 Security
  803. - ✅ Path validation prevents directory traversal
  804. - ✅ Input sanitization for all parameters
  805. - ✅ Secure file operation handling
  806. - ✅ Environment variable protection
  807. - ✅ Rate limiting support
  808. ## 🤝 Contributing
  809. We welcome contributions! Please see our [Contributing Guide](https://github.com/GenWaveLLC/svgmaker-mcp/blob/main/CONTRIBUTING.md) for details.
  810. ## ⭐ Features
  811. ### Input Format Support
  812. - SVG files (.svg)
  813. - PNG images (.png)
  814. - JPEG images (.jpg, .jpeg)
  815. - Other common image formats
  816. ### Output Capabilities
  817. - Clean, optimized SVG output
  818. - Multiple aspect ratio options
  819. - Background control (transparent/opaque)
  820. - High-quality vectorization
  821. ## 📝 License
  822. MIT © [Genwave AI](https://genwave.xyz) - see the [LICENSE](https://github.com/GenWaveLLC/svgmaker-mcp/blob/main/LICENSE) file for details.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.