reverse-engineering-assistant AGENTS.md

AGENTS.md

Project Overview

ReVa (Reverse Engineering Assistant) is a Ghidra extension that provides a Model Context Protocol (MCP) server for AI‑assisted reverse engineering. It offers a collection of tool providers that expose Ghidra functionality (decompiler, strings, symbols, etc.) via a JSON‑based MCP interface.

---

Build & Test Commands

Building the extension

# Set the Ghidra installation directory first
export GHIDRA_INSTALL_DIR=/path/to/ghidra
gradle            # no wrapper – use the system `gradle` command

Testing

• Unit tests: gradle test --info
• Integration tests (require a headed GUI environment): gradle integrationTest --info
• Run a single unit test: gradle test --tests "*MyTestClass.testMethod" --info
• Run a single integration test: gradle integrationTest --tests "*MyIntegrationTest" --info
• Check (includes lint & both test suites): gradle check

---

Project Structure

• src/main/java/reva/ – Core source code
  • util/ – Foundational utilities (AddressUtil, ProgramLookupUtil, etc.)
  • plugin/ – Ghidra plugin infrastructure and configuration
  • server/ – Embedded Jetty server and MCP transport
  • tools/ – Tool providers (decompiler, functions, strings, symbols, …)
  • resources/ – Read‑only MCP resources
  • services/ – Service‑layer abstractions
  • ui/ – Optional UI components
• src/test/ – Unit tests (no Ghidra runtime required)
• src/test.slow/ – Integration tests (require Ghidra environment)

---

Development Guidelines

Code Style

• Java version: Target Java 21.
• Formatting: 4‑space indentation, no trailing whitespace. Imports sorted alphabetically, static imports after regular imports.
• Naming: Classes & enums PascalCase; methods & variables camelCase; constants UPPER_SNAKE_CASE.
• Types: Prefer concrete generic types (List<>, Map<>) over raw collections; use Optional for nullable returns.
• Documentation: Every public class and method must have a Javadoc comment describing purpose, parameters, and return values.