@mirasim/computer-use 0.0.0-stage → 0.1.0-rc.3

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,16 @@
+Mirasim Computer Use
+Copyright 2026 MIRASIM, INC.
+
+This product includes software developed by MIRASIM, INC.
+(https://github.com/mirasim-ai/computer-use).
+
+The browser extension bridge (extension/relay.js, extension/group.js and
+src/platform/browser/bridge/) contains code adapted from Playwright
+(https://github.com/microsoft/playwright), Copyright (c) Microsoft Corporation,
+licensed under the Apache License, Version 2.0. Playwright's NOTICE reads:
+
+  Playwright
+  Copyright (c) Microsoft Corporation
+
+  This software contains code derived from the Puppeteer project (https://github.com/puppeteer/puppeteer),
+  available under the Apache 2.0 license (https://github.com/puppeteer/puppeteer/blob/master/LICENSE).

package/README.md

@@ -1,3 +1,155 @@
-# Temporary Holding Version
+# Mirasim Computer Use
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Computer use for any agent: an MCP server that lets the agent you already use (Claude Code,
+Codex, or any MCP host) operate browsers, macOS apps, Windows apps and Electron apps.
+
+Think of how a person checks an account balance on a website they use every day. They know the
+steps before the page opens, so they just go through them quickly. Someone new to the site has
+to take one step, look, and only then work out the next one. Capable models now work like the
+experienced person: they plan several GUI steps at once. Mirasim Computer Use is tuned for
+exactly that. It runs a multi-step plan reliably and gives the model accurate feedback on every
+step, so the model can trust the result instead of checking the screen after each click. With a
+strong model, the same task takes fewer model calls and finishes sooner.
+
+The screen reads back as text, a numbered list of elements from the accessibility tree, and
+pixels are used only when text is not enough. It runs no model of its own and needs no API key:
+the host's agent calls the tools with its own model. The [Mirasim](https://mirasim.ai) desktop
+app ships the same tools built in (Settings → Computer Use).
+
+## Benchmark
+
+![Same model, same tasks, 39% less time](docs/benchmark/codex-frontend.png)
+
+Six small frontend tasks on a React + Vite app (two features, three bug fixes, one QA pass), run
+in Codex in the ChatGPT desktop app with the same model and the same prompt. The only difference
+is the tool the agent checks its work with: Codex Computer Use in Codex's in-app browser, or
+Mirasim Computer Use as an MCP server. Each tool ran every task 5 times, the two interleaved in
+one session; timing comes from Codex's own session record, and the final code was graded by
+hidden behaviour checks.
+
+With Mirasim Computer Use the agent finished in 39% less time and passed 30/30 tasks (vs 26/30).
+The time was saved in round trips, not in the browser: the agent made 37% fewer model requests
+while writing almost the same number of output tokens. `observe()` returns elements as data, so
+the agent puts its checks in the script and gets back a verdict instead of reading the page after
+every click. And a click lands where a user's mouse would: on the QA task an invisible layer
+covers a button, Mirasim Computer Use fails the click and names the layer, while Codex Computer
+Use reports the click as done, and its report caught the bug in 1 of 5 runs.
+
+
+## Install
+
+Needs Node.js 22.19 or later. Register the MCP server with your agent:
+
+```sh
+claude mcp add mirasim-cu -- npx -y @mirasim/computer-use mcp
+```
+
+or install the `mirasim-cu` command once with `npm install -g @mirasim/computer-use`.
+
+**Browser** works out of the box: computer-use drives a Chrome of its own (installed Google
+Chrome is required), keeping its profile under `~/.mirasim-computer-use` so logins carry over
+between sessions. To drive the browser you are signed into instead, install the
+[Mirasim extension](https://chromewebstore.google.com/detail/mirasim/khflooofmndpmafhofjdcpjfgnlpikhg)
+and add `-e COMPUTER_USE_BROWSER=extension`.
+
+In extension mode the first browser call starts a bridge in the background and registers it as
+the extension's native-messaging host: a record under `~/.mirasim-computer-use/native-host/`
+and a manifest in each Chromium-family browser's configuration folder. The record names the
+program that started it, which under `npx` is a path in npx's cache; a record whose program is
+gone is skipped, and every bridge start writes it again.
+`npx -y @mirasim/computer-use setup extension --remove` takes it back. The extension serves one
+bridge at a time, and the Mirasim desktop app's comes first: while browser control is on there,
+extension mode says so at once and does not connect.
+Details in [docs/embedding.md](docs/embedding.md#your-own-browser-extension).
+
+**Native apps** are opt-in with `COMPUTER_USE_PLATFORMS` (comma-separated, default `browser`):
+
+```sh
+claude mcp add mirasim-cu -e COMPUTER_USE_PLATFORMS=browser,macos -- npx -y @mirasim/computer-use mcp
+```
+
+- `macos` and `windows` drive native apps through their accessibility tree in the background.
+  On macOS, grant Accessibility (and Screen Recording, for screenshots) to the app that runs
+  your agent; `mirasim-cu setup macos` checks both.
+- `electron` drives any app started with `--remote-debugging-port=<port>`
+  (`COMPUTER_USE_ELECTRON_CDP_URL`, default `http://127.0.0.1:9333`).
+
+**Which apps the agent may drive.** Before the agent first touches a native app, the server asks
+you through your agent's MCP client (MCP elicitation): allow it once, for the session, or always.
+What that looks like depends on the client:
+
+- A client that shows the question (Claude Code in a terminal, for one): you answer it there.
+- A non-interactive run (`claude -p`, CI) declines every question unseen, so an app nobody
+  allowed is refused. Allow it ahead of time with
+  `npx -y @mirasim/computer-use approvals add com.apple.TextEdit` (a macOS bundle id; on Windows
+  the executable's name, e.g. `WINWORD`). `approvals` lists them; `approvals remove` revokes one.
+- A client without elicitation support cannot ask, so the server drives **every** app the agent
+  names. On macOS, `-e COMPUTER_USE_MACOS_FALLBACK_APPS=com.apple.TextEdit,…` narrows that to
+  the listed apps.
+
+The macOS and Windows drivers use a small native helper that npm installs prebuilt for macOS
+arm64/x64 and Windows x64/arm64. Every setting, the state directory and the host protocol are
+documented in [docs/embedding.md](docs/embedding.md).
+
+## Use
+
+```sh
+mirasim-cu mcp                   # MCP stdio server — the runtime
+mirasim-cu browser open          # summon the managed browser for the user
+mirasim-cu setup browser         # dependency bootstrap: verify a driveable Chrome exists
+mirasim-cu setup macos           # check Accessibility + Screen Recording; open a missing pane
+mirasim-cu approvals             # apps answered "always allow"; add / remove <app>
+```
+
+To drive computer-use from another program — the spawn environment, the host protocol, the
+opt-in live preview, the action journal, shared native capture — see
+[docs/embedding.md](docs/embedding.md).
+
+The host's agent calls `computer_repl` directly and reads the resulting observation in the current
+session. The tool server runs no model of its own.
+
+- **`mcp`** serves the tools to a host that brings its own agent loop:
+  ```sh
+  claude mcp add mirasim-cu -- mirasim-cu mcp
+  ```
+  stdout is protocol-only, so the server records nothing by default — and the structured
+  `details` of each result (url / verdict / elementCount) never reaches the host at all.
+  `COMPUTER_USE_MCP_LOG` is the way to see it: one JSON line per call, plus a `server_start` line
+  naming the configuration.
+  ```sh
+  COMPUTER_USE_MCP_LOG=~/.mirasim-computer-use/mcp.jsonl mirasim-cu mcp
+  # {"ts":"…","type":"server_start","version":"0.1.0-rc.1","platforms":"browser","tools":[…]}
+  # {"ts":"…","type":"call","tool":"computer_repl","args":{"code":"await w.observe();"},"isError":false,"ms":412,
+  #  "details":{"url":"https://example.com","verdict":"changed","elementCount":7,"ledgerLines":2,
+  #   "timing":{"runMs":96,"observeMs":310,"steps":[{"kind":"observe","target":"","ok":true,"ms":96,"note":"7 elements"}]}}}
+  ```
+  `details.timing` says where a `computer_repl` call's time went: each step of the code (reads,
+  waits and expects included) with its `ms`, the run in total (`runMs`), and the closing
+  observation apart (`observeMs`, the settle re-check included). The model's own journal carries
+  none of it. Failures are logged the same way (`isError: true`, with `details.error`), including a tool
+  name the host got wrong. Missing parent directories are created; a log that cannot be
+  written is dropped rather than failing the call.
+
+## Tools
+
+Two tools, assembled per driver at session start:
+
+| tool | role |
+|---|---|
+| `computer_repl` | JavaScript over the GUI in a PERSISTENT session: reads (`observe()`, `find(name)`, `text()`, `page()`, `screenshot()`, `diagnostics()`), actions (`click`, `hover`, `setText`, `keys`, `scroll`, `wait`, `focus` + the driver's verbs — `openUrl`, `newTab`, `selectOption`, `paste`, `launchApp`, `menu`, …), and surface HANDLES (`computer.surfaces()` / `computer.surface(id)`) that bind verbs to one tab / window / app. Top-level declarations persist across calls; the first result carries the API reference; every run ends with one observation and a changed/frozen verdict |
+| `computer_repl_reset` | discard the JavaScript bindings — surfaces untouched |
+
+Element observations are incremental by default: when little changed since the previous
+one, only the diff is sent (refs are sticky, so unchanged lines drop out), with a full
+list re-sent periodically.
+
+## License
+
+[Apache License 2.0](LICENSE) © MIRASIM, INC. Parts of the browser extension bridge are adapted
+from [Playwright](https://github.com/microsoft/playwright) (Apache-2.0, © Microsoft Corporation);
+see [NOTICE](NOTICE). The Windows helper's statically linked Rust crates and their licenses are
+listed in [THIRD_PARTY_NOTICES](THIRD_PARTY_NOTICES).
+
+"Mirasim" and the Mirasim logo are trademarks of MIRASIM, INC. and are not licensed under the
+Apache License. Chrome, Claude, Codex, ChatGPT, macOS and Windows are trademarks of their
+respective owners; this project is not affiliated with or endorsed by them.