@cyanmycelium/mcp-broker 0.4.0 → 1.2.0

package/dist/ws.tunnel.builder.d.ts

@@ -1,139 +0,0 @@
-import { WsTunnel } from "./ws.tunnel.js";
-import type { StdioUpstreamConfig } from "./stdio.upstream.js";
-import type { RemoteUpstreamConfig } from "./remote.upstream.js";
-/**
- * Fluent builder that constructs a configured {@link WsTunnel}.
- *
- * @example
- * ```typescript
- * const tunnel = new WsTunnelBuilder()
- *     .withPort(3000)
- *     .withHost("localhost")
- *     .withStaticMount("/", "/abs/path/to/www")
- *     .build();
- *
- * await tunnel.start();
- * console.log("Broker listening on ws://localhost:3000");
- * console.log("  Provider connects to: ws://localhost:3000/provider/<name>");
- * console.log("  Clients  connect to:  ws://localhost:3000/<name>");
- * ```
- */
-export declare class WsTunnelBuilder {
-    private _port;
-    private _host;
-    private _providerPath;
-    private _providersPath;
-    private _clientPath;
-    private _ssePath;
-    private _messagesPath;
-    private _mcpPath;
-    private _samplesIndexPath;
-    private _staticMounts;
-    private _stdioUpstreams;
-    private _remoteUpstreams;
-    private _stdioClient;
-    private _tls;
-    private _brokerLocalGrammarsDir;
-    /** Sets the TCP port the broker listens on. */
-    withPort(port: number): this;
-    /**
-     * Sets the host/interface to bind to.
-     * @default "0.0.0.0" (all interfaces)
-     */
-    withHost(host: string): this;
-    /**
-     * Sets the URL path the MCP provider connects to.
-     * @default "/provider"
-     */
-    withProviderPath(path: string): this;
-    /**
-     * Sets the URL path for multiplexed provider connections.
-     * Multiple providers share a single WebSocket using the envelope protocol.
-     * @default "/providers"
-     */
-    withProvidersPath(path: string): this;
-    /**
-     * Sets the URL path MCP clients connect to.
-     * @default "/"
-     */
-    withClientPath(path: string): this;
-    /**
-     * Sets the URL path for the SSE stream (legacy Claude transport, GET).
-     * @default "/sse"
-     */
-    withSsePath(path: string): this;
-    /**
-     * Sets the URL path for JSON-RPC POST requests (legacy Claude transport).
-     * @default "/messages"
-     */
-    withMessagesPath(path: string): this;
-    /**
-     * Sets the URL path for the Streamable HTTP transport (MCP 2025-03-26).
-     * MCP Inspector and other 2025+ clients POST JSON-RPC here.
-     * @default "/mcp"
-     */
-    withMcpPath(path: string): this;
-    /**
-     * Sets the URL path that returns a `{ files: string[] }` listing of the
-     * `samples/` subdirectory under the root static mount.
-     * @default "/__samples_index__"
-     */
-    withSamplesIndexPath(path: string): this;
-    /**
-     * Adds a static-file mount served over plain HTTP.
-     * Can be called multiple times; longest-prefix match wins at runtime.
-     *
-     * @param urlPrefix  URL prefix that triggers this mount (e.g. `"/"` or `"/bundle"`).
-     * @param dir        Absolute path to the directory to serve.
-     */
-    withStaticMount(urlPrefix: string, dir: string): this;
-    /**
-     * Registers a stdio upstream provider. The broker spawns the configured
-     * command and bridges its stdin/stdout as an MCP transport. Clients reach
-     * it using `config.name` directly (e.g. `/<name>/mcp`).
-     *
-     * Can be called multiple times to register multiple providers.
-     */
-    withStdioUpstream(config: StdioUpstreamConfig): this;
-    /**
-     * Registers a remote MCP server reached by URL. The broker connects out to
-     * it and exposes it as a provider slot named `config.name`, bridging the
-     * Streamable HTTP / SSE / WebSocket transport for the slot's clients.
-     *
-     * Can be called multiple times to register multiple servers.
-     */
-    withRemoteUpstream(config: RemoteUpstreamConfig): this;
-    /**
-     * Enables the stdio client transport. The broker will read JSON-RPC from
-     * `process.stdin` and write responses to `process.stdout`, bridging Claude
-     * Desktop (or any stdio MCP client) to the named provider.
-     *
-     * All console output is automatically redirected to stderr in this mode so
-     * stdout stays clean for the JSON-RPC stream.
-     *
-     * @param providerName  The provider the stdio client maps to.
-     */
-    withStdioClient(providerName: string): this;
-    /**
-     * Enables HTTPS/WSS mode by supplying PEM-encoded certificate and key strings directly.
-     * Call this when you already have the PEM content in memory.
-     */
-    withTls(cert: string, key: string): this;
-    /**
-     * Enables HTTPS/WSS mode by reading the certificate and key from the given file paths.
-     * Files are read synchronously at call time.
-     *
-     * @param certPath  Path to the PEM certificate file (e.g. `fullchain.pem`).
-     * @param keyPath   Path to the PEM private-key file (e.g. `privkey.pem`).
-     */
-    withTlsFiles(certPath: string, keyPath: string): this;
-    /**
-     * Sets the path to a user-supplied grammars directory whose
-     * `<userAgent>/<locale>.json` files are merged on top of the packaged
-     * grammars used by the embedded broker server (the reserved `_broker`
-     * provider slot). Typically pointed at `.mcp-broker/grammars/`.
-     */
-    withBrokerLocalGrammarsDir(dir: string): this;
-    /** Constructs and returns a configured {@link WsTunnel}. */
-    build(): WsTunnel;
-}

package/dist/ws.tunnel.builder.js

@@ -1,205 +0,0 @@
-import * as fs from "fs";
-import { WsTunnel } from "./ws.tunnel.js";
-/**
- * Fluent builder that constructs a configured {@link WsTunnel}.
- *
- * @example
- * ```typescript
- * const tunnel = new WsTunnelBuilder()
- *     .withPort(3000)
- *     .withHost("localhost")
- *     .withStaticMount("/", "/abs/path/to/www")
- *     .build();
- *
- * await tunnel.start();
- * console.log("Broker listening on ws://localhost:3000");
- * console.log("  Provider connects to: ws://localhost:3000/provider/<name>");
- * console.log("  Clients  connect to:  ws://localhost:3000/<name>");
- * ```
- */
-export class WsTunnelBuilder {
-    _port = 3000;
-    _host;
-    _providerPath = "/provider";
-    _providersPath = "/providers";
-    _clientPath = "/";
-    _ssePath = "/sse";
-    _messagesPath = "/messages";
-    _mcpPath = "/mcp";
-    _samplesIndexPath = "/__samples_index__";
-    _staticMounts = [];
-    _stdioUpstreams = [];
-    _remoteUpstreams = [];
-    _stdioClient = undefined;
-    _tls = undefined;
-    _brokerLocalGrammarsDir = undefined;
-    /** Sets the TCP port the broker listens on. */
-    withPort(port) {
-        this._port = port;
-        return this;
-    }
-    /**
-     * Sets the host/interface to bind to.
-     * @default "0.0.0.0" (all interfaces)
-     */
-    withHost(host) {
-        this._host = host;
-        return this;
-    }
-    /**
-     * Sets the URL path the MCP provider connects to.
-     * @default "/provider"
-     */
-    withProviderPath(path) {
-        this._providerPath = path;
-        return this;
-    }
-    /**
-     * Sets the URL path for multiplexed provider connections.
-     * Multiple providers share a single WebSocket using the envelope protocol.
-     * @default "/providers"
-     */
-    withProvidersPath(path) {
-        this._providersPath = path;
-        return this;
-    }
-    /**
-     * Sets the URL path MCP clients connect to.
-     * @default "/"
-     */
-    withClientPath(path) {
-        this._clientPath = path;
-        return this;
-    }
-    /**
-     * Sets the URL path for the SSE stream (legacy Claude transport, GET).
-     * @default "/sse"
-     */
-    withSsePath(path) {
-        this._ssePath = path;
-        return this;
-    }
-    /**
-     * Sets the URL path for JSON-RPC POST requests (legacy Claude transport).
-     * @default "/messages"
-     */
-    withMessagesPath(path) {
-        this._messagesPath = path;
-        return this;
-    }
-    /**
-     * Sets the URL path for the Streamable HTTP transport (MCP 2025-03-26).
-     * MCP Inspector and other 2025+ clients POST JSON-RPC here.
-     * @default "/mcp"
-     */
-    withMcpPath(path) {
-        this._mcpPath = path;
-        return this;
-    }
-    /**
-     * Sets the URL path that returns a `{ files: string[] }` listing of the
-     * `samples/` subdirectory under the root static mount.
-     * @default "/__samples_index__"
-     */
-    withSamplesIndexPath(path) {
-        this._samplesIndexPath = path;
-        return this;
-    }
-    /**
-     * Adds a static-file mount served over plain HTTP.
-     * Can be called multiple times; longest-prefix match wins at runtime.
-     *
-     * @param urlPrefix  URL prefix that triggers this mount (e.g. `"/"` or `"/bundle"`).
-     * @param dir        Absolute path to the directory to serve.
-     */
-    withStaticMount(urlPrefix, dir) {
-        this._staticMounts.push({ urlPrefix, dir });
-        return this;
-    }
-    /**
-     * Registers a stdio upstream provider. The broker spawns the configured
-     * command and bridges its stdin/stdout as an MCP transport. Clients reach
-     * it using `config.name` directly (e.g. `/<name>/mcp`).
-     *
-     * Can be called multiple times to register multiple providers.
-     */
-    withStdioUpstream(config) {
-        this._stdioUpstreams.push(config);
-        return this;
-    }
-    /**
-     * Registers a remote MCP server reached by URL. The broker connects out to
-     * it and exposes it as a provider slot named `config.name`, bridging the
-     * Streamable HTTP / SSE / WebSocket transport for the slot's clients.
-     *
-     * Can be called multiple times to register multiple servers.
-     */
-    withRemoteUpstream(config) {
-        this._remoteUpstreams.push(config);
-        return this;
-    }
-    /**
-     * Enables the stdio client transport. The broker will read JSON-RPC from
-     * `process.stdin` and write responses to `process.stdout`, bridging Claude
-     * Desktop (or any stdio MCP client) to the named provider.
-     *
-     * All console output is automatically redirected to stderr in this mode so
-     * stdout stays clean for the JSON-RPC stream.
-     *
-     * @param providerName  The provider the stdio client maps to.
-     */
-    withStdioClient(providerName) {
-        this._stdioClient = { providerName };
-        return this;
-    }
-    /**
-     * Enables HTTPS/WSS mode by supplying PEM-encoded certificate and key strings directly.
-     * Call this when you already have the PEM content in memory.
-     */
-    withTls(cert, key) {
-        this._tls = { cert, key };
-        return this;
-    }
-    /**
-     * Enables HTTPS/WSS mode by reading the certificate and key from the given file paths.
-     * Files are read synchronously at call time.
-     *
-     * @param certPath  Path to the PEM certificate file (e.g. `fullchain.pem`).
-     * @param keyPath   Path to the PEM private-key file (e.g. `privkey.pem`).
-     */
-    withTlsFiles(certPath, keyPath) {
-        return this.withTls(fs.readFileSync(certPath, "utf8"), fs.readFileSync(keyPath, "utf8"));
-    }
-    /**
-     * Sets the path to a user-supplied grammars directory whose
-     * `<userAgent>/<locale>.json` files are merged on top of the packaged
-     * grammars used by the embedded broker server (the reserved `_broker`
-     * provider slot). Typically pointed at `.mcp-broker/grammars/`.
-     */
-    withBrokerLocalGrammarsDir(dir) {
-        this._brokerLocalGrammarsDir = dir;
-        return this;
-    }
-    /** Constructs and returns a configured {@link WsTunnel}. */
-    build() {
-        const options = {
-            port: this._port,
-            host: this._host,
-            providerPath: this._providerPath,
-            providersPath: this._providersPath,
-            clientPath: this._clientPath,
-            ssePath: this._ssePath,
-            messagesPath: this._messagesPath,
-            mcpPath: this._mcpPath,
-            samplesIndexPath: this._samplesIndexPath,
-            staticMounts: this._staticMounts.length > 0 ? [...this._staticMounts] : undefined,
-            stdioUpstreams: this._stdioUpstreams.length > 0 ? [...this._stdioUpstreams] : undefined,
-            remoteUpstreams: this._remoteUpstreams.length > 0 ? [...this._remoteUpstreams] : undefined,
-            stdioClient: this._stdioClient,
-            tls: this._tls,
-            brokerLocalGrammarsDir: this._brokerLocalGrammarsDir,
-        };
-        return new WsTunnel(options);
-    }
-}
-//# sourceMappingURL=ws.tunnel.builder.js.map

package/dist/ws.tunnel.builder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ws.tunnel.builder.js","sourceRoot":"","sources":["../src/ws.tunnel.builder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,QAAQ,EAA0C,MAAM,gBAAgB,CAAC;AAIlF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,OAAO,eAAe;IAChB,KAAK,GAAG,IAAI,CAAC;IACb,KAAK,CAAqB;IAC1B,aAAa,GAAG,WAAW,CAAC;IAC5B,cAAc,GAAG,YAAY,CAAC;IAC9B,WAAW,GAAG,GAAG,CAAC;IAClB,QAAQ,GAAG,MAAM,CAAC;IAClB,aAAa,GAAG,WAAW,CAAC;IAC5B,QAAQ,GAAG,MAAM,CAAC;IAClB,iBAAiB,GAAG,oBAAoB,CAAC;IACzC,aAAa,GAAkB,EAAE,CAAC;IAClC,eAAe,GAA0B,EAAE,CAAC;IAC5C,gBAAgB,GAA2B,EAAE,CAAC;IAC9C,YAAY,GAAyC,SAAS,CAAC;IAC/D,IAAI,GAA8C,SAAS,CAAC;IAC5D,uBAAuB,GAAuB,SAAS,CAAC;IAEhE,+CAA+C;IAC/C,QAAQ,CAAC,IAAY;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAY;QACjB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,IAAY;QACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,IAAY;QAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,IAAY;QACvB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QACxB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,WAAW,CAAC,IAAY;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,gBAAgB,CAAC,IAAY;QACzB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,IAAY;QACpB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,IAAY;QAC7B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CAAC,SAAiB,EAAE,GAAW;QAC1C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC;QAC5C,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,iBAAiB,CAAC,MAA2B;QACzC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAAC,MAA4B;QAC3C,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,eAAe,CAAC,YAAoB;QAChC,IAAI,CAAC,YAAY,GAAG,EAAE,YAAY,EAAE,CAAC;QACrC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;OAGG;IACH,OAAO,CAAC,IAAY,EAAE,GAAW;QAC7B,IAAI,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,QAAgB,EAAE,OAAe;QAC1C,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAC7F,CAAC;IAED;;;;;OAKG;IACH,0BAA0B,CAAC,GAAW;QAClC,IAAI,CAAC,uBAAuB,GAAG,GAAG,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,4DAA4D;IAC5D,KAAK;QACD,MAAM,OAAO,GAAoB;YAC7B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,UAAU,EAAE,IAAI,CAAC,WAAW;YAC5B,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,YAAY,EAAE,IAAI,CAAC,aAAa;YAChC,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;YACxC,YAAY,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;YACjF,cAAc,EAAE,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,SAAS;YACvF,eAAe,EAAE,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS;YAC1F,WAAW,EAAE,IAAI,CAAC,YAAY;YAC9B,GAAG,EAAE,IAAI,CAAC,IAAI;YACd,sBAAsB,EAAE,IAAI,CAAC,uBAAuB;SACvD,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;CACJ"}