Unreal Engine Binary Reader MCP server

The Binary Reader MCP server provides tools for reading and analyzing binary files, with a current focus on Unreal Engine asset files (.uasset). It helps you extract metadata and structure from binary files and can automatically detect various file formats.

Installation

Follow these steps to install the Binary Reader MCP server:

1. Clone the repository:

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

2. Create a virtual environment and activate it:

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

3. Install dependencies:

   pip install -r requirements.txt
   

Usage

The Binary Reader MCP server provides several tools through the Model Context Protocol:

Reading Unreal Asset Files

You can analyze Unreal Engine asset files (.uasset) using the following MCP command:

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

This will extract and return the structure and metadata of the Unreal Engine asset file.

Reading Generic Binary Files

For other binary file formats, you can use the generic binary metadata reader:

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

The format parameter can be:

• auto: Automatically detect the file format
• unreal: Force processing as an Unreal Engine asset
• custom: Use custom format parsing (if available)

Features

The Binary Reader MCP server includes:

• File format auto-detection
• Detailed structure analysis for supported formats
• Metadata extraction from binary files
• Support for Unreal Engine .uasset files
• Extensible design for future format support

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "binary-reader-mcp" '{"command":"python","args":["-m","main"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "binary-reader-mcp": {
            "command": "python",
            "args": [
                "-m",
                "main"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "binary-reader-mcp": {
            "command": "python",
            "args": [
                "-m",
                "main"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect