Skip to content

Commit e584367

Browse files
hyperb1isshyperb1iss
committed
📝 Update app management documentation
Update README and app_management docs with new app info tools This updates the documentation to reflect the new app information tools that were added in the app manifest migration: - Added new tools to README.md tool list: - get_app_manifest - get_app_permissions - get_app_activities - get_app_info - Removed NeonGlam Console feature from README.md - Removed Development Status section as most features are complete - Updated app_management.md with new App Information section - Fixed function names in usage examples - Added new AI assistant prompt examples
1 parent aa3095f commit e584367

File tree

2 files changed

+42
-39
lines changed

2 files changed

+42
-39
lines changed

‎README.md

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ DroidMind is a powerful bridge between AI assistants and Android devices, enabli
2525
- 👆 **UI Automation** - Interact with the device through taps, swipes, text input, and key presses
2626
- 🔍 **App Inspection** - View app manifests, shared preferences, and app-specific logs
2727
- 🔒 **Security Framework** - Protect devices with comprehensive command validation
28-
- 🌈 **NeonGlam Console** - Enjoy an aesthetic terminal experience with cyberpunk vibes
2928
- 💬 **MCP Integration** - Seamless connection to Claude, Cursor, Cline, and more
3029

3130
## 🚀 Installation
@@ -111,6 +110,10 @@ droidmind --transport sse
111110
- `stop_app` - Force stop an app on the device
112111
- `clear_app_data` - Clear app data and cache
113112
- `list_packages` - List installed packages on the device
113+
- `get_app_manifest` - Get AndroidManifest.xml contents for an app
114+
- `get_app_permissions` - Get permissions requested by an app
115+
- `get_app_activities` - Get activities defined in an app
116+
- `get_app_info` - Get detailed information about an app
114117
- `reboot_device` - Reboot the device (normal, recovery, or bootloader)
115118
- `screenshot` - Get a screenshot from a device
116119
- `capture_bugreport` - Generate a comprehensive bug report from the device
@@ -166,23 +169,6 @@ DroidMind includes a comprehensive security framework to protect your devices wh
166169

167170
The security system is designed to be permissive enough to allow common operations while preventing destructive actions. High-risk commands will display warnings to users before execution, and critical operations are blocked entirely without explicit override.
168171

169-
## 🚧 Development Status
170-
171-
DroidMind is in active development with approximately 90% of planned features implemented. See the [Development Roadmap](docs/plan.md) for details on current progress and upcoming features.
172-
173-
### Current Focus Areas:
174-
175-
1. ~~**UI Automation Development** - Adding touch, text input, and intent capabilities~~ ✅ Completed!
176-
2. ~~**Security Framework** - Adding command validation and safety features~~ ✅ Completed!
177-
3. ~~**App Management** - Completing app lifecycle and data management tools~~ ✅ Completed!
178-
4. ~~**File System Enhancements** - Robust file operations and metadata handling~~ ✅ Completed!
179-
5. **Diagnostic Tools** - Adding advanced diagnostics ✅ Major progress!
180-
- ~~Screenshot tool~~ ✅ Completed
181-
- ~~Bug report generation~~ ✅ Completed
182-
- ~~Heap dump analysis~~ ✅ Completed
183-
- Screen recording 🔄 Pending
184-
6. **Documentation Enhancement** - Comprehensive API docs and tutorials 🔄 In Progress
185-
186172
## 💻 Development
187173

188174
DroidMind uses UV for dependency management and development workflows. UV is a fast, reliable Python package manager and resolver.

‎docs/app_management.md

Lines changed: 38 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,35 +16,44 @@ The App Management module in DroidMind provides comprehensive tools and resource
1616

1717
### Installation and Removal
1818

19-
| Tool | Description | Parameters |
20-
|------|-------------|------------|
21-
| `install_app` | Install an APK on the device | `serial`, `apk_path`, `reinstall` (optional), `grant_permissions` (optional) |
22-
| `uninstall_app` | Remove an app from the device | `serial`, `package`, `keep_data` (optional) |
19+
| Tool | Description | Parameters |
20+
| --------------- | ----------------------------- | ---------------------------------------------------------------------------- |
21+
| `install_app` | Install an APK on the device | `serial`, `apk_path`, `reinstall` (optional), `grant_permissions` (optional) |
22+
| `uninstall_app` | Remove an app from the device | `serial`, `package`, `keep_data` (optional) |
2323

2424
### App Lifecycle
2525

26-
| Tool | Description | Parameters |
27-
|------|-------------|------------|
28-
| `start_app` | Launch an app | `serial`, `package`, `activity` (optional) |
29-
| `stop_app` | Force stop an app | `serial`, `package` |
30-
| `clear_app_data` | Clear app data and cache | `serial`, `package` |
26+
| Tool | Description | Parameters |
27+
| ---------------- | ------------------------ | ------------------------------------------ |
28+
| `start_app` | Launch an app | `serial`, `package`, `activity` (optional) |
29+
| `stop_app` | Force stop an app | `serial`, `package` |
30+
| `clear_app_data` | Clear app data and cache | `serial`, `package` |
3131

3232
### App Discovery
3333

34-
| Tool | Description | Parameters |
35-
|------|-------------|------------|
34+
| Tool | Description | Parameters |
35+
| --------------- | ----------------------- | ------------------------------------------ |
3636
| `list_packages` | List installed packages | `serial`, `include_system_apps` (optional) |
3737

38+
### App Information
39+
40+
| Tool | Description | Parameters |
41+
| --------------------- | ------------------------------------- | ------------------- |
42+
| `get_app_manifest` | Get AndroidManifest.xml contents | `serial`, `package` |
43+
| `get_app_permissions` | Get permissions requested by an app | `serial`, `package` |
44+
| `get_app_activities` | Get activities defined in an app | `serial`, `package` |
45+
| `get_app_info` | Get detailed information about an app | `serial`, `package` |
46+
3847
## 📁 MCP Resources
3948

4049
### App Information
4150

42-
| Resource | Description | Example Use |
43-
|----------|-------------|-------------|
44-
| `fs://{serial}/app/{package}/manifest` | App manifest | "Show me the permissions my app is requesting" |
45-
| `fs://{serial}/app/{package}/data` | App data directory listing | "What files has my app created?" |
46-
| `fs://{serial}/app/{package}/shared_prefs` | App preferences | "Show me the saved preferences in my app" |
47-
| `logs://{serial}/app/{package}` | App-specific logs | "What errors is my app generating?" |
51+
| Resource | Description | Example Use |
52+
| ------------------------------------------ | -------------------------- | ---------------------------------------------- |
53+
| `fs://{serial}/app/{package}/manifest` | App manifest | "Show me the permissions my app is requesting" |
54+
| `fs://{serial}/app/{package}/data` | App data directory listing | "What files has my app created?" |
55+
| `fs://{serial}/app/{package}/shared_prefs` | App preferences | "Show me the saved preferences in my app" |
56+
| `logs://{serial}/app/{package}` | App-specific logs | "What errors is my app generating?" |
4857

4958
## 💎 Usage Examples
5059

@@ -76,10 +85,16 @@ await clear_app_data(serial="emulator-5554", package="com.example.app")
7685

7786
```python
7887
# Get app manifest
79-
manifest = await app_manifest(serial="emulator-5554", package="com.example.app")
88+
manifest = await get_app_manifest(serial="emulator-5554", package="com.example.app")
89+
90+
# Get app permissions
91+
permissions = await get_app_permissions(serial="emulator-5554", package="com.example.app")
92+
93+
# Get app activities
94+
activities = await get_app_activities(serial="emulator-5554", package="com.example.app")
8095

81-
# Get app shared preferences
82-
prefs = await app_shared_prefs(serial="emulator-5554", package="com.example.app")
96+
# Get app info
97+
info = await get_app_info(serial="emulator-5554", package="com.example.app")
8398

8499
# Get app-specific logs
85100
logs = await app_logs(serial="emulator-5554", package="com.example.app")
@@ -113,6 +128,8 @@ When working with app management, try these prompts with your AI assistant:
113128
- "Show me all the permissions that TikTok is requesting"
114129
- "What shared preferences has my game saved?"
115130
- "Show me recent crash logs for my app"
131+
- "What activities are available in the Settings app?"
132+
- "Give me detailed information about YouTube app"
116133

117134
## 🔄 Future Enhancements
118135

@@ -121,4 +138,4 @@ When working with app management, try these prompts with your AI assistant:
121138
- Runtime permission management
122139
- App usage statistics
123140
- App network traffic monitoring
124-
- Storage usage analysis
141+
- Storage usage analysis

0 commit comments

Comments
 (0)