ShapeWords MCP

io.github.kirrrr-2423Published by GitHub account kirrrr-2423v0.2.2Updated Oct 24, 2026

Generate ShapeWords word clouds as SVG, PNG, or JSON from text or weighted words.

VerifiedSTDIODesktop onlyDeveloper ToolsMedia & Design

Overview

AI-generated overview

ShapeWords MCP lets an assistant generate word clouds as SVG, PNG or JSON from text or weighted words, either through the hosted ShapeWords service or a localSk

What you can do
Render a word cloud in one call from raw text or explicit weighted words, returning an artifact URL, job metadata and optionally inline image content. Start a render job asynchronously and check its status later by job ID. Choose output format (SVG, PNG or JSON layout data), canvas size, background, quality, palette, color mode, fonts and font sizes. Pick a mask shape from built-in ids, brand ids or a custom SVG path, and control rotation, spiral, fill mode and a layout seed for reproducible results. Render locally with the Skia engine instead of the hosted service.
When to use it
Useful when you want an assistant to turn notes, prompts, research snippets or keyword lists into a shareable word-cloud image or layout data without leaving the chat. Suited to one-off visuals as well as asynchronous batch-style workflows that poll for job completion.
Requirements
Runs as a local stdio process, typically via npx or a cloned Node.js project. By default it calls the hosted ShapeWords Render API over the network; SHAPEWORDS_API_BASE_URL can point elsewhere. Optional SHAPEWORDS_RENDER_API_KEY (or the alias SHAPEWORDS_API_KEY) is needed only for protected deployments. Timeouts are configurable via SHAPEWORDS_POLL_TIMEOUT_MS and SHAPEWORDS_REQUEST_TIMEOUT_MS.
Before you install
Text and weighted words you submit are sent to the hosted ShapeWords service by default, so avoid confidential material unless you use the local Skia engine. Hosted artifact URLs are short-lived because jobs are stored in memory. The optional API key is a secret passed by environment variable. The server only exposes rendering options, not the full ShapeWords editor or file imports.

Installation

In SourceWeft

  1. Open ShapeWords MCP in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

ShapeWords MCP

Universal MCP server for generating word clouds with ShapeWords.

It exposes ShapeWords rendering tools through the Model Context Protocol, so any MCP-capable client can create SVG, JSON, or PNG word clouds from text, workshop notes, prompts, research snippets, or agent output. By default it uses the hosted ShapeWords Render API; with engine: "skia" it renders locally inside the MCP server with the shared layout core and CanvasKit/Skia.

Tools

All tools use stdio MCP transport.

render_word_cloud

Creates a ShapeWords render job, polls until it is finished, and returns:

  • public artifact URL for hosted renders, or a local inline artifact for engine: "skia";
  • job metadata;
  • optional image content for MCP clients that support image results.

Use this tool for one-shot generation when the caller wants the final artifact.

create_word_cloud_job

Starts a render job and returns the job/status/artifact URLs without waiting.

Use this tool for asynchronous workflows where the client will poll later.

get_word_cloud_job

Checks a render job by ID.

Use this tool with the jobId returned by create_word_cloud_job or render_word_cloud.

Input Schema

render_word_cloud accepts all render options below. create_word_cloud_job accepts the hosted options only: engine: "skia" is local-only and is supported by render_word_cloud.

FieldTypeDefaultLimitsDescription
renderProfileenumcanvascanvas, apiDefault option profile. canvas matches the main ShapeWords canvas; api keeps the older compact Render API defaults.
textstringoptional1-100,000 charsSource text for the word cloud. Required unless words is provided.
wordsobject[]optional1-1000 itemsExplicit weighted words. Use when the caller already tokenized, lemmatized, or scored text.
localeenumenen, ru, ar, es, fr, zhRender/UI locale passed to ShapeWords.
formatenumsvgsvg, png, jsonArtifact format. SVG is the fastest default. JSON returns layout data. PNG is rasterized from the same shared layout.
widthinteger800240-4096Canvas width in pixels.
heightinteger600240-4096Canvas height in pixels.
backgroundenumwhitetransparent, white, darkOutput background.
qualityenumhqsq, hqStandard or high-quality render. hq matches the main canvas export scale and is slower.
engineenumautoauto, browser, browserless, skiaRenderer engine. skia uses the local MCP shared-core + CanvasKit renderer without server-side Chromium.
returnLayoutbooleanfalsetrue/falseInclude layout metadata when supported.
shapeTypestringcloud1-80 charsShape id. Use a built-in id or custom with customShapeDefinition.
customShapeDefinitionobjectomittedsee belowCustom SVG path shape. Required when shapeType is custom.
maxWordsinteger7001-1000Maximum number of words to place.
seedinteger00-4294967295Unsigned 32-bit layout seed for reproducible browserless renders. Same input, options, and seed produce the same SVG/layout.
fontFamilystringMontserrat1-80 charsShapeWords font family name, for example Inter, Roboto, Montserrat, Noto Sans.
minFontSizeinteger184-400Minimum word font size.
maxFontSizeinteger968-700Maximum word font size.
paddinginteger30-100Pixel padding used by collision detection.
rotationPresetenumorthogonalsee belowRotation preset matching the main ShapeWords canvas.
rotationsinteger[]omitted-90 to 90, max 64 valuesExplicit rotation angles. When provided, these override rotationPreset.
spiralTypeenumarchimedeanarchimedean, rectangularPlacement spiral algorithm.
fillModeenumfillfill, frequencyShape filling strategy.
palettestring[]service defaultup to 12 colorsHex colors: #rgb, #rrggbb, or #rrggbbaa.
colorModeenumservice defaultsequential, random, byFrequencyHow palette colors are assigned to words.
returnImagebooleanfalserender_word_cloud onlyDownload the finished SVG/PNG artifact and return it as MCP image content.
pollIntervalMsintegerenv/default250-10,000Polling interval for render_word_cloud.
pollTimeoutMsintegerenv/default1,000-180,000Maximum wait time for render_word_cloud.

get_word_cloud_job accepts:

FieldTypeLimitsDescription
jobIdstring6-64 charsShapeWords render job id.

words items use this shape:

FieldTypeDefaultLimitsDescription
textstringrequired1-120 charsDisplay word or emoji.
valueinteger11-100,000Weight/frequency used for sizing.
kindenumwordword, emojiWord type. Emoji are kept horizontal by the renderer.
sizeScalenumberomitted0.1-5Optional extra size multiplier used by the ShapeWords layout core when available.
repeatbooleantruetrue/falseWhether the layout may repeat this word to improve shape filling.

Rotation presets:

text
horizontal, vertical, orthogonal, crossing, crossingVoids, dancing,positiveSlope, negativeSlope, random, custom, mixed, angled, free

renderProfile: "canvas" sends the same practical defaults as the main editor canvas: shapeType: "cloud", width: 800, height: 600, quality: "hq", maxWords: 700, seed: 0, fontFamily: "Montserrat", minFontSize: 18, maxFontSize: 96, padding: 3, rotationPreset: "orthogonal", spiralType: "archimedean", and fillMode: "fill".

Use renderProfile: "api" only when you need the older compact Render API defaults: circle shape, 1024x640, SQ quality, and 120 max words.

Text Input

The MCP server can send either raw text, explicit words, or both:

  • repeated words increase frequency, for example cloud cloud cloud render render API;
  • words[] preserves caller-provided weights and avoids differences in tokenization, stop words, or lemmatization;
  • when both text and words[] are present, ShapeWords renders from words[] and keeps text as source context;
  • paragraphs, meeting notes, workshop notes, prompts, research snippets, and keyword lists are valid;
  • files such as CSV, Excel, or Google Sheets are not uploaded through this MCP server; paste or generate the text content first.

Example weighted text:

json
{  "text": "MCP MCP MCP ShapeWords ShapeWords word cloud word cloud render API agents tools",  "shapeType": "cloud",  "format": "svg",  "seed": 12345}

Example explicit weighted words:

json
{  "words": [    { "text": "ShapeWords", "value": 12 },    { "text": "MCP", "value": 9 },    { "text": "canvas", "value": 7 },    { "text": "layout", "value": 6 },    { "text": "render", "value": 5 }  ],  "shapeType": "cloud",  "format": "svg"}

Shapes

Use shapeType to choose the word-cloud mask.

Stable built-in shape ids accepted by the production renderer include:

text
rectangle, circle, heart, star, cloud, diamond, tree, triangle, arrow,square, pentagon, hexagon, octagon, cross, plus, moon, sun, drop,flame, leaf, flower, mountain, apple, house, book, camera, music,chat, location, trophy, rocket, plane, car, shield, lightning, check,infinity, tag

Built-in brand shape ids include:

text
brand-product-hunt, brand-y-combinator, brand-hacker-news,brand-indie-hackers, brand-github, brand-figma, brand-notion,brand-stripe, brand-vercel, brand-linear, brand-supabase,brand-railway, brand-netlify, brand-firebase, brand-cloudflare,brand-airtable, brand-replit, brand-anthropic

The production renderer may also accept additional generated ShapeWords ids. For portable automation, prefer the stable ids above or pass a custom SVG shape.

The local engine: "skia" path currently supports rectangle, square, circle, diamond, triangle, star, heart, cloud, custom SVG shapes, and vendored Font Awesome shape ids such as fa-cat. Unsupported local shape ids are rejected instead of silently changing the requested shape.

Custom Shapes

Set shapeType to custom and provide customShapeDefinition:

FieldTypeRequiredLimitsDescription
pathstringyes1-100,000 charsSVG path data used as the mask.
viewBoxstringyes1-120 charsSVG viewBox, for example 0 0 100 100.
fillRuleenumnononzero, evenoddSVG fill rule. Defaults to renderer behavior when omitted.
namestringno1-80 charsOptional human-readable name.
nameEnstringno1-80 charsOptional English name.

Custom heart example:

json
{  "text": "love love design care product community team support",  "shapeType": "custom",  "customShapeDefinition": {    "name": "Heart",    "path": "M 50 90 C 25 70, 0 50, 0 30 A 25 25 0 0 1 50 30 A 25 25 0 0 1 100 30 C 100 50, 75 70, 50 90 Z",    "viewBox": "0 0 100 100",    "fillRule": "nonzero"  },  "format": "svg"}

Output

render_word_cloud returns:

  • text content with the completed job id and artifact location;
  • structuredContent.job with normalized job metadata;
  • structuredContent.artifactUrl for hosted renders;
  • structuredContent.localArtifact for engine: "skia";
  • structuredContent.siteUrl;
  • optional MCP image content when returnImage is true and format is svg or png.

For engine: "skia", render_word_cloud always returns inline MCP image content for format: "png" or format: "svg" because there is no hosted artifact URL.

create_word_cloud_job returns the same metadata immediately after job creation, without waiting for completion.

get_word_cloud_job returns the latest job status and artifact URL.

Generated artifact URLs are short-lived because the ShapeWords Render API stores render jobs in memory.

Format and Engine Notes

  • svg is the recommended automation format: it is fast, compact, and works with the browserless shared-core renderer.
  • json returns layout data from the same shared-core placement.
  • png is rasterized from the same generated SVG/layout, so word placement matches SVG/JSON for the same input and options.
  • engine: "auto" is recommended unless you need to force a specific path.
  • engine: "browserless" supports svg, json, and png.
  • engine: "browser" supports svg and png, not json.
  • engine: "skia" is local-only and supported by render_word_cloud. It does not create pollable hosted jobs. Layout is generated by the vendored ShapeWords shared core; PNG is drawn directly with CanvasKit/Skia.
  • seed is honored by browserless/shared-core renders. Use engine: "auto" or engine: "browserless" for reproducible API/MCP output.
  • Non-zero seed with forced engine: "browser" is rejected by the Render API because the browser fallback does not use the deterministic shared-core seed path.

Quick Start

Run directly from GitHub:

bash
npx -y github:kirrrr-2423/shapewords-mcp

Or clone locally:

bash
git clone https://github.com/kirrrr-2423/shapewords-mcp.gitcd shapewords-mcpnpm installnpm start

Client Configuration

Use stdio transport in any MCP-compatible client.

json
{  "mcpServers": {    "shapewords": {      "command": "npx",      "args": ["-y", "github:kirrrr-2423/shapewords-mcp"],      "env": {        "SHAPEWORDS_API_BASE_URL": "https://shapewords.fun"      }    }  }}

For a local clone:

json
{  "mcpServers": {    "shapewords": {      "command": "node",      "args": ["/absolute/path/to/shapewords-mcp/src/index.js"],      "env": {        "SHAPEWORDS_API_BASE_URL": "https://shapewords.fun"      }    }  }}

Environment

VariableDefaultDescription
SHAPEWORDS_API_BASE_URLhttps://shapewords.funShapeWords app URL.
SHAPEWORDS_RENDER_API_KEYemptyOptional bearer token if your Render API requires one.
SHAPEWORDS_API_KEYemptyBackward-compatible alias for SHAPEWORDS_RENDER_API_KEY.
SHAPEWORDS_POLL_INTERVAL_MS1500Polling interval for completed renders.
SHAPEWORDS_POLL_TIMEOUT_MS90000Render wait timeout.
SHAPEWORDS_REQUEST_TIMEOUT_MS30000Per-request timeout for hosted API and artifact requests.
SHAPEWORDS_MAX_IMAGE_BYTES8388608Max downloaded artifact size when returnImage is true.

Example Prompt

text
Create a fast SVG word cloud about MCP, universal tools, word cloud generation, AI agents, and ShapeWords. Use the default ShapeWords canvas profile and return the artifact URL.

Example tool input:

json
{  "text": "MCP MCP MCP Model Context Protocol word cloud word cloud ShapeWords tools resources prompts stdio server client universal integration connector API render PNG SVG artifact agents automation context protocol schema",  "locale": "en",  "format": "svg",  "width": 800,  "height": 600,  "background": "white",  "quality": "hq",  "engine": "auto",  "returnLayout": false,  "shapeType": "cloud",  "seed": 12345,  "palette": ["#7c3aed", "#ddd6fe", "#14b8a6", "#111827"],  "returnImage": false}

More Examples

Transparent PNG

json
{  "text": "launch launch startup product customers retention growth metrics roadmap",  "format": "png",  "engine": "auto",  "shapeType": "rocket",  "width": 1200,  "height": 900,  "background": "transparent",  "quality": "hq",  "returnImage": true}

Local Skia PNG

json
{  "words": [    { "text": "MCP", "value": 12 },    { "text": "ShapeWords", "value": 10 },    { "text": "Skia", "value": 8 },    { "text": "CanvasKit", "value": 7 },    { "text": "local", "value": 6 },    { "text": "renderer", "value": 5 }  ],  "format": "png",  "engine": "skia",  "shapeType": "cloud",  "width": 800,  "height": 600,  "quality": "sq",  "seed": 12345}

JSON Layout

json
{  "text": "design system tokens components variants accessibility contrast typography layout",  "format": "json",  "engine": "browserless",  "shapeType": "diamond",  "returnLayout": true,  "seed": 7,  "maxWords": 80}

Reproducible SVG

json
{  "text": "MCP shared core browserless renderer reproducible seed deterministic layout",  "format": "svg",  "engine": "browserless",  "shapeType": "cloud",  "returnLayout": true,  "seed": 12345}

Custom Palette and Font

json
{  "text": "research synthesis interview persona journey insight opportunity experiment",  "format": "svg",  "shapeType": "book",  "fontFamily": "Roboto",  "palette": ["#111827", "#2563eb", "#14b8a6", "#f59e0b"],  "colorMode": "byFrequency",  "maxWords": 160}

Development

bash
npm installnpm run smokenpm run smoke:skianpm run inspect

The server uses stdio and writes protocol messages to stdout. Diagnostics are written to stderr.

Notes

  • Set returnImage: true in render_word_cloud when the MCP client supports image content and needs hosted-render bytes inline. Local Skia image renders are inline automatically.
  • For automation-heavy use, prefer SVG or JSON layout artifacts; request PNG only when the caller needs raster pixels.
  • Set seed when the caller needs repeatable SVG/JSON/PNG placement across MCP runs. engine: "skia" is deterministic by default.
  • Local Skia PNG output is capped at 40,000,000 pixels after quality scaling to avoid excessive local memory use.
  • Local Skia font rendering currently supports bundled Montserrat and OpenDyslexic only. Hosted renders may support more font families.
  • The MCP schema currently exposes rendering and style options only. It does not expose ShapeWords UI-only workflows such as the advanced word editor, 2D/3D view switching, CSV/Excel upload, Google Sheets import, or live room controls.
  • padding, rotationPreset, rotations, spiralType, and fillMode are exposed so MCP callers can match the main ShapeWords canvas more closely.

See THIRD_PARTY_NOTICES.txt for bundled Font Awesome and font asset notices.

Source: README.md at commit 93b207b

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.2.2LatestSep 16, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts