RoxyBrowser OpenAPI 3.0

English | 中文

RoxyBrowser OpenAPI 3.0 is a breaking rewrite of the MCP and SDK package. It separates the raw RoxyBrowser local API client from product SDKs and MCP presets, so backend endpoint names, SDK operation names, and public MCP tool names are no longer coupled.

Install

pnpm add @roxybrowser/openapi

CLI Usage

Browser profile mode:

roxybrowser-openapi-mcp --api-key "YOUR_API_KEY" --workspace-id 19744

Run the published beta directly with npx:

npx -y @roxybrowser/openapi@beta roxybrowser-openapi-mcp --api-key "YOUR_API_KEY" --workspace-id 19744

Quick SDK calls are available from the same CLI. Each method argument is parsed as JSON when possible, otherwise it is passed as a string:

npx -y @roxybrowser/openapi@beta sdk profiles.list '{"page":1,"pageSize":20}' \
  --api-key "YOUR_API_KEY" --workspace-id 19744

npx -y @roxybrowser/openapi@beta sdk profiles.open profile-1 '{"forceOpen":true}' \
  --api-key "YOUR_API_KEY" --workspace-id 19744

For a RoxyBrowser endpoint that is not in the SDK yet, call the raw API debugger:

npx -y @roxybrowser/openapi@beta api POST /browser/new_feature '{"dirId":"profile-1"}' \
  --api-key "YOUR_API_KEY" --workspace-id 19744

Raw GET requests send JSON params as query parameters, and raw POST requests send JSON params as the request body. The configured workspaceId is injected into object params by default; add --no-workspace to disable that.

Check the package version and whether an operation exists for a RoxyBrowser app version:

npx -y @roxybrowser/openapi@beta version
npx -y @roxybrowser/openapi@beta supports browser.profile.open 4.0.4

Ecommerce account mode is available as a preset shell, but it does not expose built-in tools yet:

roxybrowser-openapi-mcp --commerce --api-key "YOUR_API_KEY" --workspace-id 19744

Run the ecommerce preset shell directly with npx:

npx -y @roxybrowser/openapi@beta roxybrowser-openapi-mcp --commerce --api-key "YOUR_API_KEY" --workspace-id 19744

Options:

• -H, --api-host <url>: RoxyBrowser API base URL. Default: http://127.0.0.1:50000
• -k, --api-key <key>: RoxyBrowser API key.
• -w, --workspace-id <id>: default workspace ID injected into workspace-scoped requests.
• -t, --timeout <ms>: request timeout. Default: 30000

Environment variables are also supported: ROXY_API_HOST, ROXY_API_KEY, ROXY_TIMEOUT, and ROXY_WORKSPACE_ID.

Codex and Claude Code

If you want to add this package as a published MCP server in Codex or Claude Code, point the client at the npm package entry.

Codex:

codex mcp add roxybrowser \
  --env ROXY_API_KEY=YOUR_API_KEY \
  --env ROXY_API_HOST=http://127.0.0.1:50000 \
  --env ROXY_TIMEOUT=30000 \
  --env ROXY_WORKSPACE_ID=19744 \
  -- npx -y @roxybrowser/openapi@beta roxybrowser-openapi-mcp

Claude Code:

claude mcp add roxybrowser \
  -e ROXY_API_KEY=YOUR_API_KEY \
  -e ROXY_API_HOST=http://127.0.0.1:50000 \
  -e ROXY_TIMEOUT=30000 \
  -e ROXY_WORKSPACE_ID=19744 \
  -- npx -y @roxybrowser/openapi@beta roxybrowser-openapi-mcp

Use --commerce if you want the ecommerce preset.

MCP Inspector 2.0

The repository includes an Inspector 2.0 server configuration for both stdio presets. Copy the local environment template and provide your RoxyBrowser credentials before starting the Inspector:

cp .env.example .env

ROXY_API_KEY=your_api_key_from_roxybrowser
ROXY_API_HOST=http://127.0.0.1:50000
ROXY_TIMEOUT=30000
ROXY_WORKSPACE_ID=19744

.env is ignored by Git. The checked-in mcp.inspector.json contains no credentials and starts both roxybrowser and roxycommerce from the built lib entries.

Start the Web Inspector and select either server from the Servers screen:

pnpm inspect

Use the terminal UI instead:

pnpm inspect:tui

Run non-interactive tool-list smoke tests:

pnpm inspect:cli:browser
pnpm inspect:cli:commerce

For a direct CLI call, build first and select a server from the shared configuration:

pnpm build
pnpm exec mcp-inspector --cli --config mcp.inspector.json --server roxybrowser \
  --method tools/call --tool-name roxy_workspace_list --tool-args-json '{}'

Inspector 2.0 requires Node.js 22.19.0 or newer. The development runtime managed by this repository is Node.js 24.15.0.

SDK Usage

Browser product SDK:

import { RoxyBrowserClient } from "@roxybrowser/openapi";

const roxy = new RoxyBrowserClient({
  apiKey: "YOUR_API_KEY",
  apiHost: "http://127.0.0.1:50000",
  workspaceId: 19744,
});

const profiles = await roxy.profiles.list({
  page: 1,
  pageSize: 20,
  windowName: "Amazon",
});
const opened = await roxy.profiles.open(profiles.rows[0].dirId, { forceOpen: true });

Ecommerce product SDK:

import { RoxyCommerceClient } from "@roxybrowser/openapi";

const commerce = new RoxyCommerceClient({
  apiKey: "YOUR_API_KEY",
  workspaceId: 19744,
});

RoxyCommerceClient is currently a product shell. Ecommerce SDK methods and MCP tools will be added in a later task.

Low-level API access is available through RoxyApiClient when endpoint-shaped calls are needed:

import { RoxyApiClient } from "@roxybrowser/openapi";

const api = new RoxyApiClient({ apiKey: "YOUR_API_KEY", workspaceId: 19744 });
const raw = await api.proxy.listMerged({ page_index: 1, page_size: 20 });

SDK and MCP capabilities are versioned against the RoxyBrowser app version. The package version is available as ROXY_OPENAPI_VERSION, while supports() checks a RoxyBrowser app version:

import { RoxyBrowserClient, ROXY_OPENAPI_VERSION } from "@roxybrowser/openapi";

const roxy = new RoxyBrowserClient({
  apiKey: "YOUR_API_KEY",
  roxyBrowserVersion: "4.0.4",
});

console.log(ROXY_OPENAPI_VERSION);
console.log(roxy.getCapability("browser.profile.open"));
console.log(roxy.supports("browser.profile.open"));

Embedded MCP Usage

import { createRoxyBrowserMcpServer, createRoxyCommerceMcpServer } from "@roxybrowser/openapi";

const browserServer = createRoxyBrowserMcpServer({
  timeout: 45_000,
  roxyBrowserVersion: "4.0.4",
  includeTools: ["roxy_profile_list", "roxy_profile_get", "roxy_profile_open"],
  roxy: { apiKey: "YOUR_API_KEY", workspaceId: 19744 },
});

const commerceServer = createRoxyCommerceMcpServer({
  roxy: { apiKey: "YOUR_API_KEY", workspaceId: 19744 },
});

Public MCP Tool Names

Browser mode exposes 24 tools in profile language when a workspace is configured, or 25 tools when it is not (the additional tool is roxy_workspace_list):

• roxy_workspace_list
• roxy_project_list
• roxy_label_list
• roxy_profile_list
• roxy_profile_get
• roxy_profile_create
• roxy_profile_update
• roxy_profile_open
• roxy_profile_close
• roxy_profile_delete
• roxy_profile_connection_info
• roxy_profile_randomize_fingerprint
• roxy_profile_clear_local_cache
• roxy_profile_clear_server_cache
• roxy_proxy_list
• roxy_proxy_create
• roxy_proxy_update
• roxy_proxy_delete
• roxy_proxy_detect
• roxy_proxy_detect_channels
• roxy_platform_account_list
• roxy_platform_account_create
• roxy_platform_account_update
• roxy_platform_account_delete

Ecommerce mode is currently an empty preset shell. It exposes no built-in tools until the ecommerce toolset is designed in a later task.

Set roxyBrowserVersion to the current RoxyBrowser app version when creating a preset. Tools and schema fields added after that app version are hidden. Each MCP tool keeps debug metadata with a stable operationId, the underlying RoxyBrowser endpoint, the package version, and sinceRoxyBrowserVersion in tool _meta only when that tool has an app version requirement. Unmarked tools and schema fields are available for all RoxyBrowser app versions.

Create tools accept a resource array. Pass one item to create a single resource, or multiple items to create a batch. Browser profile, proxy, and platform-account tools use profiles, proxies, and accounts.

Architecture

The 3.0 source tree is intentionally split:

• src/api: raw RoxyBrowser HTTP API client.
• src/sdk: public SDK clients.
• src/domains/browser: browser profile, proxy, workspace, and platform account domains.
• src/domains/commerce: reserved ecommerce domain skeletons.
• src/mcp/runtime: reusable MCP runtime.
• src/mcp/presets/browser: browser-mode MCP preset.
• src/mcp/presets/commerce: ecommerce-mode MCP preset.
• src/cli: product-specific CLI entries.

See docs/architecture-3.0.md for the full design.

Development

pnpm install
pnpm check
pnpm build
pnpm test
pnpm coverage

Vite+ manages formatting, linting, type checks, testing, coverage, task execution, and library packaging. pnpm coverage builds the package, runs the 3.0 unit tests, and enforces 90% coverage for lines, branches, and functions across the rewritten API, SDK, domain, and MCP layers.