Skip to main content

MCP server for converting Markdown to mindmaps

Project description

Mindmap MCP Server

mindmap_mcp

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

This package requires Node.js to be installed when using command python or uvx to run the server.

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"]
    }
  }
}

we use --return-type to specify the return type of the mindmap content, you can choose html or filePath according to your needs.
html will return the entire HTML content of the mindmap, which you can preview in your AI client's artifact;

return_html_content

html_preview

filePath will save the mindmap to a file and return the file path,which you can open in your browser. It can save your tokens !

generate_file

file_to_open

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"]
    }
  }
}

we use --return-type to specify the return type of the mindmap content, you can choose html or filePath according to your needs. see using `uvx` for more details.

using `docker`:

First, you pull the image:

docker pull ychen94/mindmap-converter-mcp

Second, 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 an actual path on your system where you want to save mind maps, such as /Users/username/Downloads on macOS or C:\\Users\\username\\Downloads on Windows.

Tools Provided in the docker container The server provides the following MCP tools:

  1. markdown-to-mindmap-content
    Converts Markdown to an HTML mind map and returns the entire HTML content.
    You don't use the args: -v and /path/to/output/folder:/output in the command docker.
    Parameters:
    • markdown (string, required): The Markdown content to convert
    • toolbar (boolean, optional): Whether to show the toolbar (default: true)
    Best for: Simple mind maps where the HTML content size isn't a concern. And you can use artifact in your AI client to preview the mindmap.
  2. markdown-to-mindmap-file
    Converts Markdown to an HTML mind map and saves it to a file in the mounted directory.
    Parameters:
    • markdown (string, required): The Markdown content to convert
    • filename (string, optional): Custom filename (default: auto-generated timestamp name)
    • toolbar (boolean, optional): Whether to show the toolbar (default: true)
    Best for: Complex mind maps or when you want to save the tokens for later use.
    you can open the html file in your browser to view the mindmap. Also you can use the iterm-mcp-server or other terminals' mcp servers to open the file in your browser without interrupting your workflow.

Troubleshooting

File Not Found
If your mind map file isn't accessible:
1 Check that you've correctly mounted a volume to the Docker container
2 Ensure the path format is correct for your operating system
3 Make sure Docker has permission to access the directory

Docker Command Not Found
1 Verify Docker is installed and in your PATH
2 Try using the absolute path to Docker

Server Not Appearing in Claude
1 Restart Claude for Desktop after configuration changes
2 Check Claude logs for connection errors
3 Verify Docker is running

Advanced Usage
Using with Other MCP Clients

This server works with any MCP-compatible client, not just Claude for Desktop. The server implements the Model Context Protocol (MCP) version 1.0 specification.

Attention

Three installation methods have been successfully tested on macOS and Linux.

For Windows users experiencing issues with npx for this MCP, consider using the Docker method. Alternatively, if you use Visual Studio Code, the "Markmap" extension offers a potentially simpler solution than navigating command-line tools.

Features

This server provides a tool for converting Markdown content to mindmaps using the markmap-cli library:

  • Convert Markdown to interactive mindmap HTML
  • Option to create offline-capable mindmaps
  • Option to hide the toolbar
  • Return either 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

"

if you want to save the mindmap to a file, and then open it in your browser using the iTerm MCP server:

"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."

see the result

aiworkflow

mindmapinbrowser

and more

License

This project is licensed under the MIT License. For more details, please see the LICENSE file in this project repository


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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_mindmap_mcp_server-0.1.1.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_mindmap_mcp_server-0.1.1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file mseep_mindmap_mcp_server-0.1.1.tar.gz.

File metadata

  • Download URL: mseep_mindmap_mcp_server-0.1.1.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for mseep_mindmap_mcp_server-0.1.1.tar.gz
Algorithm Hash digest
SHA256 eff2eeaa0cace3bd9b6dd80fc9685320c579963245b17ecd45ed417c89ca3c45
MD5 af8675fdcbf6819e919d0f8e9c809124
BLAKE2b-256 00806515b7dacf28e7d93ef29d3ff1ee2b444035169a4575137dedd619906985

See more details on using hashes here.

File details

Details for the file mseep_mindmap_mcp_server-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mseep_mindmap_mcp_server-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d0394f0fc636340a77af4e91a834c60e8169f6cedf485931becf6558397109d
MD5 9e459ecdb23e6334753fa5a0f46faf83
BLAKE2b-256 e00d0db3d18e809a30b7789e8e45eb1807b48d2b767d4d76785904217087c35a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page