You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add logo image and improve visual branding across documentation
This update introduces a cohesive visual identity:
- Add neon glow icon logo to docs and README
- Enhance badge styling with logos and consistent colors
- Improve MCP reference formatting with better indentation
- Update quickstart guide with clearer transport explanations
- Remove plan.md from navigation structure
- Standardize documentation appearance across all files
**Control Android devices with AI through the Model Context Protocol**
10
16
11
-
</div>
12
-
13
17
**DroidMind is your visionary copilot for Android mastery, bridging the gap between your AI assistant and Android devices.** It leverages the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) to unlock unparalleled control, debugging, and system analysis capabilities—all through natural language.
14
18
15
19
Imagine your AI assistant not just _talking_ about code, but actively participating in the development loop: building, testing, and debugging directly on your Android devices. DroidMind makes this a reality.
Copy file name to clipboardExpand all lines: docs/quickstart.md
+20-12Lines changed: 20 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Your IDE will look for a configuration file (e.g., `.cursor/mcp.json` for Cursor
25
25
"git+https://github.com/hyperb1iss/droidmind",
26
26
"droidmind",
27
27
"--transport",
28
-
"stdio"// Or "sse" if your specific IDE/client setup requires it
28
+
"stdio"// The default and preferred mode for most IDE integrations
29
29
]
30
30
}
31
31
}
@@ -35,7 +35,7 @@ Your IDE will look for a configuration file (e.g., `.cursor/mcp.json` for Cursor
35
35
-**`command: "uvx"`**: Tells the IDE to use `uvx`.
36
36
-**`"--from", "git+https://github.com/hyperb1iss/droidmind"`**: `uvx` will fetch DroidMind directly from GitHub.
37
37
-**`"droidmind"`**: The package name to run.
38
-
-**`"--transport", "stdio"`**: Specifies the communication protocol. `stdio` is common for direct IDE integrations. Some clients might require `sse` (e.g., `sse://localhost:4256/sse`), in which case you'd adjust the port and ensure it's free. If using `sse`, you might also need to specify `"--host", "localhost"` and `"--port", "4256"` in the args.
38
+
-**`"--transport", "stdio"`**: Specifies the communication protocol. `stdio` is the default and preferred mode for direct IDE integrations.
39
39
40
40
Once configured, your IDE should automatically start DroidMind when needed. You typically won't see a separate terminal window for DroidMind, as the IDE manages it in the background.
41
41
@@ -45,37 +45,32 @@ Once configured, your IDE should automatically start DroidMind when needed. You
45
45
46
46
With the `mcp.json` (or equivalent) configured, your AI assistant should automatically discover and connect to DroidMind when it starts up or when you try to use a DroidMind-related tool.
47
47
48
-
-**No Manual Connection URI Needed (Usually)**: Since the IDE launches DroidMind, the connection is typically handled internally. You usually don't need to manually input an MCP URI like `sse://localhost:4256/sse` if the IDE is managing the server via `stdio` or a predefined SSE configuration within the `args`.
48
+
-**No Manual Connection URI Needed (Usually)**: Since the IDE launches DroidMind, the connection is typically handled internally. You usually don't need to manually input an MCP URI.
49
49
50
50
-**Instructions for Common Clients**:
51
51
52
52
-**Cursor**:
53
53
54
54
1. Ensure your project has a `.cursor/mcp.json` file with the DroidMind configuration shown in Step 1.
55
55
2. Restart Cursor or open a new project window.
56
-
3. Cursor should automatically use `uvx` to run DroidMind when you invoke a command that would use DroidMind's tools.
56
+
3. Cursor will automatically start DroidMind on startup, making its tools immediately available.
57
57
58
58
-**Claude Desktop**:
59
59
1. Open Claude Desktop settings (from the main application menu).
60
60
2. Go to `Developer` settings.
61
61
3. Click `Edit Config` to open `claude_desktop_config.json`.
62
-
4. Add or modify the `mcpServers` section similar to the example in Step 1. Claude Desktop is designed to launch MCP servers itself.
62
+
4. Add or modify the `mcpServers` section similar to the example below. Claude Desktop is designed to launch MCP servers itself.
63
63
```json
64
64
{
65
65
"mcpServers": {
66
-
"droidmind_via_uvx": {
67
-
// You can name this entry as you like
66
+
"droidmind": {
68
67
"command": "uvx",
69
68
"args": [
70
69
"--from",
71
70
"git+https://github.com/hyperb1iss/droidmind",
72
71
"droidmind",
73
72
"--transport",
74
-
"sse", // Claude Desktop typically uses SSE
75
-
"--host",
76
-
"localhost",
77
-
"--port",
78
-
"4256"// Or another free port
73
+
"stdio"// Default and preferred for Claude Desktop
79
74
]
80
75
// Add "workingDirectory": "/path/to/your/droidmind/project" if needed
81
76
// Add "env": { ... } if DroidMind needs specific environment variables
@@ -85,6 +80,19 @@ With the `mcp.json` (or equivalent) configured, your AI assistant should automat
85
80
```
86
81
5. Restart Claude Desktop. It will attempt to start DroidMind using this configuration.
87
82
83
+
**Note on SSE Transport (Alternative Method):**
84
+
If you need to use SSE transport instead of stdio (for specific use cases or compatibility reasons):
85
+
86
+
1. You'll need to run the DroidMind server manually with SSE enabled:
2. Then configure your AI client to connect to the SSE endpoint (e.g., `sse://localhost:4256/sse`).
93
+
94
+
This approach requires more manual setup but may be necessary for certain client configurations. See the [Installation Guide](installation.md) for more details on running DroidMind as a standalone server.
95
+
88
96
After successful connection (which is often automatic with IDE-managed servers), your AI assistant should indicate that DroidMind's tools are available (often indicated by a special icon or prefix in the chat input, or by the AI successfully executing DroidMind commands).
0 commit comments