@mcp-use/client 2.0.0-beta.16 → 2.0.0-beta.17

package/dist/react/McpClientProvider.d.ts

@@ -7,6 +7,7 @@ import type { McpServer, McpServerConfig, PendingElicitationRequest, PendingSamp
  * Context value for multi-server management
  */
 export interface McpClientContextType {
+    /** Managed servers and their current reactive state. */
     servers: McpServer[];
     /** Idempotent — safe to call multiple times with the same id; duplicates are silently ignored. */
     addServer: (id: string, config: McpServerConfig) => void;
@@ -24,10 +25,13 @@ export interface McpClientContextType {
     removeServer: (id: string, opts?: {
         clearCredentials?: boolean;
     }) => Promise<void>;
+    /** Updates cached presentation metadata for a managed server. */
     updateServerMetadata: (id: string, metadata: {
         name: string;
     }) => Promise<void>;
+    /** Merges configuration changes into a managed server. */
     updateServer: (id: string, options: Partial<McpServerConfig>) => Promise<void>;
+    /** Returns a managed server by ID. */
     getServer: (id: string) => McpServer | undefined;
     /** Whether storage has finished loading (true if no storage provider) */
     storageLoaded: boolean;
@@ -36,6 +40,7 @@ export interface McpClientContextType {
  * Props for McpClientProvider
  */
 export interface McpClientProviderProps {
+    /** React subtree that can access the MCP client context. */
     children: ReactNode;
     /**
      * Initial servers configuration (like Python MCPClient.from_dict)
@@ -57,7 +62,9 @@ export interface McpClientProviderProps {
      * Can be overridden per-server in addServer() options
      */
     defaultProxyConfig?: {
+        /** Default MCP proxy endpoint. */
         proxyAddress?: string;
+        /** Default headers sent to the MCP proxy. */
         headers?: Record<string, string>;
     };
     /**
@@ -67,7 +74,9 @@ export interface McpClientProviderProps {
      * @defaultValue false
      */
     defaultAutoProxyFallback?: boolean | {
+        /** Whether automatic proxy fallback is enabled. */
         enabled?: boolean;
+        /** Proxy endpoint used after direct connection fails. */
         proxyAddress?: string;
     };
     /**
@@ -95,8 +104,11 @@ export interface McpClientProviderProps {
         description?: string;
         /** Client icons (first icon used as logo_uri for OAuth) */
         icons?: Array<{
+            /** Icon URL. */
             src: string;
+            /** Icon media type. */
             mimeType?: string;
+            /** Supported icon sizes, such as `"48x48"`. */
             sizes?: string[];
         }>;
         /** Client website URL (used as client_uri for OAuth) */
@@ -143,20 +155,20 @@ export interface McpClientProviderProps {
     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
+     * @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
+     * @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;
 }

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

@@ -1 +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,EAEvB,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,qBAojBxB;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,YAAY,IAAI,oBAAoB,CAMnD;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAM9D"}
+{"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,EAEvB,MAAM,YAAY,CAAC;AAUpB;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,wDAAwD;IACxD,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,iEAAiE;IACjE,oBAAoB,EAAE,CACpB,EAAE,EAAE,MAAM,EACV,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,KACvB,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,0DAA0D;IAC1D,YAAY,EAAE,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,sCAAsC;IACtC,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,4DAA4D;IAC5D,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,kCAAkC;QAClC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,6CAA6C;QAC7C,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KAClC,CAAC;IAEF;;;;;OAKG;IACH,wBAAwB,CAAC,EACrB,OAAO,GACP;QACE,mDAAmD;QACnD,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,yDAAyD;QACzD,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,gBAAgB;YAChB,GAAG,EAAE,MAAM,CAAC;YACZ,uBAAuB;YACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,+CAA+C;YAC/C,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,qBAojBxB;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

@@ -18,7 +18,9 @@ export type { SamplingCreateMessageParams, SamplingCreateMessageResult, } from "
 import type { SamplingCreateMessageParams, SamplingCreateMessageResult } from "../core/config.js";
 /** JSON-RPC envelope for `sampling/createMessage`. */
 export type SamplingCreateMessageRequest = {
+    /** JSON-RPC method name. */
     method: "sampling/createMessage";
+    /** Sampling request parameters. */
     params: SamplingCreateMessageParams;
 };
 /** @deprecated Use {@link SamplingCreateMessageRequest}. */

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

@@ -1 +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,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAChF,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,oBAAoB,EACpB,gBAAgB,EAChB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,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,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,oCAAoC,GAC1C,MAAM,wBAAwB,CAAC"}
+{"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,eAAe,EACf,sBAAsB,EACtB,yBAAyB,GAC1B,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAChF,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,4BAA4B;IAC5B,MAAM,EAAE,wBAAwB,CAAC;IACjC,mCAAmC;IACnC,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,oBAAoB,EACpB,gBAAgB,EAChB,yBAAyB,EACzB,uBAAuB,EACvB,mBAAmB,EACnB,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,wBAAwB,EAC7B,KAAK,uBAAuB,EAC5B,KAAK,qBAAqB,EAC1B,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,wBAAwB,EAC7B,KAAK,oCAAoC,GAC1C,MAAM,wBAAwB,CAAC"}

package/dist/react/index.js

@@ -517,6 +517,11 @@ var BaseConnector = class {
   notificationHandlers = [];
   rootsCache = [];
   activeProgressHandlers = /* @__PURE__ */ new Set();
+  /**
+   * Creates a connector with shared SDK and callback options.
+   *
+   * @param opts - Connector initialization options.
+   */
   constructor(opts = {}) {
     this.opts = opts;
     if (opts.roots) {
@@ -699,7 +704,9 @@ var BaseConnector = class {
     }
   }
   /**
-   * Get the current roots.
+   * Returns the roots currently advertised to the server.
+   *
+   * @returns A copy of the configured roots.
    */
   getRoots() {
     return [...this.rootsCache];
@@ -768,7 +775,11 @@ var BaseConnector = class {
       "setupElicitationHandler: Elicitation handler registered successfully"
     );
   }
-  /** Disconnect and release resources. */
+  /**
+   * Disconnects the SDK client and releases transport resources.
+   *
+   * @returns A promise that resolves after cleanup completes.
+   */
   async disconnect() {
     if (!this.connected) {
       logger.debug("Not connected to MCP implementation");
@@ -779,7 +790,7 @@ var BaseConnector = class {
     this.connected = false;
     logger.debug("Disconnected from MCP implementation");
   }
-  /** Check if the client is connected */
+  /** Whether an SDK client currently exists for this connector. */
   get isClientConnected() {
     return this.client != null;
   }
@@ -789,6 +800,10 @@ var BaseConnector = class {
    * In the SDK, `Client.connect(transport)` automatically performs the
    * protocol‑level `initialize` handshake, so we only need to cache the list of
    * tools and expose some server info.
+   *
+   * @param defaultRequestOptions - Options used while fetching the initial tool list.
+   * @returns The capabilities advertised by the server.
+   * @throws When {@link BaseConnector.connect} has not completed.
    */
   async initialize(defaultRequestOptions = this.opts.defaultRequestOptions ?? {}) {
     if (!this.client) {
@@ -826,18 +841,22 @@ var BaseConnector = class {
     logger.debug("Server info:", serverInfo);
     return capabilities;
   }
-  /** Lazily expose the cached tools list. */
+  /**
+   * Returns the tool list cached during initialization.
+   *
+   * @throws When {@link BaseConnector.initialize} has not completed.
+   */
   get tools() {
     if (!this.toolsCache) {
       throw new Error("MCP client is not initialized; call initialize() first");
     }
     return this.toolsCache;
   }
-  /** Expose cached server capabilities. */
+  /** Capabilities cached during initialization, or an empty object. */
   get serverCapabilities() {
     return this.capabilitiesCache || {};
   }
-  /** Expose cached server info. */
+  /** Server identity cached during initialization, or `null`. */
   get serverInfo() {
     return this.serverInfoCache;
   }
@@ -858,7 +877,15 @@ var BaseConnector = class {
   get negotiatedProtocolVersion() {
     return this.client?.getNegotiatedProtocolVersion?.();
   }
-  /** Call a tool on the server. */
+  /**
+   * Calls a tool on the connected server.
+   *
+   * @param name - Tool name.
+   * @param args - Tool arguments.
+   * @param options - Per-request timeout, cancellation, and progress options.
+   * @returns The tool result returned by the server.
+   * @throws When the connector is not connected or the tool call fails.
+   */
   async callTool(name, args, options) {
     if (!this.client) {
       throw new Error("MCP client is not connected");
@@ -983,7 +1010,13 @@ var BaseConnector = class {
     );
     return result;
   }
-  /** Read a resource by URI. */
+  /**
+   * Reads a resource by URI.
+   *
+   * @param uri - Resource URI to read.
+   * @param options - Per-request options.
+   * @returns The resource contents returned by the server.
+   */
   async readResource(uri, options) {
     if (!this.client) {
       throw new Error("MCP client is not connected");
@@ -1018,6 +1051,11 @@ var BaseConnector = class {
     logger.debug(`Unsubscribing from resource: ${uri}`);
     return await this.client.unsubscribeResource({ uri }, options);
   }
+  /**
+   * Lists prompts exposed by the server.
+   *
+   * @returns The prompt list, or an empty list when prompts are unsupported.
+   */
   async listPrompts() {
     if (!this.client) {
       throw new Error("MCP client is not connected");
@@ -1038,6 +1076,13 @@ var BaseConnector = class {
       throw err;
     }
   }
+  /**
+   * Gets a prompt with the supplied arguments.
+   *
+   * @param name - Prompt name.
+   * @param args - Prompt arguments.
+   * @returns The rendered prompt returned by the server.
+   */
   async getPrompt(name, args) {
     if (!this.client) {
       throw new Error("MCP client is not connected");
@@ -1045,7 +1090,14 @@ var BaseConnector = class {
     logger.debug(`Getting prompt ${name}`);
     return await this.client.getPrompt({ name, arguments: args });
   }
-  /** Send a raw request through the client. */
+  /**
+   * Sends a raw, potentially non-standard request through the SDK client.
+   *
+   * @param method - JSON-RPC method name.
+   * @param params - Request parameters. Defaults to an empty object.
+   * @param options - Per-request options.
+   * @returns The unvalidated result returned by the server.
+   */
   async request(method, params = null, options) {
     if (!this.client) {
       throw new Error("MCP client is not connected");
@@ -1144,6 +1196,12 @@ var HttpConnector = class extends BaseConnector {
   reconnectionOptions;
   transportType = null;
   streamableTransport = null;
+  /**
+   * Creates an HTTP connector.
+   *
+   * @param baseUrl - MCP endpoint URL.
+   * @param opts - Authentication, transport, SDK, and reconnection options.
+   */
   constructor(baseUrl, opts = {}) {
     super(opts);
     const originalUrl = baseUrl.replace(/\/$/, "");
@@ -1261,7 +1319,12 @@ var HttpConnector = class extends BaseConnector {
     }
     return { fallbackReason, is401Error, httpStatusCode };
   }
-  /** Establish connection to the MCP implementation via streamable HTTP. */
+  /**
+   * Establishes a streamable HTTP connection to the MCP server.
+   *
+   * @returns A promise that resolves after protocol negotiation completes.
+   * @throws An error with `code: 401` when authentication is required.
+   */
   async connect() {
     if (this.connected) {
       logger.debug("Already connected to MCP implementation");
@@ -1489,6 +1552,11 @@ var HttpConnector = class extends BaseConnector {
       throw err;
     }
   }
+  /**
+   * Returns fields that identify the endpoint and negotiated transport.
+   *
+   * @returns HTTP connector identity metadata.
+   */
   get publicIdentifier() {
     return {
       type: "http",
@@ -1497,7 +1565,11 @@ var HttpConnector = class extends BaseConnector {
       protocolEra: this.protocolEra ?? "unknown"
     };
   }
-  /** Get the active transport type (`streamable-http` once connected). */
+  /**
+   * Returns the active transport type.
+   *
+   * @returns `"streamable-http"` after connection, otherwise `null`.
+   */
   getTransportType() {
     return this.transportType;
   }
@@ -1534,7 +1606,7 @@ var HttpConnector = class extends BaseConnector {
 };
 
 // src/utils/version.ts
-var VERSION = "2.0.0-beta.16";
+var VERSION = "2.0.0-beta.17";
 function getPackageVersion() {
   return VERSION;
 }
@@ -2129,11 +2201,14 @@ function trimTrailingSlashes(value) {
   return value.slice(0, end);
 }
 var BrowserOAuthClientProvider = class {
+  /** Protected MCP server URL associated with this provider. */
   serverUrl;
+  /** Pre-registered public client information, when configured. */
   staticClientInfo;
   session;
   storage;
   // Browser-only state
+  /** Whether initial connection waits for explicit authentication. */
   preventAutoAuth;
   useRedirectFlow;
   oauthProxyUrl;
@@ -2141,6 +2216,7 @@ var BrowserOAuthClientProvider = class {
   proxyOAuthRequests;
   lastAttemptedAuthUrl = null;
   authorizationPending = false;
+  /** Callback invoked immediately before an authorization popup opens. */
   onPopupWindow;
   constructor(serverUrl, options = {}) {
     if (options.staticClientInfo?.client_secret) {
@@ -2164,36 +2240,51 @@ var BrowserOAuthClientProvider = class {
     this.onPopupWindow = options.onPopupWindow;
   }
   // --- Identity / key fields exposed for callback handling ---
+  /** Prefix used for persisted OAuth keys. */
   get storageKeyPrefix() {
     return this.session.storageKeyPrefix;
   }
+  /** Stable hash used to namespace storage for this server. */
   get serverUrlHash() {
     return this.session.serverUrlHash;
   }
+  /** Human-readable OAuth client name. */
   get clientName() {
     return this.session.clientName;
   }
+  /** Public website describing the OAuth client. */
   get clientUri() {
     return this.session.clientUri;
   }
+  /** Public OAuth client logo URL. */
   get logoUri() {
     return this.session.logoUri;
   }
+  /** OAuth redirect URI. */
   get callbackUrl() {
     return this.session.callbackUrl;
   }
+  /** Space-delimited OAuth scopes requested by the client. */
   get scope() {
     return this.session.scope;
   }
   get clientMetadataUrl() {
     return this.session.clientMetadataUrl;
   }
+  /**
+   * Returns a provider-scoped storage key.
+   *
+   * @param keySuffix - Suffix identifying the stored value.
+   * @returns Namespaced storage key.
+   */
   getKey(keySuffix) {
     return this.session.getKey(keySuffix);
   }
+  /** Whether an authorization flow is awaiting completion. */
   get hasPendingFlow() {
     return this.authorizationPending;
   }
+  /** Marks the current authorization flow as complete. */
   markFlowComplete() {
     this.authorizationPending = false;
   }
@@ -2380,10 +2471,25 @@ var BrowserOAuthClientProvider = class {
     this.authorizationPending = false;
     return this.session.saveTokens(tokens, ctx);
   }
+  /**
+   * Returns the configured or dynamically registered OAuth client information.
+   *
+   * @param ctx - Optional registration context.
+   * @returns OAuth client information, or `undefined` when not registered.
+   */
   async clientInformation(ctx) {
     if (this.staticClientInfo) return this.staticClientInfo;
     return this.session.clientInformation(ctx);
   }
+  /**
+   * Persists public OAuth client registration information.
+   *
+   * Static client configuration takes precedence, and browser providers discard
+   * any client secret returned for a public client.
+   *
+   * @param clientInformation - Registration information to save.
+   * @param ctx - Optional registration context.
+   */
   async saveClientInformation(clientInformation, ctx) {
     if (this.staticClientInfo) return;
     const { client_secret: discardedClientSecret, ...publicClientInformation } = clientInformation;
@@ -2463,7 +2569,7 @@ var BrowserOAuthClientProvider = class {
   }
   /**
    * Redirects the user agent to the authorization URL, storing necessary state.
-   * @param authorizationUrl The fully constructed authorization URL from the SDK.
+   * @param authorizationUrl - The fully constructed authorization URL from the SDK.
    */
   async redirectToAuthorization(authorizationUrl) {
     const sanitizedAuthUrl = await this.prepareAuthorizationUrl(authorizationUrl);
@@ -2513,6 +2619,11 @@ var BrowserOAuthClientProvider = class {
   getLastAttemptedAuthUrl() {
     return this.lastAttemptedAuthUrl;
   }
+  /**
+   * Removes OAuth state stored for this server.
+   *
+   * @returns The number of storage entries removed.
+   */
   clearStorage() {
     this.lastAttemptedAuthUrl = null;
     this.authorizationPending = false;
@@ -3374,7 +3485,7 @@ var MCPConnection = class {
   /**
    * Normalized server metadata for this ready connection.
    *
-   * @throws {Error} When called before protocol negotiation completes.
+   * @throws When called before protocol negotiation completes.
    */
   get info() {
     const protocolEra = this.protocolEra;
@@ -3595,12 +3706,10 @@ function isOAuthClientProvider(provider) {
 var BaseMCPClient = class {
   /**
    * Internal configuration object containing MCP server definitions.
-   * @protected
    */
   config = {};
   /**
    * Map of server names to their active sessions.
-   * @protected
    */
   sessions = {};
   /**
@@ -3644,7 +3753,7 @@ var BaseMCPClient = class {
    *
    * @param _cfg - Configuration dictionary
    * @returns Client instance
-   * @throws {Error} If called on the base class instead of a concrete implementation
+   * @throws If called on the base class instead of a concrete implementation
    *
    * @example
    * ```typescript
@@ -3786,7 +3895,7 @@ var BaseMCPClient = class {
    * @param serverName - The name of the server as defined in the client configuration
    * @param autoInitialize - Whether to automatically initialize the session (default: true)
    * @returns A promise that resolves to the created MCPSession instance
-   * @throws {Error} If the server is not found in the configuration
+   * @throws If the server is not found in the configuration
    *
    * @example
    * ```typescript
@@ -3956,7 +4065,7 @@ var BaseMCPClient = class {
    *
    * @param serverName - Name of the server
    * @returns The session instance
-   * @throws {Error} If the session is not found
+   * @throws If the session is not found
    *
    * @example
    * ```typescript
@@ -4125,16 +4234,28 @@ function trackBrowserClientInit(config) {
 }
 var BrowserMCPClient = class _BrowserMCPClient extends BaseMCPClient {
   /**
-   * Get the mcp-use package version.
-   * Works in all environments (Node.js, browser, Cloudflare Workers, Deno, etc.)
+   * Returns the installed `@mcp-use/client` package version.
+   *
+   * @returns The package version string.
    */
   static getPackageVersion() {
     return getPackageVersion();
   }
+  /**
+   * Creates a browser MCP client.
+   *
+   * @param config - Client configuration containing an optional `mcpServers` map.
+   */
   constructor(config) {
     super(config);
     trackBrowserClientInit(this.config);
   }
+  /**
+   * Creates a browser client from an inline configuration object.
+   *
+   * @param cfg - Client configuration containing an optional `mcpServers` map.
+   * @returns A browser client initialized with `cfg`.
+   */
   static fromDict(cfg) {
     return new _BrowserMCPClient(cfg);
   }
@@ -7011,11 +7132,18 @@ function useMcpServer(id) {
 
 // src/react/storage.ts
 var LocalStorageProvider = class {
+  /**
+   * Creates a browser storage provider.
+   *
+   * @param storageKey - Key used for configurations. Metadata uses the same key
+   * with a `-metadata` suffix. Defaults to `"mcp-client-servers"`.
+   */
   constructor(storageKey = "mcp-client-servers") {
     this.storageKey = storageKey;
     this.metadataKey = `${storageKey}-metadata`;
   }
   metadataKey;
+  /** Returns sanitized server configurations from `localStorage`. */
   getServers() {
     try {
       const stored = localStorage.getItem(this.storageKey);
@@ -7050,6 +7178,7 @@ var LocalStorageProvider = class {
       return {};
     }
   }
+  /** Replaces all saved server configurations. */
   setServers(servers) {
     try {
       const sanitized = Object.fromEntries(
@@ -7063,17 +7192,20 @@ var LocalStorageProvider = class {
       console.error("[LocalStorageProvider] Failed to save servers.");
     }
   }
+  /** Saves one server configuration. */
   setServer(id, config) {
     const servers = this.getServers();
     servers[id] = config;
     this.setServers(servers);
   }
+  /** Removes one server and its cached metadata. */
   removeServer(id) {
     const servers = this.getServers();
     delete servers[id];
     this.setServers(servers);
     this.removeServerMetadata(id);
   }
+  /** Removes all saved configurations and metadata. */
   clear() {
     try {
       localStorage.removeItem(this.storageKey);
@@ -7098,14 +7230,17 @@ var LocalStorageProvider = class {
       console.error("[LocalStorageProvider] Failed to save metadata.");
     }
   }
+  /** Returns cached presentation metadata for a server. */
   getServerMetadata(id) {
     return this.getAllMetadata()[id];
   }
+  /** Saves presentation metadata and stamps the current cache time. */
   setServerMetadata(id, metadata) {
     const allMetadata = this.getAllMetadata();
     allMetadata[id] = { ...metadata, cachedAt: Date.now() };
     this.setAllMetadata(allMetadata);
   }
+  /** Removes cached presentation metadata for a server. */
   removeServerMetadata(id) {
     const allMetadata = this.getAllMetadata();
     delete allMetadata[id];
@@ -7115,9 +7250,11 @@ var LocalStorageProvider = class {
 var MemoryStorageProvider = class {
   storage = {};
   metadata = {};
+  /** Returns a shallow copy of all stored server configurations. */
   getServers() {
     return { ...this.storage };
   }
+  /** Replaces all stored server configurations. */
   setServers(servers) {
     this.storage = Object.fromEntries(
       Object.entries(servers).map(([id, config]) => [
@@ -7126,23 +7263,29 @@ var MemoryStorageProvider = class {
       ])
     );
   }
+  /** Stores one server configuration. */
   setServer(id, config) {
     this.storage[id] = toPersistedServerConfig(config);
   }
+  /** Removes one server and its cached metadata. */
   removeServer(id) {
     delete this.storage[id];
     this.removeServerMetadata(id);
   }
+  /** Removes all configurations and metadata. */
   clear() {
     this.storage = {};
     this.metadata = {};
   }
+  /** Returns cached presentation metadata for a server. */
   getServerMetadata(id) {
     return this.metadata[id];
   }
+  /** Saves presentation metadata and stamps the current cache time. */
   setServerMetadata(id, metadata) {
     this.metadata[id] = { ...metadata, cachedAt: Date.now() };
   }
+  /** Removes cached presentation metadata for a server. */
   removeServerMetadata(id) {
     delete this.metadata[id];
   }