使用说明

项目简介

Mindmap MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它提供了一个工具，可以将 Markdown 格式的文本内容转换为交互式的 HTML 思维导图。此服务器旨在与支持 MCP 协议的 LLM 客户端（如 Claude Desktop）配合使用，让 LLM 能够利用工具生成和展示思维导图。

主要功能点

Markdown 转思维导图: 核心功能是将 Markdown 文本转换为美观的 HTML 思维导图。
多种输出方式: 支持返回完整的 HTML 内容或将思维导图保存为 HTML 文件。
可配置选项: 允许配置是否显示工具栏、生成离线可用的思维导图。
MCP 工具集成: 通过 MCP 协议向客户端暴露工具，方便 LLM 调用。
Docker 部署: 提供 Docker 镜像，方便部署和使用。

安装步骤

使用 pip 安装 (推荐):

pip install mindmap-mcp-server

使用 uvx 安装:

uvx mindmap-mcp-server

(如果您的环境使用了 uvx 包管理器)

前提条件: 确保您的系统已安装 Node.js，因为 'markmap-cli' 依赖 Node.js 环境。

服务器配置

要将 Mindmap MCP Server 集成到 MCP 客户端（例如 Claude Desktop），您需要在客户端的配置文件中添加服务器配置信息。以下是几种配置方式，选择一种适合您的即可：

1. 使用 uvx 启动 (推荐):

如果您使用 'uvx' 安装了 'mindmap-mcp-server'，可以使用以下配置：

{
  "mcpServers": {
    "mindmap": {  // 服务器名称，可以自定义
      "command": "uvx", // 启动命令，使用 uvx
      "args": ["mindmap-mcp-server"] // 启动参数，运行 mindmap-mcp-server
    }
  }
}

2. 使用 Python 文件启动:

如果您想直接运行仓库中的 'server.py' 文件，可以使用以下配置 (需要替换 '/path/to/your/mindmap_mcp_server/server.py' 为实际路径):

{
  "mcpServers": {
    "mindmap": {  // 服务器名称，可以自定义
      "command": "python", // 启动命令，使用 python
      "args": ["/path/to/your/mindmap_mcp_server/server.py"] // 启动参数，指定 server.py 文件的路径
    }
  }
}

3. 使用 Docker 镜像启动:

如果您选择使用 Docker 镜像，可以使用以下配置 (需要替换 '/path/to/output/folder' 为您希望保存思维导图的本地文件夹路径):

{
  "mcpServers": {
    "mindmap-converter": { // 服务器名称，可以自定义
      "command": "docker", // 启动命令，使用 docker
      "args": [
        "run",
        "--rm",  // 容器退出后自动删除
        "-i",    // 保持 STDIN 打开
        "-v", "/path/to/output/folder:/output", // 挂载本地文件夹到容器的 /output 目录，用于保存思维导图文件
        "ychen94/mindmap-converter-mcp:latest" // Docker 镜像名称和标签
      ]
    }
  }
}

注意: 请将 '/path/to/output/folder' 替换为您系统上的实际路径，例如 macOS 上的 '/Users/username/Downloads' 或 Windows 上的 'C:\Users\username\Downloads'。

基本使用方法

配置完成后，在支持 MCP 协议的 LLM 客户端中，您可以指示 LLM 使用 'mindmap' 或 'mindmap-converter' (取决于您配置的服务器名称) 工具来生成思维导图。

示例 (在 Claude 中):

您可以像这样询问 Claude，让它使用 mindmap 工具生成思维导图：

give a mindmap for the following markdown code, using a mindmap tool:

# Project Planning
## Research
### Market Analysis
### Competitor Review
## Design
### Wireframes
### Mockups
## Development
### Frontend
### Backend
## Testing
### Unit Tests
### User Testing


如果您想将思维导图保存为文件并在浏览器中打开 (例如使用 iTerm MCP server):

give a mindmap for the following markdown input_code using a mindmap tool, after that,use iterm to open the generated html file. input_code:

```markdown
markdown content

...

提供的 MCP 工具:

该服务器主要提供以下 MCP 工具 (取决于您的配置方式):

markdown-to-mindmap-content (Docker 镜像中)
- 功能: 将 Markdown 转换为 HTML 思维导图内容，并直接返回 HTML 字符串。
- 参数:
  - 'markdown' (string, 必填): 要转换的 Markdown 内容。
  - 'toolbar' (boolean, 可选): 是否显示工具栏 (默认为 true)。
- 适用场景: 适用于简单的思维导图，直接在客户端展示 HTML 内容，或使用客户端的 artifact 功能预览。
markdown-to-mindmap-file (Docker 镜像中)
- 功能: 将 Markdown 转换为 HTML 思维导图，并将 HTML 文件保存到指定的输出目录。
- 参数:
  - 'markdown' (string, 必填): 要转换的 Markdown 内容。
  - 'filename' (string, 可选): 自定义文件名 (默认为自动生成的时间戳名称)。
  - 'toolbar' (boolean, 可选): 是否显示工具栏 (默认为 true)。
- 适用场景: 适用于复杂的思维导图或需要保存思维导图文件以供后续使用的情况。可以结合其他 MCP 服务器（如 iTerm MCP server）在浏览器中打开文件。
convert_markdown_to_mindmap (pip 或 uvx 安装，直接运行 'server.py')
- 功能: 将 Markdown 转换为思维导图，可以返回 HTML 内容或文件路径。
- 参数:
  - 'markdown_content' (string, 必填): 要转换的 Markdown 内容。
  - 'return_type' (string, 必填): 指定返回类型，''html'' 返回 HTML 内容，''filePath'' 返回文件路径。
  - 'offline' (boolean, 可选): 是否生成包含所有资源的离线 HTML (默认为 false)。
  - 'no_toolbar' (boolean, 可选): 是否隐藏工具栏 (默认为 false)。
- 适用场景: 灵活的工具，可以根据 'return_type' 参数选择返回 HTML 内容或文件路径，并支持离线和工具栏配置。

请根据您的需求选择合适的工具和配置方式，并在 LLM 客户端中使用相应的服务器名称和工具名称来调用思维导图生成功能。

关键词