Mermaid MCP 服务器

<!-- バッジは公開後に有効になります -->

一个 模型上下文协议 (MCP) 服务器，提供用于验证和渲染 Mermaid 图表的工具。

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

功能

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

前提条件

• Node.js (建议 v18 或更高版本)
• npm 或 yarn
• 兼容的 MCP 客户端（例如，Roo Cline VSCode 扩展）

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

安装

您可以将此服务器全局安装或本地安装在您的项目中。 但是，对于与 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
   

贡献

欢迎贡献！ 请打开一个 issue 或提交一个 pull request。

许可证

MIT