uicheck_android

Source: README

Install

Android library: https://github.com/uicheck/uicheck, path packages/android

Android native runtime client for UI Check. It connects native Android apps to @uicheck/mcp over WebSocket so AI agents can request screenshots and inspect the live Android view tree.

Install

Add this repository as an Android library dependency:

https://github.com/uicheck/uicheck

Package path:

packages/android

Start the MCP server separately:

npx @uicheck/mcp

Usage

Install the client near app startup:

import ai.uicheck.android.UiCheckAndroidOptions
import ai.uicheck.android.UiCheckAndroidSocketOptions
import ai.uicheck.android.initUiCheck
 
val client = initUiCheck(
  UiCheckAndroidOptions(
    socket = UiCheckAndroidSocketOptions(
      url = "ws://127.0.0.1:17322/socket",
      clientId = "android-demo"
    ),
    activity = this
  )
)

Dispose when no longer needed:

client.close()

Options

OptionTypeDefaultDescription
socket.urlString-@uicheck/mcp WebSocket URL
socket.clientIdString-Optional stable client id
socket.reconnectMsLong1000Reconnect interval
activityActivity-Current Activity used to read the root View and capture screenshots
screenshotfunction-Optional screenshot provider for capture_page, capture_element, and compare_screenshot, returning PNG base64