mindmap-mcp-server
by: YuChenSSR
mindmap, mcp server, artifact
📌Overview
Purpose: The Mindmap MCP Server aims to convert Markdown content into interactive mindmaps efficiently.
Overview: The Mindmap MCP Server is a configurable tool that leverages the Model Context Protocol to transform Markdown formatted text into engaging, interactive mindmaps. It supports multiple usage methods including command-line interfaces, Python scripts, and Docker deployments, allowing for flexible integration into various environments.
Key Features:
-
Markdown to Mindmap Conversion: Converts Markdown text into interactive mindmap HTML, making visual representation of information easy to access and understand.
-
Custom Output Options: Users can choose whether to receive the mindmap as direct HTML content or as a saved file, allowing for both immediate viewing and later access while conserving computational resources.
Mindmap MCP Server
A Model Context Protocol (MCP) server for converting Markdown content to interactive mindmaps.
Installation
pip install mindmap-mcp-server
Or using uvx
:
uvx mindmap-mcp-server
Or using docker
(safer and easier).
Prerequisites
Node.js must be installed when running the server using python
or uvx
.
Usage
With Claude Desktop or other MCP clients
Add this server to your claude_desktop_config.json
:
using `uvx`:
{
"mcpServers": {
"mindmap": {
"command": "uvx",
"args": ["mindmap-mcp-server", "--return-type", "html"]
}
}
}
or (recommended):
{
"mcpServers": {
"mindmap": {
"command": "uvx",
"args": ["mindmap-mcp-server", "--return-type", "filePath"]
}
}
}
Use --return-type
to specify the return type of the mindmap content, either html
or filePath
.
html
: returns entire HTML content of the mindmap for preview in your AI client's artifact.filePath
: saves the mindmap to a file and returns the file path to open in a browser. It can save your tokens.
using `python`:
Using a specific Python file in this repository:
{
"mcpServers": {
"mindmap": {
"command": "python",
"args": ["/path/to/your/mindmap_mcp_server/server.py", "--return-type", "html"]
}
}
}
or
{
"mcpServers": {
"mindmap": {
"command": "python",
"args": ["/path/to/your/mindmap_mcp_server/server.py", "--return-type", "filePath"]
}
}
}
See the uvx
usage section for more details about return types.
using `docker`:
Pull the image:
docker pull ychen94/mindmap-converter-mcp
Set the server:
{
"mcpServers": {
"mindmap-converter": {
"command": "docker",
"args": ["run", "--rm", "-i", "-v", "/path/to/output/folder:/output", "ychen94/mindmap-converter-mcp:latest"]
}
}
}
⚠️ Replace /path/to/output/folder
with your actual path for saving mind maps.
Tools Provided in the docker container:
-
markdown-to-mindmap-content
Converts Markdown to an HTML mind map and returns the entire HTML content.
Parameters:- markdown (string, required): Markdown content to convert
- toolbar (boolean, optional): Show toolbar (default: true)
Best for: Simple mind maps where content size isn't a concern, previewable as an artifact.
-
markdown-to-mindmap-file
Converts Markdown to an HTML mind map, saves it in the mounted directory.
Parameters:- markdown (string, required)
- filename (string, optional): Custom filename (default: timestamp)
- toolbar (boolean, optional): Show toolbar (default: true)
Best for: Complex mind maps, or saving tokens for later. Open the HTML file in a browser.
You may use the iterm-mcp-server or other terminals' MCP servers to open the file without interrupting your workflow.
Troubleshooting
- File Not Found: Verify volume mounting, path formats, and Docker permissions.
- Docker Command Not Found: Ensure Docker is installed and accessible.
- Server Not Appearing in Claude: Restart Claude, check logs, ensure Docker is running.
Advanced Usage
This server works with any MCP-compatible client following Model Context Protocol version 1.0.
Attention
Three installation methods are successfully tested on macOS and Linux.
For Windows users facing issues with npx
, consider the Docker method. Also, the Visual Studio Code "Markmap" extension offers an easier alternative.
Features
- Convert Markdown to interactive mindmap HTML
- Create offline-capable mindmaps
- Option to hide the toolbar
- Return HTML content or file path
Example
In Claude, you can ask:
"give a mindmap for the following markdown code, using a mindmap tool:"
# Project Planning
## Research
### Market Analysis
### Competitor Review
## Design
### Wireframes
### Mockups
## Development
### Frontend
### Backend
## Testing
### Unit Tests
### User Testing
"give a mindmap for the following markdown input_code using a mindmap tool, after that, use iterm to open the generated html file. input_code:"
markdown content
"Think about the process of putting an elephant into a refrigerator, and provide a mind map. Open it with a terminal."
License
This project is licensed under the MIT License.
For details, see the LICENSE file in this project repository: https://github.com/YuChenSSR/mindmap-mcp-server
If this project is helpful to you, please consider giving it a Star ⭐️
The advancement of technology ought to benefit all individuals rather than exploit the general populace.