Skip to main content

让大模型读写 XMind 文件,支持图片 OCR 的 MCP Server

Project description

XMind MCP Server

让大模型真正“看懂”并“修改” XMind 思维导图的本地 MCP Server。

Python License PyPI Downloads

XMind MCP Server 是一个基于 Model Context Protocol (MCP) 的本地服务。它把 XMind 文件解析、图片 OCR、节点编辑和文件写回能力封装成一套标准工具,供 Trae、Claude Desktop、Cursor 等支持 MCP 的客户端调用。


✨ 核心亮点

1. 不只是读文字,还能读图片

普通方式只能让模型看到节点的标题文字。XMind MCP Server 会对节点中的图片进行本地 OCR,把图片里的文字也喂给模型,真正“看懂”整份思维导图。

📄 工作表: 操作系统
└─ [L0] [id: root-1] 操作系统
   └─ [L1] [id: abc-123] 📷图片
         ↳ [OCR] 中央处理器
                (CPU)

2. 既能读,也能写

支持通过自然语言指令让模型直接修改 XMind 文件:

  • 添加子节点
  • 修改标题 / 备注
  • 删除节点
  • 移动节点
  • 保存回原文件或另存为新文件

3. 本地 OCR,零云端依赖

内置 RapidOCR(默认)和 PaddleOCR 两种后端,全部在本地运行:

  • 不调用任何云端多模态 API
  • 不消耗 Token
  • 图片内容识别不上传到第三方

4. 自动硬件检测与最佳配置

首次启动自动检测 GPU、CPU、内存,并选择最适合的推理后端:

显卡 Windows Linux macOS
NVIDIA CUDA ✅ CUDA ✅ CPU
AMD DirectML ✅ CPU CPU
Intel DirectML ✅ CPU CPU
无独显 CPU ✅ CPU ✅ CPU ✅

5. 安全写回,保留原文件结构

保存时不会破坏 XMind 文件中的样式、主题、附件、manifest 等资源,只修改 content.json,再安全重组 ZIP。


🆚 与纯 Python 脚本对比

能力 纯 Python 脚本 XMind MCP Server
读文本节点 ✅ 可以 ✅ 可以
找图片位置 ⚠️ 容易漏(summary、attachment、notes 里的图) ✅ 封装完整
理解图片内容 ❌ 必须依赖多模态模型 ✅ 本地 OCR,不依赖模型能力
写回 xmind ⚠️ 要手动处理 manifest checksum、ZIP 重组 ✅ 封装安全写回
批量处理 ⚠️ 自己写循环 ✅ 统一接口
被大模型调用 ❌ 需要额外包装 ✅ MCP 标准协议

📦 安装

从 PyPI 安装(推荐)

pip install xmind-mcp-server

带 RapidOCR 依赖:

pip install "xmind-mcp-server[rapidocr]"

从源码安装

git clone https://github.com/GarryWhite109909/xmind-mcp-server.git
cd xmind-mcp-server
pip install -e ".[dev]"

🚀 快速开始

1. 首次启动(自动配置)

xmind-mcp

首次运行会:

  1. 检测操作系统、CPU、内存、显卡
  2. 选择合适的 OCR 引擎和推理设备
  3. 安装对应的推理依赖(如 onnxruntime-gpu / directml)
  4. 写入配置到 ~/.xmind-mcp/config.json

第二次运行直接启动,无需重复配置。

2. 在 Trae / Claude Desktop / Cursor 中配置

Trae

打开设置 → MCP,添加服务器:

{
  "mcpServers": {
    "xmind-mcp": {
      "command": "xmind-mcp",
      "args": []
    }
  }
}

如果 xmind-mcp 不在系统 PATH,使用 Python 解释器绝对路径:

{
  "mcpServers": {
    "xmind-mcp": {
      "command": "C:\\Users\\<你的用户名>\\.miniconda\\python.exe",
      "args": ["-m", "xmind_mcp"]
    }
  }
}

💡 修改代码后,需要在 Trae 中禁用再启用该 MCP,或重启 Trae,才能加载最新版本。

Claude Desktop

编辑 claude_desktop_config.json

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
{
  "mcpServers": {
    "xmind-mcp": {
      "command": "xmind-mcp",
      "args": []
    }
  }
}

🛠️ 工具一览

读取类

工具 说明
read_structure 读取节点树结构,默认输出层级 + 节点 ID
read_all 节点树 + 图片 OCR + notes/labels/markers 元数据
list_images 列出所有含图片的节点
read_image_ocr 对指定节点的图片做 OCR
find_node 按标题关键词搜索节点,返回 ID 和路径
export_markdown 导出为 Markdown 大纲

编辑类

工具 说明
add_node 在指定父节点下添加子节点
update_node 更新节点标题 / 备注
delete_node 删除节点及其子节点
move_node 移动节点到新父节点下
save_file 保存修改,可覆盖或另存为

所有编辑工具都支持 auto_save=true,设置后会自动保存,无需再手动调用 save_file

系统类

工具 说明
get_hardware_info 查看硬件检测和 OCR 配置

💬 使用示例

例 1:让模型总结一份 XMind

请读取 D:\\docs\\操作系统.xmind,总结其中的核心概念,并识别所有图片里的文字。

模型会调用:

  1. read_all 读取完整结构和图片 OCR
  2. 基于返回内容生成总结

例 2:搜索节点并编辑

D:\\docs\\操作系统.xmind 中找到“进程”相关节点,给它们都加上一条备注“需重点复习”。

模型会调用:

  1. find_node 搜索“进程”
  2. update_node 更新备注(可设置 auto_save=true

例 3:导出为 Markdown

D:\\docs\\操作系统.xmind 导出成 Markdown 大纲,保留节点 ID。

模型会调用 export_markdown,返回:

# 操作系统

- 操作系统 `id:root-1`
  - 进程 `id:child-1`
  - 线程 `id:child-2`

⚙️ 命令行参数

xmind-mcp                    # 启动 MCP Server(首次自动配置)
xmind-mcp --setup            # 重新检测硬件并配置
xmind-mcp --info             # 打印当前硬件和配置信息
xmind-mcp --engine rapidocr  # 指定 OCR 引擎
xmind-mcp --device cuda      # 强制指定推理设备

切换 OCR 引擎:

xmind-mcp --setup --engine paddleocr

📁 本地文件位置

文件/目录 说明
~/.xmind-mcp/config.json 硬件检测结果、OCR 引擎、推理设备配置
~/.xmind-mcp/ocr_cache.db OCR 结果缓存,避免同一张图重复识别
~/.xmind-mcp/models/ OCR 模型下载缓存

MCP 关闭时会自动释放 OCR 模型占用的内存 / 显存。


✅ 支持的 XMind 版本

  • ✅ XMind Zen / XMind 2020+ / 2022 / 2024(JSON 格式)
  • ❌ XMind 8 及更早(XML 格式,暂不支持)

🧪 开发 & 测试

git clone https://github.com/GarryWhite109909/xmind-mcp-server.git
cd xmind-mcp-server
pip install -e ".[dev]"
pytest

当前测试覆盖:文件解析、节点增删改查、图片加载、OCR、MCP Server 协议握手、Markdown 导出等。


📄 License

MIT © GarryWhite

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xmind_mcp_server-0.1.2.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

xmind_mcp_server-0.1.2-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

Details for the file xmind_mcp_server-0.1.2.tar.gz.

File metadata

  • Download URL: xmind_mcp_server-0.1.2.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.11

File hashes

Hashes for xmind_mcp_server-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9fedb41c65cce830ed775a9c9d1567b8b95eb7b277d248755e7317c25de77480
MD5 61d72df89d6920d31c3715c92c2410ed
BLAKE2b-256 b09c86d344938059fd87242b71751666a5e0465c6690b877c808d1a38a67d923

See more details on using hashes here.

File details

Details for the file xmind_mcp_server-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for xmind_mcp_server-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2079a2483432c9b1b66752fd0cd39aae165ae0fb9e00d7aac7f89232aa5e6dd5
MD5 58828966e12774de7b822aec6ecd0a10
BLAKE2b-256 11f667b89038a398643fc6d95e378ef9b7ce30dfbc143352cf8824a34faa3fc2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page