uiautomator2-mcp-server 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl

u2mcp/__main__.py

@@ -1,55 +1,77 @@
 from __future__ import annotations
 
-import asyncio
 import logging
-from typing import Annotated, Any, Awaitable
+import re
+import secrets
+from typing import Annotated, Any, Literal
 
 import typer
 
-logging.basicConfig(
-    level=logging.INFO,
-    format="[%(asctime)s] %(levelname)s %(name)s - %(message)s",
-    handlers=[logging.StreamHandler()],
-    force=True,
-)
-
-logging.getLogger("mcp.server").setLevel(logging.WARNING)
-logging.getLogger("sse_starlette").setLevel(logging.WARNING)
-logging.getLogger("docket").setLevel(logging.WARNING)
-logging.getLogger("fakeredis").setLevel(logging.WARNING)
-
 
 def run(
-    http: Annotated[bool, typer.Option("--http", "-h", help="Run mcp server in streamable http mode")] = False,
-    stdio: Annotated[bool, typer.Option("--stdio", "-s", help="Run mcp server in stdio mode")] = False,
-    host: Annotated[str | None, typer.Option("--host", "-H", show_default=False, help="Host address for http mode")] = None,
-    port: Annotated[int | None, typer.Option("--port", "-p", show_default=False, help="Port number for http mode")] = None,
-    log_level: Annotated[str | None, typer.Option("--log-level", "-l", help="Log level")] = None,
+    transport: Annotated[
+        Literal["http", "stdio"], typer.Argument(help="Run mcp server on streamable-http http or stdio transport")
+    ] = "stdio",
+    host: Annotated[
+        str, typer.Option("--host", "-H", show_default=False, help="Host address of streamable-http transport")
+    ] = "127.0.0.1",
+    port: Annotated[
+        int, typer.Option("--port", "-p", show_default=False, help="Port number of streamable-http transport")
+    ] = 8000,
+    json_response: Annotated[bool, typer.Option("--json-response", "-j", help="Whether to use JSON response format")] = True,
+    log_level: Annotated[
+        Literal["debug", "info", "warning", "error", "critical"], typer.Option("--log-level", "-l", help="Log level")
+    ] = "info",
+    no_token: Annotated[
+        bool,
+        typer.Option(
+            "--no-token",
+            help="Disable authentication bearer token verification of streamable-http transport. If not set, a token will be generated randomly.",
+        ),
+    ] = False,
+    token: Annotated[
+        str | None,
+        typer.Option("--token", "-t", help="Explicit set token of streamable-http authentication"),
+    ] = None,
 ):
     """Run uiautomator2 mcp server"""
-    if not http and not stdio:
-        typer.Abort("Please specify one of ‘--http’ or ‘--stdio’")
+    logging.basicConfig(
+        level=log_level.upper(),
+        format="[%(asctime)s] %(levelname)s %(name)s - %(message)s",
+        handlers=[logging.StreamHandler()],
+        force=True,
+    )
+
+    logging.getLogger("mcp.server").setLevel(logging.WARNING)
+    logging.getLogger("sse_starlette").setLevel(logging.WARNING)
+    logging.getLogger("docket").setLevel(logging.WARNING)
+    logging.getLogger("fakeredis").setLevel(logging.WARNING)
 
     from . import tools as _
-    from .mcp import mcp
+    from .mcp import mcp, update_params
+
+    transport_kwargs: dict[str, Any] = {"json_response": json_response}
 
-    awaitables: list[Awaitable] = []
+    update_params(transport=transport)
+
+    if transport == "http":
+        if token:
+            token = token.strip()
+            if not re.match(r"^[a-zA-Z0-9\-_.~!$&'()*+,;=:@]{8,64}$", token):
+                raise typer.BadParameter("Token must be 8-64 characters long and can only contain URL-safe characters")
+        elif not no_token:
+            token = secrets.token_urlsafe()
+        if token:
+            update_params(token=token, host=host, port=port)
 
-    if http:
-        transport_kwargs: dict[str, Any] = {}
         if host:
             transport_kwargs["host"] = host
         if port:
             transport_kwargs["port"] = port
-        awaitables.append(mcp.run_http_async(transport="streamable-http", **transport_kwargs, log_level=log_level))
-
-    if stdio:
-        awaitables.append(mcp.run_stdio_async(log_level=log_level))
-
-    async def _run():
-        await asyncio.gather(*awaitables)
 
-    asyncio.run(_run())
+        mcp.run(transport="streamable-http", **transport_kwargs, log_level=log_level)
+    else:
+        mcp.run(log_level=log_level)
 
 
 def main():

u2mcp/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.1.1'
-__version_tuple__ = version_tuple = (0, 1, 1)
+__version__ = version = '0.1.2'
+__version_tuple__ = version_tuple = (0, 1, 2)
 
 __commit_id__ = commit_id = None

u2mcp/mcp.py

@@ -11,8 +11,51 @@ Before performing operations on a device, you need to initialize it using the in
 All operations require a device serial number to identify the target device.
 """
 
+from contextlib import asynccontextmanager
+from textwrap import dedent
+from typing import Any
+
 from fastmcp import FastMCP
+from fastmcp.server.auth import AccessToken, AuthProvider
+from rich.console import Console
+from rich.markdown import Markdown
 
 __all__ = ["mcp"]
 
-mcp = FastMCP(name="uiautomator2", instructions=__doc__)
+_params: dict[str, Any] = {}
+
+
+def update_params(**kwargs):
+    global _params
+    _params.update(kwargs)
+
+
+@asynccontextmanager
+async def _lifespan(instance: FastMCP):
+    if _params.get("transport") == "http" and (token := _params.get("token")):
+        content = dedent(f"""
+        ------
+
+        **Server configured with authentication token. Connect using this token in the Authorization header:**
+
+        `Authorization: Bearer {token}`
+
+        ------
+        """).strip()
+        Console().print(Markdown(content))
+
+    yield
+
+
+class _SimpleTokenAuthProvider(AuthProvider):
+    _scopes = ["mcp:tools"]
+
+    async def verify_token(self, token: str) -> AccessToken | None:
+        if server_token := _params.get("token"):
+            if token == server_token:
+                return AccessToken(token=token, client_id="user", scopes=self._scopes)
+            return None
+        return AccessToken(token=token, client_id="user", scopes=self._scopes)
+
+
+mcp = FastMCP(name="uiautomator2", instructions=__doc__, lifespan=_lifespan, auth=_SimpleTokenAuthProvider())

u2mcp/tools/device.py

@@ -10,8 +10,7 @@ from typing import Any, Literal
 
 import uiautomator2 as u2
 from adbutils import adb
-from fastmcp.dependencies import CurrentContext
-from fastmcp.server.context import Context
+from fastmcp.server.dependencies import get_context
 from fastmcp.utilities.logging import get_logger
 from PIL.Image import Image
 
@@ -62,7 +61,7 @@ async def device_list() -> list[dict[str, Any]]:
 
 
 @mcp.tool("init")
-async def init(serial: str = "", ctx: Context = CurrentContext()):
+async def init(serial: str = ""):
     """Install essential resources to device.
 
     Important:
@@ -111,6 +110,8 @@ async def init(serial: str = "", ctx: Context = CurrentContext()):
 
     logger.info("read uiautomator2 init command stdio")
 
+    ctx = get_context()
+
     while True:
         tag, line = await output_queue.get()
 

{uiautomator2_mcp_server-0.1.1.dist-info → uiautomator2_mcp_server-0.1.2.dist-info}/METADATA

@@ -1,25 +1,32 @@
 Metadata-Version: 2.4
 Name: uiautomator2-mcp-server
-Version: 0.1.1
+Version: 0.1.2
 Summary: uiautomator2 mcp server
-Author: tanbro
-License: GPL-3.0-or-later
+Author-email: tanbro <tanbro@163.com>
+License-Expression: GPL-3.0-or-later
 Project-URL: homepage, https://github.com/tanbro/uiautomator2-mcp-server
 Project-URL: documentation, https://github.com/tanbro/uiautomator2-mcp-server/blob/main/README.md
 Project-URL: repository, https://github.com/tanbro/uiautomator2-mcp-server.git
 Project-URL: issues, https://github.com/tanbro/uiautomator2-mcp-server/issues
 Project-URL: changelog, https://github.com/tanbro/uiautomator2-mcp-server/blob/main/CHANGELOG.md
+Keywords: uiautomator2,mcp,fastmcp,adb,android,adbutils
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastmcp<3.0,>=2.10
+Requires-Dist: fastmcp<3.0,>=2.11.0
 Requires-Dist: uiautomator2<4.0,>=3.5
 Dynamic: license-file
 
 # uiautomator2-mcp-server
 
-![GitHub Tag](https://img.shields.io/github/v/tag/tanbro/uiautomator2-mcp-server)
-![PyPI - Version](https://img.shields.io/pypi/v/uiautomator2-mcp-server)
+[![GitHub Tag](https://img.shields.io/github/v/tag/tanbro/uiautomator2-mcp-server)](https://github.com/tanbro/uiautomator2-mcp-server)
+[![PyPI - Version](https://img.shields.io/pypi/v/uiautomator2-mcp-server)](https://pypi.org/project/uiautomator2-mcp-server/)
 
 A MCP (Model Context Protocol) server that provides tools for controlling and interacting with Android devices using uiautomator2. This server allows you to perform various operations on Android devices such as connecting to devices, taking screenshots, getting device information, accessing UI hierarchy, tap on screens, and more.
 
@@ -36,8 +43,8 @@ A MCP (Model Context Protocol) server that provides tools for controlling and in
 ## Requirements
 
 - Python >= 3.11
-- Android device with ADB access
-- Android device with uiautomator2 resources installed
+- adb executable in your PATH
+- Android device connected in debug mode
 
 ## Installation
 
@@ -54,10 +61,10 @@ The server can be run in different transport modes:
 
 ```bash
 # Run in streamable HTTP mode
-u2mcp --http --host 0.0.0.0 --port 8000
+u2mcp --host 0.0.0.0 --port 8000 --no-token http
 
 # Run in stdio mode
-u2mcp --stdio
+u2mcp stdio
 ```
 
 ### Using the Tools

uiautomator2_mcp_server-0.1.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+u2mcp/.gitignore,sha256=mr9Izcwvjgv215xjRKhWEZ7vsyrKWhMqvWjSLHRYDjk,13
+u2mcp/__init__.py,sha256=xsioVkbaN9sg-us_kNMeH-DojD8xM-h6Nlhde6uRHCQ,104
+u2mcp/__main__.py,sha256=CBZpaNarWiWkg-g-BCfwFxaMdP4EqG5ckHtc-ZMMwcE,2813
+u2mcp/_version.py,sha256=UPabfftDNarXNRt7p9IXx9_aYhCVscDiY35GxOcfT8s,738
+u2mcp/mcp.py,sha256=jP87QaNePDt3LGzdZnlI5W8r8P-I0NrH3Tyj336ZQO8,2017
+u2mcp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+u2mcp/tools/__init__.py,sha256=tKfsoF6tYQSapfGC1ybEcU4S77cipyfO5tYR6u0eAlI,66
+u2mcp/tools/action.py,sha256=A9dCED1NiKOJpw9lBewOQ9YQvfGOkK8bEL1L9FLjCQg,5088
+u2mcp/tools/app.py,sha256=b-cOdDtjSKC8KeUK5TTJCPRXtzvwSH74P02Cm3mS-ck,6809
+u2mcp/tools/device.py,sha256=herrj5IQ1jEav2W6K4i7UidJ7eQsg-WJCiHJD1qYKVA,9196
+uiautomator2_mcp_server-0.1.2.dist-info/licenses/LICENSE,sha256=ea2KuPdrBJ0Dhw1ncbc7siZDKG4cz2z-_8cSQiu4n1g,33122
+uiautomator2_mcp_server-0.1.2.dist-info/METADATA,sha256=9BxLeh6VjVBCtTx4S6w4YMcl2Nu7aFv8lfUJZpbk44s,4251
+uiautomator2_mcp_server-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+uiautomator2_mcp_server-0.1.2.dist-info/entry_points.txt,sha256=y7lg94G2U5_VgrDtyY8-Ne4ZClFtHo6eAs3RnShuDSI,92
+uiautomator2_mcp_server-0.1.2.dist-info/top_level.txt,sha256=elTNF05b2GS8jjS4Haa3ESnG6xbfRjpyoSRsivT0Uks,6
+uiautomator2_mcp_server-0.1.2.dist-info/RECORD,,

uiautomator2_mcp_server-0.1.1.dist-info/RECORD

@@ -1,16 +0,0 @@
-u2mcp/.gitignore,sha256=mr9Izcwvjgv215xjRKhWEZ7vsyrKWhMqvWjSLHRYDjk,13
-u2mcp/__init__.py,sha256=xsioVkbaN9sg-us_kNMeH-DojD8xM-h6Nlhde6uRHCQ,104
-u2mcp/__main__.py,sha256=I5ON-vrBr8rGWblondFcP2HhuQKhDPLn1y40YYjCWng,1943
-u2mcp/_version.py,sha256=qS3Rb8IU851vIlLXMW4dseE1Fx3Ssytyif_1QTy34YM,738
-u2mcp/mcp.py,sha256=JSNkfVviZqeh-Io48STjRuI9jJYcw7eo-o80z6zOSQs,739
-u2mcp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-u2mcp/tools/__init__.py,sha256=tKfsoF6tYQSapfGC1ybEcU4S77cipyfO5tYR6u0eAlI,66
-u2mcp/tools/action.py,sha256=A9dCED1NiKOJpw9lBewOQ9YQvfGOkK8bEL1L9FLjCQg,5088
-u2mcp/tools/app.py,sha256=b-cOdDtjSKC8KeUK5TTJCPRXtzvwSH74P02Cm3mS-ck,6809
-u2mcp/tools/device.py,sha256=yN1mWMJeIh6cMQA3m5HE3VqAkaIJOyfNIuNgWn-xoSU,9242
-uiautomator2_mcp_server-0.1.1.dist-info/licenses/LICENSE,sha256=ea2KuPdrBJ0Dhw1ncbc7siZDKG4cz2z-_8cSQiu4n1g,33122
-uiautomator2_mcp_server-0.1.1.dist-info/METADATA,sha256=yw6XCj9zVj2jS108gHaCCZtQl3bOptakor8NpYO-tEg,3761
-uiautomator2_mcp_server-0.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-uiautomator2_mcp_server-0.1.1.dist-info/entry_points.txt,sha256=y7lg94G2U5_VgrDtyY8-Ne4ZClFtHo6eAs3RnShuDSI,92
-uiautomator2_mcp_server-0.1.1.dist-info/top_level.txt,sha256=elTNF05b2GS8jjS4Haa3ESnG6xbfRjpyoSRsivT0Uks,6
-uiautomator2_mcp_server-0.1.1.dist-info/RECORD,,