Gdb MCP Server

🚀 GDB Debugging Server

The GDB Debugging Server is a tool that supports AI-assisted debugging, allowing AI agents and other tools to interact with GDB via the MCP protocol. The project is hosted on GitHub and is currently under development. Feedback from the community is welcome.

🚀 Quick Start

The GDB Debugging Server enables AI agents and other tools to interact with GDB through the MCP protocol. It's an open - source project on GitHub, and the community's input is highly appreciated during its development phase.

✨ Features

1. Discover and attach to existing GDB processes: Automatically identify and attach to running GDB instances.
2. Terminal window communication (optimized for iTerm2 on macOS): Interact with the GDB terminal window on macOS with optimal support.
3. MCP protocol integration: Enable communication and integration between tools via the MCP protocol.
4. Intelligent handling of command blocking: Automatically detect and handle blocking commands (e.g., target remote) by sending an interrupt signal to avoid deadlocks.
5. Support for multiple architectures and remote debugging: Support multiple processor architectures and provide connectivity to remote debugging targets.
6. Execute common debugging operations via function calls: Implement common debugging tasks such as setting breakpoints, checking memory, and disassembling through a series of utility functions.

🎥 Demo Video

The project provides a demo video that shows how to use the GDB Debugging Server for debugging. You can access the video via the following link:

Demo Video

📦 Installation

Download and Installation

1. Clone the repository:

   git clone https://github.com/your-username/gdb-mcp-server.git
   cd gdb-mcp-server
   

2. Install dependencies:

   pip install -r requirements.txt
   

Start the Server

Start the GDB Debugging Server:

python server.py

💻 Usage Examples

System Utilities

• sys_find_gdb_processes: Find all running GDB processes.
• sys_attach_to_gdb: Attach to a specified GDB process.
• sys_start_gdb_with_remote: Start GDB and connect to a remote debugging target.

GDB Debugging Utilities

• gdb_execute_command: Execute any GDB command.
• gdb_set_breakpoint: Set a breakpoint.
• gdb_delete_breakpoint: Delete a breakpoint.
• gdb_step: Step through instructions one by one.
• gdb_next: Execute until the next line.
• gdb_finish: Execute until the function returns.
• gdb_continue: Continue program execution.
• gdb_get_registers: Get register values.
• gdb_examine_memory: Examine memory contents.
• gdb_get_stack: Get stack trace information.
• gdb_get_locals: Get local variable information.
• gdb_disassemble: Disassemble a specified code segment.
• gdb_connect_remote: Connect to a remote debugging target.

🔧 Best Practices on macOS

1. Use iTerm2 as the terminal emulator for optimal support.
2. Ensure that the GDB terminal window is open and in the foreground before starting the server.
3. For remote debugging, manually configure GDB settings first and then attach to the target via the server.

❓ Frequently Asked Questions

Common Issues on macOS

1. Window activation issue: If the GDB window cannot be activated correctly, manually bring it to the foreground.
2. Input method status: Ensure that the GDB terminal is not in Chinese or other input method states to avoid affecting command execution.
3. Command blocking: The server will automatically send an interrupt signal to handle blocking commands (e.g., target remote).

Common Issues on Linux

1. TTY permission issue: Ensure that the current user has permission to access the TTY device of the GDB process.
2. pexpect dependency: Ensure that the pexpect library is installed, which is used for interactive communication with GDB.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for specific terms.