@cyanmycelium/mcp-broker 0.1.0

package/.mcp-broker.example/README.md

@@ -0,0 +1,53 @@
+# `.mcp-broker.example/`
+
+This is a template. Copy it as `.mcp-broker/` next to where you run the
+broker, then adapt to your needs:
+
+```sh
+cp -r .mcp-broker.example .mcp-broker
+```
+
+## Layout
+
+```
+.mcp-broker/
+├── config.json          ← broker configuration (port, locale, TLS, mounts, ...)
+├── certs/               ← TLS material (optional, gitignore this)
+│   ├── cert.pem
+│   └── key.pem
+├── grammars/            ← local grammar overrides (optional)
+│   └── <userAgent>/
+│       └── <locale>.json
+└── www/                 ← static files served at "/" (optional)
+    └── index.html
+```
+
+## Path resolution
+
+Paths inside `config.json` are resolved against the **directory of the
+config file** (i.e. `.mcp-broker/`). So `"certs/cert.pem"` in the config
+points at `.mcp-broker/certs/cert.pem`. The folder is self-contained.
+
+Env vars (`MCP_BROKER_TLS_CERT`, `MCP_BROKER_WWW_DIR`, ...) are still
+resolved against `process.cwd()` — they are the deploy-time override
+mechanism and not tied to the config file's location.
+
+## Grammar overrides
+
+Drop a JSON at `grammars/<userAgent>/<locale>.json` to override individual
+tool/resource/template descriptions for that combination. Entries you don't
+override fall back to the packaged defaults shipped with the broker. See
+[`docs/config.md`](../docs/config.md) for the schema.
+
+## Suggested `.gitignore`
+
+```
+.mcp-broker/certs/
+.mcp-broker/config.json   # if it contains environment-specific values
+```
+
+Or, to gitignore the whole folder:
+
+```
+.mcp-broker/
+```

package/.mcp-broker.example/config.json

@@ -0,0 +1,32 @@
+{
+    "port": 3001,
+    "host": "0.0.0.0",
+    "locale": "fr",
+    "brokerName": "broker-eu-west",
+
+    "paths": {
+        "provider": "/provider",
+        "client":   "/",
+        "mcp":      "/mcp"
+    },
+
+    "tls": {
+        "cert": "certs/cert.pem",
+        "key":  "certs/key.pem"
+    },
+
+    "www": {
+        "open": false,
+        "mounts": [
+            { "urlPrefix": "/", "dir": "www" }
+        ]
+    },
+
+    "stdioUpstreams": [
+        {
+            "name":    "fs",
+            "command": "npx",
+            "args":    ["-y", "@modelcontextprotocol/server-filesystem", "/data"]
+        }
+    ]
+}

package/.mcp-broker.example/grammars/claude/fr.json

@@ -0,0 +1,7 @@
+{
+    "tools": {
+        "broker_info": {
+            "description": "Récupère l'identité du broker comme dans la version packagée, mais avec ton ton perso. (Exemple d'override local.)"
+        }
+    }
+}

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,253 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/pandaGaume/mcp-broker/main/docs/assets/logo.png" alt="mcp-broker" width="160" />
+</p>
+
+[![npm](https://img.shields.io/npm/v/@cyanmycelium/mcp-broker)](https://www.npmjs.com/package/@cyanmycelium/mcp-broker)
+[![CI](https://github.com/pandaGaume/mcp-broker/actions/workflows/ci-node.yml/badge.svg)](https://github.com/pandaGaume/mcp-broker/actions/workflows/ci-node.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+# @cyanmycelium/mcp-broker
+
+WebSocket-based [Model Context Protocol](https://modelcontextprotocol.io/) broker. Aggregates multiple MCP providers behind a single endpoint, with WebSocket, Streamable HTTP, SSE, and stdio client transports.
+
+> This is the Node/TypeScript implementation of the broker. Architecture, wire protocol, and roadmap are documented language-neutrally in [../docs](../docs).
+
+## Install and run
+
+```sh
+# Run the broker without installing
+npx @cyanmycelium/mcp-broker
+
+# Or install globally
+npm install -g @cyanmycelium/mcp-broker
+mcp-broker
+```
+
+The broker starts on `http://localhost:3000` by default.
+
+- Connect your MCP provider to: `ws://localhost:3000/provider/<name>`
+- Point an MCP client at: `http://localhost:3000/<name>/mcp` (Streamable HTTP) or `http://localhost:3000/<name>/sse` (legacy SSE) or `ws://localhost:3000/<name>` (raw WS)
+
+## Configuration
+
+Two sources, env vars **always win** over the file. The file is the static baseline you ship with the broker; env vars are deploy-specific overrides.
+
+### Option A — `.mcp-broker/` folder (recommended)
+
+Drop a `.mcp-broker/` folder next to where you launch the broker. Paths
+inside `config.json` are resolved against this folder, so it stays
+self-contained (certs, www, grammar overrides all next to the config).
+
+```
+your-project/
+└── .mcp-broker/
+    ├── config.json       ← broker configuration
+    ├── certs/            ← TLS material (optional)
+    ├── grammars/         ← local grammar overrides (optional)
+    └── www/              ← static dev harness (optional)
+```
+
+Minimal `config.json`:
+
+```json
+{
+    "port": 3001,
+    "locale": "fr",
+    "tls": {
+        "cert": "certs/cert.pem",
+        "key":  "certs/key.pem"
+    },
+    "www": {
+        "open":   false,
+        "mounts": [{ "urlPrefix": "/", "dir": "www" }]
+    },
+    "stdioUpstreams": [
+        {
+            "name": "fs",
+            "command": "npx",
+            "args":   ["-y", "@modelcontextprotocol/server-filesystem", "/data"]
+        }
+    ]
+}
+```
+
+Start from the [`.mcp-broker.example/`](.mcp-broker.example/) template:
+
+```sh
+cp -r node_modules/@cyanmycelium/mcp-broker/.mcp-broker.example .mcp-broker
+```
+
+Full reference (every field, defaults, recipes, grammar overrides): **[docs/config.md](docs/config.md)**.
+
+### Option B — Environment variables
+
+| Variable | Default | Notes |
+|---|---|---|
+| `MCP_BROKER_CONFIG` | `./.mcp-broker/config.json` | Path to a JSON config file (see above) |
+| `MCP_BROKER_PORT` | `3000` | TCP port to listen on |
+| `MCP_BROKER_HOST` | `0.0.0.0` | Interface to bind |
+| `MCP_BROKER_PROVIDER_PATH` | `/provider` | Prefix for provider WS connections |
+| `MCP_BROKER_CLIENT_PATH` | `/` | Prefix for raw WS clients |
+| `MCP_BROKER_MCP_PATH` | `/mcp` | Suffix for Streamable HTTP |
+| `MCP_BROKER_WWW_DIR` | (unset) | If set, serve this directory at `/` |
+| `MCP_BROKER_BUNDLE_DIR` | (unset) | If set, serve this directory at `/bundle` |
+| `MCP_BROKER_OPEN` | (unset) | `1` to auto-open the browser at the root URL on startup (requires `MCP_BROKER_WWW_DIR`) |
+| `MCP_BROKER_TLS_CERT` | (unset) | Path to a PEM certificate. Enables HTTPS/WSS |
+| `MCP_BROKER_TLS_KEY` | (unset) | Path to a PEM private key. Enables HTTPS/WSS |
+| `MCP_BROKER_PROTOCOL` | auto | `http` forces plain, `https` forces TLS, unset auto-detects from cert+key |
+| `MCP_BROKER_STDIO_PROVIDER` | (unset) | When set, bridge stdin/stdout JSON-RPC to this provider (Claude Desktop integration) |
+
+## Programmatic API
+
+```ts
+import { WsTunnelBuilder } from "@cyanmycelium/mcp-broker";
+
+const broker = new WsTunnelBuilder()
+    .withPort(3000)
+    .withHost("0.0.0.0")
+    .withProviderPath("/provider")
+    .withMcpPath("/mcp")
+    // Optional: bridge a local stdio MCP server as a provider.
+    .withStdioUpstream("my-server", "node", ["./my-server.js"])
+    // Optional: serve a dev harness at /
+    .withStaticMount("/", "/abs/path/to/www")
+    .build();
+
+await broker.start();
+```
+
+All builder methods are documented inline. The full options interface is `WsTunnelOptions`, also exported.
+
+## TLS for local development
+
+```sh
+npm run gen-cert
+# Writes ../certs/cert.pem and ../certs/key.pem (repo root)
+
+$env:MCP_BROKER_TLS_CERT="../certs/cert.pem"
+$env:MCP_BROKER_TLS_KEY="../certs/key.pem"
+npm start
+```
+
+The generated certificate covers `localhost`, `127.0.0.1`, `::1` for 365 days. Browsers will warn about an untrusted issuer on first visit. Click "Advanced → Proceed". MCP clients (Claude, Inspector) ignore certificate validation by default.
+
+## Docker
+
+A multi-stage `Dockerfile` ships with the package: build stage compiles TypeScript and copies grammar JSON, runtime stage carries only the compiled `dist/`, production `node_modules`, and runs as a non-root user.
+
+```sh
+# From the node/ directory
+docker build -t cyanmycelium/mcp-broker:0.1.0 .
+
+# Run on host port 3000
+docker run --rm -p 3000:3000 cyanmycelium/mcp-broker:0.1.0
+
+# With a custom locale and host port
+docker run --rm -p 4000:4000 \
+    -e MCP_BROKER_PORT=4000 \
+    -e MCP_BROKER_LOCALE=fr-CA \
+    cyanmycelium/mcp-broker:0.1.0
+```
+
+### Mounting TLS material
+
+```sh
+# Generate localhost certs on the host first
+npm run gen-cert  # writes ../certs/cert.pem and ../certs/key.pem
+
+docker run --rm -p 3000:3000 \
+    -v "$(pwd)/../certs:/certs:ro" \
+    -e MCP_BROKER_TLS_CERT=/certs/cert.pem \
+    -e MCP_BROKER_TLS_KEY=/certs/key.pem \
+    cyanmycelium/mcp-broker:0.1.0
+```
+
+### Mounting a static dev harness
+
+```sh
+docker run --rm -p 3000:3000 \
+    -v "$(pwd)/public:/www:ro" \
+    -e MCP_BROKER_WWW_DIR=/www \
+    cyanmycelium/mcp-broker:0.1.0
+```
+
+### Health check
+
+The image declares a `HEALTHCHECK` that opens a TCP socket on `MCP_BROKER_PORT`. Orchestrators (Docker Compose, Kubernetes liveness probe) pick it up automatically.
+
+### docker-compose snippet
+
+```yaml
+services:
+  broker:
+    build: .
+    # Or pull a published image once available:
+    # image: ghcr.io/pandagaume/mcp-broker:0.1.0
+    ports:
+      - "3000:3000"
+    environment:
+      MCP_BROKER_PORT: "3000"
+      MCP_BROKER_LOCALE: "en"
+    restart: unless-stopped
+```
+
+## Claude Desktop integration
+
+The broker can act as a stdio MCP server for Claude Desktop, bridging to any provider it manages:
+
+```json
+{
+  "mcpServers": {
+    "broker": {
+      "command": "npx",
+      "args": ["-y", "@cyanmycelium/mcp-broker"],
+      "env": { "MCP_BROKER_STDIO_PROVIDER": "<your-provider-name>" }
+    }
+  }
+}
+```
+
+In this mode all broker logging goes to stderr; stdout is reserved for the JSON-RPC stream Claude expects.
+
+## What the broker does (and does not yet)
+
+| Capability | Status |
+|---|---|
+| One named provider slot, multiple clients | ✅ |
+| Provider transports: WS dedicated, WS multiplexed, stdio upstream | ✅ |
+| Client transports: raw WS, Streamable HTTP (2025-03-26), legacy SSE, stdio bridge | ✅ |
+| TLS via PEM files | ✅ |
+| Static file serving (dev harness) | ✅ |
+| Cross-provider tool aggregation (one client sees all providers' tools at once) | 🚧 v0.4 |
+| Authentication / authorization | 🚧 v0.3 |
+| Multi-tenant isolation | 🚧 v1.0 |
+
+Full roadmap: [../docs/roadmap.md](../docs/roadmap.md).
+
+## Development
+
+```sh
+npm install
+npm run build      # tsc -b
+npm test           # vitest run
+npm run lint
+npm start          # node dist/bin.js
+```
+
+Requires Node 20.11+.
+
+## Releasing
+
+The package is published to npm by [`.github/workflows/release-node.yml`](../.github/workflows/release-node.yml), triggered by tags of the form `node-v*`.
+
+```sh
+# from the node/ directory:
+npm version patch            # creates a "node-v0.1.1" tag (.npmrc sets the prefix)
+git push --follow-tags
+```
+
+The workflow runs lint, build, test, then `npm publish --access public --provenance` and creates a GitHub Release with auto-generated notes.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).

package/dist/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};