Mermaid Diagram Generation Tool

✨ 特性

• 完全支持 Mermaid 的所有功能和语法。
• 支持配置 backgroundColor 和 theme，使大语言模型能够输出丰富的样式配置。
• 支持导出为 png、svg 和 mermaid 格式，并对 Mermaid 进行验证，以方便模型多轮输出正确的语法和图形。

🤖 使用方法

在 桌面应用 中使用，如 Claude、VSCode、Cline、Cherry Studio 等，添加以下 MCP 服务器配置。在 Mac 系统上：

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

在 Windows 系统上：

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

此外，您还可以在阿里云、ModelScope、glama.ai、smithery.ai 或其他支持 HTTP、SSE 协议的平台上使用它。

🚰 使用 SSE 或 Streamable 传输方式运行

选项 1：全局安装

全局安装包：

npm install -g mcp-mermaid

使用您首选的传输选项运行服务器：

# 对于 SSE 传输（默认端点：/sse）
mcp-mermaid -t sse

# 对于 Streamable 传输
mcp-mermaid -t streamable

选项 2：本地开发

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

# 克隆并设置
git clone https://github.com/hustcc/mcp-mermaid.git
cd mcp-mermaid
npm install
npm run build

# 使用 npm 脚本运行
npm run start:sse        # SSE 传输，端口 3033
npm run start:streamable # Streamable 传输，端口 1122

访问点

然后您可以通过以下地址访问服务器：

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

🎮 命令行选项

运行 MCP 服务器时，您还可以使用以下命令行选项。通过运行带有 -h 参数的命令查看选项。

MCP Mermaid 命令行工具

选项:
  --transport, -t  指定传输协议: "stdio", "sse" 或 "streamable"（默认: "stdio"）
  --port, -p       指定 SSE 或 streamable 传输的端口（默认: 3033）
  --endpoint, -e   指定传输的端点:
                    - 对于 SSE: 默认是 "/sse"
                    - 对于 streamable: 默认是 "/mcp"
  --help, -h       显示此帮助信息

🔨 开发

安装依赖：

npm install

构建服务器：

npm run build

启动 MCP 服务器

使用 MCP Inspector（用于调试）：

npm run start

使用不同的传输协议：

# SSE 传输（服务器发送事件）
npm run start:sse

# Streamable HTTP 传输
npm run start:streamable

直接使用 node 命令：

# 端口 3033 上的 SSE 传输
node build/index.js --transport sse --port 3033

# 端口 1122 上的 Streamable HTTP 传输
node build/index.js --transport streamable --port 1122

# STDIO 传输（用于 MCP 客户端集成）
node build/index.js --transport stdio

📄 许可证

MIT@hustcc。