inspector/clients/cli/__tests__
Repository files (latest commit first)
Filename Latest commit message Latest commit date
cliffhall 19a6df7ad3 SDK v2 migration (behavior-neutral, versionNegotiation: 'legacy') (#1624)
Migrate all three clients + core + test-servers from
@modelcontextprotocol/sdk@1.29 to SDK v2 (2.0.0-beta.4), keeping behavior
identical against legacy (2025-11-25) servers. Foundation for the SDK V2 +
New Spec stack.

Packages
- Split @modelcontextprotocol/sdk -> @modelcontextprotocol/client (Client,
  transports, OAuth, error taxonomy, protocol types) + core (Zod schemas);
  stdio -> client/stdio, Ajv -> client/validators/ajv. Test-servers ->
  @modelcontextprotocol/server (+ server-legacy/sse). Deterministic import
  rewrite (schemas -> core, everything else -> client); the codemod misroutes
  client code to /server so it was not used for path routing.
- new Client(..., { versionNegotiation: { mode: 'legacy' } }) — nothing
  2026-era goes on the wire.

Runtime (core/mcp/inspectorClient.ts)
- Error taxonomy: McpError -> ProtocolError, ErrorCode -> ProtocolErrorCode;
  RequestTimeout -> SdkError/SdkErrorCode.
- Handlers take method strings; task methods (tasks/*, notifications/tasks/*)
  use the 3-arg custom form (excluded from v2's spec-method set).
- Legacy tasks kept working (per project requirement): requestor tasks re-
  implemented over raw client.request + explicit deprecated schemas;
  experimental.tasks.callToolStream replaced by a local pollTaskToolCall
  async generator (with _progressHandlers revival so task-execution progress
  still reaches the caller). Receiver (server-initiated) tasks: the v2 Client
  validates a sampling/elicit handler result and rejects the legacy { task }
  response with -32602 — installReceiverTaskResponseBypass swaps the wrapped
  entry in the private _requestHandlers map for the task-augmented branch so
  { task } reaches the wire (fixes server-initiated sampling-via-task).
- Pagination: list verbs use raw client.request({method}, List*ResultSchema)
  for single-page behavior (v2's client.listX() auto-aggregate all pages).

Web / auth / apps
- Rename local JsonSchemaType -> InspectorFormSchema + add toFormSchema()
  structural narrowing at the SDK-schema -> form boundary.
- ext-apps still peers on SDK v1: one compat boundary with documented casts
  (remove when ext-apps#702 lands a v2 peer).
- OAuth provider saveClientInformation reconciled with v2's
  OAuthClientInformationContext; InvalidClientMetadataError re-homed as a
  local class (server-legacy/auth is not browser-safe).
- vitest.shared.mts dedupes @modelcontextprotocol/client+core to one copy so
  vi.mock intercepts the SUT's import.

Accepted v2 behavior changes (per #1624 / spec §9.2): unknown-tool call
rejects with -32602; cancellation is stream-abort (no guaranteed
notifications/cancelled frame); output-schema strictness restored via the
Inspector's own Ajv check on the default path.

npm run ci green: validate (web 3087 / cli 212 / tui 274 / launcher 5),
coverage (>=90 per-file, all clients), smoke (launcher/cli/web), storybook
(410).

Closes #1624

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-15 10:44:24 -04:00
..
helpers cli: Wave 3 — programmatic review path (rollup of #1573–#1575) (#1655) 2026-07-11 22:14:23 -04:00
app-info.test.ts cli: Wave 3 — programmatic review path (rollup of #1573–#1575) (#1655) 2026-07-11 22:14:23 -04:00
cli.test.ts test: raise per-file coverage gate to 90 across all clients (closes #1271) (#1532) 2026-06-27 15:26:03 -04:00
cliOAuth.test.ts test(cli): cover cliOAuth.ts step-up/recovery paths to the ≥90% gate 2026-07-04 16:47:48 -04:00
e2e.test.ts test(cli,tui): add in-process source coverage gates (#1484) (#1502) 2026-06-20 15:05:58 -04:00
emit-result.test.ts cli: Wave 3 — programmatic review path (rollup of #1573–#1575) (#1655) 2026-07-11 22:14:23 -04:00
error-handler.test.ts SDK v2 migration (behavior-neutral, versionNegotiation: 'legacy') (#1624) 2026-07-15 10:44:24 -04:00
format-json.test.ts cli: Wave 3 — programmatic review path (rollup of #1573–#1575) (#1655) 2026-07-11 22:14:23 -04:00
headers.test.ts feat: port CLI, TUI, and launcher from v1.5 into v2 (#1452) 2026-06-14 20:27:49 -04:00
metadata.test.ts feat: port CLI, TUI, and launcher from v1.5 into v2 (#1452) 2026-06-14 20:27:49 -04:00
methods.test.ts test: raise per-file coverage gate to 90 across all clients (closes #1271) (#1532) 2026-06-27 15:26:03 -04:00
oauth-interactive.test.ts All of the mid-session and step-up auth work 2026-07-02 16:35:31 -07:00
oauth-runner.test.ts Guided-auth removal, OAuth smoke testing, and TUI/CLI support (#1531) 2026-06-29 15:35:51 -04:00
programmatic-ergonomics.test.ts cli: Wave 3 — programmatic review path (rollup of #1573–#1575) (#1655) 2026-07-11 22:14:23 -04:00
README.md All of the mid-session and step-up auth work 2026-07-02 16:35:31 -07:00
stored-auth.test.ts Merge branch 'v2/1665-refresh-token' into v2/1579-wave4-rollup 2026-07-11 23:27:58 -04:00
tools.test.ts cli: Wave 3 — programmatic review path (rollup of #1573–#1575) (#1655) 2026-07-11 22:14:23 -04:00

CLI Tests

Running Tests

# Run all tests (pretest builds test-servers + the CLI binary)
npm test

# Run all tests under the per-file coverage gate
npm run test:coverage

# Run in watch mode (useful for test file changes)
npm run test:watch

# Run specific test file
npm run test:cli          # cli.test.ts
npm run test:cli-tools   # tools.test.ts
npm run test:cli-headers # headers.test.ts
npm run test:cli-metadata # metadata.test.ts
npx vitest run oauth-interactive.test.ts cliOAuth.test.ts  # OAuth interactive smoke parity

How the CLI is exercised

Most tests run the CLI in-process: helpers/cli-runner.ts imports runCli() from ../src/cli.ts and invokes it directly, capturing process.stdout/stderr and mapping thrown errors to an exit code. This is what lets vitest's v8 coverage instrument clients/cli/src (#1484). Because commander uses .exitOverride(), a parse/usage error throws instead of calling process.exit and tearing down the worker.

e2e.test.ts is the deliberately thin out-of-process layer: it spawns the built build/index.js as a real subprocess to cover the shebang, the index.ts isMain bootstrap, and the actual process.exit codes — the only parts the in-process runner can't reach. (scripts/smoke-cli.mjs at the repo root provides a further end-to-end check of the binary.)

Test Files

  • cli.test.ts - Basic CLI functionality: CLI mode, environment variables, config files, resources, prompts, logging, transport types
  • tools.test.ts - Tool-related tests: Tool discovery, JSON argument parsing, error handling, prompts
  • headers.test.ts - Header parsing and validation
  • metadata.test.ts - Metadata functionality: General metadata, tool-specific metadata, parsing, merging, validation
  • methods.test.ts - Method/option-validation paths not covered elsewhere (resource templates, missing/invalid options, the -- target separator)
  • error-handler.test.ts - The binary's handleError error sink, exercised in-process with process.exit stubbed
  • oauth-runner.test.ts - OAuth flag wiring (--client-config, --callback-url, CIMD overrides)
  • cliOAuth.test.ts - Unit tests for cliOAuth.ts (step-up confirm, helper wiring, retry)
  • oauth-interactive.test.ts - Integration smoke parity for CLI interactive OAuth: connect-time callback server + step-up y/N against composable TestServerHttp (auto-completes authorize URL programmatically; not a subprocess binary e2e)
  • e2e.test.ts - Out-of-process spawn of the built binary (exit codes + boot; no OAuth)

Helpers

The helpers/ directory contains shared utilities:

  • cli-runner.ts - Invokes runCli() in-process and captures stdout/stderr + exit code
  • assertions.ts - Custom assertion helpers for CLI output validation
  • fixtures.ts - Test config/catalog file generators and temporary directory management

HTTP/SSE test servers (for transport tests) come from the @modelcontextprotocol/inspector-test-server package (createTestServerHttp), and the bundled stdio server is launched via getTestMcpServerCommand().

Notes

  • Test files run in separate forked processes (pool: 'forks'), so the in-process runner's process.std*.write patching never overlaps across files; tests within a file run sequentially
  • Config files use crypto.randomUUID() for uniqueness
  • HTTP/SSE servers use dynamic port allocation to avoid conflicts
  • Coverage is enforced per-file (lines ≥ 90, statements ≥ 85, functions ≥ 80, branches ≥ 50). src/index.ts (the binary bootstrap) is excluded because it only runs in the spawned binary, which coverage can't instrument
  • All tests use the built-in MCP test servers — no external/registry dependencies