mobile-debug-mcp 0.34.0 → 0.36.0

package/dist/server/definitions/manage.js

@@ -0,0 +1,194 @@
+export const manageTools = [
+    {
+        name: 'start_app',
+        description: `Purpose:
+Launch a mobile app on Android or iOS.
+
+Inputs:
+- platform
+- appId
+- deviceId (optional)
+
+Output Structure:
+ - action_id, timestamp (ISO 8601), action_type
+ - lifecycle_state: post-dispatch lifecycle state (pending_verification or failed)
+ - source_module: runtime source of the action envelope
+ - target.selector = { appId }
+- success = true when launch was dispatched successfully
+- failure_code/retryable when launch dispatch fails
+- ui_fingerprint_before/ui_fingerprint_after when available
+
+Recommended Usage:
+1. Define the expected landing screen when it is known
+2. Call start_app
+3. If needed, wait for transition using wait_for_*
+4. Verify with expect_screen
+5. If verification fails, retry once or capture a snapshot
+
+Verification Guidance:
+- Follow RESOLVE → ACT → WAIT (if needed) → EXPECT
+- expect_screen is the authoritative verification step when the landing screen is known
+- Do not treat timing or screen change alone as final verification
+
+Failure Handling:
+- TIMEOUT → retry once
+- UNKNOWN → inspect snapshot/logs before retrying`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios']
+                },
+                appId: {
+                    type: 'string',
+                    description: 'Android package name or iOS bundle id'
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.'
+                },
+                verificationMode: { type: 'string', enum: ['none', 'light', 'full'], default: 'full' },
+                responseMode: { type: 'string', enum: ['compact', 'debug'], default: 'debug' },
+                actionTimeoutMs: { type: 'number', minimum: 100, maximum: 30000 },
+                verificationTimeoutMs: { type: 'number', minimum: 100, maximum: 60000 }
+            },
+            required: ['platform', 'appId']
+        }
+    },
+    {
+        name: 'terminate_app',
+        description: 'Terminate a mobile app on Android or iOS simulator',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios']
+                },
+                appId: {
+                    type: 'string',
+                    description: 'Android package name or iOS bundle id'
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.'
+                }
+            },
+            required: ['platform', 'appId']
+        }
+    },
+    {
+        name: 'restart_app',
+        description: `Purpose:
+Restart a mobile app on Android or iOS.
+
+Inputs:
+- platform
+- appId
+- deviceId (optional)
+
+Output Structure:
+ - action_id, timestamp (ISO 8601), action_type
+ - lifecycle_state: post-dispatch lifecycle state (pending_verification or failed)
+ - source_module: runtime source of the action envelope
+ - target.selector = { appId }
+- success = true when the restart command completed
+- failure_code/retryable when restart dispatch fails
+- ui_fingerprint_before/ui_fingerprint_after when available
+
+Recommended Usage:
+1. Define the expected landing screen when it is known
+2. Call restart_app
+3. If needed, wait for transition using wait_for_*
+4. Verify with expect_screen
+5. If verification fails, retry once or capture a snapshot
+
+Verification Guidance:
+- Follow RESOLVE → ACT → WAIT (if needed) → EXPECT
+- expect_screen is the authoritative verification step when the reopened screen is known
+- Do not treat timing or screen change alone as final verification
+
+Failure Handling:
+- TIMEOUT → retry once
+- UNKNOWN → inspect snapshot/logs before retrying`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios']
+                },
+                appId: {
+                    type: 'string',
+                    description: 'Android package name or iOS bundle id'
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.'
+                }
+            },
+            required: ['platform', 'appId']
+        }
+    },
+    {
+        name: 'reset_app_data',
+        description: 'Reset app data (clear storage) for a mobile app on Android or iOS simulator',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios']
+                },
+                appId: {
+                    type: 'string',
+                    description: 'Android package name or iOS bundle id'
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.'
+                }
+            },
+            required: ['platform', 'appId']
+        }
+    },
+    {
+        name: 'install_app',
+        description: 'Install an app on Android or iOS. Accepts a built binary (apk/.ipa/.app) or a project directory to build then install. platform and projectType are required.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Platform to install to (required).' },
+                projectType: { type: 'string', enum: ['native', 'kmp', 'react-native', 'flutter'], description: 'Project type to guide build/install tool selection (required).' },
+                appPath: { type: 'string', description: 'Path to APK, .app, .ipa, or project directory' },
+                deviceId: { type: 'string', description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.' }
+            },
+            required: ['platform', 'projectType', 'appPath']
+        }
+    },
+    {
+        name: 'build_app',
+        description: 'Build a project for Android or iOS and return the built artifact path. Does not install. platform and projectType are required.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Platform to build for (required).' },
+                projectType: { type: 'string', enum: ['native', 'kmp', 'react-native', 'flutter'], description: 'Project type to guide build tool selection (required).' },
+                projectPath: { type: 'string', description: 'Path to project directory (contains gradlew or xcodeproj/xcworkspace)' },
+                variant: { type: 'string', description: 'Optional build variant (e.g., Debug/Release)' }
+            },
+            required: ['platform', 'projectType', 'projectPath']
+        }
+    },
+    {
+        name: 'list_devices',
+        description: 'List connected devices and their metadata (android + ios).',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'] }
+            }
+        }
+    }
+];

package/dist/server/definitions/observe.js

@@ -0,0 +1,149 @@
+export const observeTools = [
+    {
+        name: 'get_logs',
+        description: 'Get recent logs from Android or iOS simulator. Returns device metadata and structured logs suitable for AI consumption.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios']
+                },
+                appId: {
+                    type: 'string',
+                    description: 'Filter by Android package name or iOS bundle id'
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.'
+                },
+                pid: { type: 'number', description: 'Filter by process id' },
+                tag: { type: 'string', description: 'Filter by tag (Android) or subsystem/category (iOS)' },
+                level: { type: 'string', description: 'Log level filter (VERBOSE, DEBUG, INFO, WARN, ERROR)' },
+                contains: { type: 'string', description: 'Substring to match in log message' },
+                since_seconds: { type: 'number', description: 'Only return logs from the last N seconds' },
+                limit: { type: 'number', description: 'Override default number of returned lines' },
+                lines: {
+                    type: 'number',
+                    description: 'Legacy - number of log lines (android only)'
+                }
+            },
+            required: ['platform']
+        }
+    },
+    {
+        name: 'capture_screenshot',
+        description: 'Capture a screenshot from an Android device or iOS simulator. Returns device metadata and the screenshot image.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios']
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device UDID (iOS) or Serial (Android). Defaults to booted/connected.'
+                }
+            },
+            required: ['platform']
+        }
+    },
+    {
+        name: 'capture_debug_snapshot',
+        description: 'Capture a complete debug snapshot (raw observation layer plus optional derived semantic layer). Returns structured JSON with snapshot_revision, captured_at_ms, snapshot_delta, and loading_state when detectable.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                reason: { type: 'string', description: 'Optional reason for snapshot' },
+                includeLogs: { type: 'boolean', description: 'Whether to include logs', default: true },
+                includeScreenshot: { type: 'boolean', description: 'Whether to collect screenshot bytes', default: true },
+                logLines: { type: 'number', description: 'Maximum number of log lines to include', default: 200 },
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override' },
+                appId: { type: 'string', description: 'Optional appId to scope logs (package/bundle id)' },
+                deviceId: { type: 'string', description: 'Optional device serial/udid' },
+                sessionId: { type: 'string', description: 'Optional log stream session id to prefer' }
+            }
+        }
+    },
+    {
+        name: 'start_log_stream',
+        description: 'Start streaming logs for a target application on Android or iOS. For Android this uses adb logcat --pid=<pid>; for iOS it streams `xcrun simctl spawn <device> log stream` with a predicate.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'], default: 'android' },
+                packageName: { type: 'string', description: 'Android package name or iOS bundle id' },
+                level: { type: 'string', enum: ['error', 'warn', 'info', 'debug'], default: 'error' },
+                deviceId: { type: 'string', description: 'Device Serial (Android) or UDID (iOS). Defaults to connected/booted device.' },
+                sessionId: { type: 'string', description: 'Session identifier for the log stream' }
+            },
+            required: ['packageName']
+        }
+    },
+    {
+        name: 'read_log_stream',
+        description: 'Read accumulated log stream entries for the active session.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                sessionId: { type: 'string' }
+            }
+        }
+    },
+    {
+        name: 'stop_log_stream',
+        description: 'Stop an active log stream for the session.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                sessionId: { type: 'string' }
+            }
+        }
+    },
+    {
+        name: 'get_ui_tree',
+        description: 'Get the current UI hierarchy from an Android device or iOS simulator. Returns a structured JSON representation of the screen content with snapshot metadata and incremental delta signals when available.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: {
+                    type: 'string',
+                    enum: ['android', 'ios'],
+                    description: 'Platform to get UI tree for'
+                },
+                deviceId: {
+                    type: 'string',
+                    description: 'Device Serial (Android) or UDID (iOS). Defaults to connected/booted device.'
+                },
+                responseMode: { type: 'string', enum: ['compact', 'debug'], default: 'debug' },
+                sinceSnapshotRevision: { type: 'number', minimum: 1 }
+            },
+            required: ['platform']
+        }
+    },
+    {
+        name: 'get_current_screen',
+        description: 'Get the currently visible activity on an Android device. Returns package and activity name.',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                deviceId: {
+                    type: 'string',
+                    description: 'Device Serial (Android). Defaults to connected/booted device.'
+                }
+            }
+        }
+    },
+    {
+        name: 'get_screen_fingerprint',
+        description: 'Generate a stable fingerprint representing the current visible screen (activity + visible UI elements).',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override (android|ios)' },
+                deviceId: { type: 'string', description: 'Optional device id/udid to target' }
+            }
+        }
+    }
+];

package/dist/server/definitions/target.js

@@ -0,0 +1,138 @@
+export const targetTools = [
+    {
+        name: 'adjust_control',
+        description: `Purpose:
+Adjust a numeric control value with verification.
+
+This is the initial adjustable-control surface for slider-like controls and other controls that expose a numeric value or value_range.
+
+Inputs:
+- exactly one of selector or element_id
+- property (defaults to "value")
+- targetValue
+- tolerance (optional; discrete default is 0, continuous default is max(step / 2, 1% of range) when omitted)
+- maxAttempts (optional; defaults to 5)
+- platform/deviceId (optional)
+
+Output Structure:
+- action_id, timestamp (ISO 8601), action_type
+- lifecycle_state: post-dispatch lifecycle state (pending_verification or failed)
+- source_module: runtime source of the action envelope
+- target_state / actual_state / within_tolerance / converged / attempts / adjustment_mode
+- target.selector = original selector or element handle
+- success = true when the control converges within tolerance
+
+Verification Guidance:
+- Prefer direct platform adjustment when the runtime exposes it; then verified increment/decrement actions; use coordinate fallback only as degraded mode
+- Use expect_state for the control value readback
+- Do not use derived semantic metadata as proof of success
+
+Failure Handling:
+- ELEMENT_NOT_FOUND → re-resolve the control
+- ELEMENT_NOT_INTERACTABLE → the control cannot be adjusted through the current runtime
+- CONTROL_CONVERGENCE_FAILED → the control did not converge within bounded retries or the requested value is out of range
+- UNKNOWN → capture a snapshot and stop`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                selector: {
+                    type: 'object',
+                    properties: {
+                        text: { type: 'string' },
+                        resource_id: { type: 'string' },
+                        accessibility_id: { type: 'string' },
+                        contains: { type: 'boolean', default: false }
+                    }
+                },
+                element_id: { type: 'string', description: 'Optional previously resolved element identifier.' },
+                property: { type: 'string', description: 'Readable numeric state property to adjust.', default: 'value' },
+                targetValue: { type: 'number', description: 'Target numeric value.' },
+                tolerance: { type: 'number', description: 'Accepted numeric tolerance around the target value. Defaults are derived from the readable control domain.' },
+                maxAttempts: { type: 'number', description: 'Maximum adjustment attempts.', default: 5 },
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override' },
+                deviceId: { type: 'string', description: 'Optional device serial/udid' }
+            },
+            required: ['targetValue'],
+            oneOf: [
+                { required: ['selector'] },
+                { required: ['element_id'] }
+            ]
+        }
+    },
+    {
+        name: 'find_element',
+        description: `Find a UI element by semantic query (text, content-desc, resource-id, class).
+
+Returns the best match plus resolution metadata when available, including confidence, selection reason, and fallback alternates.`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                query: { type: 'string', description: 'Search query (text or label)' },
+                exact: { type: 'boolean', description: 'Require exact match (true/false)', default: false },
+                timeoutMs: { type: 'number', description: 'Timeout in ms to keep searching', default: 3000 },
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override' },
+                deviceId: { type: 'string', description: 'Optional device serial/udid' }
+            },
+            required: ['query']
+        }
+    },
+    {
+        name: 'tap_element',
+        description: `Purpose:
+Tap a previously resolved UI element using its elementId.
+
+Inputs:
+- elementId: a resolved UI element identifier returned by wait_for_ui
+
+Output Structure:
+- action_id: unique timestamp-based action identifier
+- timestamp: ISO 8601 timestamp for the action attempt
+- action_type: "tap_element"
+- lifecycle_state: post-dispatch lifecycle state (pending_verification or failed)
+- source_module: runtime source of the action envelope
+- target.selector: original target handle ({ elementId })
+- target.resolved: minimal resolved element info used for the tap
+- success: true when the tap was dispatched
+- failure_code: present when success=false
+- retryable: present when failure_code exists
+- ui_fingerprint_before/ui_fingerprint_after: optional fingerprints captured around the action
+
+Recommended Usage:
+1. Resolve the target with wait_for_ui or another deterministic resolver
+2. Call tap_element
+3. If needed, wait for transition using wait_for_*
+4. Verify outcome using expect_*
+   - use expect_screen when navigation is expected
+   - use expect_element_visible when the UI change is local
+5. If verification fails, inspect failure_code and follow the retry strategy below
+
+Verification Guidance:
+- Follow RESOLVE → ACT → WAIT (if needed) → EXPECT
+- Prefer expect_screen for navigation or modal transitions
+- Prefer expect_element_visible when the tap should reveal or update a specific element
+- wait_for_* may be used for resolution and synchronization, but not as the final verification step when an applicable expect_* tool exists
+- Do not treat tap_element.success as outcome success; it only means the tap was executed
+
+Failure Handling:
+- STALE_REFERENCE → re-resolve the element, then retry
+- ELEMENT_NOT_INTERACTABLE → wait or refine the target, then retry
+- UNKNOWN → capture a snapshot and stop
+
+This tool reports execution success only. Verification must be done with a separate expect_* tool.`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                elementId: {
+                    type: 'string',
+                    description: 'A unique element identifier returned by wait_for_ui'
+                },
+                selector: { type: 'object', properties: { text: { type: 'string' }, resource_id: { type: 'string' }, accessibility_id: { type: 'string' }, contains: { type: 'boolean' } } },
+                waitFor: { type: 'object', properties: { condition: { type: 'string', enum: ['exists', 'visible', 'clickable'] }, timeoutMs: { type: 'number', minimum: 100, maximum: 10000 }, pollIntervalMs: { type: 'number', minimum: 50, maximum: 1000 }, match: { type: 'object', properties: { index: { type: 'number' } } } } },
+                platform: { type: 'string', enum: ['android', 'ios'] },
+                deviceId: { type: 'string' },
+                verificationMode: { type: 'string', enum: ['none', 'light', 'full'], default: 'full' },
+                responseMode: { type: 'string', enum: ['compact', 'debug'], default: 'debug' }
+            }
+        }
+    }
+];

package/dist/server/definitions/wait.js

@@ -0,0 +1,105 @@
+export const waitTools = [
+    {
+        name: 'wait_for_screen_change',
+        description: `Purpose:
+Detect that a screen transition has occurred by waiting for the current fingerprint to differ from a previous fingerprint.
+
+Capabilities:
+- Synchronization for uncertain navigation timing
+- Detection that something changed on screen
+
+Constraints:
+- Does not verify correctness of the resulting state
+- Must not be used alone to confirm action success when an applicable expect_* tool exists
+- For backend/API activity without a visible UI change, pass the runtime action_type into classify_action_outcome and collect network evidence only if the result remains ambiguous
+
+Recommended Usage:
+1. Capture or define the expected outcome
+2. Call an action tool
+3. Use wait_for_screen_change when transition timing is uncertain
+4. Follow with expect_screen when the expected destination is known`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override (android|ios)' },
+                previousFingerprint: { type: 'string', description: 'The fingerprint to compare against (required)' },
+                timeoutMs: { type: 'number', description: 'Timeout in ms to wait for change (default 5000)', default: 5000 },
+                pollIntervalMs: { type: 'number', description: 'Polling interval in ms (default 300)', default: 300 },
+                deviceId: { type: 'string', description: 'Optional device id/udid to target' }
+            },
+            required: ['previousFingerprint']
+        }
+    },
+    {
+        name: 'wait_for_ui_change',
+        description: `Purpose:
+Wait for a non-navigation UI mutation or in-place update to become stable.
+
+Inputs:
+- expected_change (optional): hierarchy_diff, text_change, or state_change
+- timeout_ms (optional)
+- stability_window_ms (optional)
+- scope (optional): screen or subtree
+- target (optional): element_id when scope=subtree
+
+Guidance:
+- Prefer wait_for_screen_change for navigation transitions.
+- Prefer wait_for_ui_change for in-place mutations and non-navigation updates.
+- Use the returned snapshot_revision as the observed synchronization point when available.
+- Scoped waits return scope-aware stability metadata and a lightweight change summary.
+
+Failure Handling:
+- TIMEOUT means the UI did not change in a stable way within the allotted time.`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override (android|ios)' },
+                deviceId: { type: 'string', description: 'Optional device id/udid to target' },
+                expected_change: { type: 'string', enum: ['hierarchy_diff', 'text_change', 'state_change'], description: 'Optional type of UI change to wait for' },
+                scope: { type: 'string', enum: ['screen', 'subtree'], default: 'screen', description: 'Synchronization scope for the wait' },
+                target: { type: 'string', description: 'Target element_id when scope is subtree' },
+                timeout_ms: { type: 'number', description: 'Timeout in ms to wait for change (default 60000)', default: 60000 },
+                stability_window_ms: { type: 'number', description: 'How long the change must remain stable before success (default 300)', default: 300 }
+            }
+        }
+    },
+    {
+        name: 'wait_for_ui',
+        description: `Purpose:
+Resolve elements and/or detect that a UI transition or availability condition has occurred.
+
+Capabilities:
+- Deterministic element resolution
+- Synchronization when element timing or availability is uncertain
+
+Constraints:
+- Does not verify correctness of the resulting state
+- Must not be used alone to confirm action success when an applicable expect_* tool exists
+
+Recommended Usage:
+1. Use wait_for_ui to resolve an element before acting or to wait for UI readiness
+2. Call the action tool
+3. If the expected outcome is known, follow with expect_* as final verification`,
+        inputSchema: {
+            type: 'object',
+            properties: {
+                selector: {
+                    type: 'object',
+                    properties: {
+                        text: { type: 'string' },
+                        resource_id: { type: 'string' },
+                        accessibility_id: { type: 'string' },
+                        contains: { type: 'boolean', description: 'When true, perform substring matching', default: false }
+                    }
+                },
+                condition: { type: 'string', enum: ['exists', 'not_exists', 'visible', 'clickable'], default: 'exists' },
+                timeout_ms: { type: 'number', default: 60000 },
+                poll_interval_ms: { type: 'number', default: 300 },
+                match: { type: 'object', properties: { index: { type: 'number' } } },
+                retry: { type: 'object', properties: { max_attempts: { type: 'number', default: 1 }, backoff_ms: { type: 'number', default: 0 } } },
+                platform: { type: 'string', enum: ['android', 'ios'], description: 'Optional platform override' },
+                deviceId: { type: 'string', description: 'Optional device serial/udid' }
+            }
+        }
+    }
+];