Skip to content

Commit ae7f13e

Browse files
committed
Improved uv instructions in the README.md #2
Formatted README.md to 80 characters per line
1 parent 7260c94 commit ae7f13e

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Android MCP Server
22

3-
An MCP (Model Context Protocol) server that provides programmatic control over Android devices through ADB (Android Debug Bridge). This server exposes various Android device management capabilities that can be accessed by MCP clients like [Claude desktop](https://modelcontextprotocol.io/quickstart/user) and Code editors (e.g. [Cursor](https://docs.cursor.com/context/model-context-protocol))
3+
An MCP (Model Context Protocol) server that provides programmatic control over
4+
Android devices through ADB (Android Debug Bridge). This server exposes
5+
various Android device management capabilities that can be accessed by MCP
6+
clients like [Claude desktop](https://modelcontextprotocol.io/quickstart/user)
7+
and Code editors
8+
(e.g. [Cursor](https://docs.cursor.com/context/model-context-protocol))
49

510
## Features
611

@@ -25,15 +30,19 @@ cd android-mcp-server
2530
```
2631

2732
2. Install dependencies:
28-
This project uses `uv` for project management
33+
This project uses [uv](https://github.com/astral-sh/uv) for project
34+
management via various methods of
35+
[installation](https://docs.astral.sh/uv/getting-started/installation/).
2936

3037
```bash
38+
uv python install 3.11
3139
uv sync
3240
```
3341

3442
## Configuration
3543

36-
The server uses a simple YAML configuration file (`config.yaml`) to specify the target android device
44+
The server uses a simple YAML configuration file (`config.yaml`) to specify the
45+
target android device
3746

3847
### Customizing Configuration
3948

@@ -52,7 +61,8 @@ device:
5261
5362
## Usage
5463
55-
An MCP client is needed to use this server. The Claude Desktop app is an example of an MCP client. To use this server with Claude Desktop:
64+
An MCP client is needed to use this server. The Claude Desktop app is an example
65+
of an MCP client. To use this server with Claude Desktop:
5666
5767
1. Locate your Claude Desktop configuration file:
5868
@@ -75,7 +85,8 @@ An MCP client is needed to use this server. The Claude Desktop app is an example
7585
Replace:
7686

7787
- `path/to/uv` with the actual path to your `uv` executable
78-
- `path/to/android-mcp-server` with the absolute path to where you cloned this repository
88+
- `path/to/android-mcp-server` with the absolute path to where you cloned this
89+
repository
7990

8091

8192
https://github.com/user-attachments/assets/c45bbc17-f698-43e7-85b4-f1b39b8326a8
@@ -134,7 +145,8 @@ def get_package_action_intents(package_name: str) -> list[str]:
134145
Args:
135146
package_name (str): The name of the package to get actions for
136147
Returns:
137-
list[str]: A list of all non-data actions from the Activity Resolver Table for the package
148+
list[str]: A list of all non-data actions from the Activity Resolver
149+
Table for the package
138150
"""
139151
```
140152

@@ -144,4 +156,5 @@ Contributions are welcome!
144156

145157
## Acknowledgments
146158

147-
- Built with [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)
159+
- Built with
160+
[Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)

0 commit comments

Comments
 (0)