Xmind Generator MCP

🚀 XMind Generator MCP Server

A server that generates XMind mind maps through the MCP (Model Context Protocol). This server allows Large Language Models (LLMs) to create structured mind maps via the MCP protocol.

🚀 Quick Start

The XMind Generator MCP Server enables LLMs to create structured mind maps using the MCP protocol. It offers a range of features and can be easily integrated with Claude Desktop and other MCP clients.

✨ Features

• Generate XMind mind maps with hierarchical topics.
• Support topic notes, labels, and markers.
• Save mind maps to local files.
• Facilitate easy integration for use with Claude Desktop and other MCP clients.

📦 Installation

Prerequisites

• Node.js: Version 18 or higher is required.
• XMind: Install the XMind desktop application to open and edit the generated mind maps.
• Claude Desktop: Necessary for using this tool as an extension.

Setting up with Claude Desktop

Option 1: Using npx (Recommended)

1. Create or edit the Claude Desktop configuration file:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
2. Add the following configuration:

   {
     "mcpServers": {
       "xmind-generator": {
         "command": "npx",
         "args": ["xmind-generator-mcp"],
         "env": {
           "outputPath": "/path/to/save/xmind/files",
           "autoOpenFile": "false"
         }
       }
     }
   }
   

3. Restart Claude Desktop.
4. Start using the XMind Generator in conversations.

Option 2: Local Installation

1. Clone the repository:

   git clone https://github.com/BangyiZhang/xmind-generator-mcp.git
   cd xmind-generator-mcp
   npm install
   npm run build
   

2. Create or edit the Claude Desktop configuration file:
   • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
3. Add the following configuration:

   {
     "mcpServers": {
       "xmind-generator": {
         "command": "node",
         "args": ["path/to/xmind-generator-mcp/dist/index.js"],
         "env": {
           "outputPath": "/path/to/save/xmind/files",
           "autoOpenFile": "false"
         }
       }
     }
   }
   

4. Replace path/to/xmind-generator-mcp with the actual path where you cloned the project.
5. Restart Claude Desktop.
6. Start using the XMind Generator in conversations.

Note: The env section is optional. It allows you to set environment variables for the server:

• outputPath: Specifies the location of the output folder, with the default being ./xmind_output.
• autoOpenFile: Controls whether to automatically open the generated mind map, with values of "true" or "false".

💻 Usage Examples

Available Tools

generate-mind-map

Description

Generate an XMind mind map.

Parameters

Example

{
  "title": "My First XMind Mind Map",
  "content": {
    "topic": "Start",
    "children": [
      {
        "topic": "Step 1",
        "notes": "Perform the first step operation"
      },
      {
        "topic": "Step 2",
        "notes": "Perform the second step operation",
        "children": [
          {
            "topic": "Sub-step 2.1",
            "notes": "Provide detailed instructions for the sub-step of Step 2"
          }
        ]
      }
    ]
  }
}

Output

The generated XMind file will be saved to the outputPath you specified or the default folder.

Complete Call Example

npx xmind-generator-mcp --generate-mind-map --content='{
  "title": "Project Plan",
  "content": {
    "topic": "Project Overview",
    "children": [
      {
        "topic": "Goals",
        "notes": "Complete product development"
      },
      {
        "topic": "Timeline",
        "notes": "Deadline: 2024-12-31",
        "children": [
          {
            "topic": "Phase 1",
            "notes": "Requirement analysis",
            "end_date": "2024-01-15"
          },
          {
            "topic": "Phase 2",
            "notes": "Development",
            "end_date": "2024-03-15"
          }
        ]
      }
    ]
  }
}'

📄 License

This project is licensed under the MIT License.