Adb MCP Server

🚀 ADB MCP Server

An MCP (Model Context Protocol) server for managing Android Debug Bridge (ADB) connections and interacting with Android devices.

🚀 Quick Start

The ADB MCP Server operates as a Model Context Protocol server via stdio.

Start the Server

To start the server:

npm start

For development with automatic restart on file changes:

npm run dev

✨ Features

• Device Management: List all connected Android devices.
• Screenshot Capture: Capture screenshots from connected devices.
• UI Element Inspection: Extract the UI hierarchy of the device screen.
• ADB Command Execution: Run any ADB command on connected devices.

📦 Installation

1. Clone the repository:

git clone https://github.com/yourusername/adb-mcp-server.git
cd adb-mcp-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

💻 Usage Examples

Basic Usage

The server exposes the following MCP tools:

1. Get Connected Device List

get_devices

Returns a list of all connected Android devices, along with their IDs and connection status.

2. Capture Screenshot

capture_screenshot

Parameters:

• deviceId: The ID of the device from which to capture the screenshot.
• path: The path to save the screenshot.

The screenshot will be named in the following format: YYYYMMDD_HH_MM_SS.png.

3. Get UI Elements

get_ui_elements

Parameters:

• deviceId: The ID of the device from which to extract the UI hierarchy.

Returns the complete UI hierarchy in XML format, suitable for UI automation and testing.

4. Execute ADB Command

execute_adb_command

Parameters:

• deviceId: The ID of the device on which to execute the command.
• command: The ADB command to execute.

Allows running any ADB command on the specified device.

📚 Documentation

Prerequisites

• Android Debug Bridge (ADB) must be installed on your system and added to the PATH environment variable.
• Node.js (version 14 or higher).
• TypeScript.

Project Structure

adb-mcp-server
├── src
│   ├── index.ts               # Main MCP server entry point
│   ├── handlers/              # Request handlers for each feature
│   │   ├── deviceList.ts      # Device list feature
│   │   ├── screenshot.ts      # Screenshot capture feature
│   │   └── uiElements.ts      # UI hierarchy extraction feature
│   ├── utils/                 # Utility functions
│   │   ├── adb.ts             # ADB command execution tool
│   │   └── screenshot.ts      # Screenshot processing tool
│   └── types/                 # TypeScript type definitions
├── package.json               # Project dependencies and scripts
└── tsconfig.json              # TypeScript configuration

🤝 Contribution

Contributions are welcome! Feel free to submit a Pull Request.

📄 License

This project is released under the MIT License. See the LICENSE file for details.