Mindmap MCP Server

🚀 Mindmap MCP Server

This is a server that uses the markmap-cli library to convert Markdown to interactive mind map HTML under the Model Context Protocol (MCP). It implements the MCP protocol version 1.0 specification.

🚀 Quick Start

This server uses the markmap-cli library to convert Markdown into interactive mind - map HTML under the Model Context Protocol (MCP). It implements the MCP protocol version 1.0 specification.

✨ Features

• Convert Markdown to interactive mind - map HTML.
• Support generating offline - available mind maps.
• Provide an optional function to hide the toolbar.
• Offer two modes: returning HTML content or file paths.

📦 Installation

Method 1: Local Installation

# Globally install using the npm package manager
npm install -g markmap-cli

# Install this MCP server project
git clone https://github.com/YuChenSSR/mindmap-mcp-server.git
cd mindmap-mcp-server
npm install

Method 2: Docker Installation

docker pull yuchen/mindmap-mcp-server:latest

# Start the container and map the port to 3000
docker run -p 3000:3000 yuchen/mindmap-mcp-server:latest

Method 3: Recommended for Windows Users

If you encounter issues when using markmap-cli on Windows, consider the following methods:

1. Install using Docker (recommended).
2. Install Visual Studio Code and use the Markmap plugin.

💻 Usage Examples

Configure for Claude Desktop Version

1. Open the ~/.config/claude/settings.json file.
2. Add the following configuration:

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

3. Restart the Claude desktop application.

Usage with Other MCP Clients

This server is compatible with all clients that comply with the MCP protocol and supports interaction through standard APIs.

Example Conversations in Claude

Request to Generate a Mind Map

Give me a mind map to display the following Markdown code, using the mind - mapping tool:
# Project Plan
## Research
### Market Analysis
### Competitor Review
## Design
### Wireframes
### Templates

Request to Save and Open a File

Use the mind - mapping tool to convert the following Markdown content into a mind map, then open the generated HTML file in the terminal.
Input content:
<Paste your Markdown code>

Dynamic Thinking Process

Imagine how to put an elephant in a refrigerator and provide a mind map. Open it in the terminal.

📚 Documentation

Troubleshooting Guide

1. File Not Found

• Symptom: The server returns a 404 error, indicating that the file does not exist.
• Solution:
  • Check if the target path is correct.
  • Ensure that the generated file name matches the request.

2. Docker Command Not Recognized

• Symptom: The system prompts that the Docker command is not found when you enter it.
• Solution:
  • Install and configure the Docker environment.
  • Add Docker to the system PATH variable.

3. Port Conflict Issue

• Symptom: An error occurs when starting the server, indicating that the port is occupied.
• Solution:
  • Stop the process that is using the port.
  • Or modify the server configuration to use a different port number (e.g., 3001).

Advanced Usage

Batch Processing

You can batch - convert multiple Markdown files into mind maps and manage them through the API.

Custom Styles

You can customize the style of the generated HTML page using CSS. For specific methods, refer to the markmap-cli documentation.

📄 License

This project follows the MIT open - source license. For details, please see the LICENSE file.

⚠️ Important Note

All three installation methods have been successfully tested on macOS and Linux systems.

💡 Usage Tip

If Windows users encounter issues with npx, it is recommended to use Docker or the Markmap plugin in Visual Studio Code.

Contribution Guide

Welcome to submit Pull Requests or Issues to improve this project together!