Ida Doc Hint

Ida documentation reader (sort-of) mcp server

python

0

GitHub Stars

python

Language

7 months ago

First Indexed

3 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "sysc4lls-ida-doc-hint-mcp": {
      "command": "<venv_python_path>/python.exe",
      "args": [
        "<path_to_project>/server.py"
      ],
      "env": {
        "IDADIR": "<path_to_ida_installation>"
      }
    }
  }
}

You can run a local MCP server that exposes an interface to control IDA Pro via MCP. This server enables automation scripts and tooling to interact with IDA Pro in a streamlined, repeatable way, using a defined command interface and a minimal startup footprint on Windows.

How to use

To use the MCP server, first start the local stdio server using the Python executable in your virtual environment and the server script path. Make sure IDA Pro is installed and the IDADIR environment variable points to your IDA Pro installation. Once the server is running, your MCP client can connect to it to perform automation tasks, fetch data, or control workflows that involve IDA Pro.

How to install

Prerequisites you must have before installing the MCP server:

IDA Pro installation is required
Python 3.8 or higher is required
Set the IDADIR environment variable to your IDA Pro installation directory

Install a Python-based development workflow and the dependencies for the MCP server.

# 1) Ensure IDA Pro is installed and IDADIR is set
# Example (PowerShell):
$env:IDADIR = "C:\\Program Files\\IDA Pro"

# 2) Install Poetry (if not already installed)
# Either use the official installer
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

# Or install via pipx
# pipx install poetry

# 3) Install dependencies for the MCP server project
poetry install

Once dependencies are installed, configure the MCP server using the provided JSON snippet to point to your Python environment and the server script.

"ida-pro-doc": {
  "command": "<venv_python_path>/python.exe",
  "args": [
    "<path_to_project>/server.py"
  ]
}

Additional setup and notes

The MCP server is Windows-oriented in this setup. Ensure IDA Pro is properly installed, and the server is started only after you have closed IDA Pro if you are using automation scripts that require a fresh start.

If you need to adjust where IDA Pro is located, update the IDADIR environment variable accordingly and restart the MCP server.

Troubleshooting

If you encounter issues with the MCP server, verify the IDADIR environment variable is set correctly and that IDA Pro is functioning as expected. Check for antivirus software that might block connections.

Common issues include the environment variable not being found or a refused connection. Ensure no other MCP server instance is already running and that you are on a supported Windows setup.

Notes

The server relies on idalib and may not require opening IDA Pro for certain automation workflows, though this behavior is supported only after IDA Pro 9.0. Always close IDA Pro before starting the MCP server to avoid conflicts.