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.2.0.tar.gz (474.9 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.2.0-py3-none-any.whl (474.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mermaid_doc_mcp_server-0.2.0.tar.gz
  • Upload date:
  • Size: 474.9 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.2.0.tar.gz
Algorithm Hash digest
SHA256 5f0e1360366f226b63b205b4bd3e026927da931bf655c7357e149b3608acfb5e
MD5 501d5d7bc16cc7c72784d44ef7d34756
BLAKE2b-256 b456e380abc50c70c41778b94d948b0f6c36e06e78ad2388cac2b6e978709414

See more details on using hashes here.

Provenance

The following attestation bundles were made for mermaid_doc_mcp_server-0.2.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.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mermaid_doc_mcp_server-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 378aebb7fb07ac56ba0a6e5b47ebf185679daae05515c6caf68f32cdf3cf096f
MD5 4237f2e0e4b582f1e5a9d486b1985fd9
BLAKE2b-256 fd37a6e6a4451a213ac887e6edc06d4b0cb622763b9426681ef4fa56dff670ec

See more details on using hashes here.

Provenance

The following attestation bundles were made for mermaid_doc_mcp_server-0.2.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