Binary Reader MCP

🚀 二进制阅读器 MCP（模型上下文协议）服务器

这是一个用于读取和分析各种二进制文件的 Model Context Protocol 服务器。该服务器提供了一系列工具，可对多种二进制文件格式进行读取和分析，目前已支持虚幻引擎资产文件（.uasset）。

🚀 快速开始

本服务器借助 Model Context Protocol 提供多个实用工具，能帮助你读取和分析二进制文件。

✨ 主要特性

• 可读取和分析 Unreal Engine 的 .uasset 文件。
• 能够提取二进制文件的元数据和结构。
• 支持自动检测文件格式。
• 具备可扩展架构，方便添加对新二进制格式的支持。

📦 安装指南

克隆仓库

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

创建并激活虚拟环境

python -m venv venv
source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate

安装依赖项

pip install -r requirements.txt

💻 使用示例

基础用法

读取 Unreal 资产文件

# 示例通过 MCP 的使用方法
tool: read-unreal-asset
arguments:
    file_path: "path/to/your/asset.uasset"

读取通用二进制文件

# 示例通过 MCP 的使用方法
tool: read-binary-metadata
arguments:
    file_path: "path/to/your/file.bin"
    format: "auto"  # 或者 "unreal", "custom"

📚 详细文档

项目结构

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

添加新的二进制格式支持

若要添加对新二进制格式的支持，可按以下步骤操作：

1. 创建一个新的读者类，继承自 BinaryReader。
2. 实现所需的接口方法（read_header, read_metadata）。
3. 将新格式添加到自动检测文件格式的逻辑中。
4. 更新工具列表以包含新的格式。

贡献

1. 叉克隆仓库。
2. 创建功能分支 (git checkout -b feature/amazing-feature)。
3. 提交更改 (git commit -m 'Add some amazing feature')。
4. 推送到分支 (git push origin feature/amazing-feature)。
5. 打开 Pull Request。

📄 许可证

本项目遵循 MIT License，具体细节请查看 LICENSE 文件。