使用说明

项目简介

Markmap MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务，它利用开源项目 markmap 的能力，可以将 Markdown 格式的文本一键转换为功能丰富的交互式思维导图。生成的思维导图支持多种操作，并可以导出为图片文件。

主要功能点

• Markdown 转思维导图: 将输入的 Markdown 文本快速转换为交互式 HTML 格式的思维导图。
• 多种格式导出: 支持将生成的思维导图导出为 PNG、JPG 和 SVG 图片文件。
• 交互操作: 在浏览器中查看思维导图时，支持节点展开/折叠、缩放等交互功能。
• 复制 Markdown: 提供一键复制原始 Markdown 内容的功能。
• 自动浏览器预览: 可选择在生成思维导图后自动在浏览器中打开。

安装步骤

本项目需要 Node.js 运行环境。

通过 npm 全局安装：

npm install @jinzcdev/markmap-mcp-server -g

提示：对于支持 Smithery 的 MCP 客户端（如 Claude Desktop），也可以使用 Smithery 自动安装：'npx -y @smithery/cli install @jinzcdev/markmap-mcp-server --client <your-client-name>'

服务器配置

Markmap MCP 服务器是一个给 MCP 客户端（如大型语言模型应用）调用的后端服务。要让客户端能够使用此服务，需要在客户端的 MCP 服务器配置中添加相应的条目。

配置通常是一个 JSON 对象，包含服务器的名称、连接方式（如 Stdio 标准 I/O）以及启动服务器所需的命令和参数。

基本配置信息如下：

• 服务器名称 (Name): 用于在客户端中标识此服务器的唯一名称，例如 'markmap'。
• 连接类型 (Type): 指定客户端如何与服务器通信，例如 'stdio' 表示使用标准输入/输出流。
• 启动命令 (Command): 执行服务器程序的命令，例如使用 'npx' 来运行已安装的全局包。
• 启动参数 (Args): 传递给启动命令的参数列表，例如 '@jinzcdev/markmap-mcp-server' 指定要运行的包，'--output' 参数后接一个目录路径，用于指定生成思维导图 HTML 文件的存放位置。可以根据需要修改此路径。

客户端会将此配置用于启动并连接到 Markmap MCP 服务器。

基本使用方法

一旦 Markmap MCP 服务器成功运行并连接到 MCP 客户端，客户端（如 LLM）就可以通过调用服务器暴露的 工具 (Tool) 来利用其功能。

该服务器提供一个名为 'markdown_to_mindmap' 的工具。LLM 客户端可以通过 MCP 协议调用此工具，并传递以下参数：

• 'markdown' (字符串, 必需): 包含需要转换为思维导图的 Markdown 格式文本。
• 'open' (布尔值, 可选, 默认 'false'): 指定是否在生成后自动在浏览器中打开生成的思维导图文件。

工具执行成功后，会返回一个结果，其中包含生成好的思维导图 HTML 文件的存放路径。客户端可以利用此路径来访问或显示生成的思维导图。