Ghidramcp

🚀 GhidraMCP

GhidraMCP is a tool based on the Model Context Protocol (MCP), designed to work in conjunction with the Ghidra software.

🚀 Quick Start

GhidraMCP is a tool based on the Model Context Protocol (MCP), mainly used to work in conjunction with the Ghidra software. The following content will detail the project's features, installation method, and relevant usage examples.

✨ Features

1. Powerful: GhidraMCP offers a wide range of interfaces and functions, supporting multiple model invocation methods.
2. Modular Design: The code structure is clear, facilitating easy expansion and maintenance.
3. Well - Documented: It provides detailed usage instructions and technical documentation.

📦 Installation

Prerequisites

• Download and install Ghidra software (if not already installed).

Steps

1. Add the GhidraMCP.jar file to the Ghidra extensions directory.
2. Configure environment variables or directly run the project script to start the service.

💻 Usage Examples

Example 1: Claude Desktop

To use GhidraMCP in Claude Desktop:

1. Open Claude Desktop and go to the settings interface.
2. Add a new MCP server with the following parameters:
   • Tool Key: ghidra
   • Name: GhidraMCP
   • Command: python /ABSOLUTE_PATH_TO/bridge_mcp_ghidra.py

Example 2: Cline

To use GhidraMCP in Cline:

1. Open Cline and select MCP Servers.
2. Click Remote Servers and add the following configuration:
   • Server Name: GhidraMCP
   • Server URL: http://127.0.0.1:8081/sse

Example 3: 5ire

To use GhidraMCP in 5ire:

1. Open 5ire and go to the tool settings.
2. Click New and configure the following parameters:
   • Tool Key: ghidra
   • Name: GhidraMCP
   • Command: python /ABSOLUTE_PATH_TO/bridge_mcp_ghidra.py

🛠️ Building from Source

1. Copy the following JAR files from the Ghidra directory to the project lib/ directory:

   Ghidra/Features/Base/lib/Base.jar
   Ghidra/Features/Decompiler/lib/Decompiler.jar
   Ghidra/Framework/Docking/lib/Docking.jar
   Ghidra/Framework/Generic/lib/Generic.jar
   Ghidra/Framework/Project/lib/Project.jar
   Ghidra/Framework/SoftwareModeling/lib/SoftwareModeling.jar
   Ghidra/Framework/Utility/lib/Utility.jar
   Ghidra/Framework/Gui/lib/Gui.jar
   

2. Package using Maven:

   mvn clean package assembly:single
   

   After packaging, the generated files include:
   • GhidraMCP.jar: Ghidra plugin
   • extensions.properties and Module.manifest: Plugin configuration files

📄 License

This project is licensed under the Apache 2.0 license. For specific information, please refer to Apache License.

For more detailed information, please refer to the project documentation or visit the GitHub repository.