Binary Reader MCP

🚀 Binary Reader MCP (Model Context Protocol) Server

This is a Model Context Protocol server designed for reading and analyzing various binary files. It offers tools to read and analyze multiple binary file formats, currently supporting Unreal Engine asset files (.uasset).

🚀 Quick Start

This server provides multiple tools via the Model Context Protocol for binary file analysis.

✨ Features

• Read and analyze Unreal Engine .uasset files.
• Extract metadata and structure from binary files.
• Automatically detect file formats.
• Have an extensible architecture to add support for new binary formats.

📦 Installation

1. Clone the repository:

git clone https://github.com/berlinbra/binary-reader-mcp.git
cd binary-reader-mcp

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

💻 Usage Examples

Basic Usage

1. Read Unreal asset files

# Example usage via MCP
tool: read-unreal-asset
arguments:
    file_path: "path/to/your/asset.uasset"

2. Read generic binary files

# Example usage via MCP
tool: read-binary-metadata
arguments:
    file_path: "path/to/your/file.bin"
    format: "auto"  # Or "unreal", "custom"

📚 Documentation

Project Structure

binary-reader-mcp/
├── README.md
├── requirements.txt
├── main.py
├── src/
│   ├── __init__.py
│   ├── binary_reader/
│   │   ├── __init__.py
│   │   ├── base_reader.py
│   │   ├── unreal_reader.py
│   │   └── utils.py
│   ├── api/
│   │   ├── __init__.py
│   │   ├── routes.py
│   │   └── schemas.py
│   └── config.py
└── tests/
    ├── __init__.py
    ├── test_binary_reader.py
    └── test_api.py

Add Support for New Binary Formats

To add support for a new binary format:

1. Create a new reader class that inherits from BinaryReader.
2. Implement the required interface methods (read_header, read_metadata).
3. Add the new format to the logic for automatically detecting file formats.
4. Update the tool list to include the new format.

🤝 Contribution

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.