返回 MCP 目录
public公开dns本地运行

mermaid-doc-mcp-server

Mermaid文档MCP服务是一个用于生成Mermaid图表的服务器,提供图表列表查询和文档内容获取功能。

article

README

🚀 Mermaid 文档 MCP 服务器

Mermaid 文档 MCP 服务器是一款用于生成 Mermaid 文档的服务器,能帮助用户便捷地管理和获取 Mermaid 图表的相关信息。

🚀 快速开始

Mermaid 文档 MCP 服务器可助力您轻松生成 Mermaid 文档。您可借助其功能列出所有可用的 Mermaid 图表名称,还能检索特定图表的文档内容。

✨ 主要特性

  • 列出图表:列出所有可用的 Mermaid 图表名称在文档中。
  • 获取文档内容:检索特定 Mermaid 图表的文档内容。

📦 安装指南

先决条件

安装要求

  1. AstralGitHub README 安装 uv
  2. 使用 uv python install 3.10(或更高版本)安装 Python 3.10 或更新版本。

安装步骤

要将此 MCP 服务器添加到您的 Amazon Q 或 Claude 中,请在 MCP 配置文件中添加以下内容。对于 Amazon Q,在运行 q chat 的同一目录下创建(如果不存在)一个名为 .amazonq/mcp.json 的文件,然后添加以下配置:

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

💻 使用示例

基础用法

列出所有可用的 Mermaid 图表名称

def list_diagrams() -> list:

检索特定 Mermaid 图表的文档内容

def get_diagram_doc(diagram_name: str) -> str:
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端