@roxybrowser/openapi 1.0.13-beta.6 → 1.0.13

package/README.md

@@ -177,8 +177,8 @@ This allows you to build custom UIs, scripts, or other MCP servers that reuse Ro
 - `roxy_list_labels` - Get browser labels/tags for organization
 
 ### Proxy
-- `roxy_list_proxies` - List proxy configurations in a workspace
-- `roxy_store_proxies` - Get list of proxies you've purchased (store)
+- `roxy_list_proxies` - List proxy configurations in a workspace
+- `roxy_store_proxies` - Get list of proxies you've purchased (store)
 - `roxy_create_proxy` - Create a proxy configuration
 - `roxy_batch_create_proxies` - Create multiple proxies in batch
 - `roxy_detect_proxy` - Detect/test proxy availability
@@ -254,8 +254,38 @@ npm run dev
 
 # Build for production
 npm run build
+
+# Build and run the test suite
+npm test
+
+# Launch MCP Inspector against the local stdio server
+ROXY_API_KEY=your-key npm run inspect
 ```
 
+### Test Strategy
+
+The repository now includes a lightweight test setup based on Node's built-in test runner, so no extra test framework is required.
+
+- `test/utils.test.mjs`: config resolution and HTTP request wrapper behavior
+- `test/tools.test.mjs`: tool handler formatting and health-check output
+- `test/server.test.mjs`: in-memory MCP integration using the official SDK client and transport
+
+`npm test` builds `lib/` first, then runs the tests against the built artifacts. This keeps the test path close to what gets published.
+
+### MCP Inspector
+
+Use the official MCP Inspector to debug tool discovery and tool calls locally:
+
+```bash
+# Web UI
+ROXY_API_KEY=your-key npm run inspect
+
+# CLI mode
+ROXY_API_KEY=your-key npm run inspect:cli -- --method tools/list
+```
+
+Set `ROXY_API_HOST` as needed before launching Inspector.
+
 ## API Reference
 
 ### Configuration

package/lib/cli.cjs

@@ -5,6 +5,11 @@ var commander = require('commander');
 var index_js = require('@modelcontextprotocol/sdk/server/index.js');
 var stdio_js = require('@modelcontextprotocol/sdk/server/stdio.js');
 var types_js = require('@modelcontextprotocol/sdk/types.js');
+var dotenv = require('dotenv');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var dotenv__default = /*#__PURE__*/_interopDefault(dotenv);
 
 // src/types.ts
 var ConfigError = class extends Error {
@@ -2123,6 +2128,14 @@ var ListBrowsers = class {
       searchParams.append("page_index", params.pageIndex.toString());
     if (params.pageSize)
       searchParams.append("page_size", params.pageSize.toString());
+    if (params.windowSortNum) {
+      if (params.windowSortNum.includes("-")) {
+        const [_, serialNo] = params.windowSortNum.split("-").map((s) => s.trim());
+        searchParams.append("windowSortNum", serialNo);
+      } else {
+        searchParams.append("windowSortNum", params.windowSortNum);
+      }
+    }
     const result = await request(`/browser/list_v3?${searchParams}`, {
       method: "GET"
     });
@@ -2137,23 +2150,29 @@ var ListBrowsers = class {
       const pageSize = params.pageSize ?? 15;
       const totalPages = Math.max(1, Math.ceil((data.total || 0) / pageSize));
       const hasNextPage = currentPage < totalPages;
-      text = `Found ${data.total} browsers in workspace ${params.workspaceId}:
-
-${data.rows.map((browser) => {
-        const serialNo = `${browser.workspaceName?.slice(0, 3).toLocaleUpperCase()}-${browser.windowSortNum}`;
-        return `**${browser.windowName || "Unnamed"}** (Serial No: ${serialNo})
-  - CoreVersion: ${browser.coreVersion}  - DirId: ${browser.dirId}
-  - OSVersion: ${browser.osVersion}
-  - OS: ${browser.os}
-  - Remark: ${browser.windowRemark}`;
-      }).join("\n\n")}
-
-Pagination:
-- currentPage: ${currentPage}
-- pageSize: ${pageSize}
-- totalPages: ${totalPages}
-- hasNextPage: ${hasNextPage}
-${hasNextPage ? `- nextPageHint: Call roxy_list_browsers again with pageIndex=${currentPage + 1}` : "- nextPageHint: No more pages"}`;
+      const readable = [];
+      if (data.total > 0) {
+        readable.push(`Found ${data.total} browsers in workspace ${params.workspaceId}:`);
+        const browserList = data.rows.map((browser) => {
+          const serialNo = `${browser.workspaceName?.slice(0, 3).toLocaleUpperCase()}-${browser.windowSortNum}`;
+          const info = [
+            `Profile Name: **${browser.windowName || "Unnamed"}** (SN: ${serialNo})`,
+            `  - CoreVersion: ${browser.coreVersion}`,
+            `  - OS: ${browser.os} ${browser.osVersion}`
+          ];
+          if (browser.windowRemark) {
+            info.push(`  - Remark: ${browser.windowRemark}`);
+          }
+          return info.join("\n");
+        }).join("\n\n");
+        readable.push(browserList);
+        if (totalPages > 1) {
+          readable.push(`Pagination: page=${currentPage}, totalPages=${totalPages}, hasNext=${hasNextPage}`);
+        }
+      } else {
+        readable.push(`No browsers found in workspace ${params.workspaceId}.`);
+      }
+      text = readable.join("\n\n");
     }
     return {
       content: [
@@ -2317,6 +2336,10 @@ var GetBrowserDetail = class {
       dirId: {
         type: "string",
         description: "Browser directory ID"
+      },
+      windowSortNum: {
+        type: "string",
+        description: "Filter by window `Serial No` (e.g. 1, 102)"
       }
     },
     required: ["workspaceId", "dirId"]
@@ -2342,6 +2365,14 @@ var GetBrowserDetail = class {
     const searchParams = new URLSearchParams();
     searchParams.append("workspaceId", params.workspaceId.toString());
     searchParams.append("dirId", params.dirId);
+    if (params.windowSortNum) {
+      if (params.windowSortNum.includes("-")) {
+        const [_, serialNo] = params.windowSortNum.split("-").map((s) => s.trim());
+        searchParams.append("windowSortNum", serialNo);
+      } else {
+        searchParams.append("windowSortNum", params.windowSortNum);
+      }
+    }
     const result = await request(`/browser/detail?${searchParams}`, {
       method: "GET"
     });
@@ -2774,26 +2805,10 @@ ${ws.project_details.map(
 };
 var HealthCheck = class {
   name = "roxy_health_check";
-  description = "Check if the target server is alive and healthy. This tool performs a health check to verify server connectivity and status.";
+  description = "Check whether the RoxyBrowser server is running and reachable.";
   inputSchema = {
     type: "object",
-    properties: {
-      includeWorkspaceCheck: {
-        type: "boolean",
-        description: "Include workspace connectivity tests (optional, default: true)",
-        default: true
-      },
-      includeBrowserCheck: {
-        type: "boolean",
-        description: "Include browser availability checks (optional, default: true)",
-        default: true
-      },
-      verbose: {
-        type: "boolean",
-        description: "Include detailed diagnostic information (optional, default: false)",
-        default: false
-      }
-    }
+    properties: {}
   };
   get schema() {
     return {
@@ -2802,126 +2817,19 @@ var HealthCheck = class {
       inputSchema: this.inputSchema
     };
   }
-  async handle(params) {
-    const { includeWorkspaceCheck = true, includeBrowserCheck = true, verbose = false } = params || {};
-    let healthStatus = "unknown";
-    let healthError = "";
+  async handle(_params) {
+    let text = "";
     try {
-      const healthResult = await request("/health", {
+      const result = await request("/health", {
         method: "GET"
       });
-      if (healthResult.code === 0 || healthResult.code === void 0) {
-        healthStatus = "healthy";
-      } else {
-        healthStatus = "unhealthy";
-        healthError = healthResult.msg || "Health check failed";
-      }
+      text = result.code === 0 ? "\u2705 **Server is healthy**\n\nThe RoxyBrowser server is running and reachable." : `\u274C **Server health check failed**
+
+${result.msg || "Unknown server response"}`;
     } catch (error) {
-      healthStatus = "unhealthy";
-      healthError = error.message || "Failed to connect to server";
-    }
-    let text = `## \u{1F50D} \u5065\u5EB7\u68C0\u67E5\u62A5\u544A / Health Check Report
+      text = `\u274C **Server is unavailable**
 
-`;
-    text += `### \u{1F310} \u670D\u52A1\u5668\u72B6\u6001 / Server Status
-`;
-    text += `- **\u670D\u52A1\u5668\u8FDE\u63A5 / Server Connection**: ${healthStatus === "healthy" ? "\u2705 \u6B63\u5E38" : "\u274C \u5F02\u5E38"}
-`;
-    if (healthStatus !== "healthy" && healthError) {
-      text += `- **\u9519\u8BEF\u4FE1\u606F / Error**: ${healthError}
-`;
-    }
-    if (includeWorkspaceCheck && healthStatus === "healthy") {
-      try {
-        const workspaceResult = await request("/browser/workspace?page_index=1&page_size=5", {
-          method: "GET"
-        });
-        if (workspaceResult.code === 0) {
-          const workspaces = workspaceResult.data;
-          text += `
-### \u{1F4C1} \u5DE5\u4F5C\u533A\u4FE1\u606F / Workspace Information
-`;
-          text += `- **\u53EF\u7528\u5DE5\u4F5C\u533A / Available Workspaces**: ${workspaces.total}
-`;
-          if (workspaces.rows && workspaces.rows.length > 0) {
-            text += `- **\u5DE5\u4F5C\u533A\u8BE6\u60C5 / Workspace Details**:
-`;
-            workspaces.rows.slice(0, 3).forEach((ws) => {
-              const projectCount = ws.project_details?.length || 0;
-              text += `  - ${ws.workspaceName} (ID: ${ws.id}) - ${projectCount} projects
-`;
-            });
-            if (workspaces.total > 3) {
-              text += `  - ... and ${workspaces.total - 3} more
-`;
-            }
-          }
-        } else {
-          text += `
-### \u{1F4C1} \u5DE5\u4F5C\u533A\u4FE1\u606F / Workspace Information
-`;
-          text += `- **\u72B6\u6001**: \u26A0\uFE0F \u65E0\u6CD5\u83B7\u53D6\u5DE5\u4F5C\u533A\u4FE1\u606F
-`;
-          text += `- **\u9519\u8BEF**: ${workspaceResult.msg}
-`;
-        }
-      } catch (error) {
-        text += `
-### \u{1F4C1} \u5DE5\u4F5C\u533A\u4FE1\u606F / Workspace Information
-`;
-        text += `- **\u72B6\u6001**: \u274C \u65E0\u6CD5\u83B7\u53D6\u5DE5\u4F5C\u533A\u4FE1\u606F
-`;
-        text += `- **\u9519\u8BEF**: ${error.message || "Unknown error"}
-`;
-      }
-    }
-    if (includeBrowserCheck && healthStatus === "healthy") {
-      try {
-        const workspaceResult = await request("/browser/workspace?page_index=1&page_size=1", {
-          method: "GET"
-        });
-        if (workspaceResult.code === 0 && workspaceResult.data.rows && workspaceResult.data.rows.length > 0) {
-          const firstWorkspace = workspaceResult.data.rows[0];
-          const browserResult = await request(`/browser/list_v3?workspaceId=${firstWorkspace.id}&page_index=1&page_size=5`, {
-            method: "GET"
-          });
-          if (browserResult.code === 0) {
-            const browsers = browserResult.data;
-            text += `
-### \u{1F310} \u6D4F\u89C8\u5668\u4FE1\u606F / Browser Information
-`;
-            text += `- **\u5DE5\u4F5C\u533A / Workspace**: ${firstWorkspace.workspaceName} (ID: ${firstWorkspace.id})
-`;
-            text += `- **\u6D4F\u89C8\u5668\u603B\u6570 / Total Browsers**: ${browsers.total}
-`;
-            if (browsers.rows && browsers.rows.length > 0) {
-              text += `- **\u6D4F\u89C8\u5668\u793A\u4F8B / Browser Examples**:
-`;
-              browsers.rows.slice(0, 3).forEach((browser) => {
-                text += `  - ${browser.windowName || "Unnamed"} (ID: ${browser.dirId}) - ${browser.status}
-`;
-              });
-            }
-          }
-        }
-      } catch (error) {
-        text += `
-### \u{1F310} \u6D4F\u89C8\u5668\u4FE1\u606F / Browser Information
-`;
-        text += `- **\u72B6\u6001**: \u26A0\uFE0F \u65E0\u6CD5\u83B7\u53D6\u6D4F\u89C8\u5668\u4FE1\u606F
-`;
-        text += `- **\u9519\u8BEF**: ${error.message || "Unknown error"}
-`;
-      }
-    }
-    if (verbose && healthStatus === "healthy") {
-      text += `
-### \u{1F4CA} \u8BE6\u7EC6\u4FE1\u606F / Detailed Information
-`;
-      text += `- **\u5065\u5EB7\u68C0\u67E5\u65F6\u95F4 / Check Time**: ${(/* @__PURE__ */ new Date()).toISOString()}
-`;
-      text += `- **\u68C0\u67E5\u6A21\u5F0F / Check Mode**: ${includeWorkspaceCheck ? "Workspace + " : ""}${includeBrowserCheck ? "Browser" : ""}
-`;
+${error?.message || "Failed to connect to the server"}`;
     }
     return {
       content: [
@@ -3081,8 +2989,7 @@ async function runServer() {
   const server = new RoxyBrowserMCPServer();
   await server.run();
 }
-
-// src/cli.ts
+dotenv__default.default.config();
 var PKG_VERSION = "1.0.9";
 var program = new commander.Command();
 program.name("roxy-browser-mcp").description("RoxyBrowser MCP Server - Model Context Protocol server for RoxyBrowser automation").version(PKG_VERSION, "-V, --version", "Show version").option(