Mermaid MCP Server

🚀 章鱼怪 MCP 服务器

章鱼怪 MCP 服务器是一个基于 Model Context Protocol (MCP) 的服务器，它提供了一系列工具，用于验证和渲染 Mermaid 图表。借助该服务器，AI 助手（如 Roo）能够与 Mermaid 图表进行交互，检查其语法，将其渲染为 SVG 格式，并访问相关文档链接。

🚀 快速开始

章鱼怪 MCP 服务器为开发者提供了便捷的方式来处理 Mermaid 图表。通过它，你可以轻松验证图表语法、将其渲染为 SVG 图像，并获取官方文档链接。

✨ 主要特性

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

📦 安装指南

先决条件

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

此服务器使用 @mermaid-js/mermaid-cli 内部，依赖于 Puppeteer 渲染图表。Puppeteer 在找不到合适版本时会下载 Chromium。确保在首次运行或更新依赖项时具有网络连接。

安装步骤

你可以全局安装或在项目中本地安装此服务器。但是，对于与 MCP 客户端（如 Roo Cline）一起使用，通常通过客户端的设置文件进行配置，而不是直接安装到开发项目中。

与 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": ["build/index.js"]
       }
     }
   }
   

3. 启动 VSCode 并重新加载窗口：完成后，打开 VSCode 并重新加载窗口以应用设置。

💻 使用示例

基础用法

验证语法

1. 安装服务器后，在终端中运行：

   mermaid-mcp-server validate --source <源文件路径> [--options]
   

2. 支持的选项包括：
   • --ignore-unknownDirectives：忽略未知指令（可选）
   • --strict：启用严格模式（可选）

渲染 SVG

1. 在终端中运行：

   mermaid-mcp-server render --source <源文件路径> [--options]
   

2. 支持的选项包括：
   • --theme <主题>：指定主题（默认为 light）
   • --outputDir <输出目录>：指定输出目录

获取文档链接

在终端中运行：

mermaid-mcp-server getDocument --source <源文件路径>

📄 许可证

本项目采用 MIT 许可证。

👏 贡献

欢迎对本项目进行贡献！如果你有任何问题或建议，请打开问题或提交拉取请求。