Metadata-Version: 2.5
Name: inkscape_mcp
Version: 1.3.0
Summary: MCP server that drives the Inkscape CLI from a coding agent.
Project-URL: Homepage, https://github.com/aravindev/inkscape_mcp
Project-URL: Repository, https://github.com/aravindev/inkscape_mcp
Project-URL: Issues, https://github.com/aravindev/inkscape_mcp/issues
Author-email: Aravind EV <aravindev@live.in>
License: MIT
License-File: LICENSE
License-File: NOTICE.md
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Graphics
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: fastmcp>=3.3.1
Requires-Dist: inkex>=1.2.0
Requires-Dist: jeepney>=0.8.0
Requires-Dist: loguru>=0.7.0
Requires-Dist: mcp>=1.27.2
Requires-Dist: pillow<13.0.0,>=12.2.0
Requires-Dist: prefab-ui>=0.20.1
Requires-Dist: pydantic<3.0.0,>=2.13.4
Requires-Dist: pyyaml<7.0.0,>=6.0.0
Requires-Dist: scour<0.38,>=0.37
Description-Content-Type: text/markdown

# Inkscape MCP

<p align="center">
  <img src="https://raw.githubusercontent.com/aravindev/inkscape_mcp/main/assets/social-preview.png" alt="inkscape-mcp — drive Inkscape from an AI agent" width="100%">
</p>

Let your AI agent design, edit, and analyze vector graphics through Inkscape — live alongside a running Inkscape window, or headless from the command line.

<p>
  <a href="https://pypi.org/project/inkscape-mcp/"><img src="https://img.shields.io/pypi/v/inkscape-mcp.svg?style=flat-square&logo=pypi&logoColor=white&label=PyPI" alt="PyPI"></a>
  <a href="https://pypi.org/project/inkscape-mcp/"><img src="https://img.shields.io/pypi/pyversions/inkscape-mcp.svg?style=flat-square&logo=python&logoColor=white&label=Python" alt="Python versions"></a>
  <a href="https://pypi.org/project/inkscape-mcp/"><img src="https://img.shields.io/pypi/dm/inkscape-mcp.svg?style=flat-square&label=downloads" alt="PyPI downloads"></a>
  <a href="https://github.com/aravindev/inkscape_mcp/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/aravindev/inkscape_mcp/ci.yml?branch=main&style=flat-square&logo=github&label=CI" alt="CI"></a>
  <a href="https://github.com/aravindev/inkscape_mcp/blob/main/LICENSE"><img src="https://img.shields.io/github/license/aravindev/inkscape_mcp?style=flat-square&color=yellow" alt="License"></a>
</p>

<p>
  <a href="https://modelcontextprotocol.io"><img src="https://img.shields.io/badge/MCP-1.x-1F6FEB?style=flat-square&logo=anthropic&logoColor=white" alt="MCP"></a>
  <a href="https://github.com/PrefectHQ/fastmcp"><img src="https://img.shields.io/badge/FastMCP-3.2-7c5cfc?style=flat-square" alt="FastMCP"></a>
  <a href="https://inkscape.org"><img src="https://img.shields.io/badge/Inkscape-1.4.4-000000?style=flat-square&logo=inkscape&logoColor=white" alt="Inkscape"></a>
  <a href="#getting-started"><img src="https://img.shields.io/badge/platform-Linux%20%7C%20Windows-informational?style=flat-square" alt="Platform: Linux | Windows"></a>
  <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/badge/style-ruff-D7FF64?style=flat-square&logo=ruff&logoColor=black" alt="Ruff"></a>
  <a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-success?style=flat-square&logo=pre-commit&logoColor=white" alt="pre-commit"></a>
</p>

With Inkscape MCP, your coding agent can do everything a designer does in Inkscape — sketch and reshape paths, apply effects and filters, render LaTeX equations, generate barcodes and QR codes, convert between formats, query and rewrite document structure — through plain conversation instead of menu clicks.

Pair it with a **running Inkscape window** and the agent works alongside you — it sees what you have selected, opens property dialogs on your behalf, applies edits that appear on the canvas in real time (each one a normal undo entry you can roll back), and rasterizes its own work to inspect and refine the result. Or run it **headlessly** to batch-convert artwork, automate exports, and build pipelines around vector assets — no GUI required. The full Inkscape feature surface, including its hundreds of bundled extensions, is reachable as tool calls.

## How it works

1. The agent calls one of eight portmanteau tools — `inkscape_file`, `inkscape_vector`, `inkscape_analysis`, `inkscape_system`, `inkscape_extension`, `inkscape_gradient`, `inkscape_metadata`, or `inkscape_live` — with an `operation` string that picks the actual behavior.
2. For headless work the server dispatches through `InkscapeCliWrapper`, which builds and runs an `inkscape --actions=...` (or `--export-...`) command. For live-canvas work it talks to a running Inkscape window over D-Bus and stages SVG fragments through the clipboard.
3. Inkscape reads your input file (or the open document), runs the operation, and writes the output.
4. The server returns dimensions, file paths, validation results, or whatever the operation produces — typed and trimmed for the agent's context window.

No external network. Just the Inkscape binary, an optional running Inkscape window, and your local files.

## Getting started

> Tested with **Inkscape 1.4.4** on Ubuntu 24.04.

```bash
# 1. Install Inkscape + system headers for pycairo / pygobject
sudo add-apt-repository ppa:inkscape.dev/stable
sudo apt update
sudo apt install inkscape libcairo2-dev libgirepository-2.0-dev libgirepository1.0-dev \
pkg-config python3-dev xclip
# xclip stages SVG fragments for clipboard-based insert into the canvas.
# Clipboard ops auto-detect the backend. On Wayland (the Ubuntu 24.04 default)
# wl-clipboard is preferred if installed; otherwise xclip is used, which works
# because Inkscape runs as an XWayland client. Either package is sufficient.

# 2. Register with Claude Code (uvx fetches inkscape-mcp from PyPI on first run)
claude mcp add inkscape_mcp -s user -- uvx inkscape_mcp
claude mcp list | grep inkscape_mcp   # → ✓ Connected

# 3. (Re)start Inkscape so it picks up the bundled extensions
# The MCP server auto-installs its inkex extensions to
# ~/.config/inkscape/extensions/inkscape_mcp/ on first boot. Inkscape only
# scans the extensions dir at startup, so close + reopen Inkscape once.
# Verify via:
#   inkscape_system(operation="diagnostics")  → bridge.needs_restart should be false
```

That's it. Ask the agent to convert an SVG, query an object's bounding box, run a boolean union — it'll pick the right tool.

### Alternative install paths

```bash
# Plain pip into a venv
pip install inkscape-mcp

# uv into a project
uv add inkscape-mcp
```

The PyPI name is `inkscape-mcp` (hyphen). The Python import name is `inkscape_mcp` (underscore — PEP 8 / valid identifier). Both `pip install inkscape-mcp` and `pip install inkscape_mcp` resolve to the same project (PEP 503 name normalization).

### Windows

The headless tools install and run exactly as above. The **live** bridge (`inkscape_live`) needs one extra piece: a Windows `dbus-daemon`, which isn't part of a stock Windows install. The simplest source is [MSYS2](https://www.msys2.org/) — install it, then:

```sh
pacman -S mingw-w64-x86_64-dbus   # provides dbus-daemon.exe; MCP auto-discovers it
```

`gdbus.exe` itself already ships with Inkscape, and the daemon's dependency DLLs are covered by Inkscape's, so MSYS2 is only the delivery vehicle for that one `dbus-daemon.exe`. If you already have one elsewhere, point `INKSCAPE_MCP_DBUS_DAEMON` at it (and `INKSCAPE_MCP_GDBUS` if `gdbus.exe` isn't found automatically).

On Windows the live bridge **launches and manages its own Inkscape instance** — a hand-launched Inkscape isn't on the bus, so have the agent `open_file` a document to work on it. Tested on Inkscape 1.4.x.

## Configuration

The Claude Code entry the install command above creates looks like:

```json
{
  "mcpServers": {
    "inkscape_mcp": {
      "command": "uvx",
      "args": ["inkscape_mcp"]
    }
  }
}
```

Pin a non-default Inkscape with `INKSCAPE_BIN=/path/to/inkscape` in the server env; the server only falls back to searching `$PATH` when nothing pins it. Inspect from the agent via `inkscape_system(operation="diagnostics")` — its `config_sources` block reports each tracked setting's effective value alongside where it came from (`env_var`, `config_file`, `cli_flag`, `auto_detected` or `default`).

## Try asking your agent to…

**Editing the file you have open**

- "Recolor everything blue to red"
- "Open document properties — I can't find the DPI setting"
- "Select the pen tool so I can draw a curve"
- "Show me the XML editor"
- "Hide the snap controls bar"
- "Add a drop shadow to all the rectangles"
- "Convert this monogram to a single compound path"
- "Run a boolean union on the two selected shapes"

**Generating SVG content**

- "Drop in an isometric grid into this document"
- "Generate a calendar for the current month and paste it here"
- "Make me a 24×24 settings cog icon — currentColor stroke, round caps"

**Inspection & format conversion**

- "Export this to a 4× PNG and a print-ready PDF"
- "What's the bounding box of #logo-mark?"
- "Optimize this SVG — strip Inkscape namespace cruft"
- "List every object in the file with its type and size"

**Live-canvas workflows** (Inkscape running)

- "Read what I have selected"
- "Align these three icons horizontally with equal spacing"
- "Swap the whole palette to a warmer earth-tone scheme"
- "Add a 3-stop gradient to the rect with id `hero`"

The agent picks the right tool. It can drive over 1,000 of Inkscape's actions over D-Bus (1,083 app-scope plus 163 window-scope on Inkscape 1.4.4 — ask for the exact figure with `inkscape_live(operation="ping")`), fall back to headless CLI when the GUI isn't running, and run inkex extensions for things D-Bus doesn't cover.

## Available tools

- **`inkscape_file`** — load, save, convert (PDF/PNG/EPS/PS/…), validate, batch convert.
- **`inkscape_vector`** — 49 ops covering boolean, tracing, path simplification, optimization, alignment, layer export, geometry mutation, barcodes, LPE chains, tile clones.
- **`inkscape_analysis`** — quality scoring, statistics, object lists, layer structure.
- **`inkscape_system`** — server status, diagnostics, extension discovery and execution.
- **`inkscape_extension`** — discover and invoke any installed inkex extension (headless or on the live canvas).
- **`inkscape_gradient`** — gradient-stop manipulation; linear↔radial conversion.
- **`inkscape_metadata`** — read/write Dublin-Core RDF metadata.
- **`inkscape_live`** — drive the running GUI over D-Bus: live edits, paste-in-place, XML edits, `rasterize` so the agent can see the canvas (preserves undo).

Full operation list in [`docs/TOOLS.md`](docs/TOOLS.md).

## How the agent learns to use it

An agent that just installed this server doesn't know your workflow, so the server teaches it. MCP's `InitializeResult.instructions` is pushed into the client's system prompt on connect, and this server uses it to establish the working method rather than just the mechanics: **compose procedurally instead of hand-writing SVG** (place primitives, then let Inkscape align, distribute, boolean and clone them), **rasterize and actually look at the result** before declaring it done, **ask you to select** the objects you want help with, and **open the dialog or tool** you're asking about instead of describing a menu path.

Deeper material is pull-based — `resource://inkscape/mcp-workflow` (operational guide, recipes, and the Inkscape rendering pitfalls that silently ruin output), `resource://inkscape/cli-actions` (the full verb catalog), plus `prompt://inkscape/design-workflow` for the step-by-step design loop, which most clients surface as a slash command. The pushed instructions name those explicitly so the agent knows to fetch them.

## Learn more

- [docs/INSTALL.md](docs/INSTALL.md) — full install walkthrough.
- [docs/TOOLS.md](docs/TOOLS.md) — every operation per tool.
- [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) — when things break.
- [src/inkscape_mcp/reference/](src/inkscape_mcp/reference/) — captured Inkscape 1.4.4 `--action-list` and `--help`; ships in the wheel and is served as `resource://inkscape/cli-actions` / `cli-help`.

## Star history

[![Star History Chart](https://raw.githubusercontent.com/aravindev/inkscape_mcp/main/assets/star-history.png)](https://star-history.com/#aravindev/inkscape_mcp&Date)

## Support

If you like my work and found this useful, feel free to support me at [buymeacoffee.com/aravindev](https://buymeacoffee.com/aravindev).

<a href="https://buymeacoffee.com/aravindev">
  <img src="https://raw.githubusercontent.com/aravindev/inkscape_mcp/main/assets/buymeacoffee-qr.png" alt="Buy me a coffee QR code" width="180">
</a>

## License

MIT — see [`LICENSE`](LICENSE). This project is a fork of upstream MIT-licensed work; attribution and lineage details are in [`NOTICE.md`](NOTICE.md).
