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

u2mcp/.gitignore

@@ -0,0 +1 @@
+_version.py

u2mcp/__init__.py

@@ -0,0 +1,2 @@
+from . import _version as version
+from ._version import __commit_id__, __version__, __version_tuple__

u2mcp/__main__.py

@@ -1,63 +1,60 @@
-from __future__ import annotations
-
-import logging
-from enum import StrEnum
-from typing import Annotated
-
-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)
-
-
-class Transport(StrEnum):
-    streamable_http = "streamable-http"
-    stdio = "stdio"
-    # http = "http"
-    # sse = "sse"
-
-
-def run(
-    transport: Annotated[
-        Transport, typer.Option("--transport", "-f", help="The transport mechanisms for client-server communication")
-    ] = Transport.streamable_http,
-    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,
-):
-    """Run mcp server
-    Args:
-        transport (Literal["http", "stdio"]): transport type
-        host (str | None): host
-        port (int | None): port
-    """
-    from . import tools as _
-    from .mcp import mcp
-
-    if transport == Transport.stdio:
-        mcp.run(transport.value)
-    elif transport == Transport.streamable_http:
-        transport_kwargs = {}
-        if host:
-            transport_kwargs["host"] = host
-        if port:
-            transport_kwargs["port"] = port
-        mcp.run(transport.value, **transport_kwargs)
-    else:
-        typer.Abort(f"Unknown transport: {transport}")
-
-
-def main():
-    typer.run(run)
-
-
-if __name__ == "__main__":
-    main()
+from __future__ import annotations
+
+import asyncio
+import logging
+from typing import Annotated, Any, Awaitable
+
+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,
+):
+    """Run uiautomator2 mcp server"""
+    if not http and not stdio:
+        typer.Abort("Please specify one of ‘--http’ or ‘--stdio’")
+
+    from . import tools as _
+    from .mcp import mcp
+
+    awaitables: list[Awaitable] = []
+
+    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())
+
+
+def main():
+    typer.run(run)
+
+
+if __name__ == "__main__":
+    main()

u2mcp/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.1.1'
+__version_tuple__ = version_tuple = (0, 1, 1)
+
+__commit_id__ = commit_id = None

u2mcp/mcp.py

@@ -1,18 +1,18 @@
-"""
-This MCP server provides tools for controlling and interacting with Android devices using uiautomator2.
-
-It 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...
-
-It also provides tools for managing Android applications, such as installing, uninstalling, starting, stopping, and clearing applications.
-
-Before performing operations on a device, you need to initialize it using the init tool.
-
-All operations require a device serial number to identify the target device.
-"""
-
-from fastmcp import FastMCP
-
-__all__ = ["mcp"]
-
-mcp = FastMCP(name="uiautomator2", instructions=__doc__)
+"""
+This MCP server provides tools for controlling and interacting with Android devices using uiautomator2.
+
+It 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...
+
+It also provides tools for managing Android applications, such as installing, uninstalling, starting, stopping, and clearing applications.
+
+Before performing operations on a device, you need to initialize it using the init tool.
+
+All operations require a device serial number to identify the target device.
+"""
+
+from fastmcp import FastMCP
+
+__all__ = ["mcp"]
+
+mcp = FastMCP(name="uiautomator2", instructions=__doc__)

u2mcp/tools/app.py

@@ -1,231 +1,231 @@
-from __future__ import annotations
-
-import asyncio
-from typing import Any
-
-from ..mcp import mcp
-from .device import get_device
-
-__all__ = (
-    "app_install",
-    "app_uninstall",
-    "app_uninstall_all",
-    "app_start",
-    "app_stop",
-    "app_stop_all",
-    "app_clear",
-    "app_info",
-    "app_current",
-    "app_list",
-    "app_list_running",
-    "app_auto_grant_permissions",
-)
-
-
-@mcp.tool("app_install")
-async def app_install(serial: str, data: str):
-    """Install app
-
-    Args:
-        serial (str): Android device serialno
-        data (str): APK file path or url
-    """
-    async with get_device(serial) as device:
-        await asyncio.to_thread(device.app_install, data)
-
-
-@mcp.tool("app_uninstall")
-async def app_uninstall(serial: str, package_name: str) -> bool:
-    """Uninstall an app
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-
-    Returns:
-        bool: success
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_uninstall, package_name)
-
-
-@mcp.tool("app_uninstall_all")
-async def app_uninstall_all(serial: str, excludes: list[str] | None = None) -> list[str]:
-    """Uninstall all apps
-
-    Args:
-        serial (str): Android device serialno
-        excludes (list[str] | None): packages that do not want to uninstall
-
-    Returns:
-        list[str]: list of uninstalled apps
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_uninstall_all, excludes or [])
-
-
-@mcp.tool("app_start")
-async def app_start(
-    serial: str,
-    package_name: str,
-    activity: str | None = None,
-    wait: bool = False,
-    stop: bool = False,
-):
-    """Launch application
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-        activity (str): app activity
-        stop (bool): Stop app before starting the activity. (require activity)
-        wait (bool): wait until app started. default False
-    """
-    async with get_device(serial) as device:
-        await asyncio.to_thread(device.app_start, package_name, activity, wait, stop)
-
-
-@mcp.tool("app_wait")
-async def app_wait(serial: str, package_name: str, timeout: float = 20.0, front=False):
-    """Wait until app launched
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-        timeout (float): maximum wait time seconds
-        front (bool): wait until app is current app
-    """
-    async with get_device(serial) as device:
-        if not await asyncio.to_thread(device.app_wait, package_name, timeout, front):
-            raise RuntimeError(f"Failed to wait App {package_name} to launch")
-
-
-@mcp.tool("app_stop")
-async def app_stop(serial: str, package_name: str):
-    """Stop one application
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-    """
-    async with get_device(serial) as device:
-        await asyncio.to_thread(device.app_stop, package_name)
-
-
-@mcp.tool("app_stop_all")
-async def app_stop_all(serial: str, excludes: list[str] | None = None) -> list[str]:
-    """Stop all third party applications
-
-    Args:
-        excludes (list): apps that do now want to kill
-
-    Returns:
-        list[str]: a list of killed apps
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_stop_all, excludes or [])
-
-
-@mcp.tool("app_clear")
-async def app_clear(serial: str, package_name: str):
-    """Stop and clear app data: pm clear
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-
-    Returns:
-        bool: success
-    """
-    async with get_device(serial) as device:
-        await asyncio.to_thread(device.app_clear, package_name)
-
-
-@mcp.tool("app_info")
-async def app_info(serial: str, package_name: str) -> dict[str, Any]:
-    """
-    Get app info
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-
-    Returns:
-        dict[str,Any]: app info
-
-        Example:
-            {"versionName": "1.1.7", "versionCode": 1001007}
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_info, package_name)
-
-
-@mcp.tool("app_current")
-async def app_current(serial: str) -> dict[str, Any]:
-    """
-    Get current app info
-
-    Args:
-        serial (str): Android device serialno
-
-    Returns:
-        dict[str,Any]: running app info
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_current)
-
-
-@mcp.tool("app_list")
-async def app_list(serial: str, filter: str = "") -> list[str]:
-    """
-    List installed app package names
-
-    Args:
-        serial (str): Android device serialno
-        filter (str): [-f] [-d] [-e] [-s] [-3] [-i] [-u] [--user USER_ID] [FILTER]
-
-    Returns:
-        list[str]: list of apps by filter
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_list, filter.strip())
-
-
-@mcp.tool("app_list_running")
-async def app_list_running(serial: str) -> list[str]:
-    """
-    List running apps
-
-    Args:
-        serial (str): Android device serialno
-
-    Returns:
-        list[str]: list of running apps
-    """
-    async with get_device(serial) as device:
-        return await asyncio.to_thread(device.app_list_running)
-
-
-@mcp.tool("app_auto_grant_permissions")
-async def app_auto_grant_permissions(serial: str, package_name: str):
-    """auto grant permissions
-
-    Args:
-        serial (str): Android device serialno
-        package_name (str): package name
-
-    Help of "adb shell pm":
-        grant [--user USER_ID] PACKAGE PERMISSION
-        revoke [--user USER_ID] PACKAGE PERMISSION
-            These commands either grant or revoke permissions to apps.  The permissions
-            must be declared as used in the app's manifest, be runtime permissions
-            (protection level dangerous), and the app targeting SDK greater than Lollipop MR1 (API level 22).
-
-    Help of "Android official pm" see <https://developer.android.com/tools/adb#pm>
-        Grant a permission to an app. On devices running Android 6.0 (API level 23) and higher,
-            the permission can be any permission declared in the app manifest.
-        On devices running Android 5.1 (API level 22) and lower,
-            must be an optional permission defined by the app.
-    """
-    async with get_device(serial) as device:
-        await asyncio.to_thread(device.app_auto_grant_permissions, package_name)
+from __future__ import annotations
+
+import asyncio
+from typing import Any
+
+from ..mcp import mcp
+from .device import get_device
+
+__all__ = (
+    "app_install",
+    "app_uninstall",
+    "app_uninstall_all",
+    "app_start",
+    "app_stop",
+    "app_stop_all",
+    "app_clear",
+    "app_info",
+    "app_current",
+    "app_list",
+    "app_list_running",
+    "app_auto_grant_permissions",
+)
+
+
+@mcp.tool("app_install")
+async def app_install(serial: str, data: str):
+    """Install app
+
+    Args:
+        serial (str): Android device serialno
+        data (str): APK file path or url
+    """
+    async with get_device(serial) as device:
+        await asyncio.to_thread(device.app_install, data)
+
+
+@mcp.tool("app_uninstall")
+async def app_uninstall(serial: str, package_name: str) -> bool:
+    """Uninstall an app
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+
+    Returns:
+        bool: success
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_uninstall, package_name)
+
+
+@mcp.tool("app_uninstall_all")
+async def app_uninstall_all(serial: str, excludes: list[str] | None = None) -> list[str]:
+    """Uninstall all apps
+
+    Args:
+        serial (str): Android device serialno
+        excludes (list[str] | None): packages that do not want to uninstall
+
+    Returns:
+        list[str]: list of uninstalled apps
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_uninstall_all, excludes or [])
+
+
+@mcp.tool("app_start")
+async def app_start(
+    serial: str,
+    package_name: str,
+    activity: str | None = None,
+    wait: bool = False,
+    stop: bool = False,
+):
+    """Launch application
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+        activity (str): app activity
+        stop (bool): Stop app before starting the activity. (require activity)
+        wait (bool): wait until app started. default False
+    """
+    async with get_device(serial) as device:
+        await asyncio.to_thread(device.app_start, package_name, activity, wait, stop)
+
+
+@mcp.tool("app_wait")
+async def app_wait(serial: str, package_name: str, timeout: float = 20.0, front=False):
+    """Wait until app launched
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+        timeout (float): maximum wait time seconds
+        front (bool): wait until app is current app
+    """
+    async with get_device(serial) as device:
+        if not await asyncio.to_thread(device.app_wait, package_name, timeout, front):
+            raise RuntimeError(f"Failed to wait App {package_name} to launch")
+
+
+@mcp.tool("app_stop")
+async def app_stop(serial: str, package_name: str):
+    """Stop one application
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+    """
+    async with get_device(serial) as device:
+        await asyncio.to_thread(device.app_stop, package_name)
+
+
+@mcp.tool("app_stop_all")
+async def app_stop_all(serial: str, excludes: list[str] | None = None) -> list[str]:
+    """Stop all third party applications
+
+    Args:
+        excludes (list): apps that do now want to kill
+
+    Returns:
+        list[str]: a list of killed apps
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_stop_all, excludes or [])
+
+
+@mcp.tool("app_clear")
+async def app_clear(serial: str, package_name: str):
+    """Stop and clear app data: pm clear
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+
+    Returns:
+        bool: success
+    """
+    async with get_device(serial) as device:
+        await asyncio.to_thread(device.app_clear, package_name)
+
+
+@mcp.tool("app_info")
+async def app_info(serial: str, package_name: str) -> dict[str, Any]:
+    """
+    Get app info
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+
+    Returns:
+        dict[str,Any]: app info
+
+        Example:
+            {"versionName": "1.1.7", "versionCode": 1001007}
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_info, package_name)
+
+
+@mcp.tool("app_current")
+async def app_current(serial: str) -> dict[str, Any]:
+    """
+    Get current app info
+
+    Args:
+        serial (str): Android device serialno
+
+    Returns:
+        dict[str,Any]: running app info
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_current)
+
+
+@mcp.tool("app_list")
+async def app_list(serial: str, filter: str = "") -> list[str]:
+    """
+    List installed app package names
+
+    Args:
+        serial (str): Android device serialno
+        filter (str): [-f] [-d] [-e] [-s] [-3] [-i] [-u] [--user USER_ID] [FILTER]
+
+    Returns:
+        list[str]: list of apps by filter
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_list, filter.strip())
+
+
+@mcp.tool("app_list_running")
+async def app_list_running(serial: str) -> list[str]:
+    """
+    List running apps
+
+    Args:
+        serial (str): Android device serialno
+
+    Returns:
+        list[str]: list of running apps
+    """
+    async with get_device(serial) as device:
+        return await asyncio.to_thread(device.app_list_running)
+
+
+@mcp.tool("app_auto_grant_permissions")
+async def app_auto_grant_permissions(serial: str, package_name: str):
+    """auto grant permissions
+
+    Args:
+        serial (str): Android device serialno
+        package_name (str): package name
+
+    Help of "adb shell pm":
+        grant [--user USER_ID] PACKAGE PERMISSION
+        revoke [--user USER_ID] PACKAGE PERMISSION
+            These commands either grant or revoke permissions to apps.  The permissions
+            must be declared as used in the app's manifest, be runtime permissions
+            (protection level dangerous), and the app targeting SDK greater than Lollipop MR1 (API level 22).
+
+    Help of "Android official pm" see <https://developer.android.com/tools/adb#pm>
+        Grant a permission to an app. On devices running Android 6.0 (API level 23) and higher,
+            the permission can be any permission declared in the app manifest.
+        On devices running Android 5.1 (API level 22) and lower,
+            must be an optional permission defined by the app.
+    """
+    async with get_device(serial) as device:
+        await asyncio.to_thread(device.app_auto_grant_permissions, package_name)