@oimdb/mcp 1.2.0 → 3.0.0

package/dist/index.d.cts

@@ -1,79 +1,27 @@
-/**
- * The readable shape the MCP tools need from a registry — `OIMDevRegistry` from
- * `@oimdb/devtools` already satisfies it. Declared structurally (following the
- * existing `IOIMDev*Like` convention) so `@oimdb/mcp` need not depend on
- * `@oimdb/devtools`; it is not a separate registry implementation.
- */
-interface IOIMDevRegistryLike {
-    inspect(): unknown;
-    dumpString(): string;
-}
+import { IOIMDevRegistry } from '@oimdb/cli';
+
 type TOIMDevMcpOptions = {
-    /** Port for the WebSocket bridge that browser tabs connect to. Default: 7432 */
+    /** Default 7432; unused when `registry` is given — no bridge is started. */
     wsPort?: number;
-    /**
-     * An in-process registry to read directly (your `OIMDevRegistry`). When
-     * provided, the tools answer from it without a browser/WebSocket bridge
-     * (no `wsPort` server started).
-     */
-    registry?: IOIMDevRegistryLike;
-    /**
-     * Path to a module that builds the model in this process for offline
-     * introspection. The module must export a `registry` (or a default export,
-     * or a zero-arg factory) exposing `inspect()` and `dumpString()`.
-     * Also settable via the `OIMDB_MODEL_MODULE` env var for the CLI.
-     */
+    registry?: IOIMDevRegistry;
+    /** Must export `oimDevRegistry`, a default, or a zero-arg factory. Env: `OIMDB_MODEL_MODULE`. */
     modelModulePath?: string;
+    /** LOOPBACK BY DEFAULT: a `WebSocketServer` built without a host binds everything. */
+    host?: string;
+    /** On top of the loopback origins. Exact, never `'*'`. */
+    allowedOrigins?: readonly string[];
 };
 
 declare class OIMDevMcpServer {
     private readonly mcpServer;
-    private readonly wsPort;
-    private wss;
-    private latestBrowser;
-    private readonly pending;
-    private inProcessRegistry;
-    private readonly modelModulePath?;
-    private modelModuleLoaded;
+    private readonly devBridge;
+    private readonly devModuleStateSource;
+    private readonly devStateReader;
     constructor(options?: TOIMDevMcpOptions);
-    /**
-     * Resolves the in-process registry, loading the model module on first use.
-     * Returns null when no in-process source is configured (browser-bridge mode).
-     */
-    private getInProcessRegistry;
-    /** Reads the inspect snapshot from the in-process model or the browser. */
-    private readInspect;
-    /** Reads the human-readable dump from the in-process model or the browser. */
-    private readDump;
     private registerTools;
-    private queryBrowser;
-    private setupWebSocketServer;
     start(): Promise<void>;
 }
 
-type TOIMDevUIServerOptions = {
-    wsPort?: number;
-    uiPort?: number;
-    uiDir: string;
-    open?: boolean;
-};
-declare class OIMDevUIServer {
-    private readonly wsPort;
-    private readonly uiPort;
-    private readonly uiDir;
-    private readonly shouldOpen;
-    private wss;
-    private latestBrowser;
-    private readonly pending;
-    constructor(options: TOIMDevUIServerOptions);
-    private queryBrowser;
-    private setupBridge;
-    private setupHTTP;
-    private openURL;
-    start(): void;
-}
-
 declare function createOIMDevMcpServer(options?: TOIMDevMcpOptions): OIMDevMcpServer;
-declare function createOIMDevUIServer(options: TOIMDevUIServerOptions): OIMDevUIServer;
 
-export { type IOIMDevRegistryLike, OIMDevMcpServer, OIMDevUIServer, type TOIMDevMcpOptions, type TOIMDevUIServerOptions, createOIMDevMcpServer, createOIMDevUIServer };
+export { OIMDevMcpServer, type TOIMDevMcpOptions, createOIMDevMcpServer };

package/dist/index.d.ts

@@ -1,79 +1,27 @@
-/**
- * The readable shape the MCP tools need from a registry — `OIMDevRegistry` from
- * `@oimdb/devtools` already satisfies it. Declared structurally (following the
- * existing `IOIMDev*Like` convention) so `@oimdb/mcp` need not depend on
- * `@oimdb/devtools`; it is not a separate registry implementation.
- */
-interface IOIMDevRegistryLike {
-    inspect(): unknown;
-    dumpString(): string;
-}
+import { IOIMDevRegistry } from '@oimdb/cli';
+
 type TOIMDevMcpOptions = {
-    /** Port for the WebSocket bridge that browser tabs connect to. Default: 7432 */
+    /** Default 7432; unused when `registry` is given — no bridge is started. */
     wsPort?: number;
-    /**
-     * An in-process registry to read directly (your `OIMDevRegistry`). When
-     * provided, the tools answer from it without a browser/WebSocket bridge
-     * (no `wsPort` server started).
-     */
-    registry?: IOIMDevRegistryLike;
-    /**
-     * Path to a module that builds the model in this process for offline
-     * introspection. The module must export a `registry` (or a default export,
-     * or a zero-arg factory) exposing `inspect()` and `dumpString()`.
-     * Also settable via the `OIMDB_MODEL_MODULE` env var for the CLI.
-     */
+    registry?: IOIMDevRegistry;
+    /** Must export `oimDevRegistry`, a default, or a zero-arg factory. Env: `OIMDB_MODEL_MODULE`. */
     modelModulePath?: string;
+    /** LOOPBACK BY DEFAULT: a `WebSocketServer` built without a host binds everything. */
+    host?: string;
+    /** On top of the loopback origins. Exact, never `'*'`. */
+    allowedOrigins?: readonly string[];
 };
 
 declare class OIMDevMcpServer {
     private readonly mcpServer;
-    private readonly wsPort;
-    private wss;
-    private latestBrowser;
-    private readonly pending;
-    private inProcessRegistry;
-    private readonly modelModulePath?;
-    private modelModuleLoaded;
+    private readonly devBridge;
+    private readonly devModuleStateSource;
+    private readonly devStateReader;
     constructor(options?: TOIMDevMcpOptions);
-    /**
-     * Resolves the in-process registry, loading the model module on first use.
-     * Returns null when no in-process source is configured (browser-bridge mode).
-     */
-    private getInProcessRegistry;
-    /** Reads the inspect snapshot from the in-process model or the browser. */
-    private readInspect;
-    /** Reads the human-readable dump from the in-process model or the browser. */
-    private readDump;
     private registerTools;
-    private queryBrowser;
-    private setupWebSocketServer;
     start(): Promise<void>;
 }
 
-type TOIMDevUIServerOptions = {
-    wsPort?: number;
-    uiPort?: number;
-    uiDir: string;
-    open?: boolean;
-};
-declare class OIMDevUIServer {
-    private readonly wsPort;
-    private readonly uiPort;
-    private readonly uiDir;
-    private readonly shouldOpen;
-    private wss;
-    private latestBrowser;
-    private readonly pending;
-    constructor(options: TOIMDevUIServerOptions);
-    private queryBrowser;
-    private setupBridge;
-    private setupHTTP;
-    private openURL;
-    start(): void;
-}
-
 declare function createOIMDevMcpServer(options?: TOIMDevMcpOptions): OIMDevMcpServer;
-declare function createOIMDevUIServer(options: TOIMDevUIServerOptions): OIMDevUIServer;
 
-export { type IOIMDevRegistryLike, OIMDevMcpServer, OIMDevUIServer, type TOIMDevMcpOptions, type TOIMDevUIServerOptions, createOIMDevMcpServer, createOIMDevUIServer };
+export { OIMDevMcpServer, type TOIMDevMcpOptions, createOIMDevMcpServer };

package/dist/index.js

@@ -1,33 +1,35 @@
 // src/core/OIMDevMcpServer.ts
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { WebSocketServer } from "ws";
-import { pathToFileURL } from "url";
-import { resolve as resolvePath } from "path";
 import { z } from "zod";
-async function loadRegistryFromModule(path) {
-  const url = pathToFileURL(resolvePath(path)).href;
-  const mod = await import(url);
-  let candidate = mod.registry ?? mod.default ?? mod;
-  if (typeof candidate === "function") {
-    candidate = await candidate();
-  }
-  if (!candidate || typeof candidate.inspect !== "function" || typeof candidate.dumpString !== "function") {
-    throw new Error(
-      `[OIMDB MCP] Module "${path}" must export a registry exposing inspect() and dumpString() (as a "registry" or default export, or a zero-arg factory returning one).`
-    );
-  }
-  return candidate;
-}
+import {
+  OIMDevBridge,
+  OIMDevBridgeStateSource,
+  OIMDevModuleStateSource,
+  OIMDevRegistryStateSource,
+  OIMDevStateReader
+} from "@oimdb/cli";
 var OIMDevMcpServer = class {
   constructor(options = {}) {
-    this.wss = null;
-    this.latestBrowser = null;
-    this.pending = /* @__PURE__ */ new Map();
-    this.modelModuleLoaded = false;
-    this.wsPort = options.wsPort ?? 7432;
-    this.inProcessRegistry = options.registry ?? null;
-    this.modelModulePath = options.modelModulePath;
+    const wsPort = options.wsPort ?? 7432;
+    let devStateSource;
+    if (options.registry !== void 0) {
+      devStateSource = new OIMDevRegistryStateSource(options.registry);
+    } else if (options.modelModulePath !== void 0) {
+      this.devModuleStateSource = new OIMDevModuleStateSource(options.modelModulePath);
+      devStateSource = this.devModuleStateSource;
+    } else {
+      this.devBridge = new OIMDevBridge({
+        wsPort,
+        host: options.host ?? "127.0.0.1",
+        allowedOrigins: new Set(options.allowedOrigins ?? []),
+        logPrefix: "[OIMDB MCP]",
+        portInUseHint: "npx @oimdb/mcp",
+        requestTimeoutMessage: "Browser response timeout (5s). Is the page active?"
+      });
+      devStateSource = new OIMDevBridgeStateSource(this.devBridge, wsPort);
+    }
+    this.devStateReader = new OIMDevStateReader(devStateSource);
     this.mcpServer = new McpServer(
       { name: "oimdb", version: "1.0.0" },
       {
@@ -36,292 +38,30 @@ var OIMDevMcpServer = class {
     );
     this.registerTools();
   }
-  /**
-   * Resolves the in-process registry, loading the model module on first use.
-   * Returns null when no in-process source is configured (browser-bridge mode).
-   */
-  async getInProcessRegistry() {
-    if (this.inProcessRegistry) return this.inProcessRegistry;
-    if (this.modelModulePath && !this.modelModuleLoaded) {
-      this.modelModuleLoaded = true;
-      this.inProcessRegistry = await loadRegistryFromModule(
-        this.modelModulePath
-      );
-    }
-    return this.inProcessRegistry;
-  }
-  /** Reads the inspect snapshot from the in-process model or the browser. */
-  async readInspect() {
-    const registry = await this.getInProcessRegistry();
-    if (registry) return registry.inspect();
-    return this.queryBrowser("inspect");
-  }
-  /** Reads the human-readable dump from the in-process model or the browser. */
-  async readDump() {
-    const registry = await this.getInProcessRegistry();
-    if (registry) return registry.dumpString();
-    return await this.queryBrowser("dump");
-  }
   registerTools() {
     const server = this.mcpServer;
     const nameSchema = { name: z.string().describe("Registered name") };
+    const asText = (text) => ({ content: [{ type: "text", text }] });
     server.registerTool("oimdb_inspect", {
       description: "Get full state of all registered OIMDB collections and computeds. Returns structured JSON with entity counts, field names, index keys, relations, and computed statuses. Source is the connected browser tab, or an in-process model when one is configured (offline/static \u2014 field names appear only if the model holds sample entities)."
-    }, async () => {
-      const data = await this.readInspect();
-      return { content: [{ type: "text", text: JSON.stringify(data, null, 2) }] };
-    });
+    }, async () => asText(await this.devStateReader.readInspectText()));
     server.registerTool("oimdb_dump", {
-      description: "Get a human-readable text summary of OIMDB state. Same output as registry.dump(). Reads the connected browser tab or an in-process model when configured."
-    }, async () => {
-      const text = await this.readDump();
-      return { content: [{ type: "text", text }] };
-    });
+      description: "Get a human-readable text summary of OIMDB state. Same output as oimDevRegistry.dump(). Reads the connected browser tab or an in-process model when configured."
+    }, async () => asText(await this.devStateReader.readDumpText()));
     server.registerTool("oimdb_collection", {
       description: "Get details of a specific registered collection: entity count, field names, index keys, and relations.",
       inputSchema: nameSchema
-    }, async ({ name }) => {
-      const data = await this.readInspect();
-      const info = data.collections[name];
-      if (!info) {
-        const available = Object.keys(data.collections).join(", ") || "(none registered)";
-        return { content: [{ type: "text", text: `Collection '${name}' not found. Registered: ${available}` }] };
-      }
-      return { content: [{ type: "text", text: JSON.stringify(info, null, 2) }] };
-    });
+    }, async ({ name }) => asText(await this.devStateReader.readCollectionText(name)));
     server.registerTool("oimdb_computed", {
       description: "Get status and resolved dependency names of a specific registered computed value. Shows fresh/stale/pending status, current value, and which registered sources it depends on.",
       inputSchema: nameSchema
-    }, async ({ name }) => {
-      const data = await this.readInspect();
-      const info = data.computeds[name];
-      if (!info) {
-        const available = Object.keys(data.computeds).join(", ") || "(none registered)";
-        return { content: [{ type: "text", text: `Computed '${name}' not found. Registered: ${available}` }] };
-      }
-      return { content: [{ type: "text", text: JSON.stringify(info, null, 2) }] };
-    });
-  }
-  async queryBrowser(action) {
-    if (!this.latestBrowser) {
-      throw new Error(
-        `No browser tab connected to the OIMDB MCP bridge.
-
-Live mode \u2014 add to your debug entry point:
-  import { registry } from '@oimdb/devtools';
-  registry.connect(); // connects to ws://localhost:${this.wsPort}
-Then reload the page.
-
-Offline mode \u2014 point the server at a model module instead:
-  OIMDB_MODEL_MODULE=./path/to/model.js npx @oimdb/mcp
-(the module exports a "registry" with inspect()/dumpString()).`
-      );
-    }
-    return new Promise((resolve, reject) => {
-      const id = Math.random().toString(36).slice(2);
-      const timer = setTimeout(() => {
-        this.pending.delete(id);
-        reject(new Error("Browser response timeout (5s). Is the page active?"));
-      }, 5e3);
-      this.pending.set(id, { resolve, reject, timer });
-      this.latestBrowser.ws.send(JSON.stringify({ type: "request", id, action }));
-    });
-  }
-  setupWebSocketServer() {
-    this.wss = new WebSocketServer({ port: this.wsPort });
-    this.wss.on("error", (err) => {
-      if (err.code === "EADDRINUSE") {
-        process.stderr.write(
-          `[OIMDB MCP] Port ${this.wsPort} is already in use.
-Set a different port: OIMDB_WS_PORT=7433 npx @oimdb/mcp
-`
-        );
-        process.exit(1);
-      }
-      process.stderr.write(`[OIMDB MCP] WebSocket server error: ${err.message}
-`);
-      process.exit(1);
-    });
-    this.wss.on("connection", (ws) => {
-      ws.on("message", (raw) => {
-        const msg = JSON.parse(raw.toString());
-        if (msg.type === "hello") {
-          this.latestBrowser = { ws, url: msg.url, title: msg.title };
-          process.stderr.write(`[OIMDB MCP] Browser connected: ${msg.title} (${msg.url})
-`);
-          return;
-        }
-        if (msg.type === "response") {
-          const pending = this.pending.get(msg.id);
-          if (!pending) return;
-          this.pending.delete(msg.id);
-          clearTimeout(pending.timer);
-          if (msg.error) {
-            pending.reject(new Error(msg.error));
-          } else {
-            pending.resolve(msg.data);
-          }
-        }
-      });
-      ws.on("close", () => {
-        if (this.latestBrowser?.ws === ws) {
-          this.latestBrowser = null;
-          process.stderr.write("[OIMDB MCP] Browser disconnected\n");
-        }
-      });
-    });
-    process.stderr.write(`[OIMDB MCP] Bridge ready on ws://localhost:${this.wsPort}
-`);
+    }, async ({ name }) => asText(await this.devStateReader.readComputedText(name)));
   }
   async start() {
-    const registry = await this.getInProcessRegistry();
-    if (registry) {
-      process.stderr.write(
-        "[OIMDB MCP] In-process model loaded \u2014 serving offline (no browser bridge).\n"
-      );
-    } else {
-      this.setupWebSocketServer();
-    }
-    const transport = new StdioServerTransport();
-    await this.mcpServer.connect(transport);
-  }
-};
-
-// src/core/OIMDevUIServer.ts
-import { createServer } from "http";
-import { readFileSync } from "fs";
-import { join, extname } from "path";
-import { exec } from "child_process";
-import { WebSocketServer as WebSocketServer2 } from "ws";
-var MIME = {
-  ".html": "text/html; charset=utf-8",
-  ".js": "text/javascript; charset=utf-8",
-  ".css": "text/css; charset=utf-8"
-};
-var OIMDevUIServer = class {
-  constructor(options) {
-    this.wss = null;
-    this.latestBrowser = null;
-    this.pending = /* @__PURE__ */ new Map();
-    this.wsPort = options.wsPort ?? 7432;
-    this.uiPort = options.uiPort ?? 7433;
-    this.uiDir = options.uiDir;
-    this.shouldOpen = options.open ?? true;
-  }
-  async queryBrowser(action) {
-    if (!this.latestBrowser) return null;
-    return new Promise((resolve, reject) => {
-      const id = Math.random().toString(36).slice(2);
-      const timer = setTimeout(() => {
-        this.pending.delete(id);
-        reject(new Error("timeout"));
-      }, 5e3);
-      this.pending.set(id, { resolve, reject, timer });
-      this.latestBrowser.ws.send(JSON.stringify({ type: "request", id, action }));
-    });
-  }
-  setupBridge() {
-    this.wss = new WebSocketServer2({ port: this.wsPort });
-    this.wss.on("error", (err) => {
-      if (err.code === "EADDRINUSE") {
-        process.stderr.write(
-          `[OIMDB DevTools] Port ${this.wsPort} is already in use.
-Set a different port: OIMDB_WS_PORT=7433 npx @oimdb/mcp devtools
-`
-        );
-        process.exit(1);
-      }
-      process.stderr.write(`[OIMDB DevTools] Bridge error: ${err.message}
-`);
-      process.exit(1);
-    });
-    this.wss.on("connection", (ws) => {
-      ws.on("message", (raw) => {
-        const msg = JSON.parse(raw.toString());
-        if (msg.type === "hello") {
-          this.latestBrowser = { ws, url: msg.url, title: msg.title };
-          process.stderr.write(`[OIMDB DevTools] Browser connected: ${msg.title} (${msg.url})
-`);
-          return;
-        }
-        if (msg.type === "response") {
-          const req = this.pending.get(msg.id);
-          if (!req) return;
-          this.pending.delete(msg.id);
-          clearTimeout(req.timer);
-          if (msg.error) req.reject(new Error(msg.error));
-          else req.resolve(msg.data);
-        }
-      });
-      ws.on("close", () => {
-        if (this.latestBrowser?.ws === ws) {
-          this.latestBrowser = null;
-          process.stderr.write("[OIMDB DevTools] Browser disconnected\n");
-        }
-      });
-    });
-    process.stderr.write(`[OIMDB DevTools] Bridge on ws://localhost:${this.wsPort}
-`);
-  }
-  setupHTTP() {
-    const server = createServer((req, res) => {
-      const url = req.url ?? "/";
-      res.setHeader("Access-Control-Allow-Origin", "*");
-      if (url === "/api/inspect") {
-        this.queryBrowser("inspect").then((data) => {
-          res.writeHead(200, { "Content-Type": "application/json" });
-          res.end(JSON.stringify({
-            connected: !!this.latestBrowser,
-            tab: this.latestBrowser ? { url: this.latestBrowser.url, title: this.latestBrowser.title } : null,
-            data
-          }));
-        }).catch(() => {
-          res.writeHead(200, { "Content-Type": "application/json" });
-          res.end(JSON.stringify({ connected: false, tab: null, data: null }));
-        });
-        return;
-      }
-      const filePath = join(this.uiDir, url === "/" ? "index.html" : url);
-      try {
-        const content = readFileSync(filePath);
-        res.writeHead(200, { "Content-Type": MIME[extname(filePath)] ?? "text/plain" });
-        res.end(content);
-      } catch {
-        res.writeHead(404);
-        res.end("Not found");
-      }
-    });
-    server.on("error", (err) => {
-      if (err.code === "EADDRINUSE") {
-        process.stderr.write(
-          `[OIMDB DevTools] UI port ${this.uiPort} is already in use.
-Set a different port: OIMDB_UI_PORT=7434 npx @oimdb/mcp devtools
-`
-        );
-        process.exit(1);
-      }
-    });
-    server.listen(this.uiPort, () => {
-      const uiUrl = `http://localhost:${this.uiPort}`;
-      process.stderr.write(`[OIMDB DevTools] UI ready \u2192 ${uiUrl}
-`);
-      if (this.shouldOpen) this.openURL(uiUrl);
-    });
-  }
-  openURL(url) {
-    const cmd = process.platform === "win32" ? `start "" "${url}"` : process.platform === "darwin" ? `open "${url}"` : `xdg-open "${url}"`;
-    exec(cmd, (err) => {
-      if (err) process.stderr.write(`[OIMDB DevTools] Could not open browser: ${err.message}
-`);
-    });
-  }
-  start() {
-    this.setupBridge();
-    this.setupHTTP();
-    process.stderr.write(
-      `[OIMDB DevTools] Add to debug.ts: registry.connect();
-`
-    );
+    if (this.devModuleStateSource !== void 0) await this.devModuleStateSource.loadDevRegistry();
+    if (this.devBridge !== void 0) this.devBridge.start();
+    else process.stderr.write("[OIMDB MCP] In-process model loaded \u2014 serving offline (no browser bridge).\n");
+    await this.mcpServer.connect(new StdioServerTransport());
   }
 };
 
@@ -329,12 +69,7 @@ Set a different port: OIMDB_UI_PORT=7434 npx @oimdb/mcp devtools
 function createOIMDevMcpServer(options) {
   return new OIMDevMcpServer(options);
 }
-function createOIMDevUIServer(options) {
-  return new OIMDevUIServer(options);
-}
 export {
   OIMDevMcpServer,
-  OIMDevUIServer,
-  createOIMDevMcpServer,
-  createOIMDevUIServer
+  createOIMDevMcpServer
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oimdb/mcp",
-  "version": "1.2.0",
-  "description": "MCP server and CDP inspector for OIMDB — connects AI assistants to live browser state",
+  "version": "3.0.0",
+  "description": "MCP server for OIMDB — gives AI assistants the oimdb_inspect, oimdb_dump, oimdb_collection and oimdb_computed tools over @oimdb/cli",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -14,30 +14,37 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
     }
   },
+  "oimdbRelease": {
+    "publish": true
+  },
   "bin": {
     "oimdb-mcp": "bin/oimdb-mcp.cjs"
   },
   "files": [
     "dist",
-    "bin",
-    "ui"
+    "bin"
   ],
   "scripts": {
     "build": "tsup --config tsup.config.ts --tsconfig tsconfig.build.json",
     "dev": "tsup --config tsup.config.ts --tsconfig tsconfig.build.json --watch",
-    "type-check": "tsc --noEmit",
+    "type-check": "tsc --noEmit -p tsconfig.tests.json",
     "prepublishOnly": "npm run type-check && npm run build"
   },
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.0.0",
-    "ws": "^8.18.0",
     "zod": "^3.22.0"
   },
+  "peerDependencies": {
+    "@oimdb/cli": "^1.0.0"
+  },
   "devDependencies": {
-    "@types/ws": "^8.5.10",
+    "@oimdb/cli": "*",
     "tsup": "^8.0.0",
     "typescript": "^5.2.2"
   },