How lauriewired/ghidramcp works
ghidraMCP exposes Ghidra reverse-engineering operations to MCP clients. The principal flow is client → Python MCP tool server → HTTP backend client → Ghidra extension routes → analysis service → results; the extension targets either the active GUI program or a headless program loaded through PyGhidra. The README also documents headless binary import, analysis, and persistent project saves. The graph reflects documented capabilities and sampled routing; some Python and Java internals were not excerpted, so uncertain links are omitted.
Main entry points: BackendHttpServer.java Backend HTTP routes · GhidraAnalysisService.java Ghidra analysis service · cli.py CLI and mode selection · headless.py Headless session
Components 18
MCP interface
- MCP tool definitions
src/ghidra_mcp/server.py
Python runtime
- CLI and mode selection
src/ghidra_mcp/cli.py - Backend HTTP client
src/ghidra_mcp/backend.py - Headless session
src/ghidra_mcp/headless.py
Ghidra extension
- Ghidra plugin
extension/src/main/java/com/lauriewired/GhidraMCPPlugin.java - Backend HTTP routes
extension/src/main/java/com/lauriewired/ghidramcp/http/BackendHttpServer.java - HTTP request parsing
extension/src/main/java/com/lauriewired/ghidramcp/http/Request.java - JSON responses
extension/src/main/java/com/lauriewired/ghidramcp/http/Json.java - GUI program provider
extension/src/main/java/com/lauriewired/ghidramcp/gui/GuiProgramProvider.java - Headless backend launcher
extension/src/main/java/com/lauriewired/ghidramcp/headless/HeadlessBackend.java - Headless program provider
extension/src/main/java/com/lauriewired/ghidramcp/headless/HeadlessProgramProvider.java - Program provider contract
extension/src/main/java/com/lauriewired/ghidramcp/core/ProgramProvider.java
Analysis operations
- Ghidra analysis service
extension/src/main/java/com/lauriewired/ghidramcp/core/GhidraAnalysisService.java - Analysis result models
extension/src/main/java/com/lauriewired/ghidramcp/core/Model.java - Paged results
extension/src/main/java/com/lauriewired/ghidramcp/core/Page.java - Structured errors
extension/src/main/java/com/lauriewired/ghidramcp/core/McpException.java
Other components
- MCP client
- Ghidra program
Connections 23
- MCP client → CLI and mode selection: starts server
README.md - CLI and mode selection → MCP tool definitions: creates tools
src/ghidra_mcp/cli.py - MCP tool definitions → Backend HTTP client: calls endpoints
src/ghidra_mcp/server.py - CLI and mode selection → Backend HTTP client: connects backend
src/ghidra_mcp/cli.py - CLI and mode selection → Headless session: starts headless
src/ghidra_mcp/cli.py - Headless session → Headless backend launcher: starts backend
src/ghidra_mcp/headless.py - Headless session → Backend HTTP client: sets backend URL
src/ghidra_mcp/headless.py - Backend HTTP client → Backend HTTP routes: sends HTTP requests
src/ghidra_mcp/backend.py - Ghidra plugin → GUI program provider: configures provider
extension/src/main/java/com/lauriewired/GhidraMCPPlugin.java - Ghidra plugin → Backend HTTP routes: starts server
extension/src/main/java/com/lauriewired/GhidraMCPPlugin.java - Headless backend launcher → Headless program provider: creates provider
extension/src/main/java/com/lauriewired/ghidramcp/headless/HeadlessBackend.java - Backend HTTP routes → Program provider contract: gets program
extension/src/main/java/com/lauriewired/ghidramcp/http/BackendHttpServer.java - GUI program provider → Program provider contract: implements
extension/src/main/java/com/lauriewired/ghidramcp/gui/GuiProgramProvider.java - Headless program provider → Program provider contract: implements
extension/src/main/java/com/lauriewired/ghidramcp/headless/HeadlessProgramProvider.java - Backend HTTP routes → HTTP request parsing: parses requests
extension/src/main/java/com/lauriewired/ghidramcp/http/BackendHttpServer.java - Backend HTTP routes → JSON responses: formats responses
extension/src/main/java/com/lauriewired/ghidramcp/http/BackendHttpServer.java - Backend HTTP routes → Ghidra analysis service: dispatches operations
extension/src/main/java/com/lauriewired/ghidramcp/http/BackendHttpServer.java - Ghidra analysis service → Analysis result models: returns models
extension/src/main/java/com/lauriewired/ghidramcp/core/GhidraAnalysisService.java - Ghidra analysis service → Paged results: builds pages
extension/src/main/java/com/lauriewired/ghidramcp/core/GhidraAnalysisService.java - Ghidra analysis service → Structured errors: raises errors
extension/src/main/java/com/lauriewired/ghidramcp/core/GhidraAnalysisService.java - Ghidra analysis service → Ghidra program: inspects and modifies
- Headless session → Ghidra program: loads and saves binary
src/ghidra_mcp/headless.py - MCP client → Ghidra program: requests analysis