Skip to main content

A Model Context Protocol (MCP) server that provides access to Mermaid diagram documentation.

Project 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 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:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mermaid_doc_mcp_server-0.1.0.tar.gz (474.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mermaid_doc_mcp_server-0.1.0-py3-none-any.whl (473.9 kB view details)

Uploaded Python 3

File details

Details for the file mermaid_doc_mcp_server-0.1.0.tar.gz.

File metadata

  • Download URL: mermaid_doc_mcp_server-0.1.0.tar.gz
  • Upload date:
  • Size: 474.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mermaid_doc_mcp_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 e31301b850d097c360a36bc829c600b16e06c95cd6b4c08a2c2d35f02be603e7
MD5 59a43a725b00b579b25a11f3ce74a41c
BLAKE2b-256 be4db7e61d0b748e16a0f6cf43e7ec8102371c1b6094196f1111877f2c794712

See more details on using hashes here.

Provenance

The following attestation bundles were made for mermaid_doc_mcp_server-0.1.0.tar.gz:

Publisher: python-publish.yml on moritalous/mermaid-doc-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mermaid_doc_mcp_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mermaid_doc_mcp_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66c7a7a4030fee1eb29dcbe840411aa5642888fe834ffa1f534a28c471d6df6e
MD5 13213ffae22605ea47a7895e4afa4613
BLAKE2b-256 38740ad1985bdd8a5c9caad0f056cece014eb2190628a29fc66ef1dddff9fe91

See more details on using hashes here.

Provenance

The following attestation bundles were made for mermaid_doc_mcp_server-0.1.0-py3-none-any.whl:

Publisher: python-publish.yml on moritalous/mermaid-doc-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page