AndroidMCP Framework

io.github.kshivam1177由 GitHub 账号 kshivam1177 发布v0.1.12更新于 Nov 2, 2026

MCP server and CLI for Android development and change-aware Android and Flutter testing workflows.

概览

AI 生成的概览

本地 MCP 服务器兼 CLI,让编码助手通过 adb 构建、安装、启动和测试 Android 或 Flutter 应用,并操作设备界面。

可以做什么
  • 列出已连接的模拟器和真机,并检查 Android 开发环境
  • 构建 Gradle 模块与变体,安装、启动、停止、卸载应用或清除应用数据
  • 运行仪器化测试或 JVM 单元测试,并支持 Flutter 测试
  • 检查并操作屏幕:UI 快照、点击、滑动、拖拽、输入文字、按键、手势、截图与等待
  • 在设备与本地之间传输文件,并发送原始触摸事件
  • 管理会话默认值与配置档,启用或停用工作流
适用场景
适合让助手端到端处理 Android 或 Flutter 项目:编译并部署到模拟器或已连接的手机,通过语义化 UI 自动化操作应用,并在同一会话中运行或规划测试。
运行要求
以 stdio 在本地运行,通常通过 npx 或全局 npm 安装,因此需要 Node.js 与 npm。需要 Android SDK platform-tools(adb)、Java、Gradle 和 build-tools,设备相关工具还需模拟器或 USB 连接的设备;doctor 工具可检查这些条件。未声明任何 API 密钥或环境变量。
安装前请注意
工具会操作真实设备:安装、启动、强制停止、卸载应用、清除应用数据、推送与拉取文件、发送输入事件。卸载或清除数据会销毁应用状态。截图、UI 快照和测试报告会写入项目的 .androidmcp-framework 目录。setup 会在仓库中写入配置与技能文件,迁移会复制旧数据且不会删除原目录。

安装

在 SourceWeft 中

  1. 打开 控制台中的 AndroidMCP Framework,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

AndroidMCP Framework

A Model Context Protocol (MCP) server and CLI that gives coding agents Android development capabilities: build, install, and launch on emulators and physical devices; semantic UI automation; logcat/crash diagnostics; project discovery; change-aware testing intelligence.

Testing intelligence is enabled by default alongside device, ui-automation, session-management, doctor, and workflow-discovery. Tools such as analyze_test_project, audit_screen, save_test_case, and write_test_report are available without enabling another workflow. See workflow docs.

Install

bash
npm install -g androidmcp-framework@latestandroidmcp-framework doctor# Update to the latest global release and clear npm cacheamf update# Short alias (also installed by npm)amf doctor

Or run on demand with no global install: npx -y androidmcp-framework@latest mcp. The amf update command updates a global npm installation; if you use npx, rerun it with @latest to fetch the latest version. If an update is installed, the command clears only npm's _npx execution cache under the configured npm cache directory (normally ~/.npm/_npx on macOS/Linux); it does not clear the shared package-download cache.

Connect an MCP client

json
{  "mcpServers": {    "androidmcp-framework": {      "command": "npx",      "args": ["-y", "androidmcp-framework@latest", "mcp"]    }  }}

See coding agent setup for Claude Code, Codex, Gemini CLI, Antigravity, and VS Code/GitHub Copilot instructions. Android Studio's documented MCP client requires HTTP, while this server currently exposes stdio only; see supported clients.

Initialize an app project

From the Android or Flutter repository root:

bash
androidmcp-framework setup# Generate the agent skill later, without rerunning setupandroidmcp-framework skill-gen --agent claude

This creates .androidmcp-framework/config.yaml, asks which coding agent you use in an interactive terminal, and writes a project-local SKILL.md into that agent's skills folder. Supported choices include Claude Code, Codex, Gemini CLI, Antigravity, Cursor, GitHub Copilot, and a generic agent. Existing skill files are never overwritten. You can also run androidmcp-framework skill-gen or npx -y androidmcp-framework@latest skill-gen --agent codex independently. See coding-agent skills. If existing data remains under .android-build-mcp/ or .androidbuildmcp/, inspect it and run androidmcp-framework setup --migrate to copy files without overwriting existing content. The old directory is not deleted automatically.

All project-specific framework data is kept inside .androidmcp-framework/. Screenshots are saved under .androidmcp-framework/artifacts/screenshots/, raw accessibility hierarchy snapshots under .androidmcp-framework/artifacts/snapshots/, and other evidence under .androidmcp-framework/artifacts/. screenshot returns the absolute saved image path with the image; snapshot_ui saves the full tree and returns a compact summary by default. Test-case definitions and timestamped reports remain under testcases/ and test-reports/. The workspace root is discovered by walking upward to the nearest .androidmcp-framework/config.yaml or .git marker, with the current directory as fallback. Generated artifacts are local outputs and are ignored by Git by default.

Local checkout config

Build with npm ci && npm run build, then configure the MCP client to launch the built entry point build/cli/index.js mcp. Use an absolute path to your own checkout; do not copy machine-specific paths from examples.

How it's built

  • UI automation: JavaScript/TypeScript plus Android SDK platform-tools (adb) only. The optional Python uiautomator2 bridge has been removed; no Python runtime or scripts/ directory is required.
  • Device targeting: emulators and physical devices are unified through ADB. Explicit target, session default, then single connected target are tried in that order.
  • MCP transport: stdio for local coding agents. Streamable HTTP is not implemented yet.
  • Tools: one TypeScript module per tool under src/tools/<workflow>/.

Development

bash
npm cinpm run buildnpm run typechecknpm test

TypeScript compiles from src/ to generated build/. Do not commit generated build/ or stale dist/ output.

Testing framework

The testing-intelligence workflow is enabled by default: it analyzes Native Android and Flutter workspaces, discovers nested Flutter packages, saves custom instructions and test cases, audits screens, and writes timestamped Markdown/JSON reports under .androidmcp-framework/test-reports/YYYY-MM-DD/HHmmss/. test_device routes Flutter unit/widget tests through flutter test (kind: "unit") and can run device integration tests with flutter test -d <device-id> integration_test when integration_test/ exists. See Testing Framework, Autonomous test intelligence and execution reliability, Change-aware autonomous test planning, Unified E2E run and device regression, Phases 11–15, Phases 16–20, and Phases 24–30, and Phases 31–40, and Phases 41–50, and Phases 51–60. validate_test_evidence_bundle checks multiple reports for freshness, matching Git HEAD provenance, clean working-tree state, required suites, and passing outcomes. The run_unified_test_run tool coordinates selected native/Flutter suites and saved UI cases under one resumable run ID and writes one strict-gated report. The inspect_test_runtime tool provides a read-only overview of project config, run-lock metadata, resumable manifests, and the latest report. The plan_change_aware_test_run tool connects Git changes, saved test cases, project instructions, and recent failures to produce a reviewable plan and identify unmapped changed files without executing tests. The analyze_test_quality tool combines test-matrix inventory, changed-file LCOV coverage, historical flaky-test signals, and optional baseline regression comparison in one read-only report. evaluate_test_quality_gate applies optional changed-file coverage thresholds and baseline regression policy. run_test_suite_matrix previews or sequentially executes selected project-native Flutter/Gradle suites, with execution opt-in and timestamped evidence.

Runtime selector maintenance is also available through approve_selector_repair: it validates a proposed selector against a fresh accessibility hierarchy, requires explicit approval before changing a saved test, creates a backup and audit record, and still requires a real rerun for pass/fail evidence. See runtime-verified selector repair.

License

MIT

Autonomous test lifecycle

For the recommended change-aware flow from Git analysis through reviewed test candidates, explicit approval, unified execution, and evidence-backed reporting, see Autonomous test lifecycle. The framework keeps candidate, approved, and executed states separate and falls back to broad regression when explicit test mappings do not cover changed files.

来源:README.md,提交 c67e69c

工具

30

list_devices

List Devices

List every connected Android target - booted emulators and physical devices together, the same way `adb devices -l` does. Each entry reports id (adb serial), type ('emulator'|'physical'), state, and avdName when resolvable.

无需输入参数。

build_device

Build (Device)

Compile-only build for a Gradle module + variant (assemble<Variant>). Does not install or launch. Works identically whether you plan to target an emulator or a physical device - both use the same adb, unlike Xcode's simulator/device split.

输入参数modulevariantextraArgsprojectPath

build_run_device

Build, Install, and Launch

One-shot: build a module + variant, install it, and launch it. Resolves the target automatically - an explicit targetId wins, then the active session default, then whichever single emulator/device is connected; if more than one is connected without a pin, this fails with the candidate list instead of guessing. Launches via the default launcher activity unless `activity` is given.

输入参数modulevariantactivitytargetIdextraArgsprojectPath

install_app_device

Install App

Install an already-built APK for a module + variant onto the resolved target. Does not rebuild - run build_device first if sources changed. Pass apkPath directly to skip variant lookup entirely.

输入参数moduleapkPathvarianttargetIdreinstallprojectPath

launch_app_device

Launch App

Launch an already-installed app on the resolved target. Provide packageId directly, or module/variant to look it up from the last build's APK. Uses the app's default launcher activity unless `activity` is given.

输入参数modulevariantactivitytargetIdpackageIdprojectPath

stop_app_device

Stop App

Force-stop a running app on the resolved target (adb shell am force-stop).

输入参数targetIdpackageId必填

uninstall_app_device

Uninstall App

Uninstall an app (and its data) from the resolved target.

输入参数keepDatatargetIdpackageId必填

clear_app_data_device

Clear App Data

Reset an app to first-install state on the resolved target (adb shell pm clear) - wipes the app's data and cache without uninstalling it.

输入参数targetIdpackageId必填

test_device

Test (Device)

Run tests for a module + variant. `instrumented` (default) runs connected<Variant>AndroidTest against the resolved target via ANDROID_SERIAL - needs an emulator or device attached. `unit` runs test<Variant>UnitTest on the JVM instead and needs no target at all.

输入参数kindmodulevarianttargetIdextraArgsprojectPath

push_file_device

Push File

Copy a local file or directory onto the resolved target (adb push).

输入参数targetIdlocalPath必填remotePath必填

pull_file_device

Pull File

Copy a file or directory off the resolved target onto the local filesystem (adb pull).

输入参数targetIdlocalPath必填remotePath必填

snapshot_ui

Snapshot UI

Capture a semantic UI hierarchy for the current screen - every element gets a short-lived elementRef (e1, e2, ...) that tap/long_press/type_text can target directly. Saves the captured hierarchy as JSON under .androidmcp-framework/artifacts/ui-snapshots/ by default.

输入参数targetIdprojectPathinteractiveOnly

tap

Tap

Tap either a raw (x, y) point or an elementRef from the latest snapshot_ui output. Prefer elementRef - it survives minor layout shifts that would break a hard-coded coordinate.

输入参数xytargetIdelementRef

long_press

Long Press

Long-press either a raw (x, y) point or an elementRef from the latest snapshot_ui output.

输入参数xytargetIddurationMselementRef

swipe

Swipe

Swipe either by explicit start/end coordinates, or a screen-relative direction ("up"|"down"|"left"|"right") computed from the current screen size.

输入参数endXendYstartXstartYdistancetargetIddirectiondurationMs

drag

Drag

Press-and-drag from one point to another (adb shell input draganddrop) - for reordering list items or drag targets, where a quick swipe would be interpreted as a flick instead of a hold-and-move. Endpoints can be elementRefs from the latest snapshot_ui, or raw coordinates.

输入参数endXendYstartXstartYtargetIddurationMsendElementRefstartElementRef

type_text

Type Text

Type text into whatever field currently has focus. If elementRef is given, taps it first to focus it, then types. Only ASCII-range and common Latin text renders reliably through adb input text - non-Latin scripts and emoji generally need an IME-level workaround this tool does not attempt.

输入参数text必填targetIdelementRef

key_press

Key Press

Send one hardware/software key event (adb shell input keyevent). Accepts either a symbolic Android keycode name (KEYCODE_BACK, KEYCODE_ENTER, KEYCODE_DEL, KEYCODE_TAB) or its numeric code. Prefer button for common hardware buttons (home/back/recents/power/volume) - it maps friendly names for you.

输入参数keyCode必填targetId

button

Hardware Button

Press a named hardware/system button: home, back, recents, power, volume_up, volume_down, menu, enter, camera.

输入参数button必填targetId

gesture

Gesture Preset

Named system gesture presets: expand_notifications, expand_quick_settings, collapse_statusbar (all via `cmd statusbar`, no coordinates needed), swipe_up_from_bottom (home/app-switcher gesture-nav swipe), swipe_down_from_top (notification-shade swipe as an alternative to expand_notifications on older API levels).

输入参数preset必填targetId

screenshot

Screenshot

Capture the current screen, return it as an image, and save a copy under .androidmcp-framework/artifacts/screenshots/ by default.

输入参数targetIdoutputPathprojectPath

wait_for_ui

Wait For UI

Poll the UI until a condition holds, then record the latest snapshot (same caching as snapshot_ui - refs from the result are usable directly). With textContains/resourceId: waits for a matching element to appear (or disappear, if gone:true). With neither: waits for the hierarchy to stop changing between polls ("settled").

输入参数gonetargetIdtimeoutMsresourceIdtextContainspollIntervalMs

batch

Batch

Run several same-screen UI actions in one call, resolving the target once and reusing it for every step. Use for multiple taps/toggles with no intermediate assertion needed - if you need to check state between steps, call the individual tools instead so you can inspect each result.

输入参数steps必填targetId

touch

Touch (raw down/up/move)

Send a raw touch event (adb shell input motionevent) rather than a full tap/swipe gesture. Use for composing custom multi-point sequences - e.g. DOWN, several MOVEs, then UP - that the higher-level tap/swipe/drag tools don't expose.

输入参数x必填y必填action必填targetId

session_show_defaults

Show Session Defaults

Show the active session-default profile and its resolved values (config.yaml sessionDefaults, overlaid with any runtime overrides from session_set_defaults). Call this before your first build/run/test call in a session - do not assume defaults are configured.

无需输入参数。

session_set_defaults

Set Session Defaults

Set one or more session defaults for the active profile at runtime (in-memory + persisted under the state dir for this profile - not written back to config.yaml). Only the fields you pass are changed; everything else stays as-is.

输入参数moduleavdNamevarianttargetIdprojectPathapplicationIdgradleTaskPrefix

session_clear_defaults

Clear Session Defaults

Clear runtime overrides for the active profile (or a named one) - falls back to config.yaml's static sessionDefaults on the next read, not to nothing.

输入参数profile

session_use_defaults_profile

Switch Session Defaults Profile

Switch the active session-defaults profile - useful in a monorepo with several Gradle projects, so each can keep its own remembered projectPath/module/variant/targetId without overwriting the others.

输入参数profile必填

doctor

Doctor

Check Android development prerequisites: adb, Java, Gradle, Android SDK, emulator, build-tools and the optional Google Android CLI integration. This framework does not require Python.

无需输入参数。

manage_workflows

Manage Workflows

List every workflow and which of its tools are currently enabled, or enable/disable a workflow for this running server session. Session-only - it does not edit .android-build-mcp/config.yaml, so restart-persistent changes still belong in enabledWorkflows there.

输入参数actionworkflowName

版本历史

1
  1. v0.1.12最新Oct 26, 2026

评分

已满足适用检查项的 90%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分
  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分