MCP Mermaid

MCP Mermaid

借助 AI MCP 动态生成 mermaid 图表。你还可以使用：

• mcp-server-chart 生成图表、关系图和地图。
• Infographic 生成信息图，例如 Timeline、Comparison、List、Process 等。
• 🖼️ figure.ling.pub/gallery 浏览和分享使用 mcp-mermaid 及其他工具生成的 AI 图表和图示。

✨ 功能

• 完全支持 Mermaid 的所有功能和语法。

• 支持配置 backgroundColor 和 theme，让大模型能够输出丰富的样式配置。

• 支持导出为 base64、svg、mermaid、file 以及便于远程使用的 svg_url、png_url 格式，并对 Mermaid 进行验证，帮助模型通过多轮输出正确的语法和图形。使用 outputType: "file" 可自动将 PNG 图表保存到磁盘，供 AI Agent 使用；也可以使用 URL 模式，通过公开的 mermaid.ink 链接分享图表。

🤖 使用方法

要在 Desktop APP 中使用，例如 Claude、VSCode、Cline、Cherry Studio 等，请添加以下 MCP 服务配置。在 Mac 系统上：

{
  "mcpServers": {
    "mcp-mermaid": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-mermaid"
      ]
    }
  }
}

在 Window 系统上：

{
  "mcpServers": {
    "mcp-mermaid": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "mcp-mermaid"
      ]
    }
  }
}

你也可以通过 HTTP、SSE 协议在 aliyun、modelscope、glama.ai、smithery.ai 等平台上使用。

接入点：

• SSE：http://localhost:3033/sse
• Streamable：http://localhost:1122/mcp

可用的 Docker 标签：

• susuperli/mcp-mermaid:latest - 最新稳定版本
• 在 Docker Hub 查看所有可用标签

🚰 使用 SSE 或 Streamable 传输运行

选项 1：全局安装

全局安装软件包：

npm install -g mcp-mermaid

使用你偏好的传输选项运行服务：

# For SSE transport (default endpoint: /sse)
mcp-mermaid -t sse

# For Streamable transport with custom endpoint
mcp-mermaid -t streamable

选项 2：本地开发

如果你正在本地使用源代码：

# Clone and setup
git clone https://github.com/hustcc/mcp-mermaid.git
cd mcp-mermaid
npm install
npm run build

# Run with npm scripts
npm run start:sse        # SSE transport on port 3033
npm run start:streamable # Streamable transport on port 1122

接入点

随后，你可以通过以下地址访问服务：

• SSE 传输：http://localhost:3033/sse
• Streamable 传输：http://localhost:1122/mcp（本地）或 http://localhost:3033/mcp（全局）

🎮 CLI 选项

运行 MCP 服务时，你也可以使用以下 CLI 选项。运行 CLI 时使用 -h 查看命令选项。

MCP Mermaid CLI

Options:
  --transport, -t  Specify the transport protocol: "stdio", "sse", or "streamable" (default: "stdio")
  --port, -p       Specify the port for SSE or streamable transport (default: 3033)
  --endpoint, -e   Specify the endpoint for the transport:
                    - For SSE: default is "/sse"
                    - For streamable: default is "/mcp"
  --help, -h       Show this help message

🔨 开发

安装依赖：

npm install

构建服务：

npm run build

启动 MCP 服务

使用 MCP Inspector（用于调试）：

npm run start

使用不同的传输协议：

# SSE transport (Server-Sent Events)
npm run start:sse

# Streamable HTTP transport
npm run start:streamable

直接使用 node 命令：

# SSE transport on port 3033
node build/index.js --transport sse --port 3033

# Streamable HTTP transport on port 1122
node build/index.js --transport streamable --port 1122

# STDIO transport (for MCP client integration)
node build/index.js --transport stdio

🐳 Docker 使用方法

使用 Docker 运行 MCP Mermaid：

# Pull the image
docker pull susuperli/mcp-mermaid:latest

# Run with SSE transport (default)
docker run -p 3033:3033 susuperli/mcp-mermaid:latest --transport sse

# Run with streamable transport
docker run -p 1122:1122 susuperli/mcp-mermaid:latest --transport streamable --port 1122

📄 许可证

MIT@hustcc.