MCP Server: Mermaid Validator
2025.04.04
11
JavaScript图表验证图表渲染开发效率
MCP Server: Mermaid Validator 是一个基于 Model Context Protocol 的服务器，用于验证和渲染 Mermaid 图表。该服务器使 LLMs 能够验证和渲染 Mermaid 图表，适用于需要处理 Mermaid 图表的开发场景。
View on GitHub
Overview
基本能力
产品定位
MCP Server: Mermaid Validator 是一个专门用于验证和渲染 Mermaid 图表的工具，旨在为开发者和 LLMs 提供高效的图表处理能力。
核心功能
- 验证 Mermaid 图表：检查 Mermaid 图表的语法是否正确。
- 渲染 Mermaid 图表：将有效的 Mermaid 图表渲染为 SVG 或 PNG 格式的图像。
- 错误处理：提供详细的错误信息，帮助用户修复无效的图表。
- MCP 集成：通过 Model Context Protocol 与兼容的客户端无缝集成。
适用场景
- 开发工具集成：集成到开发工具中，实时验证和渲染 Mermaid 图表。
- 文档生成：在生成文档时自动验证和渲染 Mermaid 图表。
- 教育用途：用于教学或学习 Mermaid 图表语法的工具。
工具列表
- validateMermaid：验证 Mermaid 图表并返回渲染结果。
- 参数：
diagram（Mermaid 图表语法字符串）。 - 返回值：成功时返回验证结果和渲染图像，失败时返回错误信息。
常见问题解答
- 如何集成到 MCP 客户端？
- 在 MCP 客户端配置文件中添加服务器配置，使用
npx @rtuin/mcp-mermaid-validator启动服务。 - 支持哪些输出格式？
- 默认输出为 PNG 格式，确保与大多数 MCP 客户端兼容。
- 如何处理无效图表？
- 服务会返回详细的错误信息，帮助用户修复图表。
使用教程
使用依赖
- 确保已安装 Node.js 和 npm。
- 安装 Mermaid CLI 工具：
bash npm install -g @mermaid-js/mermaid-cli
安装教程
- 安装依赖：
bash npm install - 构建应用程序：
bash npm run build - 运行服务：
bash npx @modelcontextprotocol/inspector node dist/main.js
调试方式
- 开发模式下监听文件变化：
bash npm run watch - 格式化代码：
bash npm run format - 代码检查：
bash npm run lint