@carrierllc/mcp 0.9.3 → 0.10.1

package/README.md

@@ -136,6 +136,64 @@ For multi-user deployments with OAuth 2.1 + PKCE, use the remote endpoint:
 | `ESIMVAULT_API_TOKEN` | Yes | — | Your eSIMVault OCS API token |
 | `CARRIER_OCS_API_TOKEN` | Alternative | — | Alias for `ESIMVAULT_API_TOKEN` |
 | `CARRIER_OCS_BASE_URL` | No | `https://ocs.esimvault.cloud` | OCS base URL (no trailing slash) |
+| `BROWSER_USE_API_KEY` | No | — | Browser Use Cloud key. Enables the browsing agent (`ui_agent_ask`). Runs are billed to this key at roughly **$0.20–1.00 each** |
+| `CARRIER_BROWSER_USE_MAX_RUNS` | No | `10` | Browser-agent runs allowed per CLI process. `0` disables the agent. See the caveats below |
+| `CARRIER_ALLOW_PORTAL_PASSWORD` | No | unset | Set to `1` to allow the ten OCS-dashboard tools to use a portal login from this machine. See below |
+| `CARRIER_OCS_PORTAL_USERNAME` | No | — | OCS portal username. Only used when the flag above is set |
+| `CARRIER_OCS_PORTAL_PASSWORD` | No | — | OCS portal password. Only used when the flag above is set |
+| `CARRIER_OCS_DASHBOARD_URL` | No | `https://ocs.esimvault.cloud` | Dashboard the portal agent logs into |
+
+### The browser agent costs real money
+
+`ui_agent_ask` and the OCS-dashboard tools dispatch a hosted browser agent.
+Each run costs roughly **$0.20–1.00**, billed to your own `BROWSER_USE_API_KEY`.
+
+`CARRIER_BROWSER_USE_MAX_RUNS` caps how many runs one CLI process may start.
+Read what it does not do:
+
+- It caps **runs, not dollars**. The vendor prices a run after it finishes.
+- It does **not survive a restart**. Each new CLI process starts a fresh count,
+  so a caller that respawns the CLI between runs is not bounded by it.
+
+The only hard financial ceiling is a spend limit set in your Browser Use
+account. Set one.
+
+### Opting in to the OCS portal password
+
+Ten `ui_*` tools — steering lists, sub-account creation, destination lists,
+package-template deletion, location-zone edits — have no OCS REST equivalent.
+They work by driving the OCS web dashboard, which means logging into it. By
+default the CLI has no portal login and these tools refuse.
+
+You can supply one. Understand what you are supplying first:
+
+- **This is a portal password, not a scoped API token.** It grants full
+  dashboard access to anyone who holds it. `CARRIER_OCS_API_TOKEN` is a
+  different kind of secret and is not a precedent for this.
+- **An environment variable is a poor place for one.** It is readable from shell
+  history, from `ps` output by any process on the machine, and from CI logs.
+- **It is sent to Browser Use Cloud**, which types it into the OCS login form.
+
+Carrier never logs it, never returns it in tool output, and never writes it to
+an audit row — but the exposure above is yours to accept.
+
+Two independent things must both be true, and neither alone does anything:
+
+```bash
+export CARRIER_ALLOW_PORTAL_PASSWORD=1
+export CARRIER_OCS_PORTAL_USERNAME='...'
+export CARRIER_OCS_PORTAL_PASSWORD='...'
+```
+
+With the flag set, the CLI prints the warning to stderr at startup. Without both
+halves, the ten tools return the same "requires the remote Worker" refusal they
+returned before this option existed.
+
+Every one of the ten accepts `dry_run: true`, which returns the agent prompt
+with the credentials redacted and dispatches nothing. Use it first.
+
+`ui_request_reseller_relay_change` is not one of the ten and is never gated: it
+drafts text and touches no portal.
 
 ---