Yuchenssr Mindmap MCP Server

🚀 Mindmap MCP Server

This project is a server that supports the conversion from Markdown to interactive mind - map HTML, providing multiple installation and usage methods.

🚀 Quick Start

This server supports multiple installation and startup methods. You can choose the appropriate method according to your needs.

✨ Features

• Support the conversion from Markdown to interactive mind - map HTML.
• Provide offline function options.
• Allow hiding the toolbar.
• Support two modes: returning HTML content or file path.

📦 Installation

Install with npm

Run the following command in the terminal:

npm install -g @markmap/markmap-cli

Install by cloning the source code

1. Create a new directory and clone the repository:

git clone https://github.com/YuChenSSR/mindmap-mcp-server.git
cd mindmap-mcp-server

2. Install dependencies:

npm install

Deploy with Docker

1. Pull the image:

docker pull yuchen/mindmap-mcp-server:latest

2. Run the container:

docker run -it --rm yuchen/mindmap-mcp-server:latest

💻 Usage Examples

Basic Usage

Run the following command in the terminal to start the server:

mindmap-server start

Or specify a configuration file:

mindmap-server start --config ./config.json

Advanced Usage

Run as a service

Set it as a background service:

mindmap-server run

Use with other MCP clients

This server is compatible with any client that conforms to the MCP protocol and supports the following command:

mcp --server mindmap --help

API call example

Call through an HTTP request:

curl -X POST http://localhost:3000/mindmap \
-d '{"markdown": "## Hello World\n### Basic Usage", "toolbar": true}'

📚 Documentation

Configuration Options

Edit the config.json file and add the following content:

{
  "port": 3000,
  "debug": true,
  "toolbarEnabled": true
}

Example Usage

Enter the following content in Claude Desktop: 1.

Generate a mind map for the following Markdown code:
# Project Plan
## Research
### Market Analysis
### Competitor Analysis
## Design
### Interface Sketch
### Template Design
## Development
### Front - end Development
### Back - end Development
## Testing
### Unit Testing
### User Testing

Convert the following Markdown content to a mind map and open it using a terminal tool.
Markdown content:
# Core Concepts
## Data Structures
### Arrays
### Objects
## Algorithms
### Sorting Algorithms
### Search Algorithms
## Design Patterns
### Example Pattern
### Factory Pattern

Think about the process of putting an elephant in a refrigerator and generate a mind map. Then open it via the terminal.

Troubleshooting

• File not found:

  • Ensure that the Docker container has correctly mounted the volume.
  • Check if the path format is correct.
  • Confirm that Docker has permission to access the directory.

• Docker command not recognized:

  • Verify that Docker is installed and added to the PATH.
  • Try using the absolute path of Docker.

• Server not displayed in Claude:

  • Restart the Claude Desktop software.
  • Check for connection errors in the logs.
  • Confirm that Docker is running normally.

📄 License

This project follows the MIT license. Please refer to the LICENSE file in the project repository for specific details.

Thank you for your support and use! If you need help, please contact the maintenance team at any time.