Adb MCP

🚀 ADB MCP Server

A TypeScript-based tool for interacting with Android devices via Android Debug Bridge (ADB). This tool serves as a bridge between AI models and Android device functionalities.

🚀 Quick Start

Before using any ADB tools, you must ensure that the server is up and running. Use the following command to start the server:

npx adb-mcp

You should see the following message:

[INFO] ADB MCP Server is connected and ready.

Keep this terminal window open while running the ADB tools.

✨ Features

• 📱 Device Management: List and operate connected Android devices.
• 📦 App Installation: Deploy APK files to connected devices.
• 📋 Logging: Access device log information (via logcat).
• 🔄 File Transfer: Push and pull files between the device and the host.
• 📸 UI Interaction: Capture screenshots and analyze the UI hierarchy.
• 🔧 Shell Command Execution: Run custom commands on the device.

📦 Installation

# Clone the repository
git clone https://github.com/srmorete/adb-mcp.git
cd adb-mcp

# Install dependencies
npm install

# Build TypeScript code
npm run build

# Run the server
npx adb-mcp

📚 Documentation

Prerequisites

• Node.js (v16 or higher is recommended. Node.js v16, v18, and v20 have been tested).
• ADB (Android Debug Bridge) installed and configured in the PATH environment variable.
• An Android device or emulator connected to the computer via USB or network, with USB debugging mode enabled.
• Permission to access the device (debugging authorization has been accepted).

Configuration

ADB Path Configuration

The server uses the default ADB path. To specify a custom path:

export ADB_PATH=/path/to/adb
npx adb-mcp

MCP Configuration

Add the ADB MCP server configuration:

{
  "mcpServers": {
    "adb": {
      "command": "npx",
      "args": [
        "adb-mcp"
      ]
    }
  }
}

Usage

Available Tools

• Device Management: List and operate connected Android devices.
• App Installation: Deploy APK files to connected devices.
• Logging: Access device log information via logcat.
• File Transfer: Push and pull files between the device and the host.
• UI Interaction: Capture screenshots and analyze the UI hierarchy.
• Shell Command Execution: Run custom commands on the device.

Troubleshooting

Server Issues

If the server fails to start, check if Node.js and npm are correctly installed, and ensure that all dependencies are installed.

Device Connection Issues

• Ensure that the device is correctly connected to the computer via USB or network.
• Check if the device has USB debugging mode enabled.

Logging Issues

If you cannot view the logs, check if logcat is correctly configured and ensure that the device is connected.

Compatibility

• Supported Android versions: All Android systems that support ADB.
• Supported operating systems: Windows, Linux, and macOS.

Contribution Guidelines

How to Contribute

• Submit issues and suggestions to the GitHub repository.
• Create pull requests to fix issues or add features.

📄 License

This project is licensed under the [LICENSE] license.