Skip to content
Back to search

mindmap-mcp-server

mindmap, mcp server, artifact

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/yuchenssr--mindmap-mcp-server/badge.svg)](/listings/yuchenssr--mindmap-mcp-server)

HTML

<a href="/listings/yuchenssr--mindmap-mcp-server"><img src="/api/listings/yuchenssr--mindmap-mcp-server/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

pip install mindmap-mcp-server

Or using `uvx`:

uvx mindmap-mcp-server

Or using `docker` safer and easier.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 342 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Mindmap MCP Server
  2. <p align="center">
  3. <img src="https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-21/JMi7Mn89Hw5ikd9z.jpeg" alt="mindmap_mcp" width="50%">
  4. </p>
  5. A Model Context Protocol (MCP) server for converting Markdown content to interactive mindmaps.
  6. ## Installation
  7. ```bash
  8. pip install mindmap-mcp-server
  9. ```
  10. Or using `uvx`:
  11. ```bash
  12. uvx mindmap-mcp-server
  13. ```
  14. Or using `docker` safer and easier.
  15. ## Attention
  16. Three installation methods have been successfully tested on macOS and Linux.
  17. For Windows users experiencing issues with `npx` for this MCP, consider using the Docker method. Alternatively, if you use Visual Studio Code, the ["Markmap"](https://marketplace.visualstudio.com/items?itemName=gera2ld.markmap-vscode) extension offers a potentially simpler solution than navigating command-line tools.
  18. ---
  19. If you're experiencing unresolved issues, you can use my recent system prompt as a Mindmap Assistant instead of using this MCP server.
  20. <details>
  21. <summary>Using my system prompt instead of using this MCP server</summary>
  22. ```
  23. You are a specialized assistant that generates HTML code for interactive markdown-based mind maps (markmaps). When a user sends you content, respond with a complete HTML document that displays their content as a markmap visualization.
  24. If artifact tool is turned on, you can use the artifact.
  25. Follow these requirements:
  26. 1. Use the markmap-autoloader library (version 0.18 or latest stable version)
  27. 2. Format the HTML exactly according to the template below
  28. 3. Replace the demo content in the template with the user's content, preserving their hierarchical structure
  29. 4. Maintain the markmap configuration options (maxWidth: 300, colorFreezeLevel: 2)
  30. 5. If the user doesn't provide markdown formatting (# for headings), format their content appropriately with main topics using # and subtopics using ##
  31. Template to follow:
  32. <!DOCTYPE html>
  33. <html lang="en">
  34. <head>
  35. <meta charset="UTF-8" />
  36. <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  37. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  38. <title>Markmap</title>
  39. <style>
  40. svg.markmap {
  41. width: 100%;
  42. height: 100vh;
  43. }
  44. </style>
  45. <script src="https://cdn.jsdelivr.net/npm/markmap-autoloader@0.18"></script>
  46. </head>
  47. <body>
  48. <div class="markmap">
  49. <script type="text/template">
  50. ---
  51. markmap:
  52. maxWidth: 300
  53. colorFreezeLevel: 2
  54. ---
  55. # markmap
  56. ## Links
  57. - <https://markmap.js.org/>
  58. - [GitHub](https://github.com/markmap/markmap)
  59. ## Related
  60. - [coc-markmap](https://github.com/markmap/coc-markmap)
  61. - [gatsby-remark-markmap](https://github.com/markmap/gatsby-remark-markmap)
  62. ## Features
  63. - links
  64. - **inline** ~~text~~ *styles*
  65. - multiline
  66. text
  67. - `inline code`
  68. - Katex - $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$
  69. - This is a very very very very very very very very very very very very very very very long line.
  70. </script>
  71. </div>
  72. </body>
  73. </html>
  74. ```
  75. *Visualization options:* (If formulas or symbols don’t display correctly, download the HTML file and open it in a browser.)
  76. 1. View the mindmap in artifacts (if available):
  77. ![system_prompt_artifact](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-05-20/1i9LIfoVRdCV97HM.png)
  78. 2. Render the HTML file as a mindmap:
  79. ![system_prompt_render](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-05-20/qv4ActvFaphc64oA.png)
  80. </details>
  81. ---
  82. ## Prerequisites
  83. This package requires Node.js to be installed when using command `python` or `uvx` to run the server.
  84. ## Usage
  85. ### With Claude Desktop or other MCP clients
  86. Add this server to your `claude_desktop_config.json`:
  87. <details>
  88. <summary>using `uvx`:</summary>
  89. ```json
  90. {
  91. "mcpServers": {
  92. "mindmap": {
  93. "command": "uvx",
  94. "args": ["mindmap-mcp-server", "--return-type", "html"]
  95. }
  96. }
  97. }
  98. ```
  99. or
  100. recommended:
  101. ```json
  102. {
  103. "mcpServers": {
  104. "mindmap": {
  105. "command": "uvx",
  106. "args": ["mindmap-mcp-server", "--return-type", "filePath"]
  107. }
  108. }
  109. }
  110. ```
  111. we use `--return-type` to specify the return type of the mindmap content, you can choose `html` or `filePath` according to your needs.
  112. `html` will return the entire HTML content of the mindmap, which you can preview in your AI client's artifact;
  113. ![return_html_content](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-20/qAEimhwZJDQ3NBLs.png)
  114. ![html_preview](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-21/SujqY2L5lhWSHWvi.png)
  115. `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** !
  116. ![generate_file](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-20/WDqlWhsoiAYpLmBF.png)
  117. ![file_to_open](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-20/jfRIDc5mfvNtKykC.png)
  118. </details>
  119. <details>
  120. <summary>using `python`:</summary>
  121. Using [a specific Python file](https://github.com/YuChenSSR/mindmap-mcp-server/blob/main/mindmap_mcp_server/server.py) in this repository:
  122. ```json
  123. {
  124. "mcpServers": {
  125. "mindmap": {
  126. "command": "python",
  127. "args": ["/path/to/your/mindmap_mcp_server/server.py", "--return-type", "html"]
  128. }
  129. }
  130. }
  131. ```
  132. or
  133. ```json
  134. {
  135. "mcpServers": {
  136. "mindmap": {
  137. "command": "python",
  138. "args": ["/path/to/your/mindmap_mcp_server/server.py", "--return-type", "filePath"]
  139. }
  140. }
  141. }
  142. ```
  143. 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.
  144. </details>
  145. <details>
  146. <summary>using `docker`:</summary>
  147. First, you pull the image:
  148. ```bash
  149. docker pull ychen94/mindmap-converter-mcp
  150. ```
  151. Second, set the server:
  152. ```json
  153. {
  154. "mcpServers": {
  155. "mindmap-converter": {
  156. "command": "docker",
  157. "args": ["run", "--rm", "-i", "-v", "/path/to/output/folder:/output", "ychen94/mindmap-converter-mcp:latest"]
  158. }
  159. }
  160. }
  161. ```
  162. ⚠️ 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.
  163. **Tools Provided in the docker container**
  164. The server provides the following MCP tools:
  165. 1. **markdown-to-mindmap-content**
  166. Converts Markdown to an HTML mind map and returns the entire HTML content.
  167. You don't use the args: `-v` and `/path/to/output/folder:/output` in the command `docker`.
  168. **Parameters**:
  169. • markdown (string, required): The Markdown content to convert
  170. • toolbar (boolean, optional): Whether to show the toolbar (default: true)
  171. **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.
  172. 2. **markdown-to-mindmap-file**
  173. Converts Markdown to an HTML mind map and saves it to a file in the mounted directory.
  174. **Parameters**:
  175. • markdown (string, required): The Markdown content to convert
  176. • filename (string, optional): Custom filename (default: auto-generated timestamp name)
  177. • toolbar (boolean, optional): Whether to show the toolbar (default: true)
  178. **Best for**: Complex mind maps or when you want to **save the tokens** for later use.
  179. you can open the html file in your browser to view the mindmap. Also you can use the [iterm-mcp-server](https://github.com/ferrislucas/iterm-mcp) or other terminals' mcp servers to open the file in your browser without interrupting your workflow.
  180. </details>
  181. ### Troubleshooting
  182. **File Not Found**
  183. If your mind map file isn't accessible:
  184. 1 Check that you've correctly mounted a volume to the Docker container
  185. 2 Ensure the path format is correct for your operating system
  186. 3 Make sure Docker has permission to access the directory
  187. **Docker Command Not Found**
  188. 1 Verify Docker is installed and in your PATH
  189. 2 Try using the absolute path to Docker
  190. **Server Not Appearing in Claude**
  191. 1 Restart Claude for Desktop after configuration changes
  192. 2 Check Claude logs for connection errors
  193. 3 Verify Docker is running
  194. **Advanced Usage
  195. Using with Other MCP Clients**
  196. 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.
  197. ## Features
  198. This server provides a tool for converting Markdown content to mindmaps using the `markmap-cli` library:
  199. - Convert Markdown to interactive mindmap HTML
  200. - Option to create offline-capable mindmaps
  201. - Option to hide the toolbar
  202. - Return either HTML content or file path
  203. ## Example
  204. In Claude, you can ask:
  205. 1.
  206. "**give a mindmap for the following markdown code, using a mindmap tool:**
  207. ```
  208. # Project Planning
  209. ## Research
  210. ### Market Analysis
  211. ### Competitor Review
  212. ## Design
  213. ### Wireframes
  214. ### Mockups
  215. ## Development
  216. ### Frontend
  217. ### Backend
  218. ## Testing
  219. ### Unit Tests
  220. ### User Testing
  221. ```
  222. "
  223. if you want to save the mindmap to a file, and then open it in your browser using the iTerm MCP server:
  224. 2.
  225. "**give a mindmap for the following markdown input_code using a mindmap tool,
  226. after that,use iterm to open the generated html file.
  227. input_code:**
  228. ```
  229. markdown content
  230. ```
  231. "
  232. 3.
  233. "**Think about the process of putting an elephant into a refrigerator, and provide a mind map. Open it with a terminal.**"
  234. <details>
  235. <summary>see the result</summary>
  236. ![aiworkflow](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-22/QUjGnpmUcPfd3lBI.png)
  237. ![mindmapinbrowser](https://raw.githubusercontent.com/YuChenSSR/pics/master/imgs/2025-03-22/w7DZ4shFhLoQZruq.png)
  238. </details>
  239. **and more**
  240. ## License
  241. This project is licensed under the MIT License.
  242. For more details, please see the LICENSE file in [this project repository](https://github.com/YuChenSSR/mindmap-mcp-server)
  243. ---
  244. If this project is helpful to you, please consider giving it a Star ⭐️
  245. The advancement of technology ought to benefit all individuals rather than exploit the general populace.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.