# dify-plugin-xmind-parser

**Repository Path**: azhengzz/dify-plugin-xmind-parser

## Basic Information

- **Project Name**: dify-plugin-xmind-parser
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-04
- **Last Updated**: 2025-11-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# XMind Parser Plugin

**Author:** zhangzheng
**Version:** 0.0.2
**Type:** Dify Tool Plugin

## Description

The XMind Parser is a Dify plugin that converts XMind files into programmable data types such as JSON and XML. This plugin supports both XMind Zen format (content.json) and legacy XMind format, automatically detecting the format and using the appropriate parser.

## Features

- Parse XMind files to JSON or XML format
- Support for both XMind Zen and legacy XMind formats
- Automatic format detection
- Easy integration with Dify platform
- Streamlined processing and caching for improved efficiency

## Installation

1. Clone this repository
2. Install the required dependencies:
   ```bash
   pip install -r requirements.txt
   ```

## Usage

### Running the Plugin

To run the plugin locally:
```bash
python -m main
```

### Using in Dify

1. Package the plugin for Dify deployment
2. Install the plugin in your Dify instance
3. Use the "xmind-parser" tool in your workflows

### Tool Parameters

The plugin accepts the following parameters:

- `xmind_file` (required): The XMind file to parse
- `output_type` (required): The output format, either "json" or "xml"

### Example Usage

```python
# Example of parsed output structure
{
  "content": "{parsed_xmind_content}",
  "content_type": "json"
}
```

## Architecture

The plugin follows a layered architecture:

1. **Plugin Layer**: `main.py` initializes the plugin runtime
2. **Provider Layer**: `provider/xmind-parser.py` handles provider-specific logic
3. **Tool Layer**: `tools/xmind-parser.py` implements the actual XMind parsing functionality
4. **Parsing Engine**: `tools/xmindparser/` contains the core logic for parsing XMind files

## Dependencies

- `dify_plugin`: Core Dify plugin SDK (version 0.4.0 to 0.6.x)
- `dicttoxml`: For converting parsed XMind data to XML format (version 1.7.16)

## Development

### Project Structure

```
xmind-parser/
├── main.py                 # Plugin entry point
├── manifest.yaml           # Plugin manifest
├── requirements.txt        # Python dependencies
├── GUIDE.md               # Dify plugin development guide
├── PRIVACY.md             # Privacy policy
├── README.md              # This file
├── readme/
│   └── README_zh_Hans.md  # Chinese documentation
├── provider/
│   ├── xmind-parser.py    # Provider implementation
│   └── xmind-parser.yaml  # Provider configuration
├── tools/
│   ├── xmind-parser.py    # Tool implementation
│   ├── xmind-parser.yaml  # Tool configuration
│   └── xmindparser/       # XMind parsing engine
└── _assets/
    ├── icon.svg           # Plugin icon
    └── icon-dark.svg      # Plugin icon (dark mode)
```

### Testing

Testing is typically done through the Dify platform by installing the plugin in debug mode and testing the tool functionality.

## License

This project is licensed under the MIT License - see the LICENSE file for details.

XMind parsing engine USES: https://github.com/tobyqin/xmindparser

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.