inspector/core/react/useManagedTools.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

75 lines
2.7 KiB
TypeScript

import { useState, useEffect, useCallback } from "react";
import type { InspectorClientProtocol } from "../mcp/inspectorClientProtocol.js";
import type { ManagedToolsState } from "../mcp/state/managedToolsState.js";
import type { ManagedToolsStateEventMap } from "../mcp/state/managedToolsState.js";
import type { Tool } from "@modelcontextprotocol/client";
import type { TypedEventGeneric } from "../mcp/typedEventTarget.js";
export interface UseManagedToolsResult {
tools: Tool[];
/** True when a `tools/list_changed` arrived since the last user refresh. */
listChanged: boolean;
refresh: () => Promise<Tool[]>;
}
/**
* React hook that subscribes to ManagedToolsState and returns tools + refresh.
*/
export function useManagedTools(
client: InspectorClientProtocol | null,
managedToolsState: ManagedToolsState | null,
): UseManagedToolsResult {
const [tools, setTools] = useState<Tool[]>(
managedToolsState?.getTools() ?? [],
);
const [listChanged, setListChanged] = useState<boolean>(
managedToolsState?.getListChanged() ?? false,
);
useEffect(() => {
if (!managedToolsState) {
setTools([]);
setListChanged(false);
return;
}
setTools(managedToolsState.getTools());
setListChanged(managedToolsState.getListChanged());
const onToolsChange = (
event: TypedEventGeneric<ManagedToolsStateEventMap, "toolsChange">,
) => {
setTools(event.detail);
};
const onListChangedChange = (
event: TypedEventGeneric<ManagedToolsStateEventMap, "listChangedChange">,
) => {
setListChanged(event.detail);
};
managedToolsState.addEventListener("toolsChange", onToolsChange);
managedToolsState.addEventListener(
"listChangedChange",
onListChangedChange,
);
return () => {
managedToolsState.removeEventListener("toolsChange", onToolsChange);
managedToolsState.removeEventListener(
"listChangedChange",
onListChangedChange,
);
};
}, [managedToolsState]);
const refresh = useCallback(async (): Promise<Tool[]> => {
if (!managedToolsState || !client) return [];
// A user-initiated refresh acknowledges the change — clear the indicator
// BEFORE awaiting the fetch, not after. If a `tools/list_changed` arrives
// mid-fetch, the state re-sets the flag (and auto-refreshes); clearing
// afterward would wipe that genuinely-new signal and the user would miss
// it. Clearing up front acknowledges only the change in hand.
managedToolsState.clearListChanged();
const next = await managedToolsState.refresh();
setTools(next);
return next;
}, [client, managedToolsState]);
return { tools, listChanged, refresh };
}