inspector/core/mcp/samplingCreateMessage.ts
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

81 lines
2.4 KiB
TypeScript

import type { CreateMessageRequest, CreateMessageResult } from "@modelcontextprotocol/client";
import { RELATED_TASK_META_KEY } from "@modelcontextprotocol/client";
export type { CreateMessageRequest, CreateMessageResult };
/**
* Data shape of a pending sampling request tracked by the InspectorClient.
* v2's state/screen layer consumes this interface; the runtime class below
* (SamplingCreateMessage) implements it.
*/
export interface InspectorPendingSampling {
id: string;
timestamp: Date;
request: CreateMessageRequest;
taskId?: string;
}
/**
* Represents a pending sampling request from the server
*/
export class SamplingCreateMessage {
public readonly id: string;
public readonly timestamp: Date;
public readonly request: CreateMessageRequest;
public readonly taskId?: string;
private resolvePromise?: (result: CreateMessageResult) => void;
private rejectPromise?: (error: Error) => void;
private onRemove: (id: string) => void;
constructor(
request: CreateMessageRequest,
resolve: (result: CreateMessageResult) => void,
reject: (error: Error) => void,
onRemove: (id: string) => void,
) {
this.onRemove = onRemove;
this.id = `sampling-${crypto.randomUUID()}`;
this.timestamp = new Date();
this.request = request;
// Extract taskId from request params metadata if present
const relatedTask = request.params?._meta?.[RELATED_TASK_META_KEY];
this.taskId = relatedTask?.taskId;
this.resolvePromise = resolve;
this.rejectPromise = reject;
}
/**
* Respond to the sampling request with a result
*/
async respond(result: CreateMessageResult): Promise<void> {
if (!this.resolvePromise) {
throw new Error("Request already resolved or rejected");
}
this.resolvePromise(result);
this.resolvePromise = undefined;
this.rejectPromise = undefined;
// Remove from pending list after responding
this.remove();
}
/**
* Reject the sampling request with an error
*/
async reject(error: Error): Promise<void> {
if (!this.rejectPromise) {
throw new Error("Request already resolved or rejected");
}
this.rejectPromise(error);
this.resolvePromise = undefined;
this.rejectPromise = undefined;
// Remove from pending list after rejecting
this.remove();
}
/**
* Remove this pending sample from the list
*/
remove(): void {
this.onRemove(this.id);
}
}