article
README
🚀 Mermaid 文档 MCP 服务器
Mermaid 文档 MCP 服务器是一款用于生成 Mermaid 文档的服务器,能帮助用户便捷地管理和获取 Mermaid 图表的相关信息。
🚀 快速开始
Mermaid 文档 MCP 服务器可助力您轻松生成 Mermaid 文档。您可借助其功能列出所有可用的 Mermaid 图表名称,还能检索特定图表的文档内容。
✨ 主要特性
- 列出图表:列出所有可用的 Mermaid 图表名称在文档中。
- 获取文档内容:检索特定 Mermaid 图表的文档内容。
📦 安装指南
先决条件
安装要求
- 从 Astral 或 GitHub README 安装
uv。 - 使用
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:
微信扫一扫