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

package/dist/react/McpClientProvider.d.ts

@@ -0,0 +1,242 @@
+import type { ElicitResult } from "@modelcontextprotocol/client";
+import type { SamplingCreateMessageResult } from "../core/config.js";
+import React, { type ReactNode } from "react";
+import type { StorageProvider } from "./storage.js";
+import type { McpServer, McpServerConfig, PendingElicitationRequest, PendingSamplingRequest } from "./types.js";
+/**
+ * Context value for multi-server management
+ */
+export interface McpClientContextType {
+    servers: McpServer[];
+    /** Idempotent — safe to call multiple times with the same id; duplicates are silently ignored. */
+    addServer: (id: string, config: McpServerConfig) => void;
+    /**
+     * Remove a server from the provider.
+     *
+     * By default this only tears down the live connection and leaves persisted
+     * OAuth credentials (tokens / client_info / PKCE verifier) intact, so routine
+     * remove+add churn (config refetches, deployment-status flips, env-scoped
+     * wrappers sharing a URL hash) does not silently log the user out.
+     *
+     * Pass `{ clearCredentials: true }` for an explicit logout / "forget this
+     * server" action to also wipe the persisted OAuth storage.
+     */
+    removeServer: (id: string, opts?: {
+        clearCredentials?: boolean;
+    }) => Promise<void>;
+    updateServerMetadata: (id: string, metadata: {
+        name: string;
+    }) => Promise<void>;
+    updateServer: (id: string, options: Partial<McpServerConfig>) => Promise<void>;
+    getServer: (id: string) => McpServer | undefined;
+    /** Whether storage has finished loading (true if no storage provider) */
+    storageLoaded: boolean;
+}
+/**
+ * Props for McpClientProvider
+ */
+export interface McpClientProviderProps {
+    children: ReactNode;
+    /**
+     * Initial servers configuration (like Python MCPClient.from_dict)
+     * Servers defined here will be auto-connected on mount
+     */
+    mcpServers?: Record<string, McpServerConfig>;
+    /**
+     * Default OAuth callback URL for all servers.
+     * Can be overridden per-server via the callbackUrl option in addServer().
+     * Useful when the app is mounted at a sub-path (e.g. /inspector) so the
+     * OAuth redirect lands on the correct route without requiring a server-side
+     * redirect shim.
+     */
+    defaultCallbackUrl?: string;
+    /** Default same-origin OAuth BFF URL for browser OAuth requests. */
+    defaultOAuthProxyUrl?: string;
+    /**
+     * Default proxy configuration for all servers
+     * Can be overridden per-server in addServer() options
+     */
+    defaultProxyConfig?: {
+        proxyAddress?: string;
+        headers?: Record<string, string>;
+    };
+    /**
+     * Enable automatic proxy fallback for all servers by default
+     * When enabled, if a direct connection fails with FastMCP or CORS errors,
+     * automatically retries using proxy configuration
+     * @defaultValue false
+     */
+    defaultAutoProxyFallback?: boolean | {
+        enabled?: boolean;
+        proxyAddress?: string;
+    };
+    /**
+     * Default connection options merged under each server's options (per-server wins).
+     * Useful for app-wide auth UX such as `preventAutoAuth` or `useRedirectFlow`.
+     */
+    defaultServerConfig?: Partial<McpServerConfig>;
+    /**
+     * Client info for all servers (used for OAuth registration and server capabilities).
+     * Can be overridden per-server in addServer() options.
+     *
+     * The optional `capabilities` field sets default MCP capabilities advertised to
+     * every server managed by this provider (e.g. MCP Apps / SEP-1865 extensions).
+     * It is merged with per-server `clientOptions.capabilities` (per-server takes
+     * precedence) and is stripped from the actual MCP `clientInfo` wire field.
+     */
+    clientInfo?: {
+        /** Client name displayed on OAuth consent pages (required) */
+        name: string;
+        /** Client title/display name */
+        title?: string;
+        /** Client version (required) */
+        version: string;
+        /** Client description */
+        description?: string;
+        /** Client icons (first icon used as logo_uri for OAuth) */
+        icons?: Array<{
+            src: string;
+            mimeType?: string;
+            sizes?: string[];
+        }>;
+        /** Client website URL (used as client_uri for OAuth) */
+        websiteUrl?: string;
+        /**
+         * Default capabilities advertised to all servers managed by this provider.
+         * Per-server `clientOptions.capabilities` are merged on top, with per-server
+         * values taking precedence. Stripped from the MCP `clientInfo` wire field.
+         *
+         * @example
+         * ```tsx
+         * capabilities: {
+         *   views: true,
+         *   // or explicitly:
+         *   extensions: {
+         *     "io.modelcontextprotocol/ui": { mimeTypes: ["text/html;profile=mcp-app"] },
+         *   },
+         * }
+         * ```
+         */
+        capabilities?: Record<string, unknown>;
+    };
+    /**
+     * Storage provider for persisting server configurations
+     * When provided, automatically loads servers on mount and saves on changes
+     */
+    storageProvider?: StorageProvider;
+    /**
+     * Enable RPC logging for debugging (browser only)
+     * Logs all MCP protocol messages to console
+     */
+    enableRpcLogging?: boolean;
+    /**
+     * Callback when a server is added
+     */
+    onServerAdded?: (id: string, server: McpServer) => void;
+    /**
+     * Callback when a server is removed
+     */
+    onServerRemoved?: (id: string) => void;
+    /**
+     * Callback when a server's state changes
+     */
+    onServerStateChange?: (id: string, state: McpServer["state"]) => void;
+    /**
+     * Callback when a sampling request is received from any server
+     * @param request The sampling request details
+     * @param serverId The ID of the server that sent the request
+     * @param serverName The name of the server
+     * @param approve Function to approve the request
+     * @param reject Function to reject the request
+     */
+    onSamplingRequest?: (request: PendingSamplingRequest, serverId: string, serverName: string, approve: (requestId: string, result: SamplingCreateMessageResult) => void, reject: (requestId: string, error?: string) => void) => void;
+    /**
+     * Callback when an elicitation request is received from any server
+     * @param request The elicitation request details
+     * @param serverId The ID of the server that sent the request
+     * @param serverName The name of the server
+     * @param approve Function to approve the request
+     * @param reject Function to reject the request
+     */
+    onElicitationRequest?: (request: PendingElicitationRequest, serverId: string, serverName: string, approve: (requestId: string, result: ElicitResult) => void, reject: (requestId: string, error?: string) => void) => void;
+}
+/**
+ * Provider for managing multiple MCP server connections
+ *
+ * Provides a context for adding/removing servers and accessing their state.
+ * Each server maintains its own connection, notification history, and
+ * pending sampling/elicitation requests.
+ *
+ * Supports:
+ * - Initial server configuration via `mcpServers` prop
+ * - Persistence via pluggable `storageProvider`
+ * - RPC logging for debugging
+ * - Lifecycle callbacks for state changes
+ *
+ * @example
+ * ```tsx
+ * // With initial servers
+ * <McpClientProvider
+ *   mcpServers={{
+ *     linear: { url: "https://mcp.linear.app/sse" },
+ *     github: { url: "https://mcp.github.com/mcp" }
+ *   }}
+ * >
+ *   <MyApp />
+ * </McpClientProvider>
+ *
+ * // With persistence
+ * <McpClientProvider
+ *   storageProvider={new LocalStorageProvider("my-servers")}
+ *   enableRpcLogging={true}
+ * >
+ *   <MyApp />
+ * </McpClientProvider>
+ * ```
+ */
+export declare function McpClientProvider({ children, mcpServers, defaultCallbackUrl, defaultOAuthProxyUrl, defaultProxyConfig, defaultAutoProxyFallback, defaultServerConfig, clientInfo, storageProvider, enableRpcLogging, onServerAdded, onServerRemoved, onServerStateChange, onSamplingRequest, onElicitationRequest, }: McpClientProviderProps): React.JSX.Element;
+/**
+ * Hook to access the MCP client context
+ *
+ * Provides access to all servers and management functions.
+ * Must be used within a McpClientProvider.
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   servers,
+ *   addServer,
+ *   removeServer,
+ *   updateServer,
+ *   updateServerMetadata,
+ * } = useMcpClient();
+ *
+ * // Add a server
+ * addServer("linear", { url: "https://mcp.linear.app/sse" });
+ *
+ * // Update a server's configured display name without reconnecting
+ * await updateServerMetadata("linear", { name: "Linear Production" });
+ *
+ * // Update connection-affecting configuration and reconnect
+ * await updateServer("linear", { headers: { Authorization: "Bearer ..." } });
+ * // Or from a connected server handle:
+ * await servers[0].setHeaders({ Authorization: "Bearer ..." });
+ *
+ * // Rename without reconnecting
+ * await servers[0].setDisplayName("Linear Production");
+ *
+ * // Access servers
+ * servers.forEach(server => {
+ *   console.log(server.id, server.state);
+ * });
+ * ```
+ */
+export declare function useMcpClient(): McpClientContextType;
+/**
+ * Retrieve the McpServer object for a given server id.
+ *
+ * @returns The `McpServer` for the provided `id`, or `undefined` if no matching server is registered.
+ * @throws If called outside of a `McpClientProvider` (context not available).
+ */
+export declare function useMcpServer(id: string): McpServer | undefined;
+//# sourceMappingURL=McpClientProvider.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"McpClientProvider.d.ts","sourceRoot":"","sources":["../../src/react/McpClientProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAa,MAAM,8BAA8B,CAAC;AAC5E,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,KAAK,EAAE,EAQZ,KAAK,SAAS,EACf,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,yBAAyB,EACzB,sBAAsB,EACvB,MAAM,YAAY,CAAC;AAUpB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,kGAAkG;IAClG,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,KAAK,IAAI,CAAC;IACzD;;;;;;;;;;OAUG;IACH,YAAY,EAAE,CACZ,EAAE,EAAE,MAAM,EACV,IAAI,CAAC,EAAE;QAAE,gBAAgB,CAAC,EAAE,OAAO,CAAA;KAAE,KAClC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,oBAAoB,EAAE,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,YAAY,EAAE,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,SAAS,GAAG,SAAS,CAAC;IACjD,yEAAyE;IACzE,aAAa,EAAE,OAAO,CAAC;CACxB;AA0WD;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,SAAS,CAAC;IAEpB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAE7C;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,oEAAoE;IACpE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;OAGG;IACH,kBAAkB,CAAC,EAAE;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,CAAC;IAEF;;;;;OAKG;IACH,wBAAwB,CAAC,EACrB,OAAO,GACP;QACE,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IAEN;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAE/C;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE;QACX,8DAA8D;QAC9D,IAAI,EAAE,MAAM,CAAC;QACb,gCAAgC;QAChC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,gCAAgC;QAChC,OAAO,EAAE,MAAM,CAAC;QAChB,yBAAyB;QACzB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,2DAA2D;QAC3D,KAAK,CAAC,EAAE,KAAK,CAAC;YACZ,GAAG,EAAE,MAAM,CAAC;YACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;SAClB,CAAC,CAAC;QACH,wDAAwD;QACxD,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB;;;;;;;;;;;;;;;WAeG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACxC,CAAC;IAEF;;;OAGG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC;IAExD;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;IAEvC;;OAEG;IACH,mBAAmB,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAEtE;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,CAClB,OAAO,EAAE,sBAAsB,EAC/B,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,2BAA2B,KAAK,IAAI,EACzE,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,KAChD,IAAI,CAAC;IAEV;;;;;;;OAOG;IACH,oBAAoB,CAAC,EAAE,CACrB,OAAO,EAAE,yBAAyB,EAClC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,KAAK,IAAI,EAC1D,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,KAChD,IAAI,CAAC;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,QAAQ,EACR,UAAU,EACV,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,wBAAgC,EAChC,mBAAmB,EACnB,UAAU,EACV,eAAe,EACf,gBAAwB,EACxB,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,GACrB,EAAE,sBAAsB,qBA6iBxB;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,YAAY,IAAI,oBAAoB,CAMnD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAM9D"}

package/dist/react/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * React entry point for the MCP connection console.
+ *
+ * Provides the `useMcp` hook, the multi-server `McpClientProvider`, and the
+ * supporting storage / logging utilities for connecting to MCP servers from a
+ * React app. MCP Apps host rendering lives in {@link ViewRenderer}.
+ */
+export type { UseMcpOptions, UseMcpResult, ReconnectionOptions, McpServer, McpServerConfig, 
+/** @deprecated Use McpServerConfig */
+McpServerOptions, PersistedMcpServerConfig, pickPersistedServerConfig, toPersistedServerConfig, McpNotification, PendingSamplingRequest, PendingElicitationRequest, } from "./types.js";
+export { useMcp } from "./useMcp.js";
+export { detectFavicon } from "../utils/favicon.js";
+export { onMcpAuthorization } from "../auth/callback.js";
+export { Tel, Telemetry, setTelemetrySource, } from "../telemetry/telemetry-browser.js";
+export type { CallToolResult, ContentBlock, ElicitRequestFormParams, ElicitRequestURLParams, ElicitResult, GetPromptResult, JSONRPCMessage, Prompt, ReadResourceResult, Resource, ResourceTemplateType, Tool, Transport, } from "@modelcontextprotocol/client";
+export type { SamplingCreateMessageParams, SamplingCreateMessageResult, } from "../core/config.js";
+import type { SamplingCreateMessageParams, SamplingCreateMessageResult } from "../core/config.js";
+/** JSON-RPC envelope for `sampling/createMessage`. */
+export type SamplingCreateMessageRequest = {
+    method: "sampling/createMessage";
+    params: SamplingCreateMessageParams;
+};
+/** @deprecated Use {@link SamplingCreateMessageRequest}. */
+export type { SamplingCreateMessageRequest as CreateMessageRequest };
+/** @deprecated Use {@link SamplingCreateMessageResult}. */
+export type { SamplingCreateMessageResult as CreateMessageResult };
+export { specTypeSchemas } from "@modelcontextprotocol/client";
+export { McpClientProvider, useMcpClient, useMcpServer, } from "./McpClientProvider.js";
+export type { McpClientContextType, McpClientProviderProps, } from "./McpClientProvider.js";
+export { LocalStorageProvider, MemoryStorageProvider, type CachedServerMetadata, type StorageProvider, } from "./storage.js";
+export { getRpcLogs, getAllRpcLogs, subscribeToRpcLogs, clearRpcLogs, type RpcLogEntry, } from "./rpc-logger.js";
+export { ViewRenderer, resolveViewResource, getViewResourceUri, isViewResource, isViewTool, parseCustomProps, buildViewSandboxBlobUrl, type ViewRendererProps, type ViewConnection, type ViewDisplayMode, type ViewCspMode, type ViewRendererSource, type ResolvedViewResource, type ViewCspViolation, type ViewLifecycleEvent, type ViewLifecycleStatus, type McpUiHostCapabilities, type McpUiHostContext, type McpUiResourceCsp, type McpUiResourcePermissions, } from "./view/ViewRenderer.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,EACV,aAAa,EACb,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACT,eAAe;AACf,sCAAsC;AACtC,gBAAgB,EAChB,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAGzD,OAAO,EACL,GAAG,EACH,SAAS,EACT,kBAAkB,GACnB,MAAM,mCAAmC,CAAC;AAG3C,YAAY,EACV,cAAc,EACd,YAAY,EACZ,uBAAuB,EACvB,sBAAsB,EACtB,YAAY,EACZ,eAAe,EACf,cAAc,EACd,MAAM,EACN,kBAAkB,EAClB,QAAQ,EACR,oBAAoB,EACpB,IAAI,EACJ,SAAS,GACV,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,2BAA2B,EAC3B,2BAA2B,GAC5B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,2BAA2B,EAC3B,2BAA2B,EAC5B,MAAM,mBAAmB,CAAC;AAC3B,sDAAsD;AACtD,MAAM,MAAM,4BAA4B,GAAG;IACzC,MAAM,EAAE,wBAAwB,CAAC;IACjC,MAAM,EAAE,2BAA2B,CAAC;CACrC,CAAC;AACF,4DAA4D;AAC5D,YAAY,EAAE,4BAA4B,IAAI,oBAAoB,EAAE,CAAC;AACrE,2DAA2D;AAC3D,YAAY,EAAE,2BAA2B,IAAI,mBAAmB,EAAE,CAAC;AACnE,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAG/D,OAAO,EACL,iBAAiB,EACjB,YAAY,EACZ,YAAY,GACb,MAAM,wBAAwB,CAAC;AAChC,YAAY,EACV,oBAAoB,EACpB,sBAAsB,GACvB,MAAM,wBAAwB,CAAC;AAGhC,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,oBAAoB,EACzB,KAAK,eAAe,GACrB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACL,UAAU,EACV,aAAa,EACb,kBAAkB,EAClB,YAAY,EACZ,KAAK,WAAW,GACjB,MAAM,iBAAiB,CAAC;AAGzB,OAAO,EACL,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,uBAAuB,EACvB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACrB,KAAK,kBAAkB,EACvB,KAAK,mBAAmB,EACxB,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,GAC9B,MAAM,wBAAwB,CAAC"}