Markmap MCP Server

1# Markmap MCP Server
2 
3![Sample Mindmap](./docs/markmap.svg)
4 
5[![NPM Version](https://img.shields.io/npm/v/@jinzcdev/markmap-mcp-server.svg)](https://www.npmjs.com/package/@jinzcdev/markmap-mcp-server)
6[![GitHub License](https://img.shields.io/github/license/jinzcdev/markmap-mcp-server.svg)](LICENSE)
7[![Smithery Badge](https://smithery.ai/badge/@jinzcdev/markmap-mcp-server)](https://smithery.ai/server/@jinzcdev/markmap-mcp-server)
8[![中文文档](https://img.shields.io/badge/中文文档-点击查看-blue)](README_zh-CN.md)
9[![Stars](https://img.shields.io/github/stars/jinzcdev/markmap-mcp-server)](https://github.com/jinzcdev/markmap-mcp-server)
10 
11Markmap MCP Server is based on the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) that allows one-click conversion of Markdown text to interactive mind maps, built on the open source project [markmap](https://github.com/markmap/markmap). The generated mind maps support rich interactive operations and can be exported in various image formats.
12 
13> 🎉 **Explore More Mind Mapping Tools**
14>
15> Try [MarkXMind](https://github.com/jinzcdev/markxmind) - An online editor that creates complex mind maps using simple XMindMark syntax. It supports real-time preview, multi-format export (.xmind/.svg/.png), importing existing XMind files. [Try it now](https://markxmind.js.org/)!
16 
17## Features
18 
19- 🌠 **Markdown to Mind Map**: Convert Markdown text to interactive mind maps
20- 🖼️ **Multi-format Export**: Support for exporting as PNG, JPG, and SVG images
21- 🔄 **Interactive Operations**: Support for zooming, expanding/collapsing nodes, and other interactive features
22- 📋 **Markdown Copy**: One-click copy of the original Markdown content
23- 🌐 **Automatic Browser Preview**: Option to automatically open generated mind maps in the browser
24 
25## Prerequisites
26 
271. Node.js (v20 or above)
28 
29## Installation
30 
31### Installing via Smithery
32 
33To install Markmap MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@jinzcdev/markmap-mcp-server):
34 
35```bash
36npx -y @smithery/cli install @jinzcdev/markmap-mcp-server --client claude
37```
38 
39### Manual Installation
40 
41```bash
42# Install from npm
43npm install @jinzcdev/markmap-mcp-server -g
44 
45# Basic run
46npx -y @jinzcdev/markmap-mcp-server
47 
48# Specify output directory
49npx -y @jinzcdev/markmap-mcp-server --output /path/to/output/directory
50```
51 
52Alternatively, you can clone the repository and run locally:
53 
54```bash
55# Clone the repository
56git clone https://github.com/jinzcdev/markmap-mcp-server.git
57 
58# Navigate to the project directory
59cd markmap-mcp-server
60 
61# Build project
62npm install && npm run build
63 
64# Run the server
65node build/index.js
66```
67 
68## Usage
69 
70Add the following configuration to your MCP client configuration file:
71 
72```json
73{
74  "mcpServers": {
75    "markmap": {
76      "type": "stdio",
77      "command": "npx",
78      "args": ["-y", "@jinzcdev/markmap-mcp-server"],
79      "env": {
80        "MARKMAP_DIR": "/path/to/output/directory"
81      }
82    }
83  }
84}
85```
86 
87> [!TIP]
88>
89> The service supports the following environment variables:
90>
91> - `MARKMAP_DIR`: Specify the output directory for mind maps (optional, defaults to system temp directory)
92>
93> **Priority Note**:
94>
95> When both the `--output` command line argument and the `MARKMAP_DIR` environment variable are specified, the command line argument takes precedence.
96 
97## Available Tools
98 
99### markdown-to-mindmap
100 
101Convert Markdown text into an interactive mind map.
102 
103**Parameters:**
104 
105- `markdown`: The Markdown content to convert (required string)
106- `open`: Whether to automatically open the generated mind map in the browser (optional boolean, default is false)
107 
108**Return Value:**
109 
110```json
111{
112  "content": [
113    {
114      "type": "text",
115      "text": "JSON_DATA_OF_MINDMAP_FILEPATH"
116    }
117  ]
118}
119```
120 
121## License
122 
123This project is licensed under the [MIT](./LICENSE) License.
124