XMind MCP
Convert Markdown, text outlines, HTML, Word, and Excel to XMind. MCP tools provide mind map creation, reading, structural analysis, conversion, file listing, and title translation.
中文 · Documentation index (Chinese)
Quick start
Requires UV and Python 3.11+. From the repository root, run the current source and replace the output directory with an absolute path on your machine:
uvx --python 3.12 --from . xmind-mcp --stdio --default-output-dir /absolute/path/to/output
Clients communicate through standard input/output. Waiting for input in a terminal is normal. uvx xmind-mcp installs the published package and does not include unpublished local changes.
The project uses MCP Python SDK v2, supporting the 2026-07-28 protocol revision and legacy initialization. --mode fastmcp, --mode stdio, and --stdio remain aliases for the same STDIO entry point.
See the usage guide for MCP client configuration and path rules.
Six MCP tools
| Tool | Purpose |
|---|---|
create_mind_map |
Create a mind map from JSON topics |
read_xmind_file |
Read the first sheet's topic tree and statistics |
analyze_mind_map |
Analyze nodes, depth, and structure |
convert_to_xmind |
Convert a supported input file |
list_xmind_files |
List files by directory, pattern, and depth |
translate_xmind_titles |
Translate titles through an external provider |
Topic input uses title and children, with legacy aliases supported. Output tools need an absolute default output directory or explicit absolute output path. Translation requires network access; optional AI helpers are separate from the six registered tools.
Standalone conversion
uv run xmind-convert examples/test_markdown.md output/markdown.xmind
After installation, xmind-convert input.md output/result.xmind is also available. Supported inputs are Markdown, TXT, HTML, .docx, and .xlsx; see the usage guide for parsing rules.
Development
uv venv --python 3.12
uv pip install -e '.[test]'
.venv/bin/python tests/run_all_tests.py -q
On Windows, use .venv/Scripts/python.exe instead of .venv/bin/python.
Branch pushes and pull requests run automated checks. Successful checks on main automatically increment the patch version and publish to PyPI. Configure PYPI_API_TOKEN once; see the development guide.
Documentation
- Usage guide: setup, MCP configuration, arguments, conversion, and troubleshooting.
- Architecture: models, service boundaries, configuration isolation and extensions.
- Development and publishing: environments, tests, distribution checks, versions, and PyPI releases.
Implementation and MCP entry points live in xmind_mcp/; root-level scripts and their import APIs have been removed. See the documentation index for the consolidation map.
License
1 maintainer
Metadata
1 maintainer
Release files for xmind-mcp 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xmind_mcp-2.0.0.tar.gz | 95.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xmind_mcp-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 132.9 kB
Release files / xmind_mcp-2.0.0.tar.gz
| Download URL | xmind_mcp-2.0.0.tar.gz |
|---|---|
| Size | 95.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
88150752d2bcceb9b1a390842ef5092e762d8ae609e63ca75ac0dcaf82e82043
|
|
BLAKE2b-256 checksum How to use checksums |
ab50a30d103b61fab8b2343450800febaadba4fdcdfe8308214d88c654e443b6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / xmind_mcp-2.0.0-py3-none-any.whl
| Download URL | xmind_mcp-2.0.0-py3-none-any.whl |
|---|---|
| Size | 37.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
85925b7ebf49006cce8dca95177ee620cd402b9febf16f891490c02c76b31652
|
|
BLAKE2b-256 checksum How to use checksums |
5223acbe3a4e5b10db1ac1b7906a7053f242032370141881e7918afd6467b714
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
