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 文件。