Mermaid语法验证器

一个基于Bun和TypeScript构建的Mermaid图表语法验证服务,支持所有主要Mermaid图表类型的语法检查。

  • by LF112
  • JavaScript
  • 本地部署
  • 3 星标
  • 更新于
在 GitHub 查看 lf112/mermaid-validator-mcp

使用说明

美人鱼验证器MCP

A. 模型上下文协议(MCP) 服务器构建于 包子 以及验证的TypeScript 美人鱼 图表语法。

快速开始

这个包发布在npm上。您可以直接使用npx运行它:

npx -y mermaid-validator-mcp

MCP客户端配置

将服务器添加到MCP客户端(例如Claude Desktop)配置中:

使用npx(推荐)

{
  "mcpServers": {
    "mermaid-validator": {
      "command": "npx",
      "args": ["-y", "mermaid-validator-mcp"]
    }
  }
}

使用本地来源

{
  "mcpServers": {
    "mermaid-validator": {
      "command": "bun",
      "args": [
        "/path/to/mermaid-validator-mcp/index.ts"
      ]
    }
  }
}

或者,如果您已全局安装:

{
  "mcpServers": {
    "mermaid-validator": {
      "command": "mermaid-validator-mcp"
    }
  }
}

特性

  • 单一工具—— validate_mermaid:传递任何Mermaid图文本,并接收具有检测到的图类型的成功响应或详细的解析错误消息。
  • 支持所有主要的美人鱼图类型:流程图、序列图、类、饼图、甘特图、状态图、ER、gitGraph、思维导图、时间线等。
  • 不依赖于 mermaid-cli 或任何外部渲染过程。
  • 使用JSDOM提供Mermaid所需的最小DOM环境。

需求

入门指南

# Install dependencies
bun install

# Start the MCP server (stdio mode)
bun start

工具: validate_mermaid

输入

字段 类型 描述
diagram string 要验证的美人鱼图文本

输出(JSON文本)

有效图表

{ "valid": true, "diagramType": "flowchart-v2" }

图表无效

{
  "valid": false,
  "error": "Parse error on line 2:\n...TD\n  --> B\n-------^\nExpecting 'SEMI', ..."
}

发展

# Run with auto-reload
bun dev

# Build
bun run build