IDA Doc Hint MCP

🚀 IDA Pro MCP Documentation and Tools

This project provides documentation and practical tools for interacting with IDA Pro through MCP (Machine Code Processor).

This is a personal interest project for me to learn how to use MCP and is not intended for practical use.

⚠️ System Requirements

• IDA Pro must be installed.
• Python 3.8 or a higher version is required.

🔧 Prerequisites

1. IDA Pro Installation

   • Ensure that IDA Pro is correctly installed.
   • Set the IDADIR environment variable to point to your IDA Pro installation directory.

     # Example (PowerShell):
     $env:IDADIR = "C:\Program Files\IDA Pro"
     # Or set it permanently via Windows System Properties > Environment Variables
     

2. Python Environment

   • Make sure you have Python 3.8 or a higher version installed.

📥 Installation

1. Install Poetry (if not already installed)

   (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -
   

   OR

   pipx install poetry
   

2. Install Dependencies

   poetry install
   

🚀 Set Up the MCP Server

1. Configure the Cursor MCP settings.

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

🔍 Troubleshooting

1. If you encounter issues with the MCP server:

   • Ensure that the IDADIR environment variable is correctly set.
   • Verify that the IDA Pro installation is working properly.
   • Check if any antivirus software is blocking the connection.

2. Common issues:

   • "IDADIR not found": Set the environment variable as described above.
   • Connection refused: Make sure no other MCP server instances are running.
   • Windows only: This project has only been tested and supported on Windows systems, but some adjustments may be required for other operating systems.

📝 Notes

• The server uses idalib and does not require IDA Pro to be open! (Only applicable to IDA 9.0 or higher)
• Always ensure that IDA Pro is properly closed before starting the MCP server.
• For the development of any plugins and scripts, the MCP server needs to be running for IDA Pro automation testing.
• Currently, this project only supports Windows systems, and some adjustments may be required for other operating systems.
• This is a simple implementation, but it has been effective for my testing. It allows LLMs to better understand the IDA Pro API, which helps in developing plugins and scripts.

For any issues, please feel free to contact me at sysc4lls@gmai.com

📄 License

MIT License

Copyright (c) 2024 IDA Pro MCP Documentation and Tools