Mermaid MCP Server

<!-- 标识在发布后生效 -->

这是一个提供工具用于验证和渲染 Mermaid 图表的 Model Context Protocol (MCP) 服务器。

此服务器允许AI助手（如Roo）与Mermaid图表进行交互，检查其语法，将其转换为SVG格式，并访问文档链接。

功能

• 验证Mermaid语法： 检查提供的Mermaid代码是否语法正确。
• 渲染为SVG： 将有效的Mermaid代码转换为SVG图像格式。
• 获取文档链接： 提供到官方Mermaid文档的链接。

预备条件

• Node.js（推荐版本18或更高）
• npm 或 yarn
• 兼容的MCP客户端（例如，Roo Cline VSCode扩展）

该服务器内部使用 @mermaid-js/mermaid-cli，它依赖于Puppeteer来渲染图表。如果未找到兼容版本的Chromium，Puppeteer会下载一个。确保首次运行或更新依赖项时网络连接正常。

安装

你可以全局安装此服务器，也可以在项目中本地安装。然而，对于像Roo Cline这样的MCP客户端，通常通过客户端的设置文件配置，而不是直接安装到你的开发项目中。

使用Roo Cline（推荐）：

1. 全局安装包（或记录本地安装路径）：

   npm install -g mermaid-mcp-server
   

   (或者，如果你克隆了这个仓库并构建了它，请记录 build/index.js 文件的绝对路径。)

2. 配置Roo Cline： 打开Roo Cline的MCP设置文件。位置取决于你的操作系统和VSCode设置：

   • macOS: ~/Library/Application Support/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json
   • Windows: %APPDATA%\Code\User\globalStorage\rooveterinaryinc.roo-cline\settings\mcp_settings.json
   • Linux: ~/.config/Code/User/globalStorage/rooveterinaryinc.roo-cline/settings/mcp_settings.json

   在 mcpServers 对象中添加以下配置：

   {
     "mcpServers": {
       // ... 其他服务器
       "mermaid-mcp-server": {
         // 如果全局安装：
         "command": "mermaid-mcp-server",
         // 如果从源码构建，使用绝对路径：
         // "command": "node",
         // "args": ["/absolute/path/to/mermaid-mcp-server/build/index.js"],
         "disabled": false,
         "alwaysAllow": [] // 如果你想跳过确认，可以在这里添加工具名称
       }
       // ... 其他服务器
     }
   }
   

   如果从源码构建服务器，请用实际路径替换 /absolute/path/to/mermaid-mcp-server/build/index.js。

3. 重启VSCode 或重新加载窗口以确保Roo Cline能够识别新的服务器配置。

可用工具

一旦配置完成，AI助手将可以使用以下工具：

• validate_mermaid：

  • 描述： 验证Mermaid语法而不进行渲染。
  • 输入： { "mermaid_code": "string" }
  • 输出： 表明成功或失败的文本，附带错误详情。

• render_mermaid_svg：

  • 描述： 将Mermaid代码渲染为SVG格式。
  • 输入： { "mermaid_code": "string" }
  • 输出： SVG内容作为文本（mimeType: 'image/svg+xml'）或错误消息。

• get_mermaid_docs_link：

  • 描述： 获取到官方Mermaid文档的链接。
  • 输入： {} （无需输入）
  • 输出： 包含URL的文本。

开发

1. 克隆仓库：

   git clone https://github.com/TanisukeGoro/mermaid-mcp-server.git
   cd mermaid-mcp-server
   

2. 安装依赖项：

   npm install
   

3. 构建服务器：

   npm run build
   

   (开发期间使用 npm run watch 自动重建。)

4. 使用MCP Inspector测试：

   npm run inspector
   

贡献

欢迎贡献！请打开一个问题或提交一个拉取请求。

许可证

MIT