inspector/core/react/usePagedPrompts.ts
cliffhall b33532c024 feat: allow complex JSON values in request _meta
Closes #1910

`_meta` was typed `Record<string, string>` end to end in the Inspector —
on disk as a `{ key, value }[]` pair array, in the Server Settings form as
key/value rows, and in every request verb's per-call metadata parameter.
Nothing in the MCP spec restricts a `_meta` value to a string, and the SDK
models the field as a `z.looseObject`, so the restriction was ours alone.

Widen the whole path to `RequestMetadata` (`Record<string, JsonValue>`):

- Per-server default metadata is a JSON **object** on disk and in memory.
  The pre-#1910 pair array is still read (`normalizeStoredMetadata`) so an
  existing `mcp.json` keeps working; it is never written back, so a save
  migrates the entry.
- The Server Settings → Request Metadata section is a JSON editor
  (`JsonObjectInput`) instead of key/value rows — rows cannot express an
  object value. It keeps the typed text as the display source and emits
  only parsed JSON, the same draft split `SchemaJsonField` uses, so the box
  stays typeable; invalid text is flagged inline and not applied.
- The CLI stops flattening `--metadata` / `--tool-metadata` through
  `metaValueToString`. Those values were already JSON-parsed, so
  `trace={"id":"abc"}` used to reach the wire as the *string* `{"id":"abc"}`
  and now reaches it as an object.
- `servers/show` redaction replaces a sensitive key's whole value rather
  than a string, so a structured value cannot leak through its members.
- `progressTokenOf` narrows the reserved `progressToken` key back to
  `string | number` before it reaches the SDK; any other JSON still travels
  inside `_meta` but wires up no progress callback.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0177mPHAdECD18nLLCTwR5rh
Signed-off-by: cliffhall <cliff@futurescale.com>
2026-08-23 12:23:40 -04:00

103 lines
3.4 KiB
TypeScript

import { useState, useEffect, useCallback } from "react";
import type { InspectorClientProtocol } from "../mcp/inspectorClientProtocol.js";
import type { RequestMetadata } from "../mcp/types.js";
import type {
PagedPromptsState,
PagedPromptsStateEventMap,
LoadPageResult,
} from "../mcp/state/pagedPromptsState.js";
import type { Prompt } from "@modelcontextprotocol/client";
import type { TypedEventGeneric } from "../mcp/typedEventTarget.js";
import { useListError } from "./useListError.js";
export interface UsePagedPromptsResult {
prompts: Prompt[];
/** The server's `nextCursor` from the last page (undefined = at the end). */
nextCursor?: string;
/** Pages loaded since the last reset (page 1 = 1). */
pageCount: number;
/**
* The last page load's failure, or `null` when it succeeded. In paginated
* mode this store is the display source, so this — not the managed
* store's error — is what the panel renders (#1998).
*/
error: Error | null;
loadPage: (
cursor?: string,
metadata?: RequestMetadata,
) => Promise<LoadPageResult>;
clear: () => void;
}
/**
* React hook that subscribes to PagedPromptsState and returns prompts +
* pagination progress + loadPage. The state store owns loading; this mirrors
* its observable state.
*/
export function usePagedPrompts(
client: InspectorClientProtocol | null,
pagedPromptsState: PagedPromptsState | null,
): UsePagedPromptsResult {
const [prompts, setPrompts] = useState<Prompt[]>(
pagedPromptsState?.getPrompts() ?? [],
);
const [nextCursor, setNextCursor] = useState<string | undefined>(
pagedPromptsState?.getPagination().nextCursor,
);
const [pageCount, setPageCount] = useState<number>(
pagedPromptsState?.getPagination().pageCount ?? 0,
);
useEffect(() => {
if (!pagedPromptsState) {
setPrompts([]);
setNextCursor(undefined);
setPageCount(0);
return;
}
setPrompts(pagedPromptsState.getPrompts());
setNextCursor(pagedPromptsState.getPagination().nextCursor);
setPageCount(pagedPromptsState.getPagination().pageCount);
const onPromptsChange = (
event: TypedEventGeneric<PagedPromptsStateEventMap, "promptsChange">,
) => {
setPrompts(event.detail);
};
const onPaginationChange = (
event: TypedEventGeneric<PagedPromptsStateEventMap, "paginationChange">,
) => {
setNextCursor(event.detail.nextCursor);
setPageCount(event.detail.pageCount);
};
pagedPromptsState.addEventListener("promptsChange", onPromptsChange);
pagedPromptsState.addEventListener("paginationChange", onPaginationChange);
return () => {
pagedPromptsState.removeEventListener("promptsChange", onPromptsChange);
pagedPromptsState.removeEventListener(
"paginationChange",
onPaginationChange,
);
};
}, [pagedPromptsState]);
const error = useListError(pagedPromptsState);
const loadPage = useCallback(
async (
cursor?: string,
metadata?: RequestMetadata,
): Promise<LoadPageResult> => {
if (!pagedPromptsState || !client) {
return { prompts: [], nextCursor: undefined };
}
return pagedPromptsState.loadPage(cursor, metadata);
},
[client, pagedPromptsState],
);
const clear = useCallback(() => {
pagedPromptsState?.clear();
}, [pagedPromptsState]);
return { prompts, nextCursor, pageCount, error, loadPage, clear };
}