@cyanmycelium/mcp-broker-provider 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 Support. 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 support.
+
+   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 Guillaume Pelletier (CyanMycelium)
+
+   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/README.md

@@ -0,0 +1,76 @@
+# @cyanmycelium/mcp-broker-provider
+
+Provider side of the [CyanMycelium MCP broker](https://github.com/pandaGaume/mcp-broker) tunnel: what an application uses to **publish** its MCP server to a broker slot.
+
+MCP defines two standard transports, stdio and Streamable HTTP, and both live in [`@cyanmycelium/mcp-core`](https://www.npmjs.com/package/@cyanmycelium/mcp-core). The WebSocket tunnel is not one of them: it is CyanMycelium topology, where an MCP server runs next to a browser application and reaches the outside world through a broker. That is what this package covers, so `mcp-core` stays a faithful implementation of the specification and nothing else.
+
+See [docs/packages.md](https://github.com/pandaGaume/mcp-broker/blob/main/docs/packages.md) for how this package relates to the broker, and why *provider* rather than *client*.
+
+## Install
+
+```sh
+npm install @cyanmycelium/mcp-broker-provider
+```
+
+## Entry points
+
+```ts
+import { MultiplexTransport } from "@cyanmycelium/mcp-broker-provider";
+import { decodeEnvelope } from "@cyanmycelium/mcp-broker-provider/protocol";
+```
+
+| Entry point | Contents |
+|---|---|
+| `.` | The tunnel transports, plus everything below |
+| `./protocol` | The envelope wire format: types, codec, registration notification, error codes. No dependencies, isomorphic |
+
+## The envelope protocol
+
+A multiplexed tunnel socket carries traffic for several providers at once, so every JSON-RPC message is wrapped with the name of the provider slot it belongs to:
+
+```json
+{ "provider": "scene-1", "payload": { "jsonrpc": "2.0", "id": 1, "method": "tools/list" } }
+```
+
+`./protocol` is the single definition of that format. The broker imports it rather than re-declaring the shape inline, so the two ends cannot drift.
+
+Beyond the envelope it also covers:
+
+- `notifications/register`, sent as soon as the tunnel opens to claim a provider slot. Without it the broker only learns a provider name on its first real message, and an MCP client connecting in between is told the provider is not connected.
+- The tunnel error codes: `-32001` when the provider's credentials do not allow publishing on the requested slot, `-32000` when the slot is unavailable. `tunnelErrorOf()` lets a provider recognise them instead of handing an `id: null` error frame to an MCP server, which would classify it as an unknown notification and drop it silently.
+
+Malformed frames decode to `undefined` rather than throwing: a tunnel socket is a public surface, and a peer sending garbage must not take the receiver down.
+
+## Transports
+
+| Transport | Use case |
+|---|---|
+| `MultiplexTransport` | Several servers published by one application. A single socket carries them all, keyed by slot name |
+| `DirectTransport` | One server, one socket, on `ws://<broker>/provider/<name>` |
+
+```ts
+import { McpServerBuilder } from "@cyanmycelium/mcp-core/server";
+import { MultiplexTransport } from "@cyanmycelium/mcp-broker-provider";
+
+const server = new McpServerBuilder()
+    .withName("scene-1")
+    .withTransport(MultiplexTransport.create("scene-1", "ws://localhost:3000/providers"))
+    .register(behavior)
+    .build();
+
+await server.start();
+```
+
+Transports created for the same tunnel URL share one WebSocket, whichever order they are opened in. Reconnection is handled by that shared socket, with exponential back-off and jitter; individual transports never reconnect on their own.
+
+`@cyanmycelium/mcp-core` is a peer dependency: the transports import its `IMessageTransport` type and nothing else at runtime, so your application keeps a single copy of it.
+
+## Status
+
+`0.1.0` ships the protocol module and both transports. They still exist in `@cyanmycelium/mcp-core@0.4.x` as well, and are removed there in `0.5.0` — migrate your imports before upgrading.
+
+The protocol is shared with the broker and, later, with the consumer side, so it is expected to graduate into its own `@cyanmycelium/mcp-broker-core` package. Import it through the `./protocol` subpath rather than the package root and that move will cost you one line.
+
+## License
+
+Apache-2.0

package/dist/direct.transport.d.ts

@@ -0,0 +1,28 @@
+import type { IMessageTransport } from "@cyanmycelium/mcp-core";
+/**
+ * 1:1 WebSocket transport — wraps a single `WebSocket` connection to a broker
+ * provider slot, typically `ws://<broker>/provider/<name>`.
+ *
+ * One server owns one socket. When an application publishes several servers
+ * through the same broker, prefer {@link MultiplexTransport}, which shares a
+ * single socket between them.
+ *
+ * Call {@link connect} after setting the event callbacks to open the socket.
+ */
+export declare class DirectTransport implements IMessageTransport {
+    private readonly _wsUrl;
+    private _ws;
+    onMessage: ((data: string) => void) | null;
+    onOpen: (() => void) | null;
+    onClose: (() => void) | null;
+    onError: ((error: Error) => void) | null;
+    constructor(wsUrl: string);
+    get isOpen(): boolean;
+    /**
+     * Opens the WebSocket connection and wires its events to the transport
+     * callbacks. Must be called after assigning `onOpen` / `onMessage` / etc.
+     */
+    connect(): void;
+    send(data: string): void;
+    close(): void;
+}

package/dist/direct.transport.js

@@ -0,0 +1,55 @@
+/**
+ * 1:1 WebSocket transport — wraps a single `WebSocket` connection to a broker
+ * provider slot, typically `ws://<broker>/provider/<name>`.
+ *
+ * One server owns one socket. When an application publishes several servers
+ * through the same broker, prefer {@link MultiplexTransport}, which shares a
+ * single socket between them.
+ *
+ * Call {@link connect} after setting the event callbacks to open the socket.
+ */
+export class DirectTransport {
+    _wsUrl;
+    _ws = null;
+    onMessage = null;
+    onOpen = null;
+    onClose = null;
+    onError = null;
+    constructor(wsUrl) {
+        this._wsUrl = wsUrl;
+    }
+    get isOpen() {
+        return this._ws?.readyState === WebSocket.OPEN;
+    }
+    /**
+     * Opens the WebSocket connection and wires its events to the transport
+     * callbacks. Must be called after assigning `onOpen` / `onMessage` / etc.
+     */
+    connect() {
+        const ws = new WebSocket(this._wsUrl);
+        ws.onopen = () => {
+            this._ws = ws;
+            this.onOpen?.();
+        };
+        ws.onerror = () => {
+            this.onError?.(new Error(`DirectTransport: WebSocket error on ${this._wsUrl}`));
+        };
+        ws.onclose = () => {
+            this._ws = null;
+            this.onClose?.();
+        };
+        ws.onmessage = (event) => {
+            this.onMessage?.(event.data);
+        };
+    }
+    send(data) {
+        if (this._ws?.readyState === WebSocket.OPEN) {
+            this._ws.send(data);
+        }
+    }
+    close() {
+        this._ws?.close();
+        this._ws = null;
+    }
+}
+//# sourceMappingURL=direct.transport.js.map

package/dist/direct.transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"direct.transport.js","sourceRoot":"","sources":["../src/direct.transport.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AACH,MAAM,OAAO,eAAe;IACP,MAAM,CAAS;IACxB,GAAG,GAAqB,IAAI,CAAC;IAErC,SAAS,GAAoC,IAAI,CAAC;IAClD,MAAM,GAAwB,IAAI,CAAC;IACnC,OAAO,GAAwB,IAAI,CAAC;IACpC,OAAO,GAAoC,IAAI,CAAC;IAEhD,YAAY,KAAa;QACrB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,GAAG,EAAE,UAAU,KAAK,SAAS,CAAC,IAAI,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,OAAO;QACH,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEtC,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE;YACb,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;YACd,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACpB,CAAC,CAAC;QAEF,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,KAAK,CAAC,uCAAuC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACpF,CAAC,CAAC;QAEF,EAAE,CAAC,OAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;YAChB,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;QACrB,CAAC,CAAC;QAEF,EAAE,CAAC,SAAS,GAAG,CAAC,KAA2B,EAAE,EAAE;YAC3C,IAAI,CAAC,SAAS,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC,CAAC;IACN,CAAC;IAED,IAAI,CAAC,IAAY;QACb,IAAI,IAAI,CAAC,GAAG,EAAE,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;YAC1C,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACL,CAAC;IAED,KAAK;QACD,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,CAAC;QAClB,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;IACpB,CAAC;CACJ"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Provider side of the CyanMycelium MCP broker tunnel: what an application uses
+ * to publish its MCP server to a broker slot.
+ *
+ * The tunnel envelope protocol is also published on its own entry point,
+ * `@cyanmycelium/mcp-broker-provider/protocol`, which the broker imports so both
+ * ends of the tunnel share one definition of the wire format.
+ */
+export * from "./protocol/index";
+export { DirectTransport } from "./direct.transport";
+export { MultiplexTransport } from "./multiplex.transport";

package/dist/index.js

@@ -0,0 +1,12 @@
+/**
+ * Provider side of the CyanMycelium MCP broker tunnel: what an application uses
+ * to publish its MCP server to a broker slot.
+ *
+ * The tunnel envelope protocol is also published on its own entry point,
+ * `@cyanmycelium/mcp-broker-provider/protocol`, which the broker imports so both
+ * ends of the tunnel share one definition of the wire format.
+ */
+export * from "./protocol/index";
+export { DirectTransport } from "./direct.transport";
+export { MultiplexTransport } from "./multiplex.transport";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC"}

package/dist/multiplex.transport.d.ts

@@ -0,0 +1,81 @@
+import type { IMessageTransport } from "@cyanmycelium/mcp-core";
+/**
+ * Manages a single WebSocket connection shared by multiple {@link MultiplexTransport}
+ * instances. All traffic goes through the tunnel envelope protocol, whose
+ * definition lives in `./protocol` and is shared with the broker.
+ *
+ * Reconnection is handled centrally here — individual transports do not reconnect.
+ * Use {@link getOrCreate} to obtain a per-URL singleton.
+ */
+declare class MultiplexSocket {
+    /** Per-URL cache so all transports targeting the same tunnel share one socket. */
+    private static readonly _instances;
+    private readonly _wsUrl;
+    private readonly _transports;
+    private _ws;
+    private _reconnectAttempts;
+    private _stopped;
+    private constructor();
+    /** Returns (or creates) the singleton socket for a given tunnel URL. */
+    static getOrCreate(wsUrl: string): MultiplexSocket;
+    get isOpen(): boolean;
+    register(name: string, transport: MultiplexTransport): void;
+    unregister(name: string): void;
+    /**
+     * Claims the slot for `name` so the broker eagerly creates its provider
+     * state before any MCP client connects. Without it the broker only learns
+     * about a provider on its first real message, and a client connecting in
+     * between is told the provider is not connected.
+     */
+    private _announceProvider;
+    send(provider: string, data: string): void;
+    private _connect;
+    private _routeIncoming;
+    private _scheduleReconnect;
+}
+/**
+ * A transport that multiplexes multiple MCP servers over a single shared
+ * WebSocket connection using the envelope protocol `{ provider, payload }`.
+ *
+ * Use the static {@link create} factory to obtain an instance:
+ * ```typescript
+ * const t1 = MultiplexTransport.create("scene-1", "ws://localhost:3000/providers");
+ * const t2 = MultiplexTransport.create("scene-2", "ws://localhost:3000/providers");
+ * // t1 and t2 share a single WebSocket under the hood.
+ * ```
+ */
+export declare class MultiplexTransport implements IMessageTransport {
+    private readonly _name;
+    private readonly _socket;
+    private _registered;
+    onMessage: ((data: string) => void) | null;
+    onOpen: (() => void) | null;
+    onClose: (() => void) | null;
+    onError: ((error: Error) => void) | null;
+    constructor(name: string, socket: MultiplexSocket);
+    /**
+     * Convenience factory: creates a {@link MultiplexTransport} backed by a
+     * shared {@link MultiplexSocket} for the given tunnel URL.
+     *
+     * Transports targeting the same `wsUrl` automatically share one WebSocket.
+     */
+    static create(name: string, wsUrl: string): MultiplexTransport;
+    get isOpen(): boolean;
+    /**
+     * Registers this transport with the shared socket.
+     *
+     * Safe to call multiple times — subsequent calls are no-ops.
+     */
+    activate(): void;
+    /**
+     * Opens the transport, the same way every other transport does.
+     *
+     * An alias of {@link activate} so callers never have to special-case this
+     * class: an MCP server or client just calls `connect()` on whatever
+     * transport it was handed.
+     */
+    connect(): void;
+    send(data: string): void;
+    close(): void;
+}
+export {};