金大哥 - mcp-mermaid MCP 详情

article

README

🚀 MCP Mermaid

MCP Mermaid 可借助 AI MCP 动态生成 mermaid 图表。此外，你还能使用 mcp-server-chart 来生成图表、图形和地图。

✨ 主要特性

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

🚀 快速开始

桌面应用使用方法

若要在 Desktop APP（如 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"
      ]
    }
  }
}

此外，你还可以通过 HTTP、SSE 协议在阿里云、魔搭社区、glama.ai、smithery.ai 或其他平台上使用。

SSE 或可流式传输方式运行

全局安装包

npm install -g mcp-mermaid

选择传输方式启动服务器

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

# 使用可流式传输并自定义端点
mcp-mermaid -t streamable

启动后，可通过以下地址访问服务器：

SSE 传输：http://localhost:3033/sse
可流式传输：http://localhost:3033/mcp

CLI 选项

运行 MCP 服务器时，还可以使用以下 CLI 选项。通过 -h 命令查看命令选项。

MCP Mermaid CLI

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

🔧 开发

安装依赖

npm install

构建服务器

npm run build

启动 MCP 服务器

npm run start

📄 许可证

本项目采用 MIT 许可证，版权归 hustcc 所有。

mcp-mermaid