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

u2mcp/.gitignore

@@ -1 +1 @@
-_version.py
+_version.py

u2mcp/__init__.py

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

u2mcp/__main__.py

@@ -1,82 +1,82 @@
-from __future__ import annotations
-
-import logging
-import re
-import secrets
-from typing import Annotated, Any, Literal
-
-import typer
-
-
-def run(
-    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"""
-    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, update_params
-
-    transport_kwargs: dict[str, Any] = {"json_response": json_response}
-
-    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 host:
-            transport_kwargs["host"] = host
-        if port:
-            transport_kwargs["port"] = port
-
-        mcp.run(transport="streamable-http", **transport_kwargs, log_level=log_level)
-    else:
-        mcp.run(log_level=log_level)
-
-
-def main():
-    typer.run(run)
-
-
-if __name__ == "__main__":
-    main()
+from __future__ import annotations
+
+import logging
+import re
+import secrets
+from typing import Annotated, Any, Literal
+
+import typer
+
+from .mcp import make_mcp
+
+
+def run(
+    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"""
+    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)
+
+    run_kwargs: dict[str, Any] = {"json_response": json_response, "log_level": log_level}
+
+    if transport == "http":
+        run_kwargs["transport"] = "streamable-http"
+        if host:
+            run_kwargs["host"] = host
+        if port:
+            run_kwargs["port"] = port
+        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()
+        mcp = make_mcp(token)
+    else:
+        run_kwargs["transport"] = "stdio"
+        mcp = make_mcp()
+
+    # can NOT import tools until mcp is crated
+    from . import tools as _
+
+    # run mcp
+    mcp.run(**run_kwargs)
+
+
+def main():
+    typer.run(run)
+
+
+if __name__ == "__main__":
+    main()

u2mcp/_version.py

@@ -1,34 +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.2'
-__version_tuple__ = version_tuple = (0, 1, 2)
-
-__commit_id__ = commit_id = None
+# 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.3'
+__version_tuple__ = version_tuple = (0, 1, 3)
+
+__commit_id__ = commit_id = None

u2mcp/mcp.py

@@ -1,61 +1,79 @@
-"""
-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 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"]
-
-_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())
+"""
+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.
+"""
+
+import sys
+from contextlib import asynccontextmanager
+from functools import partial
+from textwrap import dedent
+from typing import Any
+
+if sys.version_info >= (3, 12):  # qa: noqa
+    from typing import override
+else:  # qa: noqa
+    from typing_extensions import override
+
+from fastmcp import FastMCP
+from fastmcp.server.auth import AccessToken, AuthProvider
+from pydantic import AnyHttpUrl
+from rich.console import Console
+from rich.markdown import Markdown
+
+__all__ = ["mcp", "make_mcp"]
+
+
+# Warning: You can NOT import it unless call `make_mcp()`
+mcp: FastMCP
+
+
+@asynccontextmanager
+async def _lifespan(instance: FastMCP, token: str | None):
+    content = Markdown(
+        dedent(f"""
+        ------
+
+        Server configured with **authentication token**. Connect using this token in the Authorization header:
+
+        `Authorization: Bearer {token}`
+
+        ------
+        """)
+    )
+    Console(stderr=True).print(content)
+    yield
+
+
+class _SimpleTokenAuthProvider(AuthProvider):
+    @override
+    def __init__(
+        self,
+        base_url: AnyHttpUrl | str | None = None,
+        required_scopes: list[str] | None = ["mcp:tools"],
+        token: str | None = None,
+    ):
+        super().__init__(base_url, required_scopes)
+        self.token = token
+
+    @override
+    async def verify_token(self, token: str) -> AccessToken | None:
+        if self.token == token:
+            return AccessToken(token=token, client_id="user", scopes=self.required_scopes)
+        return None
+
+
+def make_mcp(token: str | None = None) -> FastMCP:
+    global mcp
+    params: dict[str, Any] = dict(name="uiautomator2", instructions=__doc__)
+    if token:
+        params.update(lifespan=partial(_lifespan, token=token), auth=_SimpleTokenAuthProvider(token=token))
+    mcp = FastMCP(**params)
+    return mcp

u2mcp/tools/__init__.py

@@ -1,3 +1,4 @@
-from .action import *
-from .app import *
-from .device import *
+from .action import *
+from .app import *
+from .device import *
+from .misc import *