@slbdn/mcp-tester 1.5.4 → 1.7.0

package/docs/api-reference.md

@@ -42,7 +42,7 @@ const client = new MCPClient({
 
 ### `start(config: ServerConfig): Promise<void>`
 
-Start the client and connect to an MCP server. Supports three transport types:
+Start the client and connect to an MCP server. Supports four transport types:
 
 #### Stdio (default)
 
@@ -99,6 +99,23 @@ await client.start({
 });
 ```
 
+#### WebSocket
+
+Connects to a server over WebSocket using the browser-native `WebSocket` API
+and the `mcp` subprotocol. Browser-friendly.
+
+| Param | Type | Required | Description |
+|-------|------|----------|-------------|
+| `config.transport` | `'websocket'` | ✅ | Must be `'websocket'` |
+| `config.url` | `string` | ✅ | `ws://` or `wss://` server URL |
+
+```typescript
+await client.start({
+  transport: 'websocket',
+  url: 'wss://api.example.com/mcp',
+});
+```
+
 **Throws:**
 - `MCPAlreadyStartedError` — if the client is already connected
 - `MCPConnectionError` — if the connection fails
@@ -127,7 +144,7 @@ if (client.isConnected()) {
 
 ### `getTransportType(): TransportType | null`
 
-Get the active transport type. Returns `'stdio'`, `'http'`, `'sse'`, or `null`.
+Get the active transport type. Returns `'stdio'`, `'http'`, `'sse'`, `'websocket'`, or `null`.
 
 ```typescript
 const type = client.getTransportType();
@@ -553,17 +570,67 @@ All matchers support `.not` negation and work identically in Jest and Vitest.
 
 ## Types
 
-### MCPServerConfig
+### ServerConfig
+
+Union of every transport configuration accepted by `start()`:
+
+```typescript
+type ServerConfig =
+  | StdioServerConfig
+  | StreamableHttpServerConfig
+  | SseServerConfig
+  | WebSocketServerConfig;
+
+type TransportType = 'stdio' | 'http' | 'sse' | 'websocket';
+```
+
+### StdioServerConfig (default)
 
 ```typescript
-interface MCPServerConfig {
+interface StdioServerConfig {
+  transport?: 'stdio';
   command: string;
   args?: string[];
   env?: Record<string, string | undefined>;
-  startupDelay?: number;
+  startupDelay?: number; // default 0
 }
 ```
 
+### StreamableHttpServerConfig
+
+```typescript
+interface StreamableHttpServerConfig {
+  transport: 'http';
+  url: string;
+  headers?: Record<string, string>;
+  sessionId?: string;
+  requestInit?: RequestInit;
+}
+```
+
+### SseServerConfig (deprecated)
+
+```typescript
+interface SseServerConfig {
+  transport: 'sse';
+  url: string;
+  headers?: Record<string, string>;
+  requestInit?: RequestInit;
+}
+```
+
+### WebSocketServerConfig
+
+```typescript
+interface WebSocketServerConfig {
+  transport: 'websocket';
+  url: string; // ws:// or wss://
+}
+```
+
+> `MCPServerConfig` is a deprecated alias for `StdioServerConfig`, kept for
+> backward compatibility.
+
 ### MCPClientOptions
 
 ```typescript

package/docs/browser.md

@@ -0,0 +1,138 @@
+# Browser Support
+
+`mcp-tester` can run inside browser and edge runtimes to test MCP servers over
+network transports. This is useful for:
+
+- Component/unit tests that run in a real browser (Vitest browser mode, Karma,
+  Playwright component testing, Web Test Runner).
+- In-browser debugging or smoke checks of a remote MCP server.
+- Edge runtimes (Cloudflare Workers, Deno Deploy, Vercel Edge) that expose
+  `fetch` and `WebSocket`.
+
+## How it works
+
+The package declares a `browser` field in `package.json`:
+
+```json
+"browser": {
+  "./dist/index.js": "./dist/browser.js",
+  "./dist/utils/stdio-transport.js": false
+}
+```
+
+When a bundler targets the browser it resolves the package entry to
+`dist/browser.js` and replaces the Node-only stdio transport with an empty
+module. You import the package exactly as you would on Node:
+
+```typescript
+import { MCPClient, assert } from '@slbdn/mcp-tester';
+
+const client = new MCPClient();
+await client.start({ transport: 'http', url: 'https://api.example.com/mcp' });
+
+const result = await client.callTool({ name: 'echo', arguments: { message: 'hi' } });
+assert.toolTextContains(result, 'hi');
+
+await client.stop();
+```
+
+Webpack, Vite, Rollup, esbuild, Parcel, and Rspack all honor the `browser`
+field. The repository's CI runs `npm run test:browser`, which bundles the
+package with esbuild using `platform: 'browser'` and fails if any Node built-in
+(`node:*`) or the stdio transport (`cross-spawn`) leaks into the bundle.
+
+## Transports
+
+| Transport | Browser | Notes |
+|-----------|:-------:|-------|
+| `http` (Streamable HTTP) | ✅ | Uses `fetch` + `ReadableStream`. Recommended for remote servers. |
+| `sse` (legacy) | ✅ | Uses `fetch` + `EventSource` semantics. |
+| `websocket` | ✅ | Uses the global `WebSocket` API. |
+| `stdio` | ❌ | Spawns a local process; Node.js only. |
+
+### Streamable HTTP
+
+```typescript
+await client.start({
+  transport: 'http',
+  url: 'https://api.example.com/mcp',
+  headers: { Authorization: 'Bearer token' },
+});
+```
+
+### WebSocket
+
+```typescript
+await client.start({
+  transport: 'websocket',
+  url: 'wss://api.example.com/mcp',
+});
+```
+
+The client connects using the `mcp` WebSocket subprotocol, matching the MCP
+SDK's `WebSocketClientTransport`.
+
+> **Node.js note:** the WebSocket transport needs a global `WebSocket`.
+> Node.js 22+ provides one. On older Node versions use `--experimental-websocket`
+> or a polyfill such as [`ws`](https://www.npmjs.com/package/ws) installed on
+> `globalThis`.
+
+## What is included
+
+The browser entry point (`dist/browser.js`) exports the browser-safe subset:
+
+- `MCPClient` and all client types (`ServerConfig`, `StreamableHttpServerConfig`,
+  `SseServerConfig`, `WebSocketServerConfig`, `MCPClientOptions`, `HealthStatus`, …)
+- Custom matchers (`toHaveTool`, `toReturnText`, `setupVitestMatchers`, …)
+- The `assert` module
+- Error classes (`MCPClientError`, `MCPTimeoutError`, …)
+- Logging/masking utilities (`startTimer`, `prettyPrint`, `maskSecrets`, …)
+- The deterministic edge-case generator (`suggestEdgeCases`, `generateToolArgs`, …)
+
+## What is Node-only
+
+These are intentionally excluded and tree-shaken from browser bundles:
+
+- **stdio transport** — spawns a child process via `cross-spawn`.
+- **`generateTests` / `generateTypes`** — read/write files and read the package
+  version from disk.
+- **AI provider** (`OpenAICompatProvider`, `createProviderFromEnv`) — uses
+  `node:crypto`, `node:fs`, and `node:path`.
+
+If you need test generation in a browser workflow, generate the files in a Node
+step (CLI or script) and run the generated tests in the browser.
+
+## Limitations
+
+- **No stdio.** Browsers cannot spawn processes. Use `http`, `sse`, or
+  `websocket`.
+- **CORS applies.** The MCP server must send appropriate
+  `Access-Control-Allow-Origin` headers (and allow the `mcp-session-id` header
+  for Streamable HTTP). This is a browser/network constraint, not a limitation
+  of this library.
+- **File-based caching is unavailable.** The AI provider (Node-only) writes a
+  cache to disk; in-browser code paths do not touch the filesystem.
+- **`process`-based features degrade gracefully.** Health checks for stdio PIDs
+  return `null`, and logging falls back to a non-TTY format.
+
+## Testing from Node
+
+You can exercise the browser-safe entry point from Node without a browser. The
+repository's `test:browser` script is a good template; a focused version is:
+
+```js
+import { build } from 'esbuild';
+
+await build({
+  entryPoints: ['src/entry.ts'],
+  bundle: true,
+  platform: 'browser',
+  format: 'esm',
+  outfile: 'out.js',
+});
+```
+
+If the bundle succeeds, no Node built-ins were pulled in.
+
+See also: [Starter Templates](./starter-templates.md) and
+[Testing](./testing.md).

package/docs/cicd.md

@@ -39,6 +39,9 @@ jobs:
       - name: Build TypeScript
         run: npm run build
 
+      - name: Check browser bundle
+        run: npm run test:browser
+
       - name: Run tests
         run: npm test
 

package/docs/cli.md

@@ -10,7 +10,7 @@ npx @slbdn/mcp-tester test node ./server.js
 
 ## Transports
 
-The CLI supports three transport types:
+The CLI supports four transport types:
 
 ### Stdio (default)
 
@@ -43,6 +43,19 @@ mcp-tester test --transport http --url https://api.example.com/mcp --headers '{"
 mcp-tester test --transport sse --url http://localhost:3000/sse
 ```
 
+### WebSocket
+
+```bash
+mcp-tester test --transport websocket --url ws://localhost:3000
+```
+
+A `ws://` or `wss://` URL passed as the first argument is auto-detected as the
+WebSocket transport:
+
+```bash
+mcp-tester test wss://api.example.com/mcp
+```
+
 ## Commands
 
 ### `test` — Test Server Connection

package/docs/nodejs-compatibility.md

@@ -6,8 +6,8 @@
 |----------------|--------|-------|
 | 18.x | ⚠️ Not Supported | ESM limitations — upgrade recommended |
 | 20.x (LTS) | ✅ Fully Supported | **Recommended** (minimum required version) |
-| 21.x | ✅ Fully Supported | Latest stable |
-| 22.x+ | ✅ Compatible | Tested, works |
+| 21.x | ⚠️ Not Supported | End-of-life; dropped from the test matrix in 1.5.2 |
+| 22.x+ | ✅ Fully Supported | Latest LTS, tested |
 
 ## Requirements
 
@@ -36,6 +36,20 @@ Targets TypeScript 5.3+ with ES2022 output.
 - ✅ Linux (Ubuntu, Debian, CentOS, Alpine)
 - ✅ Windows 10/11 (via WSL or native Node.js)
 
+## Browser and Edge Runtimes
+
+Modern browsers and edge runtimes (Cloudflare Workers, Deno Deploy, Vercel
+Edge) are supported for the network transports:
+
+| Runtime | stdio | http | sse | websocket |
+|---------|:-----:|:----:|:---:|:---------:|
+| Node.js ≥ 20 | ✅ | ✅ | ✅ | ✅ (global `WebSocket` on ≥ 22) |
+| Browsers | ❌ | ✅ | ✅ | ✅ |
+| Edge runtimes | ❌ | ✅ | ✅ | ✅ |
+
+Bundlers select the browser entry point automatically via the `browser` field.
+See [Browser Support](./browser.md) for details.
+
 ## CI/CD Version Specification
 
 **GitHub Actions:**