@bsbofmusic/agent-browser-mcp-opencode 0.1.1 → 1.0.1

package/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.0.0] - 2026-02-27
+
+### Added
+- Initial release
+- MCP server implementation for agent-browser
+- Core tools: browser_ensure, browser_doctor, browser_help, browser_version, browser_exec
+- Structured actions: browser_open, browser_snapshot, browser_click, browser_fill, browser_screenshot, browser_close, browser_get_text, browser_find, browser_wait, browser_tab
+- Bootstrap auto-installation on startup
+- ensureLatest() for automatic updates
+- Process lock to prevent concurrent installations
+- Full environment detection (OS, runtime, network, permissions)
+- Doctor diagnostics covering 7 issue categories
+
+### Features
+- One-click deployment via npx
+- Idempotent ensure operation
+- Structured output with logs and nextSteps
+- Support for ALWAYS_LATEST environment variable
+- Exec tool for full CLI capability passthrough
+
+### Dependencies
+- @modelcontextprotocol/server-stdio: ^1.0.0
+- execa: ^9.5.2
+- conf: ^12.0.0
+- semver: ^7.7.1

package/README.md

@@ -1,22 +1,301 @@
 # @bsbofmusic/agent-browser-mcp-opencode
 
-MCP (stdio) server that drives `agent-browser` for OpenCode / CC SWITCH.
+MCP Server for Vercel agent-browser - browser automation CLI for AI agents.
+
+---
+
+## What is This?
+
+This is an MCP (Model Context Protocol) wrapper for [agent-browser](https://github.com/vercel-labs/agent-browser), providing browser automation capabilities for AI assistants like OpenCode, Claude Code, and others.
+
+### Use Cases
+
+- **AI Testing**: Automate web testing workflows with AI agents
+- **Web Scraping**: Extract data from dynamic web pages
+- **Form Automation**: Fill forms, click buttons, navigate pages
+- **Visual Testing**: Take screenshots, compare snapshots
+
+---
+
+## One-Click Enable
+
+### OpenCode Configuration
+
+Add to your `opencode.json`:
+
+```json
+{
+  "mcp": {
+    "agent-browser-mcp-opencode": {
+      "command": ["npx", "-y", "@bsbofmusic/agent-browser-mcp-opencode"],
+      "enabled": true,
+      "type": "local"
+    }
+  }
+}
+```
+
+### Direct Run
+
+```bash
+npx @bsbofmusic/agent-browser-mcp-opencode
+```
+
+### Docker
+
+```bash
+docker run -it --rm bsbofmusic/agent-browser-mcp-opencode
+```
+
+### Global Install
+
+```bash
+npm install -g @bsbofmusic/agent-browser-mcp-opencode
+agent-browser-mcp-opencode
+```
+
+---
+
+## Tool List
+
+### Core Tools
+
+| Tool | Description |
+|------|-------------|
+| `browser_ensure` | Manually trigger full repair (install/upgrade) |
+| `browser_doctor` | Diagnose issues with actionable nextSteps |
+| `browser_help` | List all available commands |
+| `browser_version` | Show version info |
+| `browser_exec` | Execute any agent-browser CLI command |
+
+### Structured Actions
+
+| Tool | Description |
+|------|-------------|
+| `browser_open` | Navigate to URL |
+| `browser_snapshot` | Get accessibility tree with refs |
+| `browser_click` | Click element (@e1 or CSS selector) |
+| `browser_fill` | Fill form field |
+| `browser_screenshot` | Take screenshot |
+| `browser_close` | Close browser |
+| `browser_get_text` | Get element text |
+| `browser_find` | Semantic locator (role/text/label) |
+| `browser_wait` | Wait for element/text/URL/time |
+| `browser_tab` | Manage tabs |
+
+---
+
+## Schema Examples
+
+### browser_open
+
+**Input:**
+```json
+{
+  "name": "browser_open",
+  "arguments": {"url": "https://example.com"}
+}
+```
+
+**Output:**
+```json
+{
+  "ok": true,
+  "url": "https://example.com",
+  "duration": 2341
+}
+```
+
+### browser_snapshot
+
+**Input:**
+```json
+{
+  "name": "browser_snapshot",
+  "arguments": {"interactive": true, "compact": true}
+}
+```
+
+**Output:**
+```json
+{
+  "ok": true,
+  "output": {
+    "success": true,
+    "data": {
+      "snapshot": "- heading \"Example\" [ref=e1]\n  - button \"Submit\" [ref=e2]"
+    }
+  },
+  "duration": 1234
+}
+```
+
+### browser_exec
+
+**Input:**
+```json
+{
+  "name": "browser_exec",
+  "arguments": {
+    "command": "open example.com && snapshot -i",
+    "timeoutMs": 60000
+  }
+}
+```
+
+---
+
+## Auto-Update Strategy
+
+### Environment Variables
+
+| Variable | Default | Description |
+|----------|---------|-------------|
+| `ALWAYS_LATEST` | `1` | Check for updates before each call |
+| `UPDATE_STRATEGY` | `simple` | `atomic` or `simple` |
+| `LOG_LEVEL` | `info` | `error`, `warn`, `info`, `debug` |
+
+### Strategies
+
+**Simple (default):**
+- Direct overwrite installation
+- No rollback capability
+
+**Atomic:**
+- Uses `runtime_active/` + `runtime_staging/` directories
+- Validates before switching
+- Rolls back on failure
+
+---
+
+## Runtime Directories
+
+| Directory | Location | Purpose |
+|-----------|----------|---------|
+| Config | `~/.agent-browser/` | User configuration |
+| Sessions | `~/.agent-browser/sessions/` | Saved auth states |
+| Cache | System temp | Temporary files |
+
+These directories are auto-created on first run and are rebuildable.
+
+---
+
+## Troubleshooting
+
+### Run browser_doctor
 
-## CC SWITCH config
 ```json
 {
-  "command": "npx",
-  "args": ["-y", "@bsbofmusic/agent-browser-mcp-opencode@latest"],
-  "type": "stdio"
+  "name": "browser_doctor"
 }
 ```
 
-## Notes
-- First run may download Chromium (large).
-- This package auto-installs `agent-browser` if missing.
+**Output includes:**
+- Issue categories: network/permissions/dependencies/system_libraries/executable/browser/auth
+- Severity: critical/high/medium
+- nextSteps: actionable fix recommendations
+
+### Common Issues
+
+1. **agent-browser not installed**
+   - Run: `browser_ensure`
+   - Or: `npx agent-browser install`
+
+2. **Chromium not installed**
+   - Run: `npx agent-browser install`
+
+3. **Permission errors**
+   - Check npm global directory permissions
+   - Consider using npx instead
+
+4. **Network issues**
+   - Set npm mirror: `npm config set registry https://registry.npmmirror.com`
+   - Check proxy: `npm config get proxy`
+
+---
+
+## Verification Plan
+
+### 6.1 One-Click Deployment
+
+```bash
+npx @bsbofmusic/agent-browser-mcp-opencode
+```
+
+**Expected:** Auto-installs dependencies without manual steps.
+
+### 6.2 Capability Coverage
+
+Test with 5+ core commands:
+- `browser_open` → navigates to URL
+- `browser_snapshot` → returns accessibility tree with refs
+- `browser_click @e1` → clicks element
+- `browser_fill @e2 "test"` → fills form
+- `browser_screenshot` → captures image
+- `browser_exec` → passes through all CLI commands
+
+### 6.3 Stability
+
+- `browser_doctor` outputs 7 issue categories
+- `browser_ensure` is idempotent
+- Errors include logs + nextSteps
+
+### 6.4 Auto-Update
+
+- `browser_version` shows current/latest
+- `ALWAYS_LATEST=1` checks on each call
+
+### 6.5 Deployment Ready
+
+- No manual config after first enable
+- Survives MCP/Agent restart
+
+### 6.6 Failure Scenarios
+
+| Scenario | Expected Output |
+|----------|-----------------|
+| No network | Network error + nextSteps |
+| No permission | Permission error + nextSteps |
+| Missing deps | Dep error + nextSteps |
+
+---
+
+## Wrapper Declaration
+
+This project is a wrapper for **agent-browser** by Vercel Labs.
+
+- **Upstream**: https://github.com/vercel-labs/agent-browser
+- **License**: Apache-2.0
+- This is NOT an official upstream release
+- Upstream trademarks/copyrights belong to respective owners
+
+See [THIRD_PARTY_NOTICES.md](./THIRD_PARTY_NOTICES.md) for license details.
+
+---
+
+## Upstream License
+
+agent-browser is licensed under **Apache-2.0**.
+
+This project includes upstream code per Apache-2.0 requirements.
+
+---
+
+## Version History
+
+See [CHANGELOG.md](./CHANGELOG.md)
+
+---
+
+## Support
+
+- MCP issues: https://github.com/issues
+- agent-browser upstream: https://github.com/vercel-labs/agent-browser/issues
+
+---
+
+## License
+
+Apache-2.0 License
 
-## Env (optional)
-- `AGENT_BROWSER_SESSION=opencode`
-- `AGENT_BROWSER_STATE=.../state.json`
-- `AGENT_BROWSER_ALLOW_DOMAINS=github.com,google.com`
-- `AGENT_BROWSER_TIMEOUT_MS=60000`
+Copyright (c) 2024-2025 bsbofmusic

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,291 @@
+# Third Party Notices
+
+This file contains third party copyright notices and license information for dependencies used in this project.
+
+---
+
+## agent-browser
+
+**Project**: https://github.com/vercel-labs/agent-browser
+**License**: Apache-2.0
+**Copyright**: Copyright (c) Vercel Inc.
+
+### Apache-2.0 License
+
+                                 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 the 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.
+
+---
+
+## @modelcontextprotocol/server-stdio
+
+**Project**: https://github.com/modelcontextprotocol/modelcontextprotocol
+**License**: MIT
+**Copyright**: Anthropic Inc.
+
+MIT License
+
+Copyright (c) 2024 Anthropic Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+## execa
+
+**Project**: https://github.com/sindresorhus/execa
+**License**: MIT
+**Copyright**: Copyright (c) Sindre Sorhus
+
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+## conf
+
+**Project**: https://github.com/sindresorhus/conf
+**License**: MIT
+**Copyright**: Copyright (c) Sindre Sorhus
+
+MIT License - see execa section
+
+---
+
+## semver
+
+**Project**: https://github.com/npm/node-semver
+**License**: ISC
+**Copyright**: Copyright (c) Isaac Z. Schlueter
+
+ISC License
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+---
+
+## 封装声明
+
+本项目 `@bsbofmusic/agent-browser-mcp-opencode` 是对上游项目 [agent-browser](https://github.com/vercel-labs/agent-browser) 的 MCP 封装。
+
+- 本项目不是上游项目的官方发布
+- 上游项目的名称、商标与版权归其各自权利人所有
+- 上游项目按 Apache-2.0 许可证授权使用
+- 本项目包含上述许可证的完整文本