@xpufx/paseo-x-comms 0.3.0

package/mcp/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/mcp/README.md

@@ -0,0 +1,287 @@
+# paseo-x-comms
+
+> This repo closely follows stable releases of paseo in order to benefit
+> from new features in the plugin system. Expect breaking changes between
+> versions.
+
+[paseo](https://paseo.sh) is an agent orchestrator: AI coding agents run on
+paseo daemons, each managing its own workspaces, tools, and permissions.
+
+paseo-x-comms is an MCP server that lets agents on one paseo daemon
+(remote or local) talk to agents on another paseo daemon, even across hosts,
+through the daemon's relay (WebSocket + E2EE) or directly over TCP.
+
+## How it works
+
+```
+pi / opencode --MCP stdio--> paseo-x-comms (our server)
+                                   │  execFile("paseo", [cmd, "--host", <target>, "--json", …])
+                                   ▼
+                             paseo CLI --relay (E2EE) or direct TCP--> daemon
+```
+
+- The MCP server is just a **client** of daemons: it never runs a
+  daemon, and it only *talks* to agents; each agent does its own work on its
+  own local daemon.
+- `--host` is an **opaque string**: paseo classifies it automatically: a value
+  containing `#offer=` is a relay connection (E2EE); anything else is a direct
+  host target. Our registry maps a short name to that string.
+- Every MCP response and every tool result flows through the official SDK, so
+  framing, JSON-RPC, schema validation, and cancellation are protocol-correct
+  by construction.
+- The server also announces its behavioral contract to clients via the MCP
+  `instructions` field (initialize result), so every model using it gets the
+  envelope format and behavior notes below automatically.
+
+## Install
+
+### As a standalone MCP server
+
+```sh
+npm install -g @xpufx/paseo-x-comms
+```
+
+Requires the `paseo` CLI on PATH. Node ≥ 18.
+
+### As a paseo plugin (recommended)
+
+This repo also ships a paseo plugin that embeds the MCP server and adds the
+x-comms UI (composer pill, agent panel, timeline rendering, and the
+"Inject MCP into context" system-prompt toggle). The plugin is at the repo
+root, so install without `--path`:
+
+```sh
+paseo plugin add <owner>/paseo-x-comms
+```
+
+paseo runs a single `npm install` at the repo root, which pulls both the
+plugin dependencies and the embedded server's dependencies (`@modelcontextprotocol/sdk`,
+`zod`) into one `node_modules`. The server is spawned from `./mcp` and resolves
+its deps from that shared tree; no separate server install or PATH entry is
+required.
+
+## Quick start
+
+1. On the **target** host, get its pairing offer:
+
+   ```sh
+   paseo daemon pair --json
+   # → { "relayEnabled": true, "url": "https://app.paseo.sh/#offer=<b64>", ... }
+   ```
+
+   (Or, if that daemon is directly reachable over TCP, e.g. LAN, Tailscale, VPN,
+   use its address, e.g. `10.0.0.5:6767`, instead of an offer.)
+
+2. On **this** host, write the registry file with a name for that daemon
+   (see `paseo-x-comms.example.json` for the format):
+
+   `~/.paseo/paseo-x-comms/registry.json`:
+
+   ```json
+   { "hsi": "https://app.paseo.sh/#offer=<b64>" }
+   ```
+
+   The registry is credentials; write it yourself and do not paste offers
+   into agent contexts.
+
+3. Discover and talk:
+
+   ```
+   x_comms_list_agents(daemon="hsi")
+   x_comms_send(daemon="hsi", agentId="…", prompt="…")
+   ```
+
+## Tools
+
+> Tool names are `x_comms_*`. When a client (pi, opencode)
+> loads this MCP server, it may prefix tool names with its own server
+> registration (for example `paseo_2d_cross_2d_daemon_2d_comms_...` in pi).
+> Match the tool names the client actually exposes in its tool list; the
+> documented names below are the server's own, without any client prefix.
+
+| Tool | Purpose |
+|------|---------|
+| `x_comms_list_daemons` | List registered daemons (names only) |
+| `x_comms_add_daemon` | Register a daemon: pairing link or direct host |
+| `x_comms_remove_daemon` | Forget a registered daemon |
+| `x_comms_list_agents` | List agents on a daemon |
+| `x_comms_inspect` | Inspect an agent on a daemon |
+| `x_comms_send` | Send a message/task to an agent on a daemon (starts it if idle) |
+| `x_comms_logs` | View an agent's activity/timeline on a daemon |
+| `x_comms_wait` | Block until an agent on a daemon is idle; returns `permission` the moment it stalls on a prompt |
+| `x_comms_list_permissions` | List pending permission requests on a daemon |
+| `x_comms_allow_permission` | Allow an agent's permission request (`reqId` or `all`) |
+| `x_comms_deny_permission` | Deny an agent's permission request (`reqId` or `all`, optional `message`/`interrupt`) |
+
+## Message envelope
+
+`send` prepends a structured sender-meta envelope, one line, JSON:
+
+```
+[x-comms] {"xComms":{"version":3,"type":"x-comms.incoming_message","sender":{…},"target":{…},"sentAt":"…"}}
+```
+
+- `sender`: agentId, agentName, host, daemonServerId, cwd: who is talking and
+  from where. Sources: `agentId`/`cwd` from the environment
+  (`PASEO_AGENT_ID` / `PASEO_AGENT_CWD`), `host`/`daemonServerId` from
+  `paseo daemon status --json`, `agentName` from `paseo inspect <agentId> --json`.
+- `target`: daemon name + recipient agentId.
+- `sentAt`: ISO timestamp.
+- The prompt text itself stays prose: the meta is for machines, the prompt is
+  for humans.
+
+Recipients may parse the envelope and reply to `sender.agentId` on the
+sender's daemon. The envelope is versioned (`version: 1`), so the format can
+evolve without breaking older readers.
+
+For best results, run the same version on each daemon: the envelope format,
+tool names, and parameters evolve between releases, so a mismatched pair still
+works, but the older side answers in its older format.
+
+## Behavior notes
+
+- **Send is preemptive.** A message to a busy agent replaces its current run
+  (paseo's `replaceRunning: true` in `startAgentRun`, see
+  `packages/server/src/server/agent/agent-prompt.ts`) on both sides. If a
+  target may be busy, wait until it is idle before messaging it, or expect the
+  preemption.
+- **Permission loop.** An agent may block on a permission prompt; `send`
+  returns `permission`, `wait` surfaces it, `list_permissions` shows details,
+  and `allow_permission`/`deny_permission` answer. The loop:
+  `send` → `wait` → on `permission`: `list_permissions` + allow/deny →
+  `wait` … → `idle`.
+- **Preflight.** A target alias is resolved before dispatch: an unknown alias
+  fails with the exact string and a `pairing is required` hint, not a generic
+  failure.
+- **Self-message.** Sending to your own agent (`agentId` equals the sender)
+  fails with the fixed `x-comms self-message` label. Same-daemon routing for a
+  *different* agent is the locality rule (#9), which is still open.
+
+## Host forms
+
+The registry value is passed to paseo as an **opaque** `--host` string; paseo
+classifies it:
+
+- `https://app.paseo.sh/#offer=<b64>` : relay connection (E2EE)
+- `host:port`, `tcp://host:port?ssl=true&password=secret`, `unix:///path`,
+  IPC paths, bare port: direct connection to a reachable daemon
+
+Only these canonical forms are accepted. Anything else (e.g. a raw base64
+payload) is passed through untouched and paseo fails visibly on it. (Note:
+paseo's own `--host` help text lists only `host:port` and `tcp://…`; bare
+ports and `unix://` also work but are not documented in the CLI help.)
+
+## Extensions
+
+> [!WARNING]
+> **Extensions are trusted, unsandboxed server-tier code.** They run in this
+> MCP server's process with full Node privileges: filesystem, network, child
+> processes. There is no sandbox, no permission prompt, and no isolation
+> boundary — the same trust level as an installed paseo plugin. Only drop in
+> `.mjs` files you would run yourself.
+
+Drop `*.mjs` files into the extension dir (default
+`~/.paseo/paseo-x-comms/extensions`, override with `PASEO_X_COMMS_EXTENSIONS`).
+Each exports `register(api)` (default or named) and is loaded in filename
+order at startup. Extensions can add filters and register their own tools on
+the same MCP server:
+
+```js
+export default function register(api) {
+  // payload + context -> transform (return new payload), block, or passthrough
+  api.onSend((message, context) => ({ ...message, prompt: message.prompt.trim() }));
+  api.onReceive((data, context) => data);            // response from a daemon
+  api.onToolCall((args, context) => args);           // every tool invocation
+
+  api.registerTool(
+    "x_comms_hello",
+    { title: "Hello", description: "Demo tool", inputSchema: {} },
+    () => ({ content: [{ type: "text", text: "hi" }] }),
+  );
+}
+```
+
+- `api.version` is the extension API version (currently `1`); it is bumped on
+  any breaking change to the surface above.
+- A filter returns `undefined`/`null`/`{action:"pass"}` to pass through, a new
+  payload (or `{action:"transform", value}`) to transform, or
+  `{action:"block", reason}` to block. A block stops the chain and surfaces the
+  reason as the tool error.
+- A file that throws while loading is skipped, and a hook that throws is logged
+  and treated as passthrough. One bad extension cannot take down the server or
+  the other extensions.
+
+## Security
+
+The registry (default `~/.paseo/paseo-x-comms/registry.json`) holds live
+pairing offers (serverId, daemon public keys, relay endpoints): it is
+**credentials**. Never publish it. Configure it as a plain JSON file yourself
+(see the example); do not paste offers into agent contexts and do not share
+the file.
+
+## Configuration
+
+| Env var | Default | Purpose |
+|---------|---------|---------|
+| `PASEO_X_COMMS_REMOTES` | `~/.paseo/paseo-x-comms/registry.json` | registry file path |
+| `PASEO_X_COMMS_PASEO` | `paseo` | paseo binary |
+| `PASEO_X_COMMS_TIMEOUT_MS` | `120000` | per paseo call timeout |
+| `PASEO_X_COMMS_EXTENSIONS` | `~/.paseo/paseo-x-comms/extensions` | extension dir (trusted, unsandboxed) |
+
+## Registering with clients
+
+Example configs live in this repo: `mcp-config.example.json` (pi-style
+registration) and `paseo-x-comms.example.json` (registry format:
+never commit your real registry).
+
+pi (`~/.config/mcp/mcp.json`): the stdio form supports `env` (pi needs MCP
+enabled for this to be picked up):
+
+```json
+{
+  "mcpServers": {
+    "paseo-x-comms": {
+      "command": "node",
+      "args": ["/path/to/paseo-x-comms.mjs"],
+      "type": "stdio",
+      "env": { "PASEO_X_COMMS_REMOTES": "/path/to/paseo-x-comms.json" }
+    }
+  }
+}
+```
+
+opencode (`~/.config/opencode/opencode.jsonc`): note the key is `environment`
+(per opencode's schema):
+
+```jsonc
+{
+  "mcp": {
+    "paseo-x-comms": {
+      "type": "local",
+      "command": ["node", "/path/to/paseo-x-comms.mjs"],
+      "enabled": true,
+      "environment": { "PASEO_X_COMMS_REMOTES": "/path/to/paseo-x-comms.json" }
+    }
+  }
+}
+```
+
+## Scope
+
+Communication only. The toolset covers discovery (`list_agents`, `inspect`),
+messaging (`send`), listening (`logs`, `wait`), answering (`allow_permission`,
+`deny_permission`, `list_permissions`), and the daemon registry
+(`list_daemons`, `add_daemon`, `remove_daemon`). It deliberately does not
+operate resources on other daemons: no schedules, terminals, workspaces, or
+agent creation.
+
+## Development
+
+```sh
+npm install
+npm test          # hermetic: fake paseo CLI + temp registry, no live daemons
+```
+
+## License
+
+Apache-2.0.

package/mcp/mcp-config.example.json

@@ -0,0 +1,8 @@
+{
+  "mcpServers": {
+    "paseo-x-comms": {
+      "command": "paseo-x-comms",
+      "type": "stdio"
+    }
+  }
+}