@beeos-ai/device-mcp-server 0.2.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 BeeOS AI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing permissions
+   and limitations under the License.

package/dist/backends/android-adb-runner.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Runner contract for the Android ADB backend — extracted to its own
+ * module so utility helpers (`util/adb-files.ts`, `util/adb-shell.ts`)
+ * can depend on the type without creating a circular import back to
+ * `android-adb.ts`. The concrete `defaultRunner` and the `AndroidAdbBackend`
+ * class still live in `android-adb.ts`.
+ *
+ * Shape mirrors `child_process.execFile` semantics: throws on non-zero
+ * exit, decorates the rejected error with `code` (number or `"ENOENT"`),
+ * `stdout`, `stderr`, `signal`, `killed`. Implementations are responsible
+ * for stdout cap enforcement (returns SIGTERM-shaped error) and timeouts
+ * (returns SIGTERM-shaped error with `killed === true`).
+ */
+export interface AdbRunResult {
+    stdout: string | Buffer;
+    stderr: string;
+}
+export interface AdbRunOptions {
+    encoding?: "buffer" | "utf8";
+    timeoutMs?: number;
+    maxBufferBytes?: number;
+    cwd?: string;
+}
+/**
+ * Async `execFile`-shaped callable. Throws on non-zero exit (with `code`,
+ * `stdout`, `stderr`, `killed`, `signal` decorated on the rejected error)
+ * so consumers can recognise the standard `NodeJS.ErrnoException` shape.
+ *
+ * `code` may be either a number (process exit code) or a string
+ * (`"ENOENT"` when the binary itself is missing).
+ */
+export type AdbRunner = (file: string, args: string[], opts?: AdbRunOptions) => Promise<AdbRunResult>;

package/dist/backends/android-adb-runner.js

@@ -0,0 +1,15 @@
+/**
+ * Runner contract for the Android ADB backend — extracted to its own
+ * module so utility helpers (`util/adb-files.ts`, `util/adb-shell.ts`)
+ * can depend on the type without creating a circular import back to
+ * `android-adb.ts`. The concrete `defaultRunner` and the `AndroidAdbBackend`
+ * class still live in `android-adb.ts`.
+ *
+ * Shape mirrors `child_process.execFile` semantics: throws on non-zero
+ * exit, decorates the rejected error with `code` (number or `"ENOENT"`),
+ * `stdout`, `stderr`, `signal`, `killed`. Implementations are responsible
+ * for stdout cap enforcement (returns SIGTERM-shaped error) and timeouts
+ * (returns SIGTERM-shaped error with `killed === true`).
+ */
+export {};
+//# sourceMappingURL=android-adb-runner.js.map

package/dist/backends/android-adb-runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"android-adb-runner.js","sourceRoot":"","sources":["../../src/backends/android-adb-runner.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG"}

package/dist/backends/android-adb.d.ts

@@ -0,0 +1,153 @@
+/**
+ * AndroidAdbBackend — concrete `SandboxBackend` over Android `adb`.
+ *
+ * Migrated from the legacy `device-agent` files:
+ *   - `src/device/android.ts`
+ *   - `src/adapters/device-android-adb.ts`
+ *
+ * Owns ALL `adb` invocations. The MCP server is the only process that talks
+ * to the device daemon — `device-agent` reaches it exclusively via HTTP.
+ *
+ * **Testability**: like `MacOsBackend`, the constructor accepts an injected
+ * `runner` (an `execFile`-like async callable). Defaults bind to a
+ * spawn-backed runner. Unit tests pass spy runners so the suite runs
+ * identically on Linux CI without any real `adb` binary on `PATH`.
+ *
+ * **Error normalisation**: every `adb` invocation routes through
+ * `wrapAdbFailure(verb, args, err, timeoutMs)` so callers see a single
+ * `DeviceError` shape regardless of whether the failure came from a
+ * `SIGTERM` timeout, a missing `adb` binary (`ENOENT`), or a non-zero
+ * exit. In particular `executeCommand` no longer silently coerces
+ * `ENOENT` to `exitCode:1` — it throws `adb_not_installed` so callers
+ * can surface the real cause.
+ *
+ * **Shell quoting invariant** (v0.2.3): every `adb shell ...` invocation
+ * goes through the `sh\`...\`` tagged template from `util/adb-shell.ts`,
+ * collapsing argv to the single-string pattern that adb's wire protocol
+ * actually wants. Multi-arg `["shell", "verb", a, b, ...]` is forbidden
+ * because adb on the device joins argv with spaces and re-evaluates
+ * through `/system/bin/sh -c`, which silently drops shell metacharacters
+ * (`$`, backticks, etc.) the host thought it was passing literally. See
+ * `util/adb-shell.ts` for the gory details.
+ *
+ * **File IO** (v0.2.3): `fileRead` / `fileWrite` / `listDirectory` no
+ * longer use `adb exec-out cat` or `adb shell sh -c "echo ... | base64
+ * -d"` shell hacks. They go through `adb pull` / `adb push` (the actual
+ * file-sync protocol) and `adb shell ls -laL` (deref symlinks) via the
+ * `util/adb-files.ts` helpers. This fixes:
+ *   - `fileRead` of a missing path now throws `file_not_found` instead
+ *     of returning the device-side `cat` stderr base64-encoded.
+ *   - `fileWrite` actually writes the bytes (the old `echo | base64 -d`
+ *     pipeline was eaten by the nested-`sh -c` re-evaluation).
+ *   - `listDirectory("/sdcard")` returns the contents of the linked dir
+ *     (`/storage/self/primary`) instead of a single symlink row.
+ *
+ * **Screenshot contract** (v0.2.3): `screenshot()` returns the structured
+ * `{ data, width, height, format }` shape so the MCP wire layer can keep
+ * `width/height` consistent with the actual decoded image bytes (and
+ * `deviceWidth/deviceHeight` separately track the click coordinate
+ * system). The Android backend no longer compresses by default — the
+ * agent layer decides whether to resize.
+ */
+import { DeviceError, type DeviceInfo } from "@beeos-ai/device-common";
+import { BaseSandboxBackend, type ExecuteCommandOutput, type ListDirectoryEntry, type ScreenSize, type ScreenshotOutput, type UiDumpOutput } from "./base.js";
+import { type AdbRunOptions, type AdbRunResult, type AdbRunner } from "./android-adb-runner.js";
+export type { AdbRunOptions, AdbRunResult, AdbRunner };
+export interface AndroidAdbBackendOptions {
+    /** ADB serial, e.g. `emulator-5554`. Optional when a single device is connected. */
+    serial?: string;
+    /** Skip the connect-time `adb devices` validation; useful for tests. */
+    skipConnectValidation?: boolean;
+    /** Override the default `child_process.spawn`-backed runner (tests). */
+    runner?: AdbRunner;
+    /** Default timeout for short adb commands (default 10_000 ms). */
+    defaultTimeoutMs?: number;
+    /** Timeout for `adb shell` (default 30_000 ms). */
+    shellTimeoutMs?: number;
+    /** Timeout for `adb exec-out screencap` (default 15_000 ms). */
+    screenshotTimeoutMs?: number;
+    /** Timeout for `adb install` (default 120_000 ms — APKs can be big). */
+    installTimeoutMs?: number;
+    /** Timeout for `adb pull` / `adb push` (default 60_000 ms). */
+    fileTimeoutMs?: number;
+    /** Sleep helper, injectable for deterministic tests. */
+    sleep?: (ms: number) => Promise<void>;
+}
+export declare class AndroidAdbBackend extends BaseSandboxBackend {
+    readonly os: "android";
+    readonly tools: ReadonlySet<string>;
+    private readonly serial?;
+    private readonly skipConnectValidation;
+    private readonly runner;
+    private readonly sleep;
+    private readonly defaultTimeoutMs;
+    private readonly shellTimeoutMs;
+    private readonly screenshotTimeoutMs;
+    private readonly installTimeoutMs;
+    private readonly fileTimeoutMs;
+    constructor(opts?: AndroidAdbBackendOptions);
+    connect(): Promise<void>;
+    disconnect(): Promise<void>;
+    info(): Promise<DeviceInfo>;
+    screenshot(): Promise<ScreenshotOutput>;
+    screenSize(): Promise<ScreenSize>;
+    uiDump(): Promise<UiDumpOutput>;
+    tap(x: number, y: number): Promise<void>;
+    click(x: number, y: number): Promise<void>;
+    doubleClick(x: number, y: number): Promise<void>;
+    longPress(x: number, y: number, durationMs?: number): Promise<void>;
+    swipe(x1: number, y1: number, x2: number, y2: number, durationMs?: number): Promise<void>;
+    drag(x1: number, y1: number, x2: number, y2: number, durationMs?: number): Promise<void>;
+    scroll(x: number, y: number, direction: "up" | "down" | "left" | "right", _amount?: number): Promise<void>;
+    typeText(text: string): Promise<void>;
+    pressKey(key: string): Promise<void>;
+    back(): Promise<void>;
+    home(): Promise<void>;
+    navigate(direction: "back" | "forward" | "up"): Promise<void>;
+    launchApp(pkgOrName: string, activity?: string): Promise<void>;
+    executeCommand(body: string, opts?: {
+        timeoutS?: number;
+        cwd?: string;
+    }): Promise<ExecuteCommandOutput>;
+    fileRead(path: string): Promise<Buffer>;
+    fileWrite(path: string, content: Buffer | string): Promise<void>;
+    listDirectory(path: string): Promise<ListDirectoryEntry[]>;
+    install(path: string): Promise<void>;
+    private getCurrentApp;
+    private getCurrentIme;
+    private setIme;
+    private clearText;
+    private runShell;
+    private captureRawPng;
+    /**
+     * Run an `adb shell <single-command>`. Callers MUST build the command
+     * string via `sh\`...\`` (or pass a static literal). This is the ONLY
+     * sanctioned shape for shell invocations — any `["shell", a, b, ...]`
+     * call that bypasses this helper is a bug (see CHANGELOG 0.2.3).
+     */
+    private adbShell;
+    private adbArgs;
+}
+/**
+ * List connected ADB devices. Exposed at module scope (and as a thin
+ * member-bound helper inside `connect()`) so tests / EdgeAgent can probe
+ * device presence without instantiating a backend.
+ */
+export declare function listAdbDevices(runner?: AdbRunner, timeoutMs?: number): Promise<string[]>;
+/**
+ * Normalise every adb runner failure into a single `DeviceError` shape.
+ *
+ *   - `killed && signal === "SIGTERM"` → `adb_timeout`, retriable
+ *   - `code === "ENOENT"` (string)     → `adb_not_installed`, NOT retriable
+ *   - any non-numeric `code`           → `adb_not_installed`, NOT retriable
+ *   - everything else (numeric exit)   → `adb_<verb>_failed` / `adb_failed`
+ *
+ * The verb-specific subtypes (`adb_shell_failed`, `adb_install_failed`,
+ * `adb_screencap_failed`, `adb_devices_failed`) keep the legacy adapter's
+ * shape so existing wire consumers don't break.
+ *
+ * `DeviceError` instances are passed through unchanged — `adbPull` /
+ * `adbPush` already produce well-shaped errors and we don't want to wrap
+ * a `DeviceError` in another `DeviceError`.
+ */
+export declare function wrapAdbFailure(verb: string, args: string[], cause: unknown, timeoutMs?: number): DeviceError;