mobile-debug-mcp 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -8
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -25,7 +25,9 @@
25
25
 
26
26
  ## Installation
27
27
 
28
- Clone the repo and build:
28
+ You can install and use **Mobile Debug MCP** in one of two ways:
29
+
30
+ ### 1. Clone the repository for local development
29
31
 
30
32
  ```bash
31
33
  git clone https://github.com/YOUR_USERNAME/mobile-debug-mcp.git
@@ -34,30 +36,40 @@ npm install
34
36
  npm run build
35
37
  ```
36
38
 
37
- Alternatively, you can publish to npm and install globally:
39
+ This option is suitable if you want to modify or contribute to the code.
40
+
41
+ ### 2. Install via npm for standard use
38
42
 
39
43
  ```bash
40
44
  npm install -g mobile-debug-mcp
41
45
  ```
42
46
 
47
+ This option installs the package globally for easy use without cloning the repo.
48
+
43
49
  ---
44
50
 
45
51
  ## MCP Server Configuration
46
52
 
47
- Example WebUI MCP config:
53
+ Example WebUI MCP config using `npx --yes` and `ADB_PATH` environment variable:
48
54
 
49
55
  ```json
50
56
  {
51
57
  "mcpServers": {
52
58
  "mobile-debug": {
53
- "command": "node",
54
- "args": ["/full/path/to/mobile-debug-mcp/dist/server.js"]
59
+ "command": "npx",
60
+ "args": [
61
+ "--yes",
62
+ "mobile-debug-mcp",
63
+ "server",
64
+ "--adb-path",
65
+ "${ADB_PATH}"
66
+ ]
55
67
  }
56
68
  }
57
69
  }
58
70
  ```
59
71
 
60
- > Make sure to replace `/full/path/to/` with your actual project path.
72
+ > Make sure to set the `ADB_PATH` environment variable to the full path of your `adb` executable.
61
73
 
62
74
  ---
63
75
 
@@ -80,7 +92,7 @@ Launch a mobile app.
80
92
  ```json
81
93
  {
82
94
  "platform": "android",
83
- "id": "com.modul8.app"
95
+ "id": "com.example.app"
84
96
  }
85
97
  ```
86
98
 
@@ -92,6 +104,7 @@ Fetch recent logs from the app.
92
104
  ```json
93
105
  {
94
106
  "platform": "android" | "ios",
107
+ "id": "com.example.app", // Android package or iOS bundle ID (required)
95
108
  "lines": 200 // optional, Android only
96
109
  }
97
110
  ```
@@ -101,6 +114,7 @@ Fetch recent logs from the app.
101
114
  ```json
102
115
  {
103
116
  "platform": "android",
117
+ "id": "com.example.app",
104
118
  "lines": 200
105
119
  }
106
120
  ```
@@ -118,7 +132,7 @@ Fetch recent logs from the app.
118
132
 
119
133
  ## Notes
120
134
 
121
- - Ensure `adb` and `xcrun` are in your PATH.
135
+ - Ensure `adb` and `xcrun` are in your PATH or set `ADB_PATH` accordingly.
122
136
  - For iOS, the simulator must be booted before using `start_app` or `get_logs`.
123
137
  - You may want to clear Android logs before launching for cleaner output: `adb logcat -c`
124
138
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mobile-debug-mcp",
3
- "version": "0.2.0",
3
+ "version": "0.3.0",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "mobile-debug-mcp": "./dist/server.js"