Skip to main content
Glama
Mermaid MCP Server

Mermaid MCP Server

by wwwzhouhui

Mermaid MCP Server

Model Context Protocol (MCP) に基づく Mermaid 図表変換サーバー。AI クライアントに強力な図表生成機能を提供します

License Python MCP UV


プロジェクト紹介

Mermaid MCP Server は、Model Context Protocol (MCP) に基づく専門的な Mermaid 図表変換サーバーであり、AI クライアントに強力な図表生成機能を提供します。このプロジェクトは、Mermaid 図表コードを複数の形式の画像ファイル(PNG、JPG、SVG、PDF)に変換することができ、MCP プロトコルをサポートするさまざまな AI クライアントで高品質な図表を簡単に生成できます。

コア機能

  • 多形式出力: PNG、JPG、SVG、PDF など複数の画像形式をサポート

  • テーマカスタマイズ: default、dark、neutral、forest の4つの美しいテーマを内蔵

  • カスタムオプション: 背景色、画像サイズなどのパラメータをカスタマイズ可能

  • 構文検証: リアルタイムの Mermaid 構文検証機能を提供

  • サンプルリソース: 豊富な図表タイプのサンプルコードを内蔵

  • エラーハンドリング: 充実したエラー処理メカニズムと分かりやすいエラーメッセージ

  • STDIO/SSE デュアルモード: STDIO と SSE の2つの通信モードをサポート

  • uv パッケージ管理: 超高速の uv パッケージマネージャーを使用


Related MCP server: mcp-mermaid-validator

機能一覧

機能名

機能説明

技術スタック

ステータス

図表変換

Mermaid コードを画像に変換

mermaid.ink API

✅ 安定

多形式出力

PNG/JPG/SVG/PDF

requests + base64

✅ 安定

テーマカスタマイズ

4つの内蔵テーマ

mermaid.ink

✅ 安定

構文検証

リアルタイム構文チェック

mermaid-cli

✅ 安定

サンプルリソース

豊富な図表サンプル

静的リソース

✅ 安定

エラーハンドリング

充実したエラーメッセージ

Python 例外処理

✅ 安定

MCP プロトコル

Model Context Protocol

mcp[cli]

✅ 安定

SSE モード

Server-Sent Events

FastAPI + Uvicorn

✅ 安定


技術アーキテクチャ

技術

バージョン

用途

Python

3.12+

主要開発言語

MCP

1.9+

Model Context Protocol

FastAPI

0.104+

Web フレームワーク(SSE モード)

Uvicorn

0.24+

ASGI サーバー

requests

2.31+

HTTP クライアント

uv

latest

Python パッケージマネージャー

通信アーキテクチャ

┌─────────────────────────────────────────────────────────────────────────────────┐
│                            通信架构图                                            │
├─────────────────────────────────────────────────────────────────────────────────┤
│                                                                                 │
│   ┌──────────────────┐       ┌─────────────────────────┐       ┌─────────────┐ │
│   │  AI 客户端         │ ◄────► │   Mermaid MCP Server    │ ◄────► │ Mermaid API │ │
│   │ (Cursor/Claude)   │       │   STDIO/SSE             │       │  mermaid.ink│ │
│   └──────────────────┘       └─────────────────────────┘       └─────────────┘ │
│           │                            │                              │        │
│           ▼                            ▼                              ▼        │
│   AI 对话界面                MCP 协议通信              图表渲染转换      │
│   生成图表请求                双向数据传输              返回图像数据     │
│                                                                                 │
└─────────────────────────────────────────────────────────────────────────────────┘

インストール手順

環境要件

  • Python 3.12+

  • uv パッケージマネージャー(推奨)

依存関係のインストール

方法1:uv を使用したインストール(推奨)

# 克隆仓库
git clone https://github.com/wwwzhouhui/mermaid_mcp_server.git
cd mermaid_mcp_server

# 安装依赖
uv sync

方法2:pip を使用したインストール

pip install -r requirements.txt

使用方法

クライアント設定

Cursor 設定

~/.cursor/mcp.json ファイルに以下の設定を追加します:

STDIO モード(推奨):

{
  "mcpServers": {
    "mermaid-mcp-server-png-pdf-jpg-svg": {
      "command": "uvx",
      "args": [
        "mermaid-mcp-server-png-pdf-jpg-svg"
      ]
    }
  }
}

SSE モード:

{
  "mcpServers": {
    "mermaid-mcp-server-png-pdf-jpg-svg": {
      "url": "http://127.0.0.1:8003/sse"
    }
  }
}

Cherry Studio 設定

  1. Cherry Studio を開く

  2. 設定 → MCP Servers → サーバーを追加 に移動

  3. パラメータを設定:

    • 名前: mermaid-mcp-server-png-pdf-jpg-svg

    • 説明: Mermaid 図表生成サービス

    • タイプ: STDIO

    • コマンド: uvx

    • パラメータ: mermaid-mcp-server-png-pdf-jpg-svg

  4. 保存して有効化

Cherry Studio 設定例

Claude Desktop 設定

claude_desktop_config.json ファイルに以下を追加:

{
  "mcpServers": {
    "mermaid-mcp-server-png-pdf-jpg-svg": {
      "command": "uvx",
      "args": [
        "mermaid-mcp-server-png-pdf-jpg-svg"
      ]
    }
  }
}

Continue.dev 設定

config.json ファイルに以下を追加:

{
  "mcpServers": {
    "mermaid-mcp-server-png-pdf-jpg-svg": {
      "command": "uvx",
      "args": [
        "mermaid-mcp-server-png-pdf-jpg-svg"
      ]
    }
  }
}

サービスの起動

STDIO モード(デスクトップクライアントに推奨)

uv run python main.py

SSE モード(ネットワーク接続用)

uv run python main.py --sse

設定説明

環境変数の設定

変数名

説明

デフォルト値

HOST

サーバーアドレス

0.0.0.0

PORT

サーバーポート

8003

LOG_LEVEL

ログレベル

INFO

MERMAID_API_BASE_URL

Mermaid API アドレス

https://mermaid.ink

REQUEST_TIMEOUT

リクエストタイムアウト(秒)

30

DEBUG

デバッグモード

false

DEVELOPMENT_MODE

開発モード

false


利用可能なツール

1. convert_mermaid_to_image

Mermaid 図表コードを複数の形式の画像ファイルに変換します

パラメータ:

  • mermaid_code (string): Mermaid 図表コード

  • output_format (string, オプション): 出力形式。png、jpg、svg、pdf をサポート。デフォルトは "png"

  • theme (string, オプション): テーマスタイル。default、dark、neutral、forest をサポート。デフォルトは "default"

  • background_color (string, オプション): 背景色。16進数カラーコード

  • width (number, オプション): 画像の幅(ピクセル)

  • height (number, オプション): 画像の高さ(ピクセル)

サポートされる出力形式: PNG、JPG、SVG、PDF

2. validate_mermaid_syntax

Mermaid 図表コードの構文の正確性を検証します

パラメータ:

  • mermaid_code (string): 検証が必要な Mermaid 図表コード

戻り値:

  • valid (boolean): 検証に合格したかどうか

  • error_message (string): エラーメッセージ(検証に失敗した場合)

3. get_supported_options

コンバーターがサポートするオプションを取得します

戻り値:

  • themes (array): サポートされるテーマのリスト

  • formats (array): サポートされる形式のリスト


サポートされる図表タイプ

  • フローチャート (Flowchart): プロセスやアルゴリズムの表現に使用

  • シーケンス図 (Sequence Diagram): オブジェクト間の相互作用の表現に使用

  • ガントチャート (Gantt Chart): プロジェクト進捗管理に使用

  • 円グラフ (Pie Chart): データの割合の表現に使用

  • Git グラフ (Git Graph): Git コミット履歴の表現に使用

  • マインドマップ (Mind Map): 知識構造の表現に使用

  • クラス図 (Class Diagram): クラス構造の表現に使用


使用例

フローチャートの例

请使用 convert_mermaid_to_image 工具生成一个流程图:
flowchart TD
    A[开始] --> B{判断条件}
    B -->|是 | C[执行动作 1]
    B -->|否 | D[执行动作 2]
    C --> E[结束]
    D --> E

シーケンス図の例

请使用 convert_mermaid_to_image 工具生成一个时序图,使用深色主题:
sequenceDiagram
    participant 用户
    participant 系统
    participant 数据库

    用户->>系统:登录请求
    系统->>数据库:验证用户
    数据库-->>系统:返回结果
    系统-->>用户:登录成功

構文検証の例

首先使用 validate_mermaid_syntax 验证语法,然后使用 convert_mermaid_to_image 生成图表

リソースサンプル

図表サンプルの取得

以下のリソース URI を使用して、さまざまなタイプの図表サンプルを取得できます:

  • mermaid://examples/flowchart - フローチャートのサンプル

  • mermaid://examples/sequence - シーケンス図のサンプル

  • mermaid://examples/gantt - ガントチャートのサンプル

  • mermaid://examples/pie - 円グラフのサンプル

  • mermaid://examples/gitgraph - Git グラフのサンプル

  • mermaid://examples/mindmap - マインドマップのサンプル

  • mermaid://examples/class - クラス図のサンプル


プロジェクト構造

mermaid_mcp_server/
├── mermaid_mcp_server/       # 核心模块
│   ├── __init__.py
│   └── main.py             # 主程序入口
├── requirements.txt          # 依赖列表(pip)
├── pyproject.toml           # 项目配置(uv)
├── .env.example            # 环境变量示例
├── README.md               # 项目文档
└── .vscode/                # VSCode 配置
    └── settings.json

開発ガイド

ローカル開発

# 克隆仓库
git clone https://github.com/wwwzhouhui/mermaid_mcp_server.git
cd mermaid_mcp_server

# 安装依赖
uv sync

# 配置环境变量
cp .env.example .env

# 启动服务(STDIO 模式)
uv run python main.py

# 启动服务(SSE 模式)
uv run python main.py --sse

デバッグモード

詳細なログ出力を有効にする:

export LOG_LEVEL=DEBUG
uv run python main.py

よくある質問

A:

  1. ネットワーク接続とファイアウォール設定を確認

  2. mermaid.ink API にアクセスできることを確認

  3. プロキシ設定を確認

A:

  1. validate_mermaid_syntax ツールを使用して構文を確認

  2. Mermaid 公式ドキュメントを参照

  3. サンプルリソースのコードを使用

A:

  1. 図表の内容を簡素化

  2. 複数の小さな図表に分割

  3. 画像サイズのパラメータを調整

A:

  1. uv パッケージマネージャーをインストール:curl -LsSf https://astral.sh/uv/install.sh | sh

  2. または pip でパッケージをグローバルにインストール

  3. PATH 環境変数を確認

A:

  1. サービスが SSE モードで起動していることを確認

  2. ポート 8003 が使用中でないか確認

  3. URL 設定が正しいことを確認

A:

  1. 画像サイズのパラメータを増やす

  2. 適切なテーマを選択

  3. Mermaid コードの構造を最適化

A:

  1. ネットワーク接続速度を確認

  2. REQUEST_TIMEOUT 環境変数を増やす

  3. 図表の複雑さを簡素化

A:

  1. テーマ名のスペルが正しいことを確認

  2. そのテーマがサポートされているか確認

  3. 別のテーマ名を試す

A:

  1. background_color パラメータを使用

  2. 形式は16進数カラーコード(例:#FFFFFF)

  3. 一部の出力形式のみサポート


技術交流グループ

技術交流グループへの参加を歓迎します。使用体験やフィードバックを共有しましょう:

技術交流グループ


作者連絡先

微信QRコード


投げ銭

このプロジェクトが役に立ったなら、コーヒー一杯ごちそうしてください ☕

微信支付

微信支付


Star History

プロジェクトが良いと思ったら、Star を付けてください ⭐

Star History Chart


License

MIT License


更新履歴

v0.1.0 (現在のバージョン)

  • ✅ 初期バージョンリリース

  • ✅ PNG、JPG、SVG、PDF の多形式出力をサポート

  • ✅ 4つのテーマスタイル(default、dark、neutral、forest)を統合

  • ✅ 構文検証とサンプルリソース機能を提供

  • ✅ STDIO と SSE のデュアルモード通信をサポート

v0.0.3 (2025-07-21)

  • ✅ 初期バージョンリリース

  • ✅ 多形式の図表変換をサポート

  • ✅ 構文検証機能

  • ✅ サンプルリソース機能


貢献ガイド

Issue と Pull Request を歓迎します。このプロジェクトの改善にご協力ください!

  1. このリポジトリを Fork

  2. 機能ブランチを作成:git checkout -b feature/amazing-feature

  3. 変更をコミット:git commit -m 'Add amazing feature'

  4. ブランチにプッシュ:git push origin feature/amazing-feature

  5. Pull Request を送信


注意事項

  • 図表の生成には数秒かかる場合があります。お待ちください

  • ネットワーク接続が正常であることを確認してください。サービスは mermaid.ink のオンライン API に依存しています

  • 生成された画像データは base64 形式で返されます

  • 複雑な図表は生成により長い時間がかかる場合があります


Mermaid で美しい図表を作成しましょう! 🎨✨

Available Tools

3 tools
convert_mermaid_to_imageA
将 Mermaid 图表代码转换为多种格式的图像(PNG、JPG、PDF、SVG)。

参数:
    mermaid_code: 要转换的 Mermaid 图表语法代码
    output_format: 输出格式 - png、jpg、svg 或 pdf(默认:png)
    theme: 视觉主题 - default、dark、neutral 或 forest(默认:default)
    background_color: 背景颜色,十六进制代码(如 FF0000)或带 ! 前缀的命名颜色(如 !white)
    width: 图像宽度(像素,可选)
    height: 图像高度(像素,可选)

返回:
    包含转换后图像数据和元数据的字典

Inputs: mermaid_code (required), output_format, theme, background_color, +2 more. Returns: result

get_supported_optionsA
获取转换器支持的选项,如图表主题和输出格式。

返回:
    一个包含支持的主题和格式列表的字典。

Inputs: no named parameters. Returns: result

validate_mermaid_syntaxB
通过尝试简单转换来验证 Mermaid 图表语法。

参数:
    mermaid_code: 要验证的 Mermaid 图表语法代码

返回:
    包含验证结果的字典

Inputs: mermaid_code (required). Returns: result

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.7/5.0

    Scored across 3 tools

    Disambiguation5/5

    Each tool has a clearly distinct purpose: convert_mermaid_to_image handles the core conversion functionality, get_supported_options provides metadata about available options, and validate_mermaid_syntax performs syntax validation. There is no overlap or ambiguity between these three functions.

    Naming Consistency5/5

    All tools follow a consistent snake_case naming pattern with clear verb-action structure: convert_mermaid_to_image, get_supported_options, and validate_mermaid_syntax. The naming is predictable and follows the same convention throughout.

    Tool Count4/5

    Three tools is a reasonable number for a Mermaid diagram conversion server, though it feels slightly minimal. The tools cover the essential operations (convert, validate, get options), but additional utilities like listing available themes or handling diagram editing might enhance completeness.

    Completeness4/5

    The tool set covers the core Mermaid conversion workflow well: conversion, syntax validation, and option discovery. Minor gaps include operations like batch conversion, diagram editing utilities, or theme management, but agents can work effectively with the provided tools for most use cases.

    Related MCP Connectors

    Related MCP Servers