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

u2mcp/tools/app.py

@@ -1,231 +1,232 @@
-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
+
+from typing import Any
+
+from anyio import to_thread
+
+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", tags={"app:manage"})
+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 to_thread.run_sync(device.app_install, data)
+
+
+@mcp.tool("app_uninstall", tags={"app:manage"})
+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 to_thread.run_sync(device.app_uninstall, package_name)
+
+
+@mcp.tool("app_uninstall_all", tags={"app:manage"})
+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 to_thread.run_sync(device.app_uninstall_all, excludes or [])
+
+
+@mcp.tool("app_start", tags={"app:lifecycle"})
+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 to_thread.run_sync(device.app_start, package_name, activity, wait, stop)
+
+
+@mcp.tool("app_wait", tags={"app:lifecycle"})
+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 to_thread.run_sync(device.app_wait, package_name, timeout, front):
+            raise RuntimeError(f"Failed to wait App {package_name} to launch")
+
+
+@mcp.tool("app_stop", tags={"app:lifecycle"})
+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 to_thread.run_sync(device.app_stop, package_name)
+
+
+@mcp.tool("app_stop_all", tags={"app:lifecycle"})
+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 to_thread.run_sync(device.app_stop_all, excludes or [])
+
+
+@mcp.tool("app_clear", tags={"app:config"})
+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 to_thread.run_sync(device.app_clear, package_name)
+
+
+@mcp.tool("app_info", tags={"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 to_thread.run_sync(device.app_info, package_name)
+
+
+@mcp.tool("app_current", tags={"app:info"})
+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 to_thread.run_sync(device.app_current)
+
+
+@mcp.tool("app_list", tags={"app:info"})
+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 to_thread.run_sync(device.app_list, filter.strip())
+
+
+@mcp.tool("app_list_running", tags={"app:info"})
+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 to_thread.run_sync(device.app_list_running)
+
+
+@mcp.tool("app_auto_grant_permissions", tags={"app:config"})
+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 to_thread.run_sync(device.app_auto_grant_permissions, package_name)

u2mcp/tools/clipboard.py

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from anyio import to_thread
+
+from ..mcp import mcp
+from .device import get_device
+
+__all__ = ("read_clipboard", "write_clipboard")
+
+
+@mcp.tool("read_clipboard", tags={"clipboard:read"})
+async def read_clipboard(serial: str) -> str | None:
+    """Read clipboard from device
+
+    Args:
+        serial (str): Android device serialno
+
+    Returns:
+        str: The actual text in the clip.
+        None: If there is no text in the clip.
+    """
+    async with get_device(serial) as device:
+        return await to_thread.run_sync(lambda: device.clipboard)
+
+
+@mcp.tool("write_clipboard", tags={"clipboard:write"})
+async def write_clipboard(serial: str, text: str):
+    """Write clipboard to device
+
+    Args:
+        serial (str): Android device serialno
+        text: The actual text in the clip.
+    """
+    async with get_device(serial) as device:
+        await to_thread.run_sync(device.set_clipboard, text)