DroidMind 🧠

1<div align="center">
2 
3# 🤖 DroidMind 🧠
4 
5<img src="docs/assets/images/logo_neon_glow_icon.png" alt="DroidMind Logo" width="180" />
6 
7[![Python 3.13](https://img.shields.io/badge/python-3.13-9D00FF.svg?style=for-the-badge&logo=python&logoColor=white)](https://www.python.org/downloads/)
8[![License](https://img.shields.io/badge/license-Apache_2.0-FF00FF.svg?style=for-the-badge&logo=apache&logoColor=white)](LICENSE)
9[![Status](https://img.shields.io/badge/status-active_development-39FF14.svg?style=for-the-badge&logo=githubactions&logoColor=white)](docs/plan.md)
10[![Code Style](https://img.shields.io/badge/code_style-ruff-00FFFF.svg?style=for-the-badge&logo=ruff&logoColor=white)](https://github.com/astral-sh/ruff)
11[![Type Check](https://img.shields.io/badge/type_check-pyright-FFBF00.svg?style=for-the-badge&logo=typescript&logoColor=white)](https://github.com/microsoft/pyright)
12[![MCP](https://img.shields.io/badge/protocol-MCP-E6E6FA.svg?style=for-the-badge&logo=anthropic&logoColor=white)](https://modelcontextprotocol.io/)
13[![Android](https://img.shields.io/badge/platform-android-A4C639.svg?style=for-the-badge&logo=android&logoColor=white)](https://www.android.com/)
14[![Docs](https://img.shields.io/badge/docs-online-FF9E80.svg?style=for-the-badge&logo=gitbook&logoColor=white)](https://hyperb1iss.github.io/droidmind/)
15 
16**Control Android devices with AI through the Model Context Protocol**
17 
18</div>
19 
20DroidMind is a powerful bridge between AI assistants and Android devices, enabling control, debugging, and system analysis through natural language. By implementing the Model Context Protocol (MCP), DroidMind allows AI models to directly interact with Android devices via ADB in a secure, structured way. When used as part of an agentic coding workflow, DroidMind can enable your assistant to build and debug with your device directly in the loop.
21 
22## 💫 Core Features
23 
24DroidMind empowers AI assistants to:
25 
26- 📱 **Manage Devices**: Connect via USB/TCP-IP, list devices, view properties, and reboot.
27- 📊 **Analyze Systems**: Access logs (logcat, ANR, crash, battery), capture bug reports, and dump heap.
28- 📂 **Handle Files**: Browse, read, write, push, pull, delete, and manage device files/directories.
29- 📦 **Control Apps**: Install, uninstall, start, stop, clear data, and inspect app details (manifest, permissions, activities).
30- 🖼️ **Automate UI**: Perform taps, swipes, text input, and key presses.
31- 🐚 **Execute Shell Commands**: Run ADB shell commands with a security-conscious framework.
32- 🔒 **Operate Securely**: Benefit from command validation, risk assessment, and sanitization.
33- 💬 **Integrate Seamlessly**: Connect with any MCP-compatible client (Claude, Cursor, Cline, etc.).
34 
35For a detailed list of capabilities, see the **[User Manual](docs/user_manual/index.md)** and **[MCP Reference](docs/mcp-reference.md)**.
36 
37## 🚀 Getting Started
38 
39### Quickstart for IDEs (Zero Install with `uvx`)
40 
41For the fastest way to integrate DroidMind with an MCP-compatible IDE (like Cursor), you can configure it to run DroidMind directly from its GitHub repository using `uvx`. This method **does not require you to manually clone or install DroidMind first**.
42 
43Add the following to your IDE's MCP configuration (e.g., `.cursor/mcp.json` for Cursor):
44 
45```json
46{
47  "mcpServers": {
48    "droidmind": {
49      "command": "uvx",
50      "args": [
51        "--from",
52        "git+https://github.com/hyperb1iss/droidmind",
53        "droidmind",
54        "--transport",
55        "stdio" // The default and preferred mode for most IDE integrations
56      ]
57    }
58  }
59}
60```
61 
62Your IDE will be configured to launch DroidMind on demand. Full instructions for this setup are in the **[Quick Start Guide](docs/quickstart.md#1-configure-your-ide-to-run-droidmind-via-uvx)**.
63 
64### Prerequisites
65 
66- Python 3.13 (3.14 not yet supported)
67- `uv` (Python package manager)
68- Android device with USB debugging enabled
69- ADB (Android Debug Bridge) installed and in your system's PATH
70 
71### Installation
72 
73For detailed instructions on setting up DroidMind, including the quick IDE integration with `uvx` (covered in the Quick Start), manual installation from source, or using Docker, please see our comprehensive **[Installation Guide](docs/installation.md)**.
74 
75### Running DroidMind
76 
77How you run DroidMind depends on your setup:
78 
79- **IDE Integration (via `uvx`)**: Your IDE automatically manages running DroidMind as configured in its MCP settings (e.g., `mcp.json`). See the [Quick Start Guide](docs/quickstart.md).
80- **Manual Installation**: After installing from source, you can run DroidMind directly.
81  - **Stdio (for direct terminal interaction or some IDE setups):**
82    ```bash
83    droidmind --transport stdio
84    ```
85  - **SSE (for web UIs or AI assistants like Claude Desktop):**
86    ```bash
87    droidmind --transport sse
88    ```
89    This usually starts a server at `sse://localhost:4256/sse`.
90- **Docker**: Refer to the [Docker Guide](docs/docker.md) for commands to run DroidMind in a container.
91 
92Refer to the **[Installation Guide](docs/installation.md)** for more details on running DroidMind in different environments.
93 
94## 🐳 Running with Docker
95 
96DroidMind can also be run using Docker for a consistent, containerized environment. This is particularly useful for deployment and isolating dependencies.
97 
98For comprehensive instructions on building the Docker image and running DroidMind in a container with `stdio` or `SSE` transport, including notes on ADB device access, please refer to our **[Docker Guide](docs/docker.md)**.
99 
100## 🔮 Example AI Assistant Queries
101 
102With an AI assistant connected to DroidMind, you can make requests like:
103 
104- "List all connected Android devices and show their properties."
105- "Take a screenshot of my Pixel."
106- "Install this APK on `emulator-5554`."
107- "Show me the recent crash logs from `your_device_serial`."
108- "Tap the 'Next' button on the current screen of `emulator-5554`."
109 
110For more inspiration, check out our **[Example Queries and Workflows](docs/user_manual/example_queries.md)** in the User Manual.
111 
112## 🔒 Security
113 
114DroidMind incorporates a security framework to protect your devices:
115 
116- **Command Validation & Sanitization**
117- **Risk Assessment Categorization**
118- **Protected Path Operations**
119- **Comprehensive Logging**
120 
121High-risk operations are flagged, and critical ones are blocked by default. Learn more in our **[Security Considerations](docs/user_manual/security.md)** chapter.
122 
123## 💻 Development
124 
125DroidMind uses `uv` for dependency management and development workflows.
126 
127```bash
128# Install/update dependencies (creates/updates `.venv`)
129uv sync --all-groups
130 
131# Run tests
132uv run pytest
133 
134# Run linting
135uv run ruff check .
136 
137# Run type checking
138uv run pyright
139```
140 
141## 🤝 Contributing
142 
143Contributions are welcome! Please feel free to submit a Pull Request.
144 
1451.  Fork the repository.
1462.  Create your feature branch (`git checkout -b feature/amazing-feature`).
1473.  Set up your development environment with `uv`.
1484.  Make your changes.
1495.  Run tests, linting, and type checking.
1506.  Commit your changes (`git commit -m 'Add some amazing feature'`).
1517.  Push to the branch (`git push origin feature/amazing-feature`).
1528.  Open a Pull Request.
153 
154## 📝 License
155 
156This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.
157 
158---
159 
160<div align="center">
161 
162Created by [Stefanie Jane 🌠](https://github.com/hyperb1iss)
163 
164If you find DroidMind useful, [buy me a Monster Ultra Violet ⚡️](https://ko-fi.com/hyperb1iss)
165 
166</div>
167