@darwinium/portal-mcp 0.0.1 → 0.0.2

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 2026 Darwinium Pty Ltd
+
+   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,7 @@
+Darwinium Portal MCP
+Copyright 2026 Darwinium Pty Ltd
+
+This product includes software developed at Darwinium (https://darwinium.com).
+
+Portions of src/vendor/darwinium-instructions/ are generated from Darwinium's
+internal darwinium-instructions package and are covered by this same license.

package/README.md

@@ -1,14 +1,244 @@
 # @darwinium/portal-mcp
 
-**This is a placeholder release.** The Darwinium Portal MCP server has not been published
-yet — version `0.0.1` reserves the package name only and does nothing if run.
+Connect Claude Desktop or Claude Code to your active `*.darwinium.com` portal tab. Three tools, zero backend connections, OOB-paired to your existing portal session.
 
-When released, this package will provide a local MCP server that connects Claude Desktop and
-Claude Code to the Darwinium portal tab open in your browser, paired with a companion Chrome
-extension.
+For the full guide, visit **https://darwinium.com/portal-mcp**.
 
-Documentation and release status: **https://darwinium.com/portal-mcp**
+---
+
+## What this is
+
+`@darwinium/portal-mcp` is a stdio MCP server that bridges Claude Desktop and Claude Code to the active Darwinium portal tab in your browser. It does **not** connect to any Darwinium backend — your existing portal session handles all data access. The MCP server only sees what your portal tab sees.
+
+The three tools exposed are:
+
+- `get_page_commands` — list the page commands registered on the active tab
+- `run_page_command` — invoke a named page command with args
+- `get_context` — return the page's static instructions plus current node context
+
+## Prerequisites
+
+- macOS, Windows, or Linux with **Node.js 20 or newer** (`node --version`)
+- **Google Chrome 116+** (Chromium-based browsers are not officially supported in v1)
+- A logged-in Darwinium portal tab (`*.darwinium.com`)
+
+## Install
+
+The install is two short steps: register the MCP server with your LLM client, then run a one-time pairing command in your terminal so the MCP server can talk to your browser tab.
+
+### Step 1 — Install the Chrome extension
+
+Pick the path your environment allows:
+
+- **Chrome Web Store** (recommended for unmanaged Chrome): listing pending review — see
+  https://darwinium.com/portal-mcp/chrome-extension for the current link
+- **Unpacked** (locked corporate Chrome): run the installer in Step 2 first; it extracts a versioned copy of the extension to your platform's app-data directory and prints the exact path. Then in Chrome:
+  1. Visit `chrome://extensions`
+  2. Enable **Developer Mode** (top right)
+  3. Click **Load Unpacked**
+  4. Point it at the path the installer printed (e.g. `~/Library/Application Support/darwinium-portal-mcp/extension/` on macOS)
+
+### Step 2 — Install the MCP server
+
+Pick the LLM client you use:
+
+#### Claude Desktop
+
+```
+npx -y @darwinium/portal-mcp install
+```
+
+The installer:
+
+1. Writes a per-install token to your platform's app-data directory (mode `0600` on macOS / Linux; ACL-locked on Windows)
+2. Patches your `claude_desktop_config.json` (with a `.bak` companion for safety, additive merge — your other MCP entries are preserved)
+3. Extracts the bundled extension to your app-data directory (for the Unpacked path above)
+4. Prints a 6-digit pairing code in a box like:
+
+   ```
+   portal-mcp: pairing armed. Open the Darwinium Portal MCP extension popup
+               and enter this 6-digit code within 60 seconds.
+
+     ┌────────────────────────────────────────────────────────────┐
+     │                                                            │
+     │   Pairing code:  123456                                    │
+     │   Expires:       60s                                       │
+     │                                                            │
+     └────────────────────────────────────────────────────────────┘
+
+   portal-mcp: waiting for popup... (Ctrl+C to abort)
+   ```
+
+5. Waits for you to paste the code into the extension popup. Click the **Darwinium Portal MCP** icon in your Chrome toolbar, type the 6 digits, click **Save & Connect**. The installer prints `✓ paired with extension` and exits success.
+
+If the code expires (60 seconds) or you mistype it three times, press **Enter** at the installer's prompt to generate a fresh code. Press **Ctrl+C** to abort.
+
+#### Claude Code
+
+In any Claude Code session:
+
+```
+/plugin marketplace add darwinium-com/portal-mcp
+/plugin install portal-mcp@darwinium
+```
+
+Or register it in one line without the plugin:
+
+```
+claude mcp add darwinium-portal-mcp -- npx -y @darwinium/portal-mcp serve
+```
+
+Either way, then complete OOB pairing (one-time):
+
+```
+npx -y @darwinium/portal-mcp install
+```
+
+Same boxed pairing code, same paste-into-popup flow as the Claude Desktop track. The Claude Code marketplace install handles the config registration; the `install` subcommand handles the browser pairing — they are complementary, not redundant.
+
+## Verify your install
+
+Run the diagnostic:
+
+```
+npx -y @darwinium/portal-mcp doctor
+```
+
+You'll see nine checks. All should pass on a healthy install:
+
+- `binary.present` — the npm-fetched binary is on disk and executable
+- `token.mode` — token file is mode `0600` (macOS / Linux only)
+- `token.parent.mode` — token's parent dir is mode `0700` (macOS / Linux only)
+- `token.acl` — token file has inheritance broken (Windows only; skipped elsewhere)
+- `config.desktop.entry` — `claude_desktop_config.json.mcpServers["darwinium-portal-mcp"]` exists and is well-formed
+- `config.code.marketplace` — Claude Code plugin install is present at `~/.claude/plugins/...` (warn-only if missing — you may not be using Claude Code)
+- `extension.reachable` — the extension's WebSocket bridge accepts the token within 5 seconds
+- `port.9224.bindable` — `127.0.0.1:9224` is free for the MCP server to bind
+- `git.token-tree-warning` — token file is **not** inside a git working tree (warn-by-default; move it out or add to `.gitignore` if it is)
+
+For support tickets, attach the structured `--json` output:
+
+```
+npx -y @darwinium/portal-mcp doctor --json > doctor-output.json
+```
+
+## Rotate the token
+
+If your token file is leaked or you simply want a fresh pairing:
+
+```
+npx -y @darwinium/portal-mcp rotate-token
+```
+
+This regenerates the token and prompts you to re-pair the extension. The old token stops working immediately — the extension's next bridge call gets a "Token mismatch" error, the popup auto-detects it and shows a **Re-pair** action. Click Re-pair, paste the new 6-digit code, paired.
+
+## Common errors
+
+The MCP server returns four user-actionable error responses:
+
+| Error | What it means | What to do |
+|-------|---------------|------------|
+| `No tab connected` | The extension popup shows **Disconnected** | Open `*.darwinium.com`, click **Connect** in the popup |
+| `Connection lost mid-call` | The extension disconnected during your command | Wait for auto-reconnect (≤30s), then retry |
+| `Page navigated mid-call, current page is X` | You navigated away during the command | Retry from the new page, or include `expected_page_id` to gate the call |
+| `Token mismatch` | Extension token doesn't match the binary | Run `npx -y @darwinium/portal-mcp rotate-token` and re-pair |
+
+## Privacy Policy
+
+Full policy: **https://darwinium.com/portal-mcp/privacy**. Summary below.
+
+### What this software collects
+
+**Darwinium collects nothing through this tool.** It has no analytics, no telemetry, no
+crash reporting, and no backend of its own. The only network destination either component
+ever opens is `ws://127.0.0.1:9224` — a loopback socket on your own machine.
+
+### What data is handled, and where it goes
+
+The extension reads the Darwinium portal page you have open and passes what it reads to
+the local MCP server, which hands it to the LLM client that launched it (Claude Desktop or
+Claude Code).
+
+Be aware of what that means: **portal data you ask about does leave your machine — it is
+sent to your AI provider by your own LLM client**, exactly as any other content in that
+conversation is, under that provider's privacy policy (for Claude, Anthropic's). Darwinium
+neither sees nor receives it. Do not ask the assistant about portal data you are not
+willing to send to your AI provider.
+
+The server reaches no Darwinium backend at any point. Your existing browser session performs
+all data access, and the server only ever sees what your own portal tab already shows you.
+
+### Storage and retention
+
+- A 64-character hex pairing token is written to your platform's app-data directory
+  (mode `0600` on macOS/Linux, ACL-locked on Windows). It authorises the loopback WebSocket
+  and nothing else. It never appears in `claude_desktop_config.json` and never leaves the machine.
+- The extension stores that token, plus a short in-memory tool-call history for the popup,
+  in Chrome's local extension storage.
+- No portal data is written to disk by either component, and nothing is retained after the
+  process exits. Revoke at any time with `rotate-token`, or by removing the extension.
+
+### Scope limits
+
+- The extension's production `host_permissions` and content-script matches are exactly
+  `https://*.darwinium.com/*` and `https://*.int.darwinium.io/*`. It cannot read any other
+  site, and `scripts/check-manifest.mjs --prod` fails the build if that ever widens.
+- The 6-digit pairing code is single-use, expires in 60 seconds, and is rate-limited to
+  3 attempts.
+
+### Third parties
+
+None, other than the AI provider you have chosen to run this server under, as described above.
+
+### Contact
+
+Privacy questions: **privacy@darwinium.com**. Issues:
+**https://github.com/darwinium-com/portal-mcp/issues**.
+
+## Troubleshooting
+
+- **"It worked yesterday, broken today"** — npm cache may be stale. Run `npx clear-npx-cache` or `npm cache clean --force`. Then re-run `doctor` and check the `binary.present` version.
+- **"Load Unpacked fails on macOS because the path contains spaces"** — copy the extracted extension to a path without spaces, e.g. `cp -r '~/Library/Application Support/darwinium-portal-mcp/extension' ~/darwinium-mcp-extension` and load the latter.
+- **"Pairing code expired"** — press **Enter** at the installer's prompt to re-arm with a fresh code (counter resets).
+- **"`claude_desktop_config.json` is not valid JSON"** — fix the syntax (or delete the file) and re-run `install`. Your previous config is at `claude_desktop_config.json.bak`.
+- **"`port 9224` is already in use"** (`port.9224.bindable` doctor check fails) — another `portal-mcp serve` instance is running, or another tool has bound the port. Quit the other instance, or `lsof -i :9224` (macOS / Linux) / `netstat -ano | findstr :9224` (Windows) to find the offender.
+
+For more, see **https://darwinium.com/portal-mcp/troubleshooting**.
+
+## Building the macOS hand-over bundle (internal)
+
+Ahead of the npm and Chrome Web Store releases, `yarn package:macos` produces a folder that
+installs with double-clicks only — no terminal, no Node.js, no npm. Intended for non-technical
+users (sales, solutions engineering) on Apple Silicon.
+
+```
+yarn package:macos                       # defaults to bun-darwin-arm64
+yarn package:macos --target=bun-darwin-x64   # Intel Macs
+```
+
+Requires [bun](https://bun.sh) on PATH. Output lands in `build/` (gitignored):
+
+- `DarwiniumPortalMCP-<version>-macos-<arch>.zip` — the file you hand over
+- `DarwiniumPortalMCP/1 - Darwinium Portal MCP.mcpb` — double-click installs the MCP server
+  into Claude Desktop. It carries a `bun build --compile` standalone binary, because Claude
+  Desktop does not ship a Node runtime for mcpb extensions — it searches PATH for one, which
+  finds nothing on a machine without developer tooling.
+- `DarwiniumPortalMCP/2 - chrome-extension/` — the Load Unpacked target, at a space-free path
+- `DarwiniumPortalMCP/START-HERE.html` — the end-user guide
+- `Check-Setup.command` / `Fix-Permissions.command` — support escape hatches
+
+The bundle skips the `install` subcommand entirely: `serve` generates the token on first launch
+and surfaces it via `initialize.instructions`, so the user asks Claude for the pairing token and
+pastes it into the popup. No terminal is involved at any point.
+
+Anything resolving a bundled file must go through `src/install/bundlePaths.ts` — under a compiled
+binary `import.meta.url` and `argv[1]` both point inside bun's virtual `/$bunfs/` filesystem and
+never exist on disk.
 
 ## License
 
-ISC
+Apache-2.0 — see [LICENSE](./LICENSE).
+
+## Source
+
+`@darwinium/portal-mcp` source repository: https://github.com/darwinium-com/portal-mcp *(publishes with v1.0)*.