Mermaid Doc MCP Server

by moritalous

2 stars
118 downloads
Not rated
GitHub

Description

# Mermaid Doc MCP Server Mermaid Doc MCP Server is a server for generating Mermaid documents. ## Features - **List Diagrams**: List all available Mermaid diagram names in the documentation. - **Retrieve Documentation**: Retrieve the documentation content for a specific Mermaid…

About

# Mermaid Doc MCP Server Mermaid Doc MCP Server is a server for generating Mermaid documents. ## Features - **List Diagrams**: List all available Mermaid diagram names in the documentation. - **Retrieve Documentation**: Retrieve the documentation content for a specific Mermaid diagram. ## Prerequisites ###…

Details

Author
moritalous
GitHub stars
2
Downloads
118
Categories
Other

- List all available Mermaid diagram names.
- Retrieve documentation for a specific diagram.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Mermaid Doc MCP Server
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install uv and Python 3.10 or newer, then add the server to your MCP configuration file (e.g., .amazonq/mcp.json for Amazon Q) using the uvx command with mermaid-doc-mcp-server@latest.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

Mermaid Doc MCP Server

Mermaid Doc MCP Server is a server for generating Mermaid documents.

Features

- List Diagrams: List all available Mermaid diagram names in the documentation.
- Retrieve Documentation: Retrieve the documentation content for a specific Mermaid diagram.

Prerequisites

Installation Requirements

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

Installation

To add this MCP server to your Amazon Q or Claude, add the following to your MCP config file. With Amazon Q, create (if does not yet exist) a file named .amazonq/mcp.json under the same directory that is running q chat. Then add the following config:

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

Tools

list_diagrams

List all available Mermaid diagram names in the documentation.

def list_diagrams() -> list:

get_diagram_doc

Retrieve the documentation content for a specific Mermaid diagram.

def get_diagram_doc(diagram_name: str) -> str:
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.