Mermaid Doc MCP Server

🚀 Mermaid Documentation MCP Server

A server for generating Mermaid documentation, which can list available Mermaid diagrams and retrieve their documentation content.

🚀 Quick Start

The Mermaid Documentation MCP Server is designed to generate Mermaid documentation. It offers two main functions: listing all available Mermaid diagram names in the documentation and retrieving the documentation content of specific Mermaid diagrams.

✨ Features

• List Diagrams: Lists all available Mermaid diagram names in the documentation.
• Get Documentation Content: Retrieves the documentation content of a specific Mermaid diagram.

📦 Installation

Prerequisites

Installation Requirements

1. Install uv from Astral or GitHub README.
2. Install Python 3.10 or a more recent version using uv python install 3.10 (or a higher version).

Adding the Server

To add this MCP server to your Amazon Q or Claude, add the following content to the MCP configuration file. For Amazon Q, create (if it doesn't exist) a file named .amazonq/mcp.json in the same directory where you run q chat, and then add the following configuration:

{
  "mcpServers": {
    "mermaid-doc-mcp-server": {
        "command": "uvx",
        "args": ["mermaid-doc-mcp-server@latest"]
    }
  }
}

💻 Usage Examples

Basic Usage

list_diagrams

Lists all available Mermaid diagram names in the documentation.

def list_diagrams() -> list:

get_diagram_doc

Retrieves the documentation content of a specific Mermaid diagram.

def get_diagram_doc(diagram_name: str) -> str: