[{"_1":2,"_456":-5,"_457":-5},"loaderData",{"_3":4,"_22":23,"_287":288},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":-5},"attributes",[15],"bot","id",17365307,"membership","referenceId","0199a0f5-80f3-75d9-86a5-0e41e3be6810","userAccount","routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_24":25,"_80":-5,"_81":38,"_27":82,"_203":204,"_286":186},"availableLocales",[26,38,45,52,59,66,73],{"_27":28,"_31":35,"_36":37},"mcpServer",{"_29":30,"_31":32,"_33":34},"description","Ein Model Context Protocol-Server, der es KI-Assistenten ermöglicht, auf YARA-Regeln basierende Bedrohungsanalysen für Dateien und URLs durchzuführen und so eine umfassende Regelverwaltung und detaillierte Scan-Ergebnisse zu unterstützen.","name","YaraFlux MCP-Server","readme","# YaraFlux MCP-Server\n\n[![GitHub-Version (aktuellste nach Datum)](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases) [![CI](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions) [![Codecov](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux) [![Codacy-Abzeichen](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh\\&utm_medium=referral\\&utm_content=\\&utm_campaign=Badge_grade) [![Lizenz: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Python-Version](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/) [![FastAPI](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/) [![MCP](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol) [![Codestil: schwarz](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nEin Model Context Protocol (MCP)-Server für YARA-Scans, der LLMs die Möglichkeit bietet, Dateien mit YARA-Regeln zu analysieren.\n\n## 📋 Übersicht\n\nDer YaraFlux MCP Server ermöglicht KI-Assistenten die Durchführung von YARA-regelbasierten Bedrohungsanalysen über die standardisierte Model Context Protocol-Schnittstelle. Der Server integriert YARA-Scanning mit modernen KI-Assistenten und unterstützt so umfassendes Regelmanagement, sicheres Scanning und detaillierte Ergebnisanalysen durch eine modulare Architektur.\n\n## 🧩 Architekturübersicht\n\n```\n+------------------------------------------+\n| AI Assistant |\n+--------------------+---------------------+\n |\n | Model Context Protocol\n |\n+--------------------v---------------------+\n| YaraFlux MCP Server |\n| |\n| +----------------+ +---------------+ |\n| | MCP Server | | Tool Registry | |\n| +-------+--------+ +-------+-------+ |\n| | | |\n| +-------v--------+ +-------v-------+ |\n| | YARA Service | | Storage Layer | |\n| +----------------+ +---------------+ |\n| |\n+------------------------------------------+\n | |\n +-----------------+ +---------------+\n | YARA Engine | | Storage |\n | - Rule Compiling| | - Local FS |\n | - File Scanning | | - MinIO/S3 |\n +-----------------+ +---------------+\n```\n\nYaraFlux folgt einer modularen Architektur, die Belange trennt zwischen:\n\n* **MCP-Integrationsschicht** : Bewältigt die Kommunikation mit KI-Assistenten\n* **Tool-Implementierungsebene** : Implementiert die YARA-Scan- und Verwaltungsfunktionalität\n* **Speicherabstraktionsschicht** : Bietet flexible Speicheroptionen\n* **YARA Engine Integration** : Nutzt YARA für Scanning und Regelmanagement\n\nAusführliche Architekturdiagramme finden Sie in der [Architekturdokumentation](docs/architecture_diagram.md) .\n\n## ✨ Funktionen\n\n* 🔄 **Modulare Architektur**\n\n * Saubere Trennung von MCP-Integration, Tool-Implementierung und Speicherung\n * Standardisiertes Parameter-Parsing und Fehlerbehandlung\n * Flexibles Speicher-Backend mit lokalen und S3/MinIO-Optionen\n\n* 🤖 **MCP-Integration**\n\n * 19 integrierte MCP-Tools für umfassende Funktionalität\n * Optimiert für die Claude Desktop-Integration\n * Direkte Dateianalyse aus Konversationen heraus\n * Kompatibel mit der neuesten MCP-Protokollspezifikation\n\n* 🔍 **YARA-Scannen**\n\n * Scannen von URLs und Dateiinhalten\n * Detaillierte Spielinformationen mit Kontext\n * Speicherung und Abruf von Scanergebnissen\n * Leistungsoptimierte Scan-Engine\n\n* 📝 **Regelverwaltung**\n\n * YARA-Regeln erstellen, lesen, aktualisieren, löschen\n * Regelvalidierung mit detaillierter Fehlerberichterstattung\n * Importieren Sie Regeln aus dem ThreatFlux-Repository\n * Kategorisierung nach Quelle (benutzerdefiniert vs. Community)\n\n* 📊 **Dateianalyse**\n\n * Hexadezimalansicht für die Binäranalyse\n * String-Extraktion mit konfigurierbaren Parametern\n * Dateimetadaten und Hash-Informationen\n * Sicheres Hochladen und Speichern von Dateien\n\n* 🔐 **Sicherheitsfunktionen**\n\n * JWT-Authentifizierung für den API-Zugriff\n * Nicht-Root-Containerausführung\n * Sichere Speicherisolierung\n * Konfigurierbare Zugriffskontrollen\n\n## 🚀 Schnellstart\n\n### Docker-Image verwenden\n\n````bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n````\n\n### Installation von der Quelle\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 Claude Desktop-Integration\n\nYaraFlux ist für die nahtlose Integration mit Claude Desktop über das Model Context Protocol konzipiert.\n\n1. Erstellen Sie das Docker-Image:\n\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. Zur Claude Desktop-Konfiguration hinzufügen ( `~/Library/Application Support/Claude/claude_desktop_config.json` ):\n\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. Starten Sie Claude Desktop neu, um den Server zu aktivieren.\n\n## 🛠️ Verfügbare MCP-Tools\n\nYaraFlux stellt 19 integrierte MCP-Tools bereit:\n\n### Regelverwaltungstools\n\n* **list\\_yara\\_rules** : Listet verfügbare YARA-Regeln mit Filteroptionen auf\n* **get\\_yara\\_rule** : Ruft den Inhalt und die Metadaten einer bestimmten YARA-Regel ab\n* **validate\\_yara\\_rule** : Validiert die YARA-Regelsyntax mit detaillierter Fehlerberichterstattung\n* **add\\_yara\\_rule** : Erstellen Sie eine neue YARA-Regel\n* **update\\_yara\\_rule** : Aktualisieren Sie eine vorhandene YARA-Regel\n* **delete\\_yara\\_rule** : Löscht eine YARA-Regel\n* **import\\_threatflux\\_rules** : Importieren Sie Regeln aus dem ThreatFlux-GitHub-Repository\n\n### Scan-Tools\n\n* **scan\\_url** : Scannen Sie Inhalte von einer URL mit angegebenen YARA-Regeln\n* **scan\\_data** : Scannen Sie bereitgestellte Daten (Base64-codiert) mit angegebenen Regeln\n* **get\\_scan\\_result** : Ruft detaillierte Ergebnisse eines vorherigen Scans ab\n\n### Dateiverwaltungstools\n\n* **upload\\_file** : Laden Sie eine Datei zur Analyse oder zum Scannen hoch\n* **get\\_file\\_info** : Metadaten zu einer hochgeladenen Datei abrufen\n* **list\\_files** : Liste hochgeladener Dateien mit Seitennummerierung und Sortierung\n* **delete\\_file** : Löscht eine hochgeladene Datei\n* **extract\\_strings** : Extrahieren Sie ASCII/Unicode-Zeichenfolgen aus einer Datei\n* **get\\_hex\\_view** : Hexadezimale Ansicht des Dateiinhalts abrufen\n* **download\\_file** : Laden Sie eine hochgeladene Datei herunter\n\n### Speicherverwaltungstools\n\n* **get\\_storage\\_info** : Speichernutzungsstatistik abrufen\n* **clean\\_storage** : Entfernen Sie alte Dateien, um Speicherplatz freizugeben\n\n## 📚 Dokumentation\n\nEine umfassende Dokumentation ist im Verzeichnis [docs/](docs/) verfügbar:\n\n* [Architekturdiagramme](docs/architecture_diagram.md) – Visuelle Darstellung der Systemarchitektur\n* [Codeanalyse](docs/code_analysis.md) – Detaillierte Codestruktur und Empfehlungen\n* [Installationshandbuch](docs/installation.md) - Detaillierte Einrichtungsanweisungen\n* [CLI-Nutzungshandbuch](docs/cli.md) – Dokumentation zur Befehlszeilenschnittstelle\n* [API-Referenz](docs/api.md) – REST-API-Endpunkte und -Verwendung\n* [YARA-Regelhandbuch](docs/yara_rules.md) – Erstellen und Verwalten von YARA-Regeln\n* [MCP-Integration](docs/mcp.md) – Details zur Model Context Protocol-Integration\n* [Dateiverwaltung](docs/file_management.md) – Funktionen zur Dateiverwaltung\n* [Beispiele](docs/examples.md) – Anwendungsbeispiele aus der Praxis\n\n## 🗂️ Projektstruktur\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 Entwicklung\n\n### Lokale Entwicklung\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### CI/CD-Workflows\n\nDieses Projekt verwendet GitHub Actions für kontinuierliche Integration und Bereitstellung:\n\n* **CI-Tests** : Läuft bei jeder Push- und Pull-Anforderung an Haupt- und Entwicklungszweige\n\n * Führt Tests, Formatierungen, Lint-Tests und Typprüfungen durch\n * Erstellt und testet Docker-Images\n * Lädt Testabdeckungsberichte zu Codecov hoch\n\n* **Automatische Versionserhöhung** : Erhöht die Version automatisch beim Pushen in den Hauptzweig\n\n * Aktualisiert die Version in pyproject.toml, setup.py und Dockerfile\n * Erstellt Git-Tags für neue Versionen\n\n* **Release veröffentlichen** : Ausgelöst nach erfolgreicher automatischer Versionserhöhung\n\n * Erstellt Docker-Images für mehrere Phasen\n * Generiert Versionshinweise aus Git-Commits\n * Erstellt GitHub-Release mit Artefakten\n * Veröffentlicht Docker-Images im Docker Hub\n\nDiese Workflows gewährleisten die Codequalität und automatisieren den Release-Prozess.\n\n### Statusprüfungen\n\nDie folgenden Statusprüfungen werden für Pull Requests ausgeführt:\n\n* ✅ **Formatüberprüfung** : Stellt sicher, dass der Code den Black- und Isort-Formatierungsstandards entspricht\n* ✅ **Lint-Verifizierung** : Validiert die Codequalität und die Einhaltung von Codierungsstandards\n* ✅ **Testausführung** : Führt die vollständige Testsuite aus, um die Funktionalität zu überprüfen\n* ✅ **Abdeckungsbericht** : Stellt eine ausreichende Testabdeckung der Codebasis sicher\n\n## 🌐 API-Dokumentation\n\nInteraktive API-Dokumentation verfügbar unter:\n\n* Swagger-Benutzeroberfläche: \n* ReDoc: \n\nEine ausführliche API-Dokumentation finden Sie in [der API-Referenz](docs/api.md) .\n\n## 🤝 Beitragen\n\nBeiträge sind willkommen! Senden Sie gerne einen Pull Request.\n\n1. Forken Sie das Repository\n2. Erstellen Sie Ihren Feature-Zweig ( `git checkout -b feature/amazing-feature` )\n3. Übernehmen Sie Ihre Änderungen ( `git commit -m 'Add some amazing feature'` )\n4. Pushen zum Zweig ( `git push origin feature/amazing-feature` )\n5. Öffnen einer Pull-Anfrage\n\n## 📄 Lizenz\n\nDieses Projekt ist unter der MIT-Lizenz lizenziert – Einzelheiten finden Sie in der Datei [LICENSE](LICENSE) .\n\n## 💖 Spenden oder nach Funktionen fragen\n\n* [Patreon](https://patreon.com/vtriple)\n* [PayPal](https://paypal.me/ThreatFlux)","German","tag","de-DE",{"_27":39,"_31":43,"_36":44},{"_29":40,"_31":41,"_33":42},"A Model Context Protocol server that enables AI assistants to perform YARA rule-based threat analysis on files and URLs, supporting comprehensive rule management and detailed scanning results.","YaraFlux MCP Server","# YaraFlux MCP Server\n[![GitHub release (latest by date)](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases)\n[![CI](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions)\n[![codecov](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python Version](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/)\n[![FastAPI](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/)\n[![MCP](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nA Model Context Protocol (MCP) server for YARA scanning, providing LLMs with capabilities to analyze files with YARA rules.\n\n## 📋 Overview\n\nYaraFlux MCP Server enables AI assistants to perform YARA rule-based threat analysis through the standardized Model Context Protocol interface. The server integrates YARA scanning with modern AI assistants, supporting comprehensive rule management, secure scanning, and detailed result analysis through a modular architecture.\n\n## 🧩 Architecture Overview\n\n```\n+------------------------------------------+\n| AI Assistant |\n+--------------------+---------------------+\n |\n | Model Context Protocol\n |\n+--------------------v---------------------+\n| YaraFlux MCP Server |\n| |\n| +----------------+ +---------------+ |\n| | MCP Server | | Tool Registry | |\n| +-------+--------+ +-------+-------+ |\n| | | |\n| +-------v--------+ +-------v-------+ |\n| | YARA Service | | Storage Layer | |\n| +----------------+ +---------------+ |\n| |\n+------------------------------------------+\n | |\n +-----------------+ +---------------+\n | YARA Engine | | Storage |\n | - Rule Compiling| | - Local FS |\n | - File Scanning | | - MinIO/S3 |\n +-----------------+ +---------------+\n```\n\nYaraFlux follows a modular architecture that separates concerns between:\n- **MCP Integration Layer**: Handles communication with AI assistants\n- **Tool Implementation Layer**: Implements YARA scanning and management functionality\n- **Storage Abstraction Layer**: Provides flexible storage options\n- **YARA Engine Integration**: Leverages YARA for scanning and rule management\n\nFor detailed architecture diagrams, see the [Architecture Documentation](docs/architecture_diagram.md).\n\n## ✨ Features\n\n- 🔄 **Modular Architecture**\n - Clean separation of MCP integration, tool implementation, and storage\n - Standardized parameter parsing and error handling\n - Flexible storage backend with local and S3/MinIO options\n\n- 🤖 **MCP Integration**\n - 19 integrated MCP tools for comprehensive functionality\n - Optimized for Claude Desktop integration\n - Direct file analysis from within conversations\n - Compatible with latest MCP protocol specification\n\n- 🔍 **YARA Scanning**\n - URL and file content scanning\n - Detailed match information with context\n - Scan result storage and retrieval\n - Performance-optimized scanning engine\n\n- 📝 **Rule Management**\n - Create, read, update, delete YARA rules\n - Rule validation with detailed error reporting\n - Import rules from ThreatFlux repository\n - Categorization by source (custom vs. community)\n\n- 📊 **File Analysis**\n - Hexadecimal view for binary analysis\n - String extraction with configurable parameters\n - File metadata and hash information\n - Secure file upload and storage\n\n- 🔐 **Security Features**\n - JWT authentication for API access\n - Non-root container execution\n - Secure storage isolation\n - Configurable access controls\n\n## 🚀 Quick Start\n### Using Docker Image\n\n```bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n```\n\n### Installation from Source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 Claude Desktop Integration\n\nYaraFlux is designed for seamless integration with Claude Desktop through the Model Context Protocol.\n\n1. Build the Docker image:\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json`):\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. Restart Claude Desktop to activate the server.\n\n## 🛠️ Available MCP Tools\n\nYaraFlux exposes 19 integrated MCP tools:\n\n### Rule Management Tools\n- **list_yara_rules**: List available YARA rules with filtering options\n- **get_yara_rule**: Get a specific YARA rule's content and metadata\n- **validate_yara_rule**: Validate YARA rule syntax with detailed error reporting\n- **add_yara_rule**: Create a new YARA rule\n- **update_yara_rule**: Update an existing YARA rule\n- **delete_yara_rule**: Delete a YARA rule\n- **import_threatflux_rules**: Import rules from ThreatFlux GitHub repository\n\n### Scanning Tools\n- **scan_url**: Scan content from a URL with specified YARA rules\n- **scan_data**: Scan provided data (base64 encoded) with specified rules\n- **get_scan_result**: Retrieve detailed results from a previous scan\n\n### File Management Tools\n- **upload_file**: Upload a file for analysis or scanning\n- **get_file_info**: Get metadata about an uploaded file\n- **list_files**: List uploaded files with pagination and sorting\n- **delete_file**: Delete an uploaded file\n- **extract_strings**: Extract ASCII/Unicode strings from a file\n- **get_hex_view**: Get hexadecimal view of file content\n- **download_file**: Download an uploaded file\n\n### Storage Management Tools\n- **get_storage_info**: Get storage usage statistics\n- **clean_storage**: Remove old files to free up storage space\n\n## 📚 Documentation\n\nComprehensive documentation is available in the [docs/](docs/) directory:\n\n- [Architecture Diagrams](docs/architecture_diagram.md) - Visual representation of system architecture\n- [Code Analysis](docs/code_analysis.md) - Detailed code structure and recommendations\n- [Installation Guide](docs/installation.md) - Detailed setup instructions\n- [CLI Usage Guide](docs/cli.md) - Command-line interface documentation\n- [API Reference](docs/api.md) - REST API endpoints and usage\n- [YARA Rules Guide](docs/yara_rules.md) - Creating and managing YARA rules\n- [MCP Integration](docs/mcp.md) - Model Context Protocol integration details\n- [File Management](docs/file_management.md) - File handling capabilities\n- [Examples](docs/examples.md) - Real-world usage examples\n\n## 🗂️ Project Structure\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 Development\n\n### Local Development\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### CI/CD Workflows\n\nThis project uses GitHub Actions for continuous integration and deployment:\n\n- **CI Tests**: Runs on every push and pull request to main and develop branches\n - Runs tests, formatting, linting, and type checking\n - Builds and tests Docker images\n - Uploads test coverage reports to Codecov\n\n- **Version Auto-increment**: Automatically increments version on pushes to main branch\n - Updates version in pyproject.toml, setup.py, and Dockerfile\n - Creates git tag for new version\n\n- **Publish Release**: Triggered after successful version auto-increment\n - Builds Docker images for multiple stages\n - Generates release notes from git commits\n - Creates GitHub release with artifacts\n - Publishes Docker images to Docker Hub\n\nThese workflows ensure code quality and automate the release process.\n\n### Status Checks\n\nThe following status checks run on pull requests:\n\n- ✅ **Format Verification**: Ensures code follows Black and isort formatting standards\n- ✅ **Lint Verification**: Validates code quality and compliance with coding standards\n- ✅ **Test Execution**: Runs the full test suite to verify functionality\n- ✅ **Coverage Report**: Ensures sufficient test coverage of the codebase\n\n## 🌐 API Documentation\n\nInteractive API documentation available at:\n- Swagger UI: http://localhost:8000/docs\n- ReDoc: http://localhost:8000/redoc\n\nFor detailed API documentation, see [API Reference](docs/api.md).\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## 💖 Donate or Ask for Features\n\n- [Patreon](https://patreon.com/vtriple)\n- [PayPal](https://paypal.me/ThreatFlux)\n","English","en-US",{"_27":46,"_31":50,"_36":51},{"_29":47,"_31":48,"_33":49},"Un servidor de protocolo de contexto de modelo que permite a los asistentes de IA realizar análisis de amenazas basados en reglas YARA en archivos y URL, lo que admite una gestión integral de reglas y resultados de escaneo detallados.","Servidor MCP de YaraFlux","# Servidor MCP de YaraFlux\n\n[![Lanzamiento de GitHub (última fecha)](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases) [![CI](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions) [![código decodificador](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux) [![Insignia de Codacy](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh\\&utm_medium=referral\\&utm_content=\\&utm_campaign=Badge_grade) [![Licencia: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Versión de Python](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/) [![API rápida](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/) [![MCP](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol) [![Estilo de código: negro](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nUn servidor de Protocolo de Contexto de Modelo (MCP) para escaneo YARA, que proporciona a los LLM capacidades para analizar archivos con reglas YARA.\n\n## 📋 Descripción general\n\nEl servidor MCP de YaraFlux permite a los asistentes de IA realizar análisis de amenazas basados en reglas de YARA mediante la interfaz estandarizada del Protocolo de Contexto de Modelo. El servidor integra el análisis de YARA con los asistentes de IA modernos, lo que facilita la gestión integral de reglas, el análisis seguro y el análisis detallado de resultados mediante una arquitectura modular.\n\n## 🧩 Descripción general de la arquitectura\n\n```\n+------------------------------------------+\n| AI Assistant |\n+--------------------+---------------------+\n |\n | Model Context Protocol\n |\n+--------------------v---------------------+\n| YaraFlux MCP Server |\n| |\n| +----------------+ +---------------+ |\n| | MCP Server | | Tool Registry | |\n| +-------+--------+ +-------+-------+ |\n| | | |\n| +-------v--------+ +-------v-------+ |\n| | YARA Service | | Storage Layer | |\n| +----------------+ +---------------+ |\n| |\n+------------------------------------------+\n | |\n +-----------------+ +---------------+\n | YARA Engine | | Storage |\n | - Rule Compiling| | - Local FS |\n | - File Scanning | | - MinIO/S3 |\n +-----------------+ +---------------+\n```\n\nYaraFlux sigue una arquitectura modular que separa las preocupaciones entre:\n\n* **Capa de integración MCP** : gestiona la comunicación con los asistentes de IA\n* **Capa de implementación de herramientas** : implementa la funcionalidad de escaneo y gestión de YARA\n* **Capa de abstracción de almacenamiento** : proporciona opciones de almacenamiento flexibles\n* **Integración de YARA Engine** : aprovecha YARA para el escaneo y la gestión de reglas\n\nPara obtener diagramas de arquitectura detallados, consulte la [Documentación de arquitectura](docs/architecture_diagram.md) .\n\n## ✨ Características\n\n* 🔄 **Arquitectura modular**\n\n * Separación limpia de la integración de MCP, la implementación de herramientas y el almacenamiento\n * Análisis de parámetros estandarizados y manejo de errores\n * Backend de almacenamiento flexible con opciones locales y S3/MinIO\n\n* 🤖 **Integración MCP**\n\n * 19 herramientas MCP integradas para una funcionalidad integral\n * Optimizado para la integración con Claude Desktop\n * Análisis directo de archivos desde dentro de las conversaciones\n * Compatible con la última especificación del protocolo MCP\n\n* 🔍 **Escaneo YARA**\n\n * Escaneo de contenido de archivos y URL\n * Información detallada del partido con contexto\n * Almacenamiento y recuperación de resultados de escaneo\n * Motor de escaneo con rendimiento optimizado\n\n* 📝 **Gestión de reglas**\n\n * Crear, leer, actualizar, eliminar reglas de YARA\n * Validación de reglas con informes detallados de errores\n * Importar reglas desde el repositorio de ThreatFlux\n * Categorización por fuente (personalizada vs. comunitaria)\n\n* 📊 **Análisis de archivos**\n\n * Vista hexadecimal para análisis binario\n * Extracción de cadenas con parámetros configurables\n * Metadatos de archivo e información hash\n * Carga y almacenamiento seguros de archivos\n\n* 🔐 **Funciones de seguridad**\n\n * Autenticación JWT para acceso a API\n * Ejecución de contenedor no raíz\n * Aislamiento de almacenamiento seguro\n * Controles de acceso configurables\n\n## 🚀 Inicio rápido\n\n### Uso de la imagen de Docker\n\n````bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n````\n\n### Instalación desde la fuente\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 Integración de escritorio de Claude\n\nYaraFlux está diseñado para una integración perfecta con Claude Desktop a través del Protocolo de Contexto de Modelo.\n\n1. Construya la imagen de Docker:\n\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. Agregar a la configuración de Claude Desktop ( `~/Library/Application Support/Claude/claude_desktop_config.json` ):\n\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. Reinicie Claude Desktop para activar el servidor.\n\n## 🛠️ Herramientas MCP disponibles\n\nYaraFlux expone 19 herramientas MCP integradas:\n\n### Herramientas de gestión de reglas\n\n* **list\\_yara\\_rules** : Lista de reglas YARA disponibles con opciones de filtrado\n* **get\\_yara\\_rule** : obtiene el contenido y los metadatos de una regla YARA específica\n* **validate\\_yara\\_rule** : Valida la sintaxis de la regla YARA con informes detallados de errores\n* **add\\_yara\\_rule** : Crea una nueva regla YARA\n* **update\\_yara\\_rule** : Actualizar una regla YARA existente\n* **delete\\_yara\\_rule** : Eliminar una regla YARA\n* **import\\_threatflux\\_rules** : Importar reglas desde el repositorio de GitHub de ThreatFlux\n\n### Herramientas de escaneo\n\n* **scan\\_url** : escanear contenido de una URL con reglas YARA especificadas\n* **scan\\_data** : escanea los datos proporcionados (codificados en base64) con las reglas especificadas\n* **get\\_scan\\_result** : recupera resultados detallados de un escaneo anterior\n\n### Herramientas de gestión de archivos\n\n* **upload\\_file** : Sube un archivo para analizarlo o escanearlo\n* **get\\_file\\_info** : Obtener metadatos sobre un archivo cargado\n* **list\\_files** : Lista de archivos cargados con paginación y ordenación\n* **delete\\_file** : Eliminar un archivo cargado\n* **extract\\_strings** : Extrae cadenas ASCII/Unicode de un archivo\n* **get\\_hex\\_view** : Obtener una vista hexadecimal del contenido del archivo\n* **download\\_file** : Descargar un archivo cargado\n\n### Herramientas de gestión de almacenamiento\n\n* **get\\_storage\\_info** : Obtener estadísticas de uso del almacenamiento\n* **clean\\_storage** : elimina archivos antiguos para liberar espacio de almacenamiento\n\n## 📚 Documentación\n\nLa documentación completa está disponible en el directorio [docs/](docs/) :\n\n* [Diagramas de arquitectura](docs/architecture_diagram.md) : representación visual de la arquitectura del sistema\n* [Análisis de código](docs/code_analysis.md) : estructura detallada del código y recomendaciones\n* [Guía de instalación](docs/installation.md) : instrucciones de configuración detalladas\n* [Guía de uso de la CLI](docs/cli.md) : documentación de la interfaz de línea de comandos\n* [Referencia de API](docs/api.md) : puntos finales y uso de la API REST\n* [Guía de reglas de YARA](docs/yara_rules.md) : creación y gestión de reglas de YARA\n* [Integración MCP](docs/mcp.md) - Detalles de la integración del Protocolo de Contexto del Modelo\n* [Gestión de archivos](docs/file_management.md) : capacidades de manejo de archivos\n* [Ejemplos](docs/examples.md) - Ejemplos de uso en el mundo real\n\n## 🗂️ Estructura del proyecto\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 Desarrollo\n\n### Desarrollo local\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### Flujos de trabajo de CI/CD\n\nEste proyecto utiliza GitHub Actions para la integración y la implementación continuas:\n\n* **Pruebas CI** : se ejecutan en cada solicitud de inserción y extracción a las ramas principal y de desarrollo\n\n * Ejecuta pruebas, formateo, revisión de errores y verificación de tipos.\n * Crea y prueba imágenes de Docker\n * Carga informes de cobertura de pruebas a Codecov\n\n* **Incremento automático de versión** : incrementa automáticamente la versión al enviarla a la rama principal\n\n * Se actualiza la versión en pyproject.toml, setup.py y Dockerfile\n * Crea una etiqueta git para la nueva versión\n\n* **Publicar versión** : se activa después de un incremento automático de versión exitoso\n\n * Crea imágenes de Docker para múltiples etapas\n * Genera notas de lanzamiento a partir de confirmaciones de Git\n * Crea una versión de GitHub con artefactos\n * Publica imágenes de Docker en Docker Hub\n\nEstos flujos de trabajo garantizan la calidad del código y automatizan el proceso de lanzamiento.\n\n### Comprobaciones de estado\n\nLas siguientes comprobaciones de estado se ejecutan en solicitudes de extracción:\n\n* ✅ **Verificación de formato** : garantiza que el código siga los estándares de formato Black e isort\n* ✅ **Verificación de pelusa** : valida la calidad del código y el cumplimiento de los estándares de codificación\n* ✅ **Ejecución de pruebas** : ejecuta el conjunto de pruebas completo para verificar la funcionalidad\n* ✅ **Informe de cobertura** : garantiza una cobertura de prueba suficiente de la base de código\n\n## 🌐 Documentación de la API\n\nDocumentación API interactiva disponible en:\n\n* Interfaz de usuario Swagger: \n* ReDoc: \n\nPara obtener documentación detallada de la API, consulte [Referencia de API](docs/api.md) .\n\n## 🤝 Contribuyendo\n\n¡Agradecemos sus contribuciones! No dude en enviar una solicitud de incorporación de cambios.\n\n1. Bifurcar el repositorio\n2. Crea tu rama de funciones ( `git checkout -b feature/amazing-feature` )\n3. Confirme sus cambios ( `git commit -m 'Add some amazing feature'` )\n4. Empujar a la rama ( `git push origin feature/amazing-feature` )\n5. Abrir una solicitud de extracción\n\n## 📄 Licencia\n\nEste proyecto está licenciado bajo la licencia MIT: consulte el archivo [de LICENCIA](LICENSE) para obtener más detalles.\n\n## 💖 Dona o pide funciones\n\n* [Patreon](https://patreon.com/vtriple)\n* [PayPal](https://paypal.me/ThreatFlux)","Spanish","es-ES",{"_27":53,"_31":57,"_36":58},{"_29":54,"_31":55,"_33":56},"AI アシスタントがファイルや URL に対して YARA ルールベースの脅威分析を実行できるようにし、包括的なルール管理と詳細なスキャン結果をサポートするモデルコンテキストプロトコルサーバー。","YaraFlux MCP サーバー","# YaraFlux MCP サーバー\n\n[![GitHub リリース（最新日付）](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases) [![CI](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions) [![コードコフ](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux) [![Codacyバッジ](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh\\&utm_medium=referral\\&utm_content=\\&utm_campaign=Badge_grade) [![ライセンス: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Pythonバージョン](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/) [![ファストAPI](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/) [![MCP](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol) [![コードスタイル: 黒](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nYARA スキャン用のモデルコンテキストプロトコル (MCP) サーバー。LLM に YARA ルールを使用してファイルを分析する機能を提供します。\n\n## 📋 概要\n\nYaraFlux MCPサーバーは、AIアシスタントが標準化されたモデルコンテキストプロトコルインターフェースを介してYARAルールベースの脅威分析を実行できるようにします。このサーバーはYARAスキャンを最新のAIアシスタントと統合し、モジュール型アーキテクチャを通じて包括的なルール管理、セキュアスキャン、詳細な結果分析をサポートします。\n\n## 🧩 アーキテクチャの概要\n\n```\n+------------------------------------------+\n| AI Assistant |\n+--------------------+---------------------+\n |\n | Model Context Protocol\n |\n+--------------------v---------------------+\n| YaraFlux MCP Server |\n| |\n| +----------------+ +---------------+ |\n| | MCP Server | | Tool Registry | |\n| +-------+--------+ +-------+-------+ |\n| | | |\n| +-------v--------+ +-------v-------+ |\n| | YARA Service | | Storage Layer | |\n| +----------------+ +---------------+ |\n| |\n+------------------------------------------+\n | |\n +-----------------+ +---------------+\n | YARA Engine | | Storage |\n | - Rule Compiling| | - Local FS |\n | - File Scanning | | - MinIO/S3 |\n +-----------------+ +---------------+\n```\n\nYaraFlux は、次の懸念事項を分離するモジュール式アーキテクチャに従います。\n\n* **MCP統合レイヤー**: AIアシスタントとの通信を処理\n* **ツール実装層**:YARAスキャンおよび管理機能を実装します\n* **ストレージ抽象化レイヤー**:柔軟なストレージオプションを提供\n* **YARAエンジン統合**:スキャンとルール管理にYARAを活用\n\n詳細なアーキテクチャ図については、[アーキテクチャドキュメントを](docs/architecture_diagram.md)参照してください。\n\n## ✨ 特徴\n\n* 🔄**モジュラーアーキテクチャ**\n\n * MCP統合、ツール実装、ストレージの明確な分離\n * 標準化されたパラメータ解析とエラー処理\n * ローカルおよび S3/MinIO オプションを備えた柔軟なストレージバックエンド\n\n* 🤖 **MCP 統合**\n\n * 包括的な機能を実現する19の統合MCPツール\n * Claude Desktop 統合に最適化\n * 会話内から直接ファイルを分析\n * 最新のMCPプロトコル仕様と互換性があります\n\n* 🔍 **YARAスキャン**\n\n * URLとファイルコンテンツのスキャン\n * コンテキスト付きの詳細な試合情報\n * スキャン結果の保存と取得\n * パフォーマンス最適化されたスキャンエンジン\n\n* 📝**ルール管理**\n\n * YARAルールの作成、読み取り、更新、削除\n * 詳細なエラーレポートによるルール検証\n * ThreatFluxリポジトリからルールをインポートする\n * ソースによる分類（カスタム vs. コミュニティ）\n\n* 📊**ファイル分析**\n\n * バイナリ解析のための16進表示\n * 設定可能なパラメータによる文字列抽出\n * ファイルのメタデータとハッシュ情報\n * 安全なファイルのアップロードと保存\n\n* 🔐**セキュリティ機能**\n\n * APIアクセスのためのJWT認証\n * 非ルートコンテナ実行\n * 安全なストレージ分離\n * 設定可能なアクセス制御\n\n## 🚀 クイックスタート\n\n### Dockerイメージの使用\n\n````bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n````\n\n### ソースからのインストール\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 クロードデスクトップ統合\n\nYaraFlux は、モデルコンテキストプロトコルを通じて Claude Desktop とシームレスに統合できるように設計されています。\n\n1. Docker イメージをビルドします。\n\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. Claude Desktop 構成 ( `~/Library/Application Support/Claude/claude_desktop_config.json` ) に追加します。\n\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. サーバーをアクティブにするには、Claude Desktop を再起動します。\n\n## 🛠️ 利用可能なMCPツール\n\nYaraFlux は 19 個の統合 MCP ツールを公開します。\n\n### ルール管理ツール\n\n* **list\\_yara\\_rules** : フィルタリングオプション付きの利用可能なYARAルールを一覧表示する\n* **get\\_yara\\_rule** : 特定のYARAルールのコンテンツとメタデータを取得する\n* **validate\\_yara\\_rule** : 詳細なエラーレポートでYARAルール構文を検証する\n* **add\\_yara\\_rule** : 新しいYARAルールを作成する\n* **update\\_yara\\_rule** : 既存のYARAルールを更新する\n* **delete\\_yara\\_rule** : YARAルールを削除する\n* **import\\_threatflux\\_rules** : ThreatFlux GitHub リポジトリからルールをインポートする\n\n### スキャンツール\n\n* **scan\\_url** : 指定されたYARAルールを使用してURLからコンテンツをスキャンします\n* **scan\\_data** : 指定されたルールで提供されたデータ（base64エンコード）をスキャンします。\n* **get\\_scan\\_result** : 前回のスキャンから詳細な結果を取得する\n\n### ファイル管理ツール\n\n* **upload\\_file** : 分析またはスキャン用のファイルをアップロードします\n* **get\\_file\\_info** : アップロードされたファイルに関するメタデータを取得する\n* **list\\_files** : アップロードされたファイルをページ区切りと並べ替え付きで一覧表示する\n* **delete\\_file** : アップロードされたファイルを削除する\n* **extract\\_strings** : ファイルから ASCII/Unicode 文字列を抽出する\n* **get\\_hex\\_view** : ファイルの内容を16進数で表示する\n* **download\\_file** : アップロードされたファイルをダウンロードする\n\n### ストレージ管理ツール\n\n* **get\\_storage\\_info** : ストレージ使用状況の統計情報を取得する\n* **clean\\_storage** : 古いファイルを削除してストレージスペースを解放します\n\n## 📚 ドキュメント\n\n包括的なドキュメントは[docs/](docs/)ディレクトリにあります。\n\n* [アーキテクチャ図](docs/architecture_diagram.md)- システムアーキテクチャの視覚的表現\n* [コード分析](docs/code_analysis.md)- 詳細なコード構造と推奨事項\n* [インストールガイド](docs/installation.md)- 詳細なセットアップ手順\n* [CLI 使用ガイド](docs/cli.md)- コマンドラインインターフェースのドキュメント\n* [API リファレンス](docs/api.md)- REST API エンドポイントと使用方法\n* [YARAルールガイド](docs/yara_rules.md)- YARAルールの作成と管理\n* [MCP統合](docs/mcp.md)- モデルコンテキストプロトコル統合の詳細\n* [ファイル管理](docs/file_management.md)- ファイル処理機能\n* [例](docs/examples.md)- 実際の使用例\n\n## 🗂️ プロジェクト構造\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 開発\n\n### 地域開発\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### CI/CDワークフロー\n\nこのプロジェクトでは、継続的な統合とデプロイメントに GitHub Actions を使用します。\n\n* **CI テスト**: メインブランチと開発ブランチへのすべてのプッシュリクエストとプルリクエストで実行されます。\n\n * テスト、フォーマット、リンティング、型チェックを実行します\n * Dockerイメージのビルドとテスト\n * テストカバレッジレポートをCodecovにアップロードします\n\n* **バージョン自動増分**: メインブランチへのプッシュ時にバージョンを自動的に増分します\n\n * pyproject.toml、setup.py、Dockerfile のバージョンを更新します\n * 新しいバージョンのgitタグを作成する\n\n* **リリースの公開**: バージョンの自動増分が成功した後にトリガーされます\n\n * 複数のステージのDockerイメージをビルドする\n * Gitコミットからリリースノートを生成する\n * 成果物を含むGitHubリリースを作成する\n * Docker イメージを Docker Hub に公開します\n\nこれらのワークフローはコードの品質を保証し、リリースプロセスを自動化します。\n\n### ステータスチェック\n\nプルリクエストでは次のステータスチェックが実行されます。\n\n* ✅**フォーマット検証**: コードが Black および isort フォーマット標準に準拠していることを確認します\n* ✅ **Lint検証**: コードの品質とコーディング標準への準拠を検証します\n* ✅**テスト実行**: 完全なテストスイートを実行して機能を検証します\n* ✅**カバレッジレポート**: コードベースの十分なテストカバレッジを保証します\n\n## 🌐 APIドキュメント\n\nインタラクティブな API ドキュメントは次の場所で入手できます。\n\n* Swagger UI: \n* 再ドキュメント: \n\n詳細な API ドキュメントについては、 [API リファレンス](docs/api.md)を参照してください。\n\n## 🤝 貢献する\n\n貢献を歓迎します！お気軽にプルリクエストを送信してください。\n\n1. リポジトリをフォークする\n2. 機能ブランチを作成します（ `git checkout -b feature/amazing-feature` ）\n3. 変更をコミットします ( `git commit -m 'Add some amazing feature'` )\n4. ブランチにプッシュする ( `git push origin feature/amazing-feature` )\n5. プルリクエストを開く\n\n## 📄 ライセンス\n\nこのプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細については[LICENSE](LICENSE)ファイルを参照してください。\n\n## 💖 寄付または機能のリクエスト\n\n* [パトレオン](https://patreon.com/vtriple)\n* [ペイパル](https://paypal.me/ThreatFlux)","Japanese","ja-JP",{"_27":60,"_31":64,"_36":65},{"_29":61,"_31":62,"_33":63},"AI 어시스턴트가 파일 및 URL에 대한 YARA 규칙 기반 위협 분석을 수행하여 포괄적인 규칙 관리와 자세한 검사 결과를 지원할 수 있는 모델 컨텍스트 프로토콜 서버입니다.","YaraFlux MCP 서버","# YaraFlux MCP 서버\n\n[![GitHub 릴리스(날짜별 최신)](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases) [![씨아이](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions) [![코드코브](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux) [![코디시 배지](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh\\&utm_medium=referral\\&utm_content=\\&utm_campaign=Badge_grade) [![라이센스: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![파이썬 버전](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/) [![패스트API](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/) [![엠씨피](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol) [![코드 스타일: 검정색](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nYARA 스캐닝을 위한 MCP(모델 컨텍스트 프로토콜) 서버로, LLM에 YARA 규칙이 적용된 파일을 분석하는 기능을 제공합니다.\n\n## 📋 개요\n\nYaraFlux MCP 서버는 AI 지원팀이 표준화된 모델 컨텍스트 프로토콜(Model Context Protocol) 인터페이스를 통해 YARA 규칙 기반 위협 분석을 수행할 수 있도록 지원합니다. 이 서버는 YARA 스캐닝을 최신 AI 지원팀과 통합하여 모듈형 아키텍처를 통해 포괄적인 규칙 관리, 안전한 스캐닝 및 상세 결과 분석을 지원합니다.\n\n## 🧩 아키텍처 개요\n\n지엑스피1\n\nYaraFlux는 다음과 같은 문제를 분리하는 모듈형 아키텍처를 따릅니다.\n\n* **MCP 통합 계층** : AI 어시스턴트와의 통신을 처리합니다.\n* **도구 구현 계층** : YARA 스캐닝 및 관리 기능을 구현합니다.\n* **저장 추상화 계층** : 유연한 저장 옵션 제공\n* **YARA 엔진 통합** : 스캐닝 및 규칙 관리를 위해 YARA 활용\n\n자세한 아키텍처 다이어그램은 [아키텍처 문서를](docs/architecture_diagram.md) 참조하세요.\n\n## ✨ 특징\n\n* 🔄 **모듈형 아키텍처**\n\n * MCP 통합, 도구 구현 및 스토리지의 명확한 분리\n * 표준화된 매개변수 구문 분석 및 오류 처리\n * 로컬 및 S3/MinIO 옵션을 갖춘 유연한 스토리지 백엔드\n\n* 🤖 **MCP 통합**\n\n * 포괄적인 기능을 위한 19개의 통합 MCP 도구\n * Claude Desktop 통합에 최적화됨\n * 대화 내에서 직접 파일 분석\n * 최신 MCP 프로토콜 사양과 호환\n\n* 🔍 **야라 스캐닝**\n\n * URL 및 파일 콘텐츠 스캐닝\n * 컨텍스트를 포함한 자세한 경기 정보\n * 스캔 결과 저장 및 검색\n * 성능 최적화된 스캐닝 엔진\n\n* 📝 **규칙 관리**\n\n * YARA 규칙 생성, 읽기, 업데이트, 삭제\n * 자세한 오류 보고를 통한 규칙 검증\n * ThreatFlux 저장소에서 규칙 가져오기\n * 출처별 분류(사용자 정의 대 커뮤니티)\n\n* 📊 **파일 분석**\n\n * 이진 분석을 위한 16진수 뷰\n * 구성 가능한 매개변수를 사용한 문자열 추출\n * 파일 메타데이터 및 해시 정보\n * 안전한 파일 업로드 및 저장\n\n* 🔐 **보안 기능**\n\n * API 액세스를 위한 JWT 인증\n * 루트가 아닌 컨테이너 실행\n * 안전한 스토리지 격리\n * 구성 가능한 액세스 제어\n\n## 🚀 빠른 시작\n\n### Docker 이미지 사용\n\n````bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n````\n\n### 소스에서 설치\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 Claude 데스크톱 통합\n\nYaraFlux는 Model Context Protocol을 통해 Claude Desktop과 원활하게 통합되도록 설계되었습니다.\n\n1. Docker 이미지를 빌드합니다.\n\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. Claude Desktop 구성에 추가( `~/Library/Application Support/Claude/claude_desktop_config.json` ):\n\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. 서버를 활성화하려면 Claude Desktop을 다시 시작하세요.\n\n## 🛠️ 사용 가능한 MCP 도구\n\nYaraFlux는 19개의 통합 MCP 도구를 제공합니다.\n\n### 규칙 관리 도구\n\n* **list\\_yara\\_rules** : 필터링 옵션을 사용하여 사용 가능한 YARA 규칙을 나열합니다.\n* **get\\_yara\\_rule** : 특정 YARA 규칙의 콘텐츠 및 메타데이터를 가져옵니다.\n* **validate\\_yara\\_rule** : 자세한 오류 보고를 통해 YARA 규칙 구문을 검증합니다.\n* **add\\_yara\\_rule** : 새로운 YARA 규칙을 만듭니다.\n* **update\\_yara\\_rule** : 기존 YARA 규칙을 업데이트합니다.\n* **delete\\_yara\\_rule** : YARA 규칙 삭제\n* **import\\_threatflux\\_rules** : ThreatFlux GitHub 저장소에서 규칙 가져오기\n\n### 스캐닝 도구\n\n* **scan\\_url** : 지정된 YARA 규칙을 사용하여 URL에서 콘텐츠를 스캔합니다.\n* **scan\\_data** : 지정된 규칙에 따라 제공된 데이터(base64 인코딩)를 스캔합니다.\n* **get\\_scan\\_result** : 이전 스캔의 자세한 결과를 검색합니다.\n\n### 파일 관리 도구\n\n* **upload\\_file** : 분석이나 스캐닝을 위해 파일을 업로드합니다.\n* **get\\_file\\_info** : 업로드된 파일에 대한 메타데이터를 가져옵니다.\n* **list\\_files** : 페이지 매김 및 정렬을 통해 업로드된 파일을 나열합니다.\n* **delete\\_file** : 업로드된 파일을 삭제합니다\n* **extract\\_strings** : 파일에서 ASCII/Unicode 문자열을 추출합니다.\n* **get\\_hex\\_view** : 파일 내용의 16진수 보기를 가져옵니다.\n* **download\\_file** : 업로드된 파일을 다운로드합니다\n\n### 스토리지 관리 도구\n\n* **get\\_storage\\_info** : 스토리지 사용 통계 가져오기\n* **clean\\_storage** : 오래된 파일을 제거하여 저장 공간을 확보합니다.\n\n## 📚 문서\n\n자세한 내용은 [docs/](docs/) 디렉토리에서 확인할 수 있습니다.\n\n* [아키텍처 다이어그램](docs/architecture_diagram.md) - 시스템 아키텍처의 시각적 표현\n* [코드 분석](docs/code_analysis.md) - 자세한 코드 구조 및 권장 사항\n* [설치 가이드](docs/installation.md) - 자세한 설정 지침\n* [CLI 사용 가이드](docs/cli.md) - 명령줄 인터페이스 문서\n* [API 참조](docs/api.md) - REST API 엔드포인트 및 사용법\n* [YARA 규칙 가이드](docs/yara_rules.md) - YARA 규칙 생성 및 관리\n* [MCP 통합](docs/mcp.md) - 모델 컨텍스트 프로토콜 통합 세부 정보\n* [파일 관리](docs/file_management.md) - 파일 처리 기능\n* [예제](docs/examples.md) - 실제 사용 예제\n\n## 🗂️ 프로젝트 구조\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 개발\n\n### 지역 개발\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### CI/CD 워크플로\n\n이 프로젝트에서는 지속적인 통합 및 배포를 위해 GitHub Actions를 사용합니다.\n\n* **CI 테스트** : 메인 및 개발 브랜치에 대한 모든 푸시 및 풀 요청에서 실행됩니다.\n\n * 테스트, 포맷팅, 린팅 및 유형 검사를 실행합니다.\n * Docker 이미지를 빌드하고 테스트합니다.\n * Codecov에 테스트 적용 범위 보고서 업로드\n\n* **버전 자동 증가** : 메인 브랜치에 푸시할 때 버전이 자동으로 증가합니다.\n\n * pyproject.toml, setup.py 및 Dockerfile의 버전을 업데이트합니다.\n * 새 버전에 대한 git 태그를 생성합니다.\n\n* **릴리스 게시** : 버전 자동 증가 성공 후 트리거됨\n\n * 여러 단계에 대한 Docker 이미지를 빌드합니다.\n * git 커밋에서 릴리스 노트를 생성합니다.\n * 아티팩트를 사용하여 GitHub 릴리스를 생성합니다.\n * Docker Hub에 Docker 이미지를 게시합니다.\n\n이러한 워크플로는 코드 품질을 보장하고 릴리스 프로세스를 자동화합니다.\n\n### 상태 확인\n\n다음 상태 확인은 풀 리퀘스트에서 실행됩니다.\n\n* ✅ **형식 검증** : 코드가 Black 및 isort 형식 표준을 따르는지 확인합니다.\n* ✅ **Lint 검증** : 코드 품질과 코딩 표준 준수 여부를 검증합니다.\n* ✅ **테스트 실행** : 기능을 검증하기 위해 전체 테스트 모음을 실행합니다.\n* ✅ **커버리지 보고서** : 코드베이스의 충분한 테스트 커버리지를 보장합니다.\n\n## 🌐 API 문서\n\n대화형 API 문서는 다음에서 확인할 수 있습니다.\n\n* Swagger UI: \n* ReDoc: \n\n자세한 API 문서는 [API 참조를](docs/api.md) 확인하세요.\n\n## 🤝 기여하기\n\n기여를 환영합니다! 풀 리퀘스트를 제출해 주세요.\n\n1. 저장소를 포크하세요\n2. 기능 브랜치를 생성합니다( `git checkout -b feature/amazing-feature` )\n3. 변경 사항을 커밋하세요( `git commit -m 'Add some amazing feature'` )\n4. 브랜치에 푸시( `git push origin feature/amazing-feature` )\n5. 풀 리퀘스트 열기\n\n## 📄 라이센스\n\n이 프로젝트는 MIT 라이선스에 따라 라이선스가 부여되었습니다. 자세한 내용은 [라이선스](LICENSE) 파일을 참조하세요.\n\n## 💖 기부 또는 기능 요청\n\n* [후원자](https://patreon.com/vtriple)\n* [페이팔](https://paypal.me/ThreatFlux)","Korean","ko-KR",{"_27":67,"_31":71,"_36":72},{"_29":68,"_31":69,"_33":70},"Сервер Model Context Protocol, который позволяет помощникам с искусственным интеллектом выполнять анализ угроз на основе правил YARA для файлов и URL-адресов, поддерживая комплексное управление правилами и подробные результаты сканирования.","Сервер YaraFlux MCP","# Сервер YaraFlux MCP\n\n[![Релиз GitHub (последний по дате)](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases) [![КИ](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions) [![кодеков](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux) [![Значок Кодаси](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh\\&utm_medium=referral\\&utm_content=\\&utm_campaign=Badge_grade) [![Лицензия: Массачусетский технологический институт](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Версия Python](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/) [![FastAPI](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/) [![МКП](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol) [![Стиль кода: черный](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nСервер протокола контекста модели (MCP) для сканирования YARA, предоставляющий LLM возможность анализировать файлы с помощью правил YARA.\n\n## 📋 Обзор\n\nYaraFlux MCP Server позволяет помощникам ИИ выполнять анализ угроз на основе правил YARA через стандартизированный интерфейс Model Context Protocol. Сервер интегрирует сканирование YARA с современными помощниками ИИ, поддерживая комплексное управление правилами, безопасное сканирование и подробный анализ результатов через модульную архитектуру.\n\n## 🧩 Обзор архитектуры\n\n```\n+------------------------------------------+\n| AI Assistant |\n+--------------------+---------------------+\n |\n | Model Context Protocol\n |\n+--------------------v---------------------+\n| YaraFlux MCP Server |\n| |\n| +----------------+ +---------------+ |\n| | MCP Server | | Tool Registry | |\n| +-------+--------+ +-------+-------+ |\n| | | |\n| +-------v--------+ +-------v-------+ |\n| | YARA Service | | Storage Layer | |\n| +----------------+ +---------------+ |\n| |\n+------------------------------------------+\n | |\n +-----------------+ +---------------+\n | YARA Engine | | Storage |\n | - Rule Compiling| | - Local FS |\n | - File Scanning | | - MinIO/S3 |\n +-----------------+ +---------------+\n```\n\nYaraFlux имеет модульную архитектуру, которая разделяет задачи между:\n\n* **Уровень интеграции MCP** : обеспечивает связь с помощниками на базе искусственного интеллекта.\n* **Уровень реализации инструмента** : реализует функции сканирования и управления YARA.\n* **Уровень абстракции хранения** : обеспечивает гибкие возможности хранения.\n* **Интеграция с движком YARA** : использует YARA для сканирования и управления правилами.\n\nПодробные схемы архитектуры см. [в документации по архитектуре](docs/architecture_diagram.md) .\n\n## ✨ Особенности\n\n* 🔄 **Модульная архитектура**\n\n * Четкое разделение интеграции MCP, внедрения инструментов и хранения\n * Стандартизированный анализ параметров и обработка ошибок\n * Гибкая внутренняя система хранения с локальными и S3/MinIO-опциями\n\n* 🤖 **Интеграция MCP**\n\n * 19 интегрированных инструментов MCP для комплексной функциональности\n * Оптимизировано для интеграции с Claude Desktop\n * Прямой анализ файлов из разговоров\n * Совместимость с последней спецификацией протокола MCP\n\n* 🔍 **Сканирование YARA**\n\n * Сканирование URL-адресов и содержимого файлов\n * Подробная информация о совпадениях с контекстом\n * Хранение и извлечение результатов сканирования\n * Оптимизированный по производительности сканирующий механизм\n\n* 📝 **Управление правилами**\n\n * Создание, чтение, обновление, удаление правил YARA\n * Проверка правил с подробным отчетом об ошибках\n * Импортировать правила из репозитория ThreatFlux\n * Категоризация по источнику (пользовательский или общественный)\n\n* 📊 **Анализ файла**\n\n * Шестнадцатеричное представление для двоичного анализа\n * Извлечение строк с настраиваемыми параметрами\n * Метаданные файла и хэш-информация\n * Безопасная загрузка и хранение файлов\n\n* 🔐 **Функции безопасности**\n\n * Аутентификация JWT для доступа к API\n * Выполнение контейнера без прав root\n * Безопасная изоляция хранилища\n * Настраиваемый контроль доступа\n\n## 🚀 Быстрый старт\n\n### Использование образа Docker\n\n````bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n````\n\n### Установка из источника\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 Интеграция Claude Desktop\n\nYaraFlux разработан для бесшовной интеграции с Claude Desktop через протокол контекста модели.\n\n1. Создайте образ Docker:\n\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. Добавьте в конфигурацию Claude Desktop ( `~/Library/Application Support/Claude/claude_desktop_config.json` ):\n\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. Перезапустите Claude Desktop, чтобы активировать сервер.\n\n## 🛠️ Доступные инструменты MCP\n\nYaraFlux предлагает 19 интегрированных инструментов MCP:\n\n### Инструменты управления правилами\n\n* **list\\_yara\\_rules** : Список доступных правил YARA с параметрами фильтрации\n* **get\\_yara\\_rule** : Получить содержимое и метаданные определенного правила YARA\n* **validate\\_yara\\_rule** : проверка синтаксиса правил YARA с подробным отчетом об ошибках\n* **add\\_yara\\_rule** : Создать новое правило YARA\n* **update\\_yara\\_rule** : обновить существующее правило YARA\n* **delete\\_yara\\_rule** : Удалить правило YARA\n* **import\\_threatflux\\_rules** : Импорт правил из репозитория ThreatFlux GitHub\n\n### Инструменты сканирования\n\n* **scan\\_url** : Сканировать содержимое с URL-адреса с указанными правилами YARA\n* **scan\\_data** : Сканировать предоставленные данные (в кодировке base64) с указанными правилами\n* **get\\_scan\\_result** : получение подробных результатов предыдущего сканирования\n\n### Инструменты управления файлами\n\n* **upload\\_file** : Загрузить файл для анализа или сканирования\n* **get\\_file\\_info** : Получить метаданные о загруженном файле\n* **list\\_files** : Список загруженных файлов с разбивкой на страницы и сортировкой\n* **delete\\_file** : Удалить загруженный файл\n* **extract\\_strings** : Извлечение строк ASCII/Unicode из файла\n* **get\\_hex\\_view** : Получить шестнадцатеричное представление содержимого файла\n* **download\\_file** : Загрузить загруженный файл\n\n### Инструменты управления хранилищем\n\n* **get\\_storage\\_info** : Получить статистику использования хранилища\n* **clean\\_storage** : Удалите старые файлы, чтобы освободить место на диске.\n\n## 📚 Документация\n\nПодробная документация доступна в каталоге [docs/](docs/) :\n\n* [Схемы архитектуры](docs/architecture_diagram.md) — визуальное представление архитектуры системы\n* [Анализ кода](docs/code_analysis.md) — подробная структура кода и рекомендации\n* [Руководство по установке](docs/installation.md) - Подробные инструкции по настройке\n* [Руководство по использованию CLI](docs/cli.md) — документация по интерфейсу командной строки\n* [Справочник API](docs/api.md) — конечные точки REST API и их использование\n* [Руководство по правилам YARA](docs/yara_rules.md) — Создание и управление правилами YARA\n* [Интеграция MCP](docs/mcp.md) - подробности интеграции протокола контекста модели\n* [Управление файлами](docs/file_management.md) — возможности обработки файлов\n* [Примеры](docs/examples.md) - Примеры использования в реальной жизни\n\n## 🗂️ Структура проекта\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 Развитие\n\n### Местное развитие\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### Рабочие процессы CI/CD\n\nВ этом проекте для непрерывной интеграции и развертывания используются действия GitHub:\n\n* **Тесты CI** : запускаются при каждом запросе push и pull в основных и разрабатываемых ветках.\n\n * Выполняет тесты, форматирование, линтинг и проверку типов\n * Создает и тестирует образы Docker\n * Загружает отчеты о тестовом покрытии в Codecov\n\n* **Автоувеличение версии** : автоматически увеличивает версию при отправке в основную ветку.\n\n * Обновляет версию в pyproject.toml, setup.py и Dockerfile\n * Создает тег git для новой версии\n\n* **Опубликовать релиз** : срабатывает после успешного автоматического увеличения версии\n\n * Создает образы Docker для нескольких этапов\n * Создает заметки о выпуске из коммитов git\n * Создает релиз GitHub с артефактами\n * Публикует образы Docker в Docker Hub\n\nЭти рабочие процессы обеспечивают качество кода и автоматизируют процесс выпуска.\n\n### Проверка статуса\n\nПри запросах на извлечение выполняются следующие проверки статуса:\n\n* ✅ **Проверка формата** : гарантирует, что код соответствует стандартам форматирования Black и Isort\n* ✅ **Проверка Lint** : проверяет качество кода и его соответствие стандартам кодирования.\n* ✅ **Выполнение теста** : запускает полный набор тестов для проверки функциональности\n* ✅ **Отчет о покрытии** : обеспечивает достаточное тестовое покрытие кодовой базы\n\n## 🌐 API-документация\n\nИнтерактивная документация API доступна по адресу:\n\n* Пользовательский интерфейс Swagger: \n* Передокументировать: \n\nПодробную документацию по API см. в [Справочнике API](docs/api.md) .\n\n## 🤝 Вклад\n\nВклады приветствуются! Пожалуйста, не стесняйтесь отправлять запрос на включение.\n\n1. Форк репозитория\n2. Создайте ветку функций ( `git checkout -b feature/amazing-feature` )\n3. Зафиксируйте свои изменения ( `git commit -m 'Add some amazing feature'` )\n4. Отправить в ветку ( `git push origin feature/amazing-feature` )\n5. Открыть запрос на извлечение\n\n## 📄 Лицензия\n\nДанный проект лицензирован по лицензии MIT — подробности см. в файле [LICENSE](LICENSE) .\n\n## 💖 Пожертвуйте или попросите функции\n\n* [Патреон](https://patreon.com/vtriple)\n* [PayPal](https://paypal.me/ThreatFlux)","Russian","ru-RU",{"_27":74,"_31":78,"_36":79},{"_29":75,"_31":76,"_33":77},"模型上下文协议服务器，使AI助手能够对文件和URL进行基于YARA规则的威胁分析，支持全面的规则管理和详细的扫描结果。","YaraFlux MCP 服务器","# YaraFlux MCP 服务器\n\n[![GitHub 版本（按日期排序）](https://img.shields.io/github/v/release/ThreatFlux/YaraFlux)](https://github.com/ThreatFlux/YaraFlux/releases) [![CI](https://github.com/ThreatFlux/YaraFlux/workflows/CI/badge.svg)](https://github.com/ThreatFlux/YaraFlux/actions) [![代码验证](https://codecov.io/gh/ThreatFlux/YaraFlux/branch/main/graph/badge.svg)](https://codecov.io/gh/ThreatFlux/YaraFlux) [![Codacy徽章](https://app.codacy.com/project/badge/Grade/8f7728ae613540938411196abe4359f6)](https://app.codacy.com/gh/ThreatFlux/YaraFlux/dashboard?utm_source=gh\\&utm_medium=referral\\&utm_content=\\&utm_campaign=Badge_grade) [![许可证：MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Python 版本](https://img.shields.io/badge/python-3.13-blue)](https://www.python.org/downloads/) [![快速API](https://img.shields.io/badge/FastAPI-0.104.1-009688)](https://fastapi.tiangolo.com/) [![微胶囊钙](https://img.shields.io/badge/MCP-Integrated-blueviolet)](https://docs.anthropic.com/claude/docs/model-context-protocol) [![代码样式：黑色](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\n用于 YARA 扫描的模型上下文协议 (MCP) 服务器，为 LLM 提供使用 YARA 规则分析文件的功能。\n\n## 📋 概述\n\nYaraFlux MCP 服务器使 AI 助手能够通过标准化的模型上下文协议 (MCP) 接口执行基于 YARA 规则的威胁分析。该服务器将 YARA 扫描与现代 AI 助手集成，通过模块化架构支持全面的规则管理、安全扫描和详细的结果分析。\n\n## 🧩 架构概述\n\n```\n+------------------------------------------+\n| AI Assistant |\n+--------------------+---------------------+\n |\n | Model Context Protocol\n |\n+--------------------v---------------------+\n| YaraFlux MCP Server |\n| |\n| +----------------+ +---------------+ |\n| | MCP Server | | Tool Registry | |\n| +-------+--------+ +-------+-------+ |\n| | | |\n| +-------v--------+ +-------v-------+ |\n| | YARA Service | | Storage Layer | |\n| +----------------+ +---------------+ |\n| |\n+------------------------------------------+\n | |\n +-----------------+ +---------------+\n | YARA Engine | | Storage |\n | - Rule Compiling| | - Local FS |\n | - File Scanning | | - MinIO/S3 |\n +-----------------+ +---------------+\n```\n\nYaraFlux 采用模块化架构，将关注点分为：\n\n* **MCP 集成层**：处理与 AI 助手的通信\n* **工具实现层**：实现YARA扫描和管理功能\n* **存储抽象层**：提供灵活的存储选项\n* **YARA 引擎集成**：利用 YARA 进行扫描和规则管理\n\n详细的架构图请参见[架构文档](docs/architecture_diagram.md)。\n\n## ✨ 特点\n\n* 🔄**模块化架构**\n\n * MCP 集成、工具实现和存储的清晰分离\n * 标准化参数解析和错误处理\n * 灵活的存储后端，具有本地和 S3/MinIO 选项\n\n* 🤖 **MCP 集成**\n\n * 19 个集成 MCP 工具，功能全面\n * 针对 Claude Desktop 集成进行了优化\n * 从对话中直接进行文件分析\n * 兼容最新MCP协议规范\n\n* 🔍 **YARA 扫描**\n\n * URL和文件内容扫描\n * 带有上下文的详细匹配信息\n * 扫描结果存储和检索\n * 性能优化的扫描引擎\n\n* 📝**规则管理**\n\n * 创建、读取、更新、删除 YARA 规则\n * 带有详细错误报告的规则验证\n * 从 ThreatFlux 存储库导入规则\n * 按来源分类（习俗与社区）\n\n* 📊**文件分析**\n\n * 用于二进制分析的十六进制视图\n * 使用可配置参数的字符串提取\n * 文件元数据和哈希信息\n * 安全的文件上传和存储\n\n* 🔐**安全功能**\n\n * API 访问的 JWT 身份验证\n * 非 root 容器执行\n * 安全存储隔离\n * 可配置的访问控制\n\n## 🚀 快速入门\n\n### 使用 Docker 镜像\n\n````bash\n# Pull the latest Docker image\ndocker pull threatflux/yaraflux-mcp-server:latest\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n threatflux/yaraflux-mcp-server:latest\n### Using Docker building from source\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Build the Docker image\ndocker build -t yaraflux-mcp-server:latest .\n\n# Run the container\ndocker run -p 8000:8000 \\\n -e JWT_SECRET_KEY=your-secret-key \\\n -e ADMIN_PASSWORD=your-admin-password \\\n -e DEBUG=true \\\n yaraflux-mcp-server:latest\n````\n\n### 从源安装\n\n```bash\n# Clone the repository\ngit clone https://github.com/ThreatFlux/YaraFlux.git\ncd YaraFlux/\n\n# Install dependencies (requires Python 3.13+)\nmake install\n\n# Run the server\nmake run\n```\n\n## 🧩 Claude 桌面集成\n\nYaraFlux 旨在通过模型上下文协议与 Claude Desktop 无缝集成。\n\n1. 构建 Docker 镜像：\n\n```bash\ndocker build -t yaraflux-mcp-server:latest .\n```\n\n2. 添加到 Claude 桌面配置（ `~/Library/Application Support/Claude/claude_desktop_config.json` ）：\n\n```json\n{\n \"mcpServers\": {\n \"yaraflux-mcp-server\": {\n \"command\": \"docker\",\n \"args\": [\n \"run\",\n \"-i\",\n \"--rm\",\n \"--env\",\n \"JWT_SECRET_KEY=your-secret-key\",\n \"--env\",\n \"ADMIN_PASSWORD=your-admin-password\",\n \"--env\",\n \"DEBUG=true\",\n \"--env\",\n \"PYTHONUNBUFFERED=1\",\n \"threatflux/yaraflux-mcp-server:latest\"\n ],\n \"disabled\": false,\n \"autoApprove\": [\n \"scan_url\",\n \"scan_data\",\n \"list_yara_rules\",\n \"get_yara_rule\"\n ]\n }\n }\n}\n```\n\n3. 重新启动 Claude Desktop 以激活服务器。\n\n## 🛠️ 可用的 MCP 工具\n\nYaraFlux 公开了 19 种集成的 MCP 工具：\n\n### 规则管理工具\n\n* **list\\_yara\\_rules** ：列出可用的 YARA 规则以及过滤选项\n* **get\\_yara\\_rule** ：获取特定 YARA 规则的内容和元数据\n* **validate\\_yara\\_rule** ：验证 YARA 规则语法并提供详细的错误报告\n* **add\\_yara\\_rule** ：创建一个新的 YARA 规则\n* **update\\_yara\\_rule** ：更新现有的 YARA 规则\n* **delete\\_yara\\_rule** ：删除 YARA 规则\n* **import\\_threatflux\\_rules** ：从 ThreatFlux GitHub 存储库导入规则\n\n### 扫描工具\n\n* **scan\\_url** ：使用指定的 YARA 规则扫描 URL 中的内容\n* **scan\\_data** ：使用指定规则扫描提供的数据（base64编码）\n* **get\\_scan\\_result** ：检索上次扫描的详细结果\n\n### 文件管理工具\n\n* **upload\\_file** ：上传文件进行分析或扫描\n* **get\\_file\\_info** ：获取有关上传文件的元数据\n* **list\\_files** ：列出已上传的文件，并进行分页和排序\n* **delete\\_file** ：删除已上传的文件\n* **extract\\_strings** ：从文件中提取 ASCII/Unicode 字符串\n* **get\\_hex\\_view** ：获取文件内容的十六进制视图\n* **download\\_file** ：下载已上传的文件\n\n### 存储管理工具\n\n* **get\\_storage\\_info** ：获取存储使用情况统计信息\n* **clean\\_storage** ：删除旧文件以释放存储空间\n\n## 📚 文档\n\n[docs/](docs/)目录中提供了全面的文档：\n\n* [架构图](docs/architecture_diagram.md)——系统架构的可视化表示\n* [代码分析](docs/code_analysis.md)——详细的代码结构和建议\n* [安装指南](docs/installation.md)- 详细设置说明\n* [CLI 使用指南](docs/cli.md)- 命令行界面文档\n* [API 参考](docs/api.md)- REST API 端点和用法\n* [YARA 规则指南](docs/yara_rules.md)- 创建和管理 YARA 规则\n* [MCP 集成](docs/mcp.md)- 模型上下文协议集成详情\n* [文件管理](docs/file_management.md)- 文件处理功能\n* [示例](docs/examples.md)- 真实世界的使用示例\n\n## 🗂️ 项目结构\n\n```\nyaraflux_mcp_server/\n├── src/\n│ └── yaraflux_mcp_server/\n│ ├── app.py # FastAPI application\n│ ├── auth.py # JWT authentication and user management\n│ ├── config.py # Configuration settings loader\n│ ├── models.py # Pydantic models for requests/responses\n│ ├── mcp_server.py # MCP server implementation\n│ ├── utils/ # Utility functions package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── error_handling.py # Standardized error handling\n│ │ ├── param_parsing.py # Parameter parsing utilities\n│ │ └── wrapper_generator.py # Tool wrapper generation\n│ ├── mcp_tools/ # Modular MCP tools package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base tool registration utilities\n│ │ ├── file_tools.py # File management tools\n│ │ ├── rule_tools.py # YARA rule management tools\n│ │ ├── scan_tools.py # Scanning tools\n│ │ └── storage_tools.py # Storage management tools\n│ ├── storage/ # Storage implementation package\n│ │ ├── __init__.py # Package initialization\n│ │ ├── base.py # Base storage interface\n│ │ ├── factory.py # Storage client factory\n│ │ ├── local.py # Local filesystem storage\n│ │ └── minio.py # MinIO/S3 storage\n│ ├── routers/ # API route definitions\n│ │ ├── __init__.py # Package initialization\n│ │ ├── auth.py # Authentication API routes\n│ │ ├── files.py # File management API routes\n│ │ ├── rules.py # YARA rule management API routes\n│ │ └── scan.py # YARA scanning API routes\n│ ├── yara_service.py # YARA rule management and scanning\n│ ├── __init__.py # Package initialization\n│ └── __main__.py # CLI entry point\n├── docs/ # Documentation\n├── tests/ # Test suite\n├── Dockerfile # Docker configuration\n├── entrypoint.sh # Container entrypoint script\n├── Makefile # Build automation\n├── pyproject.toml # Project metadata and dependencies\n├── requirements.txt # Core dependencies\n└── requirements-dev.txt # Development dependencies\n```\n\n## 🧪 开发\n\n### 本地开发\n\n```bash\n# Set up development environment\nmake dev-setup\n\n# Run tests\nmake test\n\n# Code quality checks\nmake lint\nmake format\nmake security-check\n\n# Generate test coverage report\nmake coverage\n\n# Run development server\nmake run\n```\n\n### CI/CD 工作流程\n\n该项目使用 GitHub Actions 进行持续集成和部署：\n\n* **CI 测试**：在主分支和开发分支的每个推送和拉取请求上运行\n\n * 运行测试、格式化、linting 和类型检查\n * 构建和测试 Docker 镜像\n * 将测试覆盖率报告上传至 Codecov\n\n* **版本自动增加**：推送到主分支时自动增加版本\n\n * pyproject.toml、setup.py 和 Dockerfile 中的更新版本\n * 为新版本创建 git 标签\n\n* **发布 Release** ：版本自动增量成功后触发\n\n * 为多个阶段构建 Docker 镜像\n * 从 git 提交生成发行说明\n * 使用工件创建 GitHub 版本\n * 将 Docker 镜像发布到 Docker Hub\n\n这些工作流程确保代码质量并使发布过程自动化。\n\n### 状态检查\n\n以下状态检查针对拉取请求运行：\n\n* ✅**格式验证**：确保代码遵循 Black 和 isort 格式标准\n* ✅ **Lint 验证**：验证代码质量和是否符合编码标准\n* ✅**测试执行**：运行完整的测试套件以验证功能\n* ✅**覆盖率报告**：确保代码库有足够的测试覆盖率\n\n## 🌐 API 文档\n\n交互式 API 文档可在以下位置获取：\n\n* Swagger 用户界面： \n* ReDoc： \n\n有关详细的 API 文档，请参阅[API 参考](docs/api.md)。\n\n## 🤝 贡献\n\n欢迎贡献代码！欢迎提交 Pull 请求。\n\n1. 分叉存储库\n2. 创建你的功能分支（ `git checkout -b feature/amazing-feature` ）\n3. 提交您的更改（ `git commit -m 'Add some amazing feature'` ）\n4. 推送到分支（ `git push origin feature/amazing-feature` ）\n5. 打开拉取请求\n\n## 📄 许可证\n\n该项目根据 MIT 许可证获得许可 - 有关详细信息，请参阅[LICENSE](LICENSE)文件。\n\n## 💖 捐赠或索取功能\n\n* [Patreon](https://patreon.com/vtriple)\n* [PayPal](https://paypal.me/ThreatFlux)","Chinese","zh-CN","githubUser","locale",{"_83":84,"_13":85,"_93":40,"_94":40,"_16":95,"_96":97,"_31":41,"_123":124,"_131":-5,"_132":-5,"_133":134,"_192":193,"_198":-5,"_104":170,"_199":174,"_107":200,"_201":202},"addedAt","2025-03-29T01:01:51.882313Z",[86,87,88,89,90,91,92],"category:security-and-iam","category:file-systems","category:code-execution","hosting:hybrid","language:python","license_grade:a","author:claimed","descriptionMarkdown","descriptionPlainText",4060,"integrations",[98,109,116],{"_99":100,"_29":106,"_107":108},"brand",{"_101":102,"_31":103,"_104":105},"logoSvgPath","M12 .0387C5.3729.0384.0003 5.3931 0 11.9988c-.001 6.6066 5.372 11.9628 12 11.9625 6.628.0003 12.001-5.3559 12-11.9625-.0003-6.6057-5.3729-11.9604-12-11.96m-.829 5.4153h7.55l-7.5805 5.3284h5.1828L5.279 18.5436q2.9466-6.5444 5.892-13.0896","FastAPI","slug","fastapi","Uses FastAPI to provide REST API endpoints for YARA scanning, rule management, and file operations, with interactive API documentation.","uid","b47hc6bat2",{"_99":110,"_29":114,"_107":115},{"_101":111,"_31":112,"_104":113},"M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12","GitHub","github","Allows importing YARA rules directly from the ThreatFlux GitHub repository to expand scanning capabilities.","kn52gbbkbf",{"_99":117,"_29":121,"_107":122},{"_101":118,"_31":119,"_104":120},"M13.2072.006c-.6216-.0478-1.2.1943-1.6211.582a2.15 2.15 0 0 0-.0938 3.0352l3.4082 3.5507a3.042 3.042 0 0 1-.664 4.6875l-.463.2383V7.2853a15.4198 15.4198 0 0 0-8.0174 10.4862v.0176l6.5487-3.3281v7.621L13.7794 24V13.6817l.8965-.4629a4.4432 4.4432 0 0 0 1.2207-7.0292l-3.371-3.5254a.7489.7489 0 0 1 .037-1.0547.7522.7522 0 0 1 1.0567.0371l.4668.4863-.006.0059 4.0704 4.2441a.0566.0566 0 0 0 .082 0 .06.06 0 0 0 0-.0703l-3.1406-5.1425-.1484.1425.1484-.1445C14.4945.3926 13.8287.0538 13.2072.006Zm-.9024 9.8652v2.9941l-4.1523 2.1484a13.9787 13.9787 0 0 1 2.7676-3.9277 14.1784 14.1784 0 0 1 1.3847-1.2148z","MinIO","minio","Offers flexible storage options with MinIO/S3 integration for storing files, YARA rules, and scan results, providing an alternative to local storage.","ke4vnsdwfn","namespace",{"_125":126,"_104":130},"owner",{"_127":128},"githubAccount",{"_129":130},"login","ThreatFlux","readmeMarkdown","redditPostExternalId","repository",{"_135":136,"_155":156,"_159":160,"_180":181,"_185":186,"_187":-5,"_188":189},"argumentsJsonSchema",{"_137":138,"_152":153,"_144":154},"properties",{"_139":140,"_146":147,"_149":150},"DEBUG",{"_141":142,"_29":143,"_144":145},"default","true","Enable debug mode","type","string","ADMIN_PASSWORD",{"_29":148,"_144":145},"Password for administrative access","JWT_SECRET_KEY",{"_29":151,"_144":145},"Secret key for JWT authentication","required",[149,146],"object","githubProject",{"_33":42,"_157":158},"url","https://github.com/ThreatFlux/YaraFlux","githubRepository",{"_161":162,"_163":164,"_165":166,"_16":167,"_168":169,"_31":170,"_125":171,"_173":174,"_175":176,"_178":179},"defaultBranch","main","fullName","ThreatFlux/YaraFlux","githubTreeId",323433,6857,"language","Python","YaraFlux",{"_129":130,"_107":172},"Pk6qIR1gXG","recentStargazers",0,"spdxLicense",{"_31":177},"MIT License","stargazers",15,"glamaJson",{"_182":183},"maintainers",[184],"wroersma","inspectable",false,"npmPackage","supportedPlatforms",[190,191],"LINUX","MACOS","scores",{"_194":195,"_196":-5,"_197":-5},"license",100,"quality","security","simpleIcon","toolCount","vu61ypz27z","updatedAt","2025-10-01T15:45:49.599409Z","meta",[205,208,210,217,220,222,225,228,231,234,237,239,242,245,247,249,251,253,255],{"_206":207},"title","YaraFlux MCP Server | Glama",{"_209":40,"_31":29},"content",{"_211":212,"_213":214,"_215":216},"href","https://glama.ai/mcp/servers/@ThreatFlux/YaraFlux","rel","canonical","tagName","link",{"_209":41,"_218":219},"property","og:title",{"_209":40,"_218":221},"og:description",{"_209":223,"_218":224},"https://glama.ai/logo.png","og:logo",{"_209":226,"_218":227},"https://glama.ai/mcp/servers/@ThreatFlux/YaraFlux/og-image","og:image",{"_209":229,"_218":230},"630","og:image:height",{"_209":232,"_218":233},"1200","og:image:width",{"_209":235,"_218":236},"website","og:type",{"_209":212,"_218":238},"og:url",{"_209":240,"_218":241},"Glama – MCP Hosting Platform","og:site_name",{"_209":243,"_31":244},"summary_large_image","twitter:card",{"_209":240,"_31":246},"twitter:title",{"_209":40,"_31":248},"twitter:description",{"_209":226,"_31":250},"twitter:image",{"_209":229,"_31":252},"twitter:image:height",{"_209":232,"_31":254},"twitter:image:width",{"_256":257},"script:ld+json",{"_258":259,"_260":261},"@context","http://schema.org","@graph",[262],{"_258":263,"_264":265,"_266":267},"https://schema.org","@type","BreadcrumbList","itemListElement",[268,275,279,283],{"_264":269,"_270":271,"_31":272,"_273":274},"ListItem","item","/","Glama","position",1,{"_264":269,"_270":276,"_31":277,"_273":278},"/mcp","MCP",2,{"_264":269,"_270":280,"_31":281,"_273":282},"/mcp/servers","Servers",3,{"_264":269,"_270":284,"_31":41,"_273":285},"/mcp/servers/@ThreatFlux/YaraFlux",4,"visitorIsMaintainer","routes/_public/mcp/servers/~namespace/~slug/_pages/_explorer/blob/~commit/~/_route",{"_289":290,"_27":296,"_323":324,"_203":336,"_333":360,"_361":362},"blob",{"_209":291,"_292":293,"_294":295},"#!/usr/bin/env python\n\"\"\"Setup script for YaraFlux MCP Server.\"\"\"\n\nfrom setuptools import setup\n\nif __name__ == \"__main__\":\n setup()\n","fileName","setup.py","size",136,{"_83":84,"_13":297,"_93":40,"_94":40,"_16":95,"_96":298,"_31":41,"_123":305,"_131":-5,"_132":-5,"_133":308,"_192":322,"_198":-5,"_104":170,"_199":174,"_107":200,"_201":202},[86,87,88,89,90,91,92],[299,301,303],{"_99":300,"_29":106,"_107":108},{"_101":102,"_31":103,"_104":105},{"_99":302,"_29":114,"_107":115},{"_101":111,"_31":112,"_104":113},{"_99":304,"_29":121,"_107":122},{"_101":118,"_31":119,"_104":120},{"_125":306,"_104":130},{"_127":307},{"_129":130},{"_135":309,"_155":315,"_159":316,"_180":319,"_185":186,"_187":-5,"_188":321},{"_137":310,"_152":314,"_144":154},{"_139":311,"_146":312,"_149":313},{"_141":142,"_29":143,"_144":145},{"_29":148,"_144":145},{"_29":151,"_144":145},[149,146],{"_33":42,"_157":158},{"_161":162,"_163":164,"_165":166,"_16":167,"_168":169,"_31":170,"_125":317,"_173":174,"_175":318,"_178":179},{"_129":130,"_107":172},{"_31":177},{"_182":320},[184],[190,191],{"_194":195,"_196":-5,"_197":-5},"member",{"_325":326,"_329":330,"_331":293,"_165":166,"_332":186,"_333":293,"_334":335,"_294":295,"_144":289},"commit",{"_327":328},"sha","066627717e3965e87f94bfeb51b0b62993734481","contentStoredObjectPointerId",467997,"fullPath","indexable","path","safeToDisplayAsText",true,[337,339,341,343,345,346,347,349,350,351,352,353,354,355,356,357,358,359],{"_206":338},"setup.py | YaraFlux MCP Server | Glama",{"_209":340,"_31":29},"Enterprise-grade security, privacy, and features like agents, MCP, prompt templates, and more.",{"_211":342,"_213":214,"_215":216},"https://glama.ai/mcp/servers/@ThreatFlux/YaraFlux/blob/066627717e3965e87f94bfeb51b0b62993734481/",{"_209":344,"_218":219},"setup.py | YaraFlux MCP Server",{"_209":340,"_218":221},{"_209":223,"_218":224},{"_209":348,"_218":227},"https://glama.ai/generated-images/og?title=setup.py+%7C+YaraFlux+MCP+Server",{"_209":229,"_218":230},{"_209":232,"_218":233},{"_209":235,"_218":236},{"_209":342,"_218":238},{"_209":240,"_218":241},{"_209":243,"_31":244},{"_209":240,"_31":246},{"_209":340,"_31":248},{"_209":348,"_31":250},{"_209":229,"_31":252},{"_209":232,"_31":254},"","treeMembers",[363,367,370,373,376,379,382,385,388,391,394,397,400,403,406,409,412,415,418,421,424,427,430,433,436,439,442,445,448,450,453],{"_325":364,"_331":365,"_333":365,"_144":366},{"_327":328},"docs","tree",{"_325":368,"_331":369,"_333":369,"_144":366},{"_327":328},"examples",{"_325":371,"_331":372,"_333":372,"_144":366},{"_327":328},".github",{"_325":374,"_331":375,"_333":375,"_144":366},{"_327":328},"images",{"_325":377,"_331":378,"_333":378,"_144":366},{"_327":328},"src",{"_325":380,"_331":381,"_333":381,"_144":366},{"_327":328},"tests",{"_325":383,"_331":384,"_333":384,"_144":289},{"_327":328},"bandit.yaml",{"_325":386,"_331":387,"_333":387,"_144":289},{"_327":328},"codecov.yml",{"_325":389,"_331":390,"_333":390,"_144":289},{"_327":328},"docker-compose.yml",{"_325":392,"_331":393,"_333":393,"_144":289},{"_327":328},"docker-entrypoint.sh",{"_325":395,"_331":396,"_333":396,"_144":289},{"_327":328},"Dockerfile",{"_325":398,"_331":399,"_333":399,"_144":289},{"_327":328},".dockerignore",{"_325":401,"_331":402,"_333":402,"_144":289},{"_327":328},"entrypoint.sh",{"_325":404,"_331":405,"_333":405,"_144":289},{"_327":328},".env",{"_325":407,"_331":408,"_333":408,"_144":289},{"_327":328},".env.example",{"_325":410,"_331":411,"_333":411,"_144":289},{"_327":328},".gitignore",{"_325":413,"_331":414,"_333":414,"_144":289},{"_327":328},"glama.json",{"_325":416,"_331":417,"_333":417,"_144":289},{"_327":328},"LICENSE",{"_325":419,"_331":420,"_333":420,"_144":289},{"_327":328},"Makefile",{"_325":422,"_331":423,"_333":423,"_144":289},{"_327":328},"mypy.ini",{"_325":425,"_331":426,"_333":426,"_144":289},{"_327":328},".pylintrc",{"_325":428,"_331":429,"_333":429,"_144":289},{"_327":328},"pyproject.toml",{"_325":431,"_331":432,"_333":432,"_144":289},{"_327":328},"pytest.ini",{"_325":434,"_331":435,"_333":435,"_144":289},{"_327":328},"README.md",{"_325":437,"_331":438,"_333":438,"_144":289},{"_327":328},"requirements-dev.txt",{"_325":440,"_331":441,"_333":441,"_144":289},{"_327":328},"requirements.txt",{"_325":443,"_331":444,"_333":444,"_144":289},{"_327":328},".safety-project.ini",{"_325":446,"_331":447,"_333":447,"_144":289},{"_327":328},"SECURITY.md",{"_325":449,"_331":293,"_333":293,"_144":289},{"_327":328},{"_325":451,"_331":452,"_333":452,"_144":289},{"_327":328},"test.txt",{"_325":454,"_331":455,"_333":455,"_144":289},{"_327":328},"uv.lock","actionData","errors"]

MCP directory API