MCP Mermaid

1# <img src="https://mermaid.js.org/favicon.svg" height="24"/> MCP Mermaid ![](https://badge.mcpx.dev?type=server 'MCP Server')  [![build](https://github.com/hustcc/mcp-mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/hustcc/mcp-mermaid/actions/workflows/build.yml) [![npm Version](https://img.shields.io/npm/v/mcp-mermaid.svg)](https://www.npmjs.com/package/mcp-mermaid) [![smithery badge](https://smithery.ai/badge/@hustcc/mcp-mermaid)](https://smithery.ai/server/@hustcc/mcp-mermaid) [![npm License](https://img.shields.io/npm/l/mcp-mermaid.svg)](https://www.npmjs.com/package/mcp-mermaid) [![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/hustcc/mcp-mermaid)](https://archestra.ai/mcp-catalog/hustcc__mcp-mermaid)
2 
3Generate <img src="https://mermaid.js.org/favicon.svg" height="14"/> [mermaid](https://mermaid.js.org/) diagram and chart with AI MCP dynamically. Also you can use:
4 
5- <img src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*ZFK8SrovcqgAAAAAAAAAAAAAemJ7AQ/original" height="14"/> [mcp-server-chart](https://github.com/antvis/mcp-server-chart) to generate chart, graph, map.
6- <img src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*EdkXSojOxqsAAAAAQHAAAAgAemJ7AQ/original" height="14"/> [Infographic](https://github.com/antvis/Infographic) to generate infographic, such as `Timeline`, `Comparison`, `List`, `Process` and so on.
7 
8 
9## ✨ Features
10 
11- Fully support all features and syntax of `Mermaid`.
12- Support configuration of `backgroundColor` and `theme`, enabling large AI models to output rich style configurations.
13 
14- Support exporting to `base64`, `svg`, `mermaid`, `file`, and remote-friendly `svg_url`, `png_url` formats, with validation for `Mermaid` to facilitate the model's multi-round output of correct syntax and graphics. Use `outputType: "file"` to automatically save PNG diagrams to disk for AI agents, or the URL modes to share diagrams through public mermaid.ink links.
15 
16 
17<img width="720" alt="mcp-mermaid" src="https://mermaid.js.org/header.png" />
18 
19 
20## 🤖 Usage
21 
22To use with `Desktop APP`, such as Claude, VSCode, Cline, Cherry Studio, and so on, add the  MCP server config below. On Mac system:
23 
24```json
25{
26  "mcpServers": {
27    "mcp-mermaid": {
28      "command": "npx",
29      "args": [
30        "-y",
31        "mcp-mermaid"
32      ]
33    }
34  }
35}
36```
37 
38On Window system:
39 
40```json
41{
42  "mcpServers": {
43    "mcp-mermaid": {
44      "command": "cmd",
45      "args": [
46        "/c",
47        "npx",
48        "-y",
49        "mcp-mermaid"
50      ]
51    }
52  }
53}
54```
55 
56Also, you can use it on aliyun, modelscope, glama.ai, smithery.ai or others with HTTP, SSE Protocol.
57 
58 
59## 🚰 Run with SSE or Streamable transport
60 
61### Option 1: Global Installation
62 
63Install the package globally:
64 
65```bash
66npm install -g mcp-mermaid
67```
68 
69Run the server with your preferred transport option:
70 
71```bash
72# For SSE transport (default endpoint: /sse)
73mcp-mermaid -t sse
74 
75# For Streamable transport with custom endpoint
76mcp-mermaid -t streamable
77```
78 
79### Option 2: Local Development
80 
81If you're working with the source code locally:
82 
83```bash
84# Clone and setup
85git clone https://github.com/hustcc/mcp-mermaid.git
86cd mcp-mermaid
87npm install
88npm run build
89 
90# Run with npm scripts
91npm run start:sse        # SSE transport on port 3033
92npm run start:streamable # Streamable transport on port 1122
93```
94 
95### Access Points
96 
97Then you can access the server at:
98 
99- SSE transport: `http://localhost:3033/sse`
100- Streamable transport: `http://localhost:1122/mcp` (local) or `http://localhost:3033/mcp` (global)
101 
102## 🎮 CLI Options
103 
104You can also use the following CLI options when running the MCP server. Command options by run cli with `-h`.
105 
106```plain
107MCP Mermaid CLI
108 
109Options:
110  --transport, -t  Specify the transport protocol: "stdio", "sse", or "streamable" (default: "stdio")
111  --port, -p       Specify the port for SSE or streamable transport (default: 3033)
112  --endpoint, -e   Specify the endpoint for the transport:
113                    - For SSE: default is "/sse"
114                    - For streamable: default is "/mcp"
115  --help, -h       Show this help message
116```
117 
118## 🔨 Development
119 
120Install dependencies:
121 
122```bash
123npm install
124```
125 
126Build the server:
127 
128```bash
129npm run build
130```
131 
132### Start the MCP server
133 
134**Using MCP Inspector (for debugging):**
135 
136```bash
137npm run start
138```
139 
140**Using different transport protocols:**
141 
142```bash
143# SSE transport (Server-Sent Events)
144npm run start:sse
145 
146# Streamable HTTP transport
147npm run start:streamable
148```
149 
150**Direct node commands:**
151 
152```bash
153# SSE transport on port 3033
154node build/index.js --transport sse --port 3033
155 
156# Streamable HTTP transport on port 1122
157node build/index.js --transport streamable --port 1122
158 
159# STDIO transport (for MCP client integration)
160node build/index.js --transport stdio
161```
162 
163## 📄 License
164 
165MIT@[hustcc](https://github.com/hustcc).
166