How apeyroux/mcp-xmind works
Project type and purpose
• This is a single‑process, backend‑only “Model Context Protocol” (MCP) server written in TypeScript/Node.js.
• It exposes a CLI/JSON‑RPC interface (invoked by Claude Desktop or via npx) for analyzing and querying XMind (.xmind) mind‑map files.
• Key use cases: directory scanning, fuzzy search, node extraction, task listing, multi‑file analysis, secure path validation.
File structure
• Top‐level files:
• index.ts – application entry point, dispatches tool commands
• package.json, tsconfig.json – build and dependency configuration
• .gitignore, CHANGELOG.md, README.md – standard repo meta
• No separate “src/” or “lib/” directories: index.ts likely imports/organizes all modules.
• External dependencies in package.json hint at main modules:
• @modelcontextprotocol/sdk – protocol layer for registering “tools”
• adm-zip – .xmind archive extraction/parsing
• zod – runtime input validation
README for additional insights
• Defines eight “tools” (read_xmind, search_nodes, get_todo_tasks, etc.) implemented as discrete handlers.
• Security: only whitelisted directories, path normalization, error handling.
• Usage: invoked as node dist/index.js <allowed-dir>… or via npx.
• Development flow: build → dist/index.js → MCP inspector or runtime.
Diagramming recommendations
• Use clear, consistent labels for each module/component.
• Blue for the MCP Protocol Layer
• Green for Business Logic (handlers, query engine)
• Orange for I/O (file system, parser)