mobile-debug-mcp 0.30.1 → 0.31.0

package/README.md

@@ -16,11 +16,36 @@ A minimal, secure MCP server for AI-assisted mobile development. Build, install,
 - Xcode command-line tools for iOS support
 - [idb](https://github.com/facebook/idb) for iOS device support
 
+## Environment Setup
+
+The server discovers Android and iOS tools automatically from standard locations by default. Manual environment setup is still supported, but it should be treated as the fallback for non-standard installs, overrides, or reproducible pinned toolchains.
+
+Use explicit paths when:
+- you have multiple SDKs installed
+- the tools live outside standard locations
+- you want deterministic setup across machines
+- automatic discovery does not find the expected binary
+
+Leave the variables unset when:
+- the tools are already on `PATH`
+- the standard Android and Xcode locations are enough
+
+Common environment variables:
+- `ADB_PATH`: explicit path to `adb`
+- `ANDROID_SDK_ROOT` or `ANDROID_HOME`: Android SDK root
+- `XCRUN_PATH`: explicit path to `xcrun`
+- `MCP_IDB_PATH` or `IDB_PATH`: explicit path to `idb`
+- `GRADLE_JAVA_HOME` or `JAVA_HOME`: Java home for Gradle-backed operations
+
+For normal use, call `get_system_status` first. It reports the detected host, Android, and iOS toolchain state so the client can decide whether automatic discovery is sufficient or whether explicit overrides are needed.
+
 ## Configuration
 
 <details>
 
-<summary>Android Studio</summary>
+<summary>Android setup</summary>
+
+Recommended when you want Android only, or when you want to make the Android toolchain explicit.
 
 ```json
 {
@@ -28,17 +53,25 @@ A minimal, secure MCP server for AI-assisted mobile development. Build, install,
     "mobile-debug": {
       "command": "npx",
       "args": ["--yes","mobile-debug-mcp","server"],
-      "env": { "ADB_PATH": "/path/to/adb", "XCRUN_PATH": "/usr/bin/xcrun", "IDB_PATH": "/path/to/idb" }
+      "env": {
+        "ADB_PATH": "/path/to/adb",
+        "ANDROID_SDK_ROOT": "/path/to/android/sdk",
+        "GRADLE_JAVA_HOME": "/path/to/jdk"
+      }
     }
   }
 }
 ```
 
+For Android-only setups, `XCRUN_PATH` and `IDB_PATH` are not required unless you want to pin them explicitly.
+
 </details>
 
 <details>
 
-<summary>Copilot</summary>
+<summary>iOS setup</summary>
+
+Recommended when you want iOS simulator or device support, or when `idb` lives in a non-standard location.
 
 ```json
 {
@@ -46,12 +79,18 @@ A minimal, secure MCP server for AI-assisted mobile development. Build, install,
     "mobile-debug": {
       "command": "npx",
       "args": ["--yes","mobile-debug-mcp","server"],
-      "env": { "ADB_PATH": "/path/to/adb", "XCRUN_PATH": "/usr/bin/xcrun", "IDB_PATH": "/path/to/idb" }
+      "env": {
+        "XCRUN_PATH": "/usr/bin/xcrun",
+        "MCP_IDB_PATH": "/path/to/idb",
+        "IDB_PATH": "/path/to/idb"
+      }
     }
   }
 }
 ```
 
+For iOS-only setups, `ADB_PATH` and `ANDROID_SDK_ROOT` are not required unless you want to pin them explicitly.
+
 </details>
 
 <details>
@@ -69,7 +108,13 @@ args:
 environment variables:
 * ADB_PATH: /path/to/adb
 * XCRUN_PATH: /usr/bin/xcrun
-* IDC_PATH: /path/to/idb"
+* IDB_PATH: /path/to/idb
+* MCP_IDB_PATH: /path/to/idb
+* ANDROID_SDK_ROOT: /path/to/android/sdk
+* GRADLE_JAVA_HOME: /path/to/jdk
+* JAVA_HOME: /path/to/jdk
+
+If you are unsure whether the environment is configured correctly, run `get_system_status` first. It reports the detected host, Android, and iOS toolchain state in a structured form.
 
 </details>