关键词

Mermaid文档图表文档检索LLM工具

使用说明

项目简介

Mermaid文档MCP服务器是一个实现了 Model Context Protocol (MCP) 的后端服务，专门用于提供 Mermaid 绘图语法的文档信息。该服务器允许大型语言模型 (LLM) 客户端通过标准化的 MCP 协议，查询和获取各种 Mermaid 图表类型的文档，帮助 LLM 更好地理解和生成 Mermaid 图表。

主要功能点

  • 列出可用图表类型: 提供工具 'list_diagrams'，允许 LLM 客户端获取所有支持的 Mermaid 图表类型列表。
  • 检索图表文档: 提供工具 'get_diagram_doc'，允许 LLM 客户端根据图表类型名称，检索对应的 Mermaid 文档内容。

安装步骤

  1. 安装 'uv': 根据 Astral uv 文档 或 GitHub仓库 的说明安装 'uv'。'uv' 是一个快速的 Python 包安装和管理工具。
  2. 安装 Python 3.10 或更高版本: 使用 'uv python install 3.10' (或更高版本) 安装 Python 3.10 或更新的版本。你也可以使用其他方式安装 Python，但请确保版本符合要求。

服务器配置

要将此 MCP 服务器添加到你的 MCP 客户端（例如 Amazon Q 或 Claude），你需要配置客户端的 MCP 配置文件。以 Amazon Q 为例，你需要创建一个名为 '.amazonq/mcp.json' 的文件（如果不存在），并将以下 JSON 配置添加到该文件中。

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

配置参数说明:

  • '"mermaid-doc-mcp-server"': 服务器名称，可以自定义，用于在 MCP 客户端中标识该服务器。
  • '"command": "uvx"': 启动服务器的命令。'uvx' 是 'uv' 工具提供的用于运行包的可执行文件的命令。
  • '"args": ["mermaid-doc-mcp-server@latest"]': 传递给 'uvx' 命令的参数。'mermaid-doc-mcp-server@latest' 指示 'uvx' 运行最新版本的 'mermaid-doc-mcp-server' 包。

注意: 上述配置假设你已经将 'mermaid-doc-mcp-server' 安装为 Python 包，并且可以使用 'uvx' 命令来运行它。 具体的安装和运行方式请参考仓库的详细文档。

基本使用方法

配置完成后，MCP 客户端（如 Amazon Q 或 Claude）将能够连接到 'mermaid-doc-mcp-server'。LLM 客户端可以通过 MCP 协议调用服务器提供的工具：

  1. 'list_diagrams' 工具: 调用此工具可以获取一个包含所有支持的 Mermaid 图表类型名称的列表。LLM 可以使用此列表来了解可以查询哪些类型的图表文档。

  2. 'get_diagram_doc' 工具: 调用此工具时，需要提供一个图表类型名称作为参数 (例如: "sequenceDiagram", "flowchart" 等)。服务器将返回该图表类型的 Mermaid 文档内容。LLM 可以使用这些文档内容来生成更准确和符合规范的 Mermaid 图表代码。

示例使用场景:

LLM 客户端可以先调用 'list_diagrams' 获取支持的图表类型列表，然后根据用户的意图，选择合适的图表类型，并调用 'get_diagram_doc' 获取该图表类型的文档，最后利用文档内容来辅助生成 Mermaid 代码或回答用户关于 Mermaid 语法的问题。

信息

分类

开发者工具

访问项目