Skip to main content

Ghidra backend for re-mcp — headless Ghidra MCP server using pyhidra

Project description

re-mcp-ghidra

Ghidra backend for RE-MCP — a headless Ghidra MCP server using pyhidra. Exposes Ghidra's analysis capabilities over the Model Context Protocol, letting LLMs drive reverse engineering directly.

This is a standalone server, not a Ghidra plugin. It uses pyhidra to run Ghidra's analysis engine without a GUI.

Requirements

  • Python 3.12+
  • Ghidra 11+
  • JDK 21+
  • macOS, Windows, or Linux

Installation

uv tool install re-mcp-ghidra

Or with pip:

pip install re-mcp-ghidra

Finding Ghidra

The server looks for your Ghidra installation in the following order:

  1. GHIDRA_INSTALL_DIR environment variable — set this if Ghidra is in a non-standard location.
  2. Config fileghidra-install-dir in ~/.ghidra/ghidra-config.json.
  3. Platform-specific default paths (e.g. /Applications/ghidra_* on macOS).

See the main documentation for the full list of default search paths per platform.

Usage

# Run the server (direct stdio mode)
re-mcp-ghidra

# Or with uvx (no install needed)
uvx re-mcp-ghidra

MCP client configuration

{
  "mcpServers": {
    "ghidra": {
      "command": "uvx",
      "args": ["re-mcp-ghidra"]
    }
  }
}

CLI subcommands

Command Description
re-mcp-ghidra (or re-mcp-ghidra stdio) Direct stdio mode — single-session, workers die on disconnect (default)
re-mcp-ghidra proxy Stdio proxy that auto-spawns a persistent HTTP daemon
re-mcp-ghidra serve Start the HTTP daemon directly
re-mcp-ghidra stop Gracefully shut down a running daemon

Environment variables

Variable Default Description
GHIDRA_INSTALL_DIR (auto-detected) Path to Ghidra installation directory
GHIDRA_MCP_MAX_WORKERS (unlimited) Maximum simultaneous databases (1-8)
GHIDRA_MCP_LOG_LEVEL WARNING Logging level
GHIDRA_MCP_LOG_DIR (unset) Directory for per-run log files
GHIDRA_MCP_IDLE_TIMEOUT 300 Auto-shutdown timeout in seconds (0 to disable)

Features

  • Full decompilation and disassembly
  • Function, type, and structure management
  • Cross-reference and call graph analysis
  • String and byte pattern search
  • Binary patching and instruction assembly
  • Function ID and data type archive support
  • Multi-database support with concurrent analysis
  • MCP resources for structured read-only access

See the main documentation for the full tool catalog, multi-database workflows, and detailed usage.

License

Dual-licensed under MIT and Apache-2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

re_mcp_ghidra-3.0.0.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

re_mcp_ghidra-3.0.0-py3-none-any.whl (105.6 kB view details)

Uploaded Python 3

File details

Details for the file re_mcp_ghidra-3.0.0.tar.gz.

File metadata

  • Download URL: re_mcp_ghidra-3.0.0.tar.gz
  • Upload date:
  • Size: 61.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for re_mcp_ghidra-3.0.0.tar.gz
Algorithm Hash digest
SHA256 4e11313bb0c0332268210d681f1b5da4913c29aea0b0024d814947c622621739
MD5 7d717e9642531d3e3ae69fc2be4faf0b
BLAKE2b-256 a285563b47011b5f47619c39a6536f747c8c9bcff4d5fd17a8a017ce8c35825a

See more details on using hashes here.

Provenance

The following attestation bundles were made for re_mcp_ghidra-3.0.0.tar.gz:

Publisher: publish.yml on jtsylve/re-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file re_mcp_ghidra-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: re_mcp_ghidra-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 105.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for re_mcp_ghidra-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4585b07942b444ec70cb2b771a0f2fa842865b3de825b8250f13e3687ba5d55
MD5 22b1a11d4de49a6d1470f3763d74e9d3
BLAKE2b-256 3a64f415c6293e194acc8a11c9a0afc44cedc4768adc81e527dada112aa5bc29

See more details on using hashes here.

Provenance

The following attestation bundles were made for re_mcp_ghidra-3.0.0-py3-none-any.whl:

Publisher: publish.yml on jtsylve/re-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page