项目简介

Binary Reader MCP 是一个基于 Model Context Protocol (MCP) 的服务器，专注于二进制文件读取和分析。它提供了一系列工具，用于解析不同格式的二进制文件，最初支持 Unreal Engine 的 .uasset 资源文件。该服务器旨在为大型语言模型（LLM）客户端提供结构化的二进制文件信息，以便 LLM 能够理解和利用这些数据。

主要功能点

• Unreal Engine .uasset 文件分析: 能够读取和解析 Unreal Engine 的 .uasset 资源文件，提取文件头和元数据信息。
• 通用二进制文件元数据读取: 提供读取通用二进制文件元数据的能力，并支持自动或手动指定文件格式进行解析。
• 可扩展的架构: 易于扩展，可以添加对新的二进制文件格式的支持。
• MCP 协议支持: 遵循 Model Context Protocol，通过 JSON-RPC 协议与客户端通信，提供工具注册和调用功能。

安装步骤

1. 克隆仓库

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

2. 创建并激活虚拟环境

   python -m venv venv
   source venv/bin/activate   # Linux/macOS
   # venv\Scripts\activate  # Windows
   

3. 安装依赖

   pip install -r requirements.txt
   

服务器配置

Binary Reader MCP 服务器通过标准输入/输出 (stdio) 与 MCP 客户端进行通信。以下是 MCP 客户端配置服务器连接的示例 JSON 格式信息。

{
    "serverName": "binary_reader",
    "command": "python",
    "args": ["main.py"]
}

配置参数说明:

• 'serverName': 服务器名称，这里设置为 "binary_reader"。
• 'command': 启动服务器的命令，通常是 Python 解释器。
• 'args': 传递给启动命令的参数，指定运行 'main.py' 文件。确保在 MCP 客户端的工作目录下可以找到 'main.py' 文件，或者使用绝对路径。

注意: 确保您的系统已安装 Python 环境，并且在运行 MCP 客户端时，虚拟环境已激活，以便正确加载项目依赖。

基本使用方法

Binary Reader MCP 服务器提供了以下工具供 MCP 客户端调用：

1. 读取 Unreal 资源文件 (read-unreal-asset)

   用于分析 Unreal Engine 的 .uasset 文件。客户端需要提供文件路径作为参数。

   工具名称: 'read-unreal-asset'

   参数:

   {
       "tool": "read-unreal-asset",
       "arguments": {
           "file_path": "path/to/your/asset.uasset"  //  替换为实际的 .uasset 文件路径
       }
   }
   

2. 读取通用二进制文件元数据 (read-binary-metadata)

   用于读取通用二进制文件的元数据。客户端需要提供文件路径，并可以选择指定文件格式（"auto", "unreal", "custom"）。

   工具名称: 'read-binary-metadata'

   参数:

   {
       "tool": "read-binary-metadata",
       "arguments": {
           "file_path": "path/to/your/file.bin",  // 替换为实际的二进制文件路径
           "format": "auto"                     // 可选，文件格式，默认为 "auto"
       }
   }
   

   服务器将返回包含文件分析结果的文本内容，例如文件头信息和元数据。客户端可以解析这些文本内容，并将其用于后续的 LLM 任务。