Gdb MCP Server

🚀 GDB 調試服務器

GDB 調試服務器是一款支持 AI 輔助調試的工具，它允許 AI 代理及其他工具藉助 MCP 協議與 GDB 展開交互。此項目託管於 GitHub，目前仍在開發中，歡迎社區反饋意見。

🚀 快速開始

GDB 調試服務器支持 AI 輔助調試，允許工具通過 MCP 協議與 GDB 交互。你可以按以下步驟下載、安裝並啟動服務器：

下載與安裝

git clone https://github.com/your-username/gdb-mcp-server.git
cd gdb-mcp-server
pip install -r requirements.txt

啟動服務器

python server.py

✨ 主要特性

1. 發現並附加到現有 GDB 進程：可自動識別並附加到正在運行的 GDB 實例。
2. 終端窗口通信（macOS 優化支持 iTerm2）：在 macOS 系統上能與 GDB 終端窗口進行交互，提供優質支持。
3. MCP 協議集成：藉助 MCP 協議實現工具間的通信與集成。
4. 智能處理命令阻塞：自動檢測並處理阻塞性命令（如 target remote），發送中斷信號以避免死鎖。
5. 多架構和遠程調試支持：支持多種處理器架構，還能連接遠程調試目標。
6. 函數調用執行常見調試操作：通過一系列工具函數可實現斷點設置、內存檢查、反彙編等常見調試任務。

📺 演示視頻

項目提供了演示視頻，展示瞭如何使用 GDB 調試服務器進行調試。點擊下面的鏈接觀看： 演示視頻

📦 安裝指南

下載與安裝

1. 克隆倉庫：

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

2. 安裝依賴：

   pip install -r requirements.txt
   

啟動服務器

啟動 GDB 調試服務器：

python server.py

💻 使用示例

基礎用法

以下是使用工具函數的基礎示例，展示如何查找運行的 GDB 進程：

# 調用系統工具函數查找所有運行的 GDB 進程
sys_find_gdb_processes()

高級用法

以下示例展示瞭如何組合使用工具函數進行調試操作，如設置斷點並執行到下一行：

# 附加到指定的 GDB 進程
sys_attach_to_gdb(some_gdb_process_id)
# 設置斷點
gdb_set_breakpoint('main')
# 執行到下一行
gdb_next()

📚 詳細文檔

工具函數

系統工具

• sys_find_gdb_processes：查找所有運行的 GDB 進程。
• sys_attach_to_gdb：附加到指定的 GDB 進程。
• sys_start_gdb_with_remote：啟動 GDB 並連接到遠程調試目標。

GDB 調試工具

• gdb_execute_command：執行任意 GDB 命令。
• gdb_set_breakpoint：設置斷點。
• gdb_delete_breakpoint：刪除斷點。
• gdb_step：單步執行指令。
• gdb_next：執行到下一行。
• gdb_finish：執行到函數返回。
• gdb_continue：繼續程序執行。
• gdb_get_registers：獲取寄存器值。
• gdb_examine_memory：檢查內存內容。
• gdb_get_stack：獲取堆棧跟蹤信息。
• gdb_get_locals：獲取局部變量信息。
• gdb_disassemble：反彙編指定代碼段。
• gdb_connect_remote：連接到遠程調試目標。

macOS 最佳實踐

1. 使用 iTerm2 作為終端模擬器，以獲得最佳支持。
2. 確保 GDB 終端窗口在啟動服務器前已打開並處於前臺。
3. 對於遠程調試，請先手動配置 GDB 設置，再通過服務器附加到目標。

常見問題

macOS 上的常見問題

1. 窗口激活問題：如果 GDB 窗口無法正確激活，請手動將其置於前臺。
2. 輸入法狀態：確保 GDB 終端未處於中文或其他輸入法狀態，以免影響命令執行。
3. 命令阻塞：對於阻塞性命令（如 target remote），服務器會自動發送中斷信號以處理。

Linux 上的常見問題

1. TTY 權限問題：確保當前用戶有權限訪問 GDB 進程的 TTY 設備。
2. pexpect 依賴：確保已安裝 pexpect 庫，該庫用於與 GDB 的交互式通信。

📄 許可證

本項目採用 MIT 許可證，具體條款請參閱 LICENSE 文件。