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>
This commit is contained in:
parent
8d33e76f97
commit
19a6df7ad3
1 changed files with 2545 additions and 2123 deletions
|
|
@ -6,13 +6,20 @@
|
|||
*/
|
||||
|
||||
import * as z from "zod/v4";
|
||||
import type { Implementation } from "@modelcontextprotocol/sdk/types.js";
|
||||
import {
|
||||
RELATED_TASK_META_KEY,
|
||||
type Implementation,
|
||||
type ElicitRequestFormParams,
|
||||
type ElicitRequestURLParams,
|
||||
type GetTaskResult,
|
||||
type CallToolResult,
|
||||
} from "@modelcontextprotocol/server";
|
||||
import {
|
||||
CreateMessageResultSchema,
|
||||
CreateTaskResultSchema,
|
||||
ElicitResultSchema,
|
||||
GetTaskResultSchema,
|
||||
} from "@modelcontextprotocol/sdk/types.js";
|
||||
} from "@modelcontextprotocol/core";
|
||||
import type {
|
||||
ToolDefinition,
|
||||
TaskToolDefinition,
|
||||
|
|
@ -21,27 +28,12 @@ import type {
|
|||
ResourceTemplateDefinition,
|
||||
ServerConfig,
|
||||
TestServerContext,
|
||||
} from "./composable-test-server.js";
|
||||
import { getTestServerControl } from "./test-server-control.js";
|
||||
import type {
|
||||
ElicitRequestFormParams,
|
||||
ElicitRequestURLParams,
|
||||
} from "@modelcontextprotocol/sdk/types.js";
|
||||
import type {
|
||||
TaskRequestHandlerExtra,
|
||||
CreateTaskRequestHandlerExtra,
|
||||
} from "@modelcontextprotocol/sdk/experimental/tasks/interfaces.js";
|
||||
import { RELATED_TASK_META_KEY } from "@modelcontextprotocol/sdk/types.js";
|
||||
import { toJsonSchemaCompat } from "@modelcontextprotocol/sdk/server/zod-json-schema-compat.js";
|
||||
import type { ShapeOutput } from "@modelcontextprotocol/sdk/server/zod-compat.js";
|
||||
import type {
|
||||
GetTaskResult,
|
||||
CallToolResult,
|
||||
ServerRequest,
|
||||
ServerNotification,
|
||||
} from "@modelcontextprotocol/sdk/types.js";
|
||||
import type { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
|
||||
import type { ZodRawShapeCompat } from "@modelcontextprotocol/sdk/server/zod-compat.js";
|
||||
HandlerExtra,
|
||||
ShapeOutput,
|
||||
} from "./composable-test-server.js";
|
||||
import { getTestServerControl } from "./test-server-control.js";
|
||||
|
||||
/** Build a CallToolResult from a text message (and optional isError). */
|
||||
function toToolResult(text: string, isError?: boolean): CallToolResult {
|
||||
|
|
@ -1224,7 +1216,9 @@ export function createAddToolTool(): ToolDefinition {
|
|||
params.name as string,
|
||||
{
|
||||
description: params.description as string,
|
||||
inputSchema: params.inputSchema as ZodRawShapeCompat | undefined,
|
||||
inputSchema: params.inputSchema as
|
||||
| Record<string, z.ZodType>
|
||||
| undefined,
|
||||
},
|
||||
async () => {
|
||||
return {
|
||||
|
|
@ -1327,7 +1321,9 @@ export function createAddPromptTool(): ToolDefinition {
|
|||
params.name as string,
|
||||
{
|
||||
description: params.description as string | undefined,
|
||||
argsSchema: params.argsSchema as ZodRawShapeCompat | undefined,
|
||||
argsSchema: params.argsSchema as
|
||||
| Record<string, z.ZodType>
|
||||
| undefined,
|
||||
},
|
||||
async () => {
|
||||
return {
|
||||
|
|
@ -1457,7 +1453,7 @@ export function createSendProgressTool(
|
|||
handler: async (
|
||||
params: Record<string, unknown>,
|
||||
context?: TestServerContext,
|
||||
extra?: RequestHandlerExtra<ServerRequest, ServerNotification>,
|
||||
extra?: HandlerExtra,
|
||||
): Promise<CallToolResult> => {
|
||||
if (!context) {
|
||||
throw new Error("Server context not available");
|
||||
|
|
@ -1470,7 +1466,10 @@ export function createSendProgressTool(
|
|||
const message = (params.message as string) || "Processing...";
|
||||
|
||||
// Extract progressToken from metadata
|
||||
const progressToken = extra?._meta?.progressToken;
|
||||
const progressToken = extra?._meta?.progressToken as
|
||||
| string
|
||||
| number
|
||||
| undefined;
|
||||
|
||||
// Send progress notifications
|
||||
let sent = 0;
|
||||
|
|
@ -1668,7 +1667,7 @@ async function runTaskExecution(params: RunTaskExecutionParams): Promise<void> {
|
|||
if (elicitationSchema) {
|
||||
await extra.taskStore.updateTaskStatus(task.taskId, "input_required");
|
||||
try {
|
||||
const jsonSchema = toJsonSchemaCompat(
|
||||
const jsonSchema = z.toJSONSchema(
|
||||
elicitationSchema,
|
||||
) as ElicitRequestFormParams["requestedSchema"];
|
||||
const elicitationParams: ElicitRequestFormParams = {
|
||||
|
|
@ -1908,7 +1907,10 @@ export function createTaskTool(
|
|||
const message = (args as Record<string, unknown>)?.message as
|
||||
| string
|
||||
| undefined;
|
||||
const progressToken = extra._meta?.progressToken;
|
||||
const progressToken = extra._meta?.progressToken as
|
||||
| string
|
||||
| number
|
||||
| undefined;
|
||||
const task = await extra.taskStore.createTask({});
|
||||
runTaskExecution({
|
||||
task,
|
||||
|
|
|
|||
Loading…
Reference in a new issue