diff --git a/README.md b/README.md index bc0961c..8552484 100644 --- a/README.md +++ b/README.md @@ -8,21 +8,21 @@ # GhidraMCP GhidraMCP is an Model Context Protocol server for allowing LLMs to autonomously reverse engineer applications. It exposes numerous tools from core Ghidra functionality to MCP clients. -## Features +# Features MCP Server + Ghidra Plugin - Decompile and analyze binaries in Ghidra - Automatically rename methods and data - List methods, classes, imports, and exports -## Installation +# Installation -### Prerequisites +## Prerequisites - Mac / Windows - Install [Ghidra](https://ghidra-sre.org) - Python3 -### Ghidra +## Ghidra First, download the latest [release](https://github.com/LaurieWired/GhidraMCP/releases) from this repository. This contains the Ghidra plugin and Python MCP client. Then, you can directly import the plugin into Ghidra. 1. Run Ghidra @@ -33,7 +33,7 @@ First, download the latest [release](https://github.com/LaurieWired/GhidraMCP/re 6. Make sure the GhidraMCPPlugin is enabled in `File` -> `Configure` -> `Developer` -### Option 1: Claude Desktop +## Option 1: Claude Desktop To set up Claude Desktop as a Ghidra MCP client, go to `Claude` -> `Settings` -> `Developer` -> `Edit Config` -> `claude_desktop_config.json` and add the following: ```json @@ -54,14 +54,14 @@ Alternatively, edit this file directly: /Users/YOUR_USER/Library/Application Support/Claude/claude_desktop_config.json ``` -### Option 2: 5ire +## Option 2: 5ire Another MCP client that supports multiple models on the backend is [5ire](https://github.com/nanbingxyz/5ire). To set up GhidraMCP, open 5ire and go to `Tools` -> `New` and set the following configurations: 1. Tool Key: ghidra 2. Name: GhidraMCP 3. Command: `python /ABSOLUTE_PATH_TO/bridge_mcp_ghidra.py` -## Building from Source +# Building from Source Build with Maven by running: `mvn clean package assembly:single`