mermaid-svg-mcp
v0.2.1
Published
A simplified MCP server for generating SVG files from Mermaid diagrams
Maintainers
Readme
Mermaid SVG MCP Server
A simplified Model Context Protocol (MCP) server that generates SVG files from Mermaid diagram syntax. This is a streamlined version focused solely on SVG generation, without the complexity of multiple export formats.
Features
- Single Focus: Only generates SVG output - no base64, PNG, or file outputs
- Theme Support: Supports 5 built-in Mermaid themes (default, base, forest, dark, neutral)
- Background Colors: Customizable background colors for diagrams
- Custom Filenames: Optional filename parameter for controlling output file names
- Clean API: Simple, focused tool interface
- Puppeteer-Based: Uses headless browser for reliable rendering
Installation
From npm (Recommended)
npm install -g mermaid-svg-mcpFrom source
git clone <repository-url>
cd mermaid-svg-mcp
npm install
npm run buildUsage
As MCP Server
Add to your MCP client configuration (typically in mcp.json or Claude Desktop config):
Using npx (recommended - no global install needed):
{
"mcpServers": {
"mermaid-svg": {
"command": "npx",
"args": ["-y", "mermaid-svg-mcp"]
}
}
}Using global install:
{
"mcpServers": {
"mermaid-svg": {
"command": "mermaid-svg-mcp"
}
}
}Using local development version:
{
"mcpServers": {
"mermaid-svg": {
"command": "node",
"args": ["/path/to/mermaid-svg-mcp/dist/index.js"]
}
}
}Tool Interface
The server provides a single tool: generate_mermaid_svg
Parameters:
mermaid(required): The Mermaid diagram syntaxtheme(optional): Theme name - one of: default, base, forest, dark, neutralbackgroundColor(optional): CSS color value for background (default: "white")filename(optional): Custom filename for the SVG file (without extension)
Example:
{
"mermaid": "graph TD\\n A[Start] --> B{Decision}\\n B -->|Yes| C[Success]\\n B -->|No| D[Try Again]\\n D --> A",
"theme": "dark",
"backgroundColor": "#f0f0f0",
"filename": "my-flowchart"
}Returns:
- Saves SVG file to disk with specified or auto-generated filename
- Returns confirmation message with file path
Supported Diagram Types
All standard Mermaid diagram types are supported:
- Flowcharts
- Sequence diagrams
- Class diagrams
- State diagrams
- ER diagrams
- User journey
- Gantt charts
- Pie charts
- And more...
Development
npm run dev # Run in development mode
npm run build # Build for production
npm start # Run built versionComparison with Original MCP
This simplified version removes:
- Multiple output formats (base64, file, URL generation)
- File system operations
- Complex configuration options
- PNG rendering options
And focuses on:
- Clean SVG-only output
- Simple parameter interface
- Reliable rendering
- Minimal dependencies
License
MIT
