mindmap-mcp-server

🚀 Mindmap MCP 服务器

Mindmap MCP 服务器是一个借助 markmap-cli 库的工具，它能在 Model Context Protocol (MCP) 协议下，把 Markdown 转换为互动式思维导图 HTML。该服务器遵循 MCP 协议版本 1.0 规范。

🚀 快速开始

此服务器可将 Markdown 转换为互动式思维导图 HTML，支持生成离线可用的思维导图，还具备可选隐藏工具栏功能，提供返回 HTML 内容或文件路径两种模式。

✨ 主要特性

• 将 Markdown 转换为互动式思维导图 HTML
• 支持生成离线可用的思维导图
• 可选隐藏工具栏功能
• 返回 HTML 内容或文件路径两种模式

📦 安装指南

方法一：本地安装

# 使用 npm 包管理器进行全局安装
npm install -g markmap-cli

# 安装此 MCP 服务器项目
git clone https://github.com/YuChenSSR/mindmap-mcp-server.git
cd mindmap-mcp-server
npm install

方法二：Docker 安装

docker pull yuchen/mindmap-mcp-server:latest

# 启动容器，映射端口到 3000
docker run -p 3000:3000 yuchen/mindmap-mcp-server:latest

方法三：Windows 用户推荐

如果在 Windows 上使用 markmap-cli 出现问题，请考虑以下方法：

1. 使用 Docker 安装（推荐）
2. 安装 Visual Studio Code 并使用 Markmap 插件

💻 使用示例

基础用法

配置到 Claude 桌面版

1. 打开 ~/.config/claude/settings.json 文件
2. 添加以下配置：

   "mcpServers": [
     {
       "name": "mindmap-server",
       "url": "http://localhost:3000"
     }
   ]
   

3. 重启 Claude 桌面应用程序

其他 MCP 客户端使用

此服务器与所有符合 MCP 协议的客户端兼容，支持通过标准 API 进行交互。

高级用法

在 Claude 中执行以下对话

1. 请求生成思维导图：

   给我一个用于展示以下 Markdown 代码的思维导图，使用思维导图工具：
   # 项目计划
   ## 研究
   ### 市场分析
   ### 竞争对手审查
   ## 设计
   ### 线框图
   ### 模板
   

2. 请求保存并打开文件：

   使用思维导图工具将以下 Markdown 内容转换为思维导图，然后用终端打开生成的 HTML 文件。
   输入内容：
   <粘贴你的 Markdown 代码>
   

3. 动态思考过程：

   想象一下如何将一头大象放进冰箱，并提供一个思维导图。在终端中打开它。
   

📚 详细文档

注意事项

• 已成功测试适用于 macOS 和 Linux 系统的三种安装方法。
• Windows 用户若遇 npx 问题，建议使用 Docker 或 Visual Studio Code 的 Markmap 插件。

故障排除指南

1. 文件未找到

• 症状：服务器返回 404 错误，提示文件不存在。
• 解决方法：
  • 检查目标路径是否正确。
  • 确保生成的文件名与请求的一致。

2. Docker 命令未识别

• 症状：输入 docker 命令时系统提示命令未找到。
• 解决方法：
  • 安装并配置 Docker 环境。
  • 将 Docker 添加到系统 PATH 变量中。

3. 端口冲突问题

• 症状：启动服务器时报错，端口被占用。
• 解决方法：
  • 停止正在使用该端口的进程。
  • 或者修改服务器配置，使用不同的端口号（如 3001）。

高级用法

批量处理

可以将多个 Markdown 文件批量转换为思维导图，并通过 API 进行管理。

自定义样式

支持通过 CSS 定制生成的 HTML 页面样式，具体方法请参考 markmap-cli 文档。

贡献指南

欢迎提交 Pull Request 或 Issues，共同完善此项目！

📄 许可证

项目遵循 MIT 开源协议，详情请见 LICENSE 文件。