@mcp-use/client 0.0.0-bootstrap.0 → 2.0.0-beta.0

package/dist/react/useMcp-helpers.d.ts

@@ -0,0 +1,99 @@
+import { BrowserOAuthClientProvider } from "../auth/browser.js";
+import type { OAuthClientInformation } from "@modelcontextprotocol/client";
+import type { MCPServerInfo } from "../core/session.js";
+export declare const USE_MCP_SERVER_NAME = "inspector-server";
+/** Asserts that a condition is true, throwing an error if not. */
+export declare function assert(condition: unknown, message: string): asserts condition;
+type ServerInfoWithIcon = MCPServerInfo & {
+    icon?: string;
+};
+type AddLog = (level: "debug" | "info" | "warn" | "error", message: string, ...args: unknown[]) => void;
+/** Resolve a server-provided icon, then fall back to domain favicon discovery. */
+export declare function loadServerIcon(params: {
+    serverInfo: MCPServerInfo;
+    url?: string;
+    isMounted: () => boolean;
+    setServerInfo: (update: (previous?: ServerInfoWithIcon) => ServerInfoWithIcon | undefined) => void;
+    addLog: AddLog;
+}): Promise<string | null>;
+/** Human-readable reason when MCP operations run before the client is usable. */
+export declare function formatMcpNotReadyReason(state: string, hasClient: boolean): string;
+type OAuthClientConfig = {
+    name?: string;
+    version?: string;
+    uri?: string;
+    logo_uri?: string;
+};
+export declare function deriveOAuthClientConfigFromClientInfo(clientInfo: {
+    name: string;
+    title?: string;
+    version: string;
+    description?: string;
+    icons?: Array<{
+        src: string;
+        mimeType?: string;
+        sizes?: string[];
+    }>;
+    websiteUrl?: string;
+}): OAuthClientConfig;
+export declare function isOAuthDiscoveryFailure(error: Error | unknown): boolean;
+/**
+ * Derive the companion OAuth proxy endpoint from an MCP proxy endpoint.
+ *
+ * The Inspector proxy convention is `/proxy` for MCP traffic and `/oauth` for
+ * OAuth metadata/token requests. An explicit OAuth URL always takes priority.
+ */
+export declare function deriveOAuthProxyUrl(gatewayUrl: string | undefined, explicitOAuthProxyUrl: string | undefined): string | undefined;
+export declare function createBrowserOAuthProvider(params: {
+    effectiveOAuthUrl: string;
+    storageKeyPrefix: string;
+    oauthClientConfig: OAuthClientConfig;
+    callbackUrl: string;
+    preventAutoAuth: boolean;
+    useRedirectFlow: boolean;
+    /** MCP proxy URL used to derive the companion OAuth proxy when needed. */
+    gatewayUrl?: string;
+    /**
+     * Explicit OAuth proxy base URL. Takes precedence over the URL derived from
+     * `gatewayUrl`. Lets consumers proxy OAuth traffic (CORS bypass) while
+     * keeping MCP traffic direct.
+     */
+    oauthProxyUrl?: string;
+    onPopupWindow?: (url: string, features: string, window: globalThis.Window | null) => void;
+    /**
+     * Whether the provider should route OAuth requests through the derived
+     * OAuth proxy (to bypass CORS). The provider exposes this via its scoped
+     * `getProxyFetch()` — it never patches the global `fetch`.
+     */
+    proxyOAuthRequests: boolean;
+    staticClientInfo?: OAuthClientInformation;
+    clientMetadataUrl?: string;
+    scope?: string;
+}): {
+    provider: BrowserOAuthClientProvider;
+    oauthProxyUrl?: string;
+};
+type LogLevel = "debug" | "info" | "warn" | "error";
+export declare function startConnectionHealthMonitoring(params: {
+    gatewayUrl?: string;
+    url?: string;
+    allHeaders?: Record<string, string>;
+    getAuthHeaders?: () => Promise<Record<string, string>>;
+    isMountedRef: {
+        current: boolean;
+    };
+    stateRef: {
+        current: string;
+    };
+    autoReconnectRef: {
+        current: boolean | number | Record<string, unknown>;
+    };
+    setState: (state: "discovering") => void;
+    addLog: (level: LogLevel, message: string, ...args: unknown[]) => void;
+    connect: () => void;
+    defaultReconnectDelay: number;
+    healthCheckIntervalMs?: number;
+    healthCheckTimeoutMs?: number;
+}): () => void;
+export {};
+//# sourceMappingURL=useMcp-helpers.d.ts.map

package/dist/react/useMcp-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMcp-helpers.d.ts","sourceRoot":"","sources":["../../src/react/useMcp-helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAChE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AAC3E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,eAAO,MAAM,mBAAmB,qBAAqB,CAAC;AAEtD,kEAAkE;AAClE,wBAAgB,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAI7E;AAED,KAAK,kBAAkB,GAAG,aAAa,GAAG;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC5D,KAAK,MAAM,GAAG,CACZ,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,EAC1C,OAAO,EAAE,MAAM,EACf,GAAG,IAAI,EAAE,OAAO,EAAE,KACf,IAAI,CAAC;AAEV,kFAAkF;AAClF,wBAAsB,cAAc,CAAC,MAAM,EAAE;IAC3C,UAAU,EAAE,aAAa,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,OAAO,CAAC;IACzB,aAAa,EAAE,CACb,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,kBAAkB,KAAK,kBAAkB,GAAG,SAAS,KACtE,IAAI,CAAC;IACV,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CA8CzB;AAED,iFAAiF;AACjF,wBAAgB,uBAAuB,CACrC,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,OAAO,GACjB,MAAM,CAER;AAED,KAAK,iBAAiB,GAAG;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,wBAAgB,qCAAqC,CAAC,UAAU,EAAE;IAChE,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,KAAK,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;KAClB,CAAC,CAAC;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,GAAG,iBAAiB,CAOpB;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAevE;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,qBAAqB,EAAE,MAAM,GAAG,SAAS,GACxC,MAAM,GAAG,SAAS,CAWpB;AAED,wBAAgB,0BAA0B,CAAC,MAAM,EAAE;IACjD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,OAAO,CAAC;IACzB,eAAe,EAAE,OAAO,CAAC;IACzB,0EAA0E;IAC1E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,KAC7B,IAAI,CAAC;IACV;;;;OAIG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,GAAG;IACF,QAAQ,EAAE,0BAA0B,CAAC;IACrC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAwBA;AAED,KAAK,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpD,wBAAgB,+BAA+B,CAAC,MAAM,EAAE;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,cAAc,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACvD,YAAY,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC;IACnC,QAAQ,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC9B,gBAAgB,EAAE;QAAE,OAAO,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAC;IAC1E,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;IACzC,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;IACvE,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,GAAG,MAAM,IAAI,CAgFb"}

package/dist/react/useMcp-operations.d.ts

@@ -0,0 +1,156 @@
+import type { CompleteRequestParams, CompleteResult, Prompt, Resource, ResourceTemplateType as ResourceTemplate, Tool } from "@modelcontextprotocol/client";
+import { type Dispatch, type RefObject, type SetStateAction } from "react";
+import type { MCPConnection } from "../core/session.js";
+import type { UseMcpResult } from "./types.js";
+type AddLog = (level: UseMcpResult["log"][number]["level"], message: string, ...args: unknown[]) => void;
+type Params = {
+    stateRef: RefObject<UseMcpResult["state"]>;
+    connectionRef: RefObject<MCPConnection | null>;
+    hasClient: () => boolean;
+    isMounted: () => boolean;
+    setTools: Dispatch<SetStateAction<Tool[]>>;
+    setResources: Dispatch<SetStateAction<Resource[]>>;
+    setResourceTemplates: Dispatch<SetStateAction<ResourceTemplate[]>>;
+    setPrompts: Dispatch<SetStateAction<Prompt[]>>;
+    addLog: AddLog;
+};
+export declare function useMcpOperations(params: Params): {
+    callTool: (name: string, args?: Record<string, unknown>, options?: {
+        timeout?: number;
+        maxTotalTimeout?: number;
+        resetTimeoutOnProgress?: boolean;
+        signal?: AbortSignal;
+    }) => Promise<any>;
+    listResources: () => Promise<void>;
+    readResource: (uri: string) => Promise<{
+        [x: string]: unknown;
+        contents: ({
+            uri: string;
+            text: string;
+            mimeType?: string | undefined;
+            _meta?: {
+                [x: string]: unknown;
+            } | undefined;
+        } | {
+            uri: string;
+            blob: string;
+            mimeType?: string | undefined;
+            _meta?: {
+                [x: string]: unknown;
+            } | undefined;
+        })[];
+        _meta?: {
+            [x: string]: unknown;
+            progressToken?: string | number | undefined;
+            "io.modelcontextprotocol/related-task"?: {
+                taskId: string;
+            } | undefined;
+        } | undefined;
+    }>;
+    listPrompts: () => Promise<void>;
+    refreshTools: () => Promise<void>;
+    refreshResources: () => Promise<void>;
+    refreshPrompts: () => Promise<void>;
+    refreshResourceTemplates: () => Promise<void>;
+    refreshAll: () => Promise<undefined>;
+    getPrompt: (name: string, args?: Record<string, unknown>) => Promise<{
+        [x: string]: unknown;
+        messages: {
+            role: "user" | "assistant";
+            content: {
+                type: "text";
+                text: string;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            } | {
+                type: "image";
+                data: string;
+                mimeType: string;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            } | {
+                type: "audio";
+                data: string;
+                mimeType: string;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            } | {
+                uri: string;
+                name: string;
+                type: "resource_link";
+                description?: string | undefined;
+                mimeType?: string | undefined;
+                size?: number | undefined;
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+                icons?: {
+                    src: string;
+                    mimeType?: string | undefined;
+                    sizes?: string[] | undefined;
+                    theme?: "light" | "dark" | undefined;
+                }[] | undefined;
+                title?: string | undefined;
+            } | {
+                type: "resource";
+                resource: {
+                    uri: string;
+                    text: string;
+                    mimeType?: string | undefined;
+                    _meta?: {
+                        [x: string]: unknown;
+                    } | undefined;
+                } | {
+                    uri: string;
+                    blob: string;
+                    mimeType?: string | undefined;
+                    _meta?: {
+                        [x: string]: unknown;
+                    } | undefined;
+                };
+                annotations?: {
+                    audience?: ("user" | "assistant")[] | undefined;
+                    priority?: number | undefined;
+                    lastModified?: string | undefined;
+                } | undefined;
+                _meta?: {
+                    [x: string]: unknown;
+                } | undefined;
+            };
+        }[];
+        _meta?: {
+            [x: string]: unknown;
+            progressToken?: string | number | undefined;
+            "io.modelcontextprotocol/related-task"?: {
+                taskId: string;
+            } | undefined;
+        } | undefined;
+        description?: string | undefined;
+    }>;
+    complete: (request: CompleteRequestParams) => Promise<CompleteResult>;
+};
+export {};
+//# sourceMappingURL=useMcp-operations.d.ts.map

package/dist/react/useMcp-operations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMcp-operations.d.ts","sourceRoot":"","sources":["../../src/react/useMcp-operations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,cAAc,EACd,MAAM,EACN,QAAQ,EACR,oBAAoB,IAAI,gBAAgB,EACxC,IAAI,EACL,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,KAAK,QAAQ,EACb,KAAK,SAAS,EACd,KAAK,cAAc,EACpB,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,KAAK,MAAM,GAAG,CACZ,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,EAC3C,OAAO,EAAE,MAAM,EACf,GAAG,IAAI,EAAE,OAAO,EAAE,KACf,IAAI,CAAC;AAEV,KAAK,MAAM,GAAG;IACZ,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3C,aAAa,EAAE,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAC/C,SAAS,EAAE,MAAM,OAAO,CAAC;IACzB,SAAS,EAAE,MAAM,OAAO,CAAC;IACzB,QAAQ,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC3C,YAAY,EAAE,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACnD,oBAAoB,EAAE,QAAQ,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC;IACnE,UAAU,EAAE,QAAQ,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAmBF,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM;;eAsJwsW,CAAC;uBAA6G,CAAC;8BAA+H,CAAC;cAAsE,CAAC;;;wBA7G7hX,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAkFL,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;wBAQnC,qBAAqB,KAAG,OAAO,CAAC,cAAc,CAAC;EAkBlE"}

package/dist/react/useMcp.d.ts

@@ -0,0 +1,48 @@
+import type { UseMcpOptions, UseMcpResult } from "./types.js";
+type UseMcpInternalOptions = UseMcpOptions & {
+    _initialServerInfo?: {
+        name?: string;
+        version?: string;
+        title?: string;
+        websiteUrl?: string;
+        icons?: Array<{
+            src: string;
+            mimeType?: string;
+        }>;
+        icon?: string;
+    };
+};
+/**
+ * React hook for connecting to and interacting with MCP servers
+ *
+ * Provides a complete interface for MCP server connections including:
+ * - Automatic connection management with reconnection
+ * - OAuth authentication with automatic token refresh
+ * - Tool, resource, and prompt access
+ * - AI chat functionality with conversation memory
+ * - Streamable HTTP transport
+ *
+ * @param options - Configuration options for the MCP connection
+ * @returns MCP connection state and methods
+ *
+ * @example
+ * ```typescript
+ * const mcp = useMcp({
+ *   url: 'http://localhost:3000/mcp',
+ *   headers: { Authorization: 'Bearer YOUR_API_KEY' }
+ * })
+ *
+ * // Wait for connection
+ * useEffect(() => {
+ *   if (mcp.state === 'ready') {
+ *     console.log('Connected!', mcp.tools)
+ *   }
+ * }, [mcp.state])
+ *
+ * // Call a tool
+ * const result = await mcp.callTool('send-email', { to: 'user@example.com' })
+ * ```
+ */
+export declare function useMcp(options: UseMcpInternalOptions): UseMcpResult;
+export {};
+//# sourceMappingURL=useMcp.d.ts.map

package/dist/react/useMcp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useMcp.d.ts","sourceRoot":"","sources":["../../src/react/useMcp.ts"],"names":[],"mappings":"AAmCA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAmC9D,KAAK,qBAAqB,GAAG,aAAa,GAAG;IAC3C,kBAAkB,CAAC,EAAE;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,KAAK,CAAC,EAAE,KAAK,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QAClD,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,qBAAqB,GAAG,YAAY,CA01DnE"}