Skip to content

arikusi/nakkas

Repository files navigation

nakkas

MCP server that turns AI into an SVG artist.
One rendering engine. AI decides everything.

npm version downloads license Marketplace

Officially listed on the MCP Registry, Glama, LobeHub, and PulseMCP.

Official MCP Registry LobeHub Ask DeepWiki

Glama Badge

Nakkas is an MCP (Model Context Protocol) server that lets AI assistants like Claude create animated SVG graphics from a declarative JSON config: logos, icons, loading spinners, GitHub README banners, badges, and generative art. It renders CSS @keyframes and SMIL animations with no JavaScript, so the output works inside GitHub READMEs and anywhere an <img> tag renders SVG. Every render comes back as a PNG preview plus a server-side artifact id, so the AI sees its own work immediately and iterates without the SVG text ever passing through its context window.

nakkaş means painter/artist in Turkish (old).

"make a neon terminal logo with animated binary digits"
  → AI constructs JSON config
  → nakkas renders to animated SVG
  → AI previews the PNG, critiques, revises
  → clean animated SVG output

Why

  • One tool, infinite designs. render_svg takes a JSON config. AI fills in everything.
  • The AI sees its own work. Every render returns a PNG preview, so the model critiques and revises instead of designing blind.
  • Token-cheap iteration. The SVG stays on the server as an artifact; preview and save address it by id, so revision loops don't pay for the SVG text.
  • Pure declarative SVG. CSS @keyframes + SMIL animations, no JavaScript. Survives GitHub's camo proxy.
  • Zero external deps. No cloud API, no API keys. Runs locally.

Install

Claude Desktop

Add to your config file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "nakkas": {
      "command": "npx",
      "args": ["-y", "nakkas@latest"]
    }
  }
}

Claude Code (CLI)

claude mcp add nakkas npx nakkas@latest

Cursor / Zed / Other MCP clients

{
  "mcpServers": {
    "nakkas": {
      "command": "npx",
      "args": ["-y", "nakkas@latest"]
    }
  }
}

Local Development

git clone https://github.com/arikusi/nakkas
cd nakkas
npm install && npm run build
# Use dist/index.js as the command

Quick Start

Ask your AI (with Nakkas connected):

"Make an animated SVG: dark terminal frame (800×200), glowing cyan text 'NAKKAS', neon glow filter, fade-in on load."

"Create a loading spinner: a circle with a draw-on stroke animation that loops every 1.5 seconds."

"Data visualization: animated bar chart, 5 bars, each fading in with a staggered delay, gradient fills."

"Profile badge (400×120): blue-to-purple gradient, white username text, drop shadow, subtle pulse animation."

Tools

Nakkas provides three tools:

Tool Purpose
render_svg Takes SVGConfig JSON, returns a PNG preview + artifact id (+ design analysis warnings)
preview Re-renders a stored artifact (or raw SVG) to PNG at any width
save Saves a stored artifact (or raw content) to disk as SVG (text) or PNG (raster)

The intended workflow: render → look at the returned preview → revise the config → render again → save. The rendered SVG stays on the server as an artifact: render_svg answers with the preview image and an id like art-1, and preview/save accept that id directly. The SVG text never has to travel back through the model's context window, which cuts the token cost of an iteration loop to a fraction of pasting SVG around. Artifacts live for the server process lifetime (capped at 32, oldest evicted).

The save Tool

{ "artifact": "art-1", "outputPath": "./design.svg", "format": "auto" }

Pass either artifact (id from render_svg, preferred) or content (raw string). Formats: auto (infers from extension), svg (text file), png (renders to raster first). If the file exists, a numeric counter is appended to prevent overwriting. The actual saved path is returned.

The render_svg Tool

Input: SVGConfig JSON object Output: PNG preview image + a summary naming the artifact id, plus optional design analysis notes

The response shape is controlled by an optional output block in the config:

{ "output": { "svg": false, "preview": true, "previewWidth": 800, "minify": false } }
  • svg: true includes the full SVG text in the response (off by default; the artifact id covers preview and save)
  • preview: false skips the PNG image
  • previewWidth scales the preview
  • minify: true collapses whitespace in the stored and saved SVG
  • frames: N (2 to 10) replaces the static preview with one filmstrip image sampling the CSS animations at N points in time — the way to verify motion, since a single preview only shows the starting state

With frames, nakkas evaluates the @keyframes math itself (duration, delay, iteration count, direction, fill mode, easing per segment) and bakes each sampled state into a static frame. Transform origins declared as transform-box: fill-box are resolved numerically from the element's geometry. SMIL animations are not sampled.

After rendering, the response may include design warnings about common issues such as too many concurrent animations, missing transformBox, group-level scale transforms, content extending past the viewport (measured from the real rendered bounding box, with the overflow in pixels), or low-contrast text against the canvas background (WCAG ratios).

SVGConfig Structure

{
  canvas: {
    width: number | string,   // e.g. 800 or "100%"
    height: number | string,
    viewBox?: string,          // "0 0 800 400"
    background?: string        // hex "#111111" or "transparent"
  },

  defs?: {
    gradients?: Gradient[],   // linearGradient | radialGradient
    filters?: Filter[],        // preset or raw primitives
    clipPaths?: ClipPath[],
    masks?: Mask[],
    symbols?: Symbol[],
    paths?: { id, d }[]       // for textPath elements
  },

  elements: Element[],         // shapes, text, groups, use instances

  animations?: CSSAnimation[]  // CSS @keyframes definitions
}

Element Types

Type Required fields Notes
rect width, height x, y default 0; rx/ry for rounded corners
circle r cx, cy default 0
ellipse rx, ry Independent horizontal/vertical radii
line x1, y1, x2, y2
polyline points Open path: "10,20 50,80 90,20"
polygon points Auto-closed shape
path d Full SVG path commands
image href, width, height URL or data:image/... URI for embedded images
text content String or (string | Tspan)[] array
textPath pathId, text Text following a curve; path defined in defs.paths
group children Shared attrs applied to all children (no nested groups)
use href Instance a symbol or clone an element by #id
radial-group cx, cy, count, radius, child Place N copies around a full circle
arc-group cx, cy, radius, count, startAngle, endAngle, child Place N copies along a circular arc
grid-group cols, rows, colSpacing, rowSpacing, child Place copies in an M by N grid
scatter-group width, height, count, seed, child Scatter N copies at seeded random positions
path-group waypoints, count, child Distribute N copies evenly along a polyline
parametric fn Mathematical curve: rose, heart, star, lissajous, spiral, superformula, epitrochoid, hypotrochoid, wave

Two field names differ from raw SVG on purpose: the string of a text element goes in content (on textPath it is text), and validation errors will point you to the exact field if you mix them up. Pattern groups rotate each copy to face outward by default; set rotateChildren: false when the child is text or any shape that should stay upright.

All Visual Elements (Shared Fields)

{
  id?: string,             // required for filter/gradient/clip references
  cssClass?: string,       // matches CSS animation names
  fill?: string,           // "#rrggbb" | "none" | "url(#gradId)"
  stroke?: string,
  strokeWidth?: number,
  strokeDasharray?: string, // "10 5", use for draw-on animation
  strokeDashoffset?: number,
  opacity?: number,        // 0–1
  filter?: string,         // "url(#filterId)"
  clipPath?: string,       // "url(#clipId)"
  transform?: string,      // "rotate(45)" "translate(100, 50)"
  transformBox?: "fill-box" | "view-box" | "stroke-box",  // set "fill-box" for CSS rotation
  transformOrigin?: string, // "center", works with fill-box
  smilAnimations?: SMILAnimation[]
}

Filter Presets

Reference as filter: "url(#myId)" on any element after defining in defs.filters:

{ "type": "preset", "id": "myGlow", "preset": "glow", "stdDeviation": 8, "color": "#ff00ff" }
Preset Key params Effect
glow stdDeviation, color Soft halo
neon stdDeviation, color Intense bright glow
blur stdDeviation Gaussian blur
drop-shadow stdDeviation, offsetX, offsetY, color Drop shadow
glitch stdDeviation Turbulence displacement (animated)
grayscale value (0–1) Desaturate
sepia Warm sepia tone
invert Invert colors
saturate value Boost/reduce saturation
hue-rotate value (degrees) Shift hues
chromatic-aberration value (px offset, default 3) RGB channel split for lens distortion look
noise value (opacity 0 to 1, default 0.25) Film grain and texture overlay
outline color, value (thickness, default 2) Colored outline around the element
inner-shadow color, stdDeviation, value (opacity, default 0.5) Shadow inside the element
emboss stdDeviation, value (intensity, default 1.5) 3D relief shading effect

CSS Animations

{
  "animations": [{
    "name": "pulse",
    "duration": "2s",
    "iterationCount": "infinite",
    "direction": "alternate",
    "keyframes": [
      { "offset": "from", "properties": { "opacity": "0.3", "transform": "scale(0.9)" } },
      { "offset": "to",   "properties": { "opacity": "1",   "transform": "scale(1.1)" } }
    ]
  }],
  "elements": [{
    "type": "circle",
    "cx": 100, "cy": 100, "r": 40,
    "cssClass": "pulse",
    "transformBox": "fill-box",
    "transformOrigin": "center"
  }]
}

CSS property keys: camelCase (strokeDashoffset) or kebab-case (stroke-dashoffset). Both work.

Animatable CSS properties: opacity, fill, stroke, transform, filter, clip-path, stroke-dasharray, stroke-dashoffset, font-size, letter-spacing and more.

SMIL Animations

Three SMIL types, defined inline on each element via smilAnimations: []:

{ "kind": "animate",          "attributeName": "d",       "from": "...", "to": "...", "dur": "2s" }
{ "kind": "animateTransform", "type": "rotate",            "from": "0 100 100", "to": "360 100 100", "dur": "3s" }
{ "kind": "animateMotion",    "path": "M 0 0 C ...",      "dur": "4s", "rotate": "auto" }

Path morphing (attributeName: "d"): from/to paths must have identical command types and counts. Only coordinates can differ.

Fonts

Prefer the CSS generic families: sans-serif, serif, monospace. They resolve to a real font on every platform, both in browsers and in nakkas previews. Named fonts like Arial or Helvetica only exist on some systems (not on most Linux machines), so a design that depends on them will render differently elsewhere. The safe pattern is a named font with a generic fallback: "Georgia, serif".

In preview and PNG save, generic families are resolved through the operating system's own font mapping (fontconfig on Linux), so what the AI sees matches what a browser on that machine would show. Custom font families are accepted and work when the font is available in the rendering environment.

Use Cases & Compatibility

Context CSS @keyframes SMIL External fonts Interactive (onclick)
GitHub README <img>
Web page <img>
Web page inline SVG
Design tool export
Static file viewer depends depends

Troubleshooting

"MCP error -32602: Input validation error"

This means the MCP SDK rejected the input before it reached the handler. It usually happens on the first attempt and works on retry. The most common triggers:

  • Gradient type typo. Use "linearGradient" or "radialGradient", not "linear" or "radial". This is the single most frequent mistake.
  • Keyframe offset as string. Write 0 or 100 (numbers) or "from" / "to". Writing "0%" or "100%" will fail.
  • Colors in gradients and filters. Gradient stop and filter colors must be hex: "#ff0000", not "red" or rgb(). Element fill/stroke accept any paint string ("#ff0000", "none", "url(#id)"), with hex being the safest choice across renderers.
  • Missing type on elements. Every element object needs a type field.

Validation errors that reach the handler name the exact failing field (for example elements.1.content: Required) and append a field reference for the failing element type, so a retry usually succeeds on the first correction. Numeric strings on number fields (letterSpacing: "6") are coerced automatically instead of failing.

The handler also checks reference integrity before rendering: a dangling url(#id) in fill/stroke/filter/clipPath/mask, a use.href pointing nowhere, a textPath.pathId missing from defs.paths, or a duplicate ID all come back as errors with the exact field path and the list of defined IDs, instead of rendering silently broken output.

If you're building an MCP client integration and seeing this consistently, the issue is likely in how your client serializes arguments. See anthropics/claude-code#29104 for context on known serialization quirks.

Preview shows a blank or unexpected image

A single preview renders a static snapshot at t=0, before any animation starts. To see the motion, render with output: { frames: 4 } (or up to 10): nakkas samples the CSS animations at N points in time and returns one labeled filmstrip image. SMIL animations are the exception; they are not sampled and always show their base state.

If the image is completely blank:

  • Check that your elements have fill or stroke set. A shape without fill on a transparent canvas is invisible.
  • Check coordinates. An element at x: 2000 on an 800px wide canvas is simply off-screen.
  • If using filter: "url(#myFilter)", make sure myFilter is actually defined in defs.filters.

Animations not working on GitHub

GitHub READMEs render SVG through <img> tags, which strips JavaScript but keeps CSS and SMIL. If your animation works locally but not on GitHub:

  • Avoid <script> or event handlers (onclick, onmouseover). These are removed.
  • External fonts won't load. Stick to generic families (monospace, sans-serif, serif) or named fonts with a generic fallback.
  • CSS @import for fonts is blocked. If you need a specific font, use inline <text> with a system fallback.

Large SVG output

If render_svg returns a warning about file size (over 50kb), the parametric curves are probably sampling too many points; reduce steps. Pattern groups are cheap: the child is defined once and instanced with <use>, so a grid-group with cols: 50, rows: 50 costs one child definition plus 2500 one-line <use> tags. For the smallest possible file, add output: { minify: true }.

Tech Stack

  • TypeScript + Node.js 18+
  • @modelcontextprotocol/sdk (MCP server)
  • zod (schema validation and AI type guidance)
  • No external SVG libraries, pure XML construction
  • Vitest (370 tests)

License

MIT. Built by arikusi.

About

MCP server that turns AI into an SVG artist

Topics

Resources

License

Contributing

Stars

17 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors