| 1 | <p align="center"> |
| 2 | <!--<a href="https://github.com/blacktop/ida-mcp-rs"><img alt="Logo" src="https://raw.githubusercontent.com/blacktop/ida-mcp-rs/refs/heads/main/docs/logo.svg" height="400"/></a>--> |
| 3 | <h1 align="center">ida-mcp-rs</h1> |
| 4 | <h4><p align="center">Headless IDA Pro MCP server for AI-powered reverse engineering.</p></h4> |
| 5 | <p align="center"> |
| 6 | <a href="https://github.com/blacktop/ida-mcp-rs/actions" alt="Actions"> |
| 7 | <img src="https://github.com/blacktop/ida-mcp-rs/actions/workflows/build.yml/badge.svg" /></a> |
| 8 | <a href="https://github.com/blacktop/ida-mcp-rs/releases/latest" alt="Downloads"> |
| 9 | <img src="https://img.shields.io/github/downloads/blacktop/ida-mcp-rs/total.svg" /></a> |
| 10 | <a href="https://github.com/blacktop/ida-mcp-rs/releases" alt="GitHub Release"> |
| 11 | <img src="https://img.shields.io/github/v/release/blacktop/ida-mcp-rs" /></a> |
| 12 | <a href="http://doge.mit-license.org" alt="LICENSE"> |
| 13 | <img src="https://img.shields.io/:license-mit-blue.svg" /></a> |
| 14 | </p> |
| 15 | <br> |
| 16 | |
| 17 | ## Prerequisites |
| 18 | |
| 19 | - IDA Pro 9.4 with valid license |
| 20 | |
| 21 | ## Getting Started |
| 22 | |
| 23 | ### Install |
| 24 | |
| 25 | **macOS / Linux** (via [Homebrew](https://brew.sh)) |
| 26 | ```bash |
| 27 | brew install blacktop/tap/ida-mcp # Latest (IDA 9.4) |
| 28 | ``` |
| 29 | |
| 30 | **macOS (Apple Silicon), older IDA releases** (via versioned Homebrew casks) |
| 31 | ```bash |
| 32 | brew install blacktop/tap/ida-mcp@9.3 # IDA 9.3/9.3sp1 |
| 33 | brew install blacktop/tap/ida-mcp@9.2 # IDA 9.2 |
| 34 | ``` |
| 35 | |
| 36 | **Windows** (via [Scoop](https://scoop.sh)) |
| 37 | ```powershell |
| 38 | scoop bucket add blacktop https://github.com/blacktop/scoop-bucket |
| 39 | scoop install blacktop/ida-mcp |
| 40 | ``` |
| 41 | |
| 42 | > **Windows note:** See the [Windows platform setup](#windows) section below for DLL discovery options. |
| 43 | |
| 44 | **macOS / Linux** (via [Nix](https://nixos.org)) |
| 45 | ```bash |
| 46 | nix shell github:blacktop/nur#ida-mcp \ |
| 47 | --extra-experimental-features 'nix-command flakes' |
| 48 | ``` |
| 49 | |
| 50 | **Direct download** — grab the archive for your platform from [GitHub Releases](https://github.com/blacktop/ida-mcp-rs/releases). |
| 51 | |
| 52 | **Build from source** |
| 53 | |
| 54 | See [docs/BUILDING.md](docs/BUILDING.md). |
| 55 | |
| 56 | > ida-mcp versions mirror IDA Pro versions (`v9.4.x` for IDA 9.4, `v9.3.x` for IDA 9.3, and `v9.2.x` for IDA 9.2). A version mismatch is detected at startup with a clear error message. Scoop and NUR publish the latest version. For older IDA versions, use the matching [GitHub Release](https://github.com/blacktop/ida-mcp-rs/releases) or, on Apple Silicon, the versioned Homebrew cask. |
| 57 | |
| 58 | ### Platform Setup |
| 59 | |
| 60 | #### macOS |
| 61 | |
| 62 | Standard IDA installations in `/Applications` work automatically: |
| 63 | ```bash |
| 64 | claude mcp add ida -- ida-mcp |
| 65 | ``` |
| 66 | |
| 67 | If you see `Library not loaded: @rpath/libida.dylib`, set `DYLD_LIBRARY_PATH` to your IDA path: |
| 68 | ```bash |
| 69 | claude mcp add ida -e DYLD_LIBRARY_PATH='/path/to/IDA.app/Contents/MacOS' -- ida-mcp |
| 70 | ``` |
| 71 | |
| 72 | Supported paths (auto-detected): |
| 73 | - `/Applications/IDA Professional 9.4.app/Contents/MacOS` |
| 74 | - `/Applications/IDA Home 9.4.app/Contents/MacOS` |
| 75 | - `/Applications/IDA Essential 9.4.app/Contents/MacOS` |
| 76 | |
| 77 | #### Linux |
| 78 | |
| 79 | The IDA installer defaults to `~/ida-pro-9.4` — the launcher script auto-detects this: |
| 80 | ```bash |
| 81 | claude mcp add ida -- ida-mcp |
| 82 | ``` |
| 83 | |
| 84 | For non-default install locations, set `IDADIR`: |
| 85 | ```bash |
| 86 | claude mcp add ida -e IDADIR='/path/to/ida' -- ida-mcp |
| 87 | ``` |
| 88 | |
| 89 | Resolution order: `$IDADIR` → `~/ida-pro-9.4` → `/opt/ida-pro-9.4` and other RUNPATH fallbacks. |
| 90 | |
| 91 | #### Windows |
| 92 | |
| 93 | **Option A** — Install `ida-mcp.exe` into your IDA directory (simplest, no env setup needed): |
| 94 | ```powershell |
| 95 | # Copy the binary next to ida.dll / idalib.dll |
| 96 | copy ida-mcp.exe "C:\Program Files\IDA Professional 9.4\" |
| 97 | claude mcp add ida -- "C:\Program Files\IDA Professional 9.4\ida-mcp.exe" |
| 98 | ``` |
| 99 | |
| 100 | **Option B** — Install via [Scoop](https://scoop.sh) (auto-detects IDA and sets `IDADIR`): |
| 101 | ```powershell |
| 102 | scoop bucket add blacktop https://github.com/blacktop/scoop-bucket |
| 103 | scoop install blacktop/ida-mcp |
| 104 | claude mcp add ida -- ida-mcp |
| 105 | ``` |
| 106 | |
| 107 | **Option C** — Set `IDADIR` manually: |
| 108 | ```powershell |
| 109 | $idaDir = "C:\Program Files\IDA Professional 9.4" |
| 110 | [Environment]::Set |