mcp-use 0.2.0 → 1.0.0

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

@@ -0,0 +1,9 @@
+/**
+ * Entry point for the React integration.
+ * Provides the useMcp hook and related types.
+ */
+export { useMcp } from './useMcp.js';
+export type { UseMcpOptions, UseMcpResult } from './types.js';
+export { onMcpAuthorization } from '../auth/callback.js';
+export type { Tool, Resource, ResourceTemplate, Prompt } from '@modelcontextprotocol/sdk/types.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/react/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAG7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAGxD,YAAY,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAA"}

package/dist/src/react/index.js

@@ -0,0 +1,11 @@
+import {
+  useMcp
+} from "../../chunk-4DEFXVWT.js";
+import {
+  onMcpAuthorization
+} from "../../chunk-YUSC6R6V.js";
+import "../../chunk-SHUYVCID.js";
+export {
+  onMcpAuthorization,
+  useMcp
+};

package/dist/src/react/types.d.ts

@@ -0,0 +1,139 @@
+import type { Tool, Resource, ResourceTemplate, Prompt } from '@modelcontextprotocol/sdk/types.js';
+export type UseMcpOptions = {
+    /** The /sse URL of your remote MCP server */
+    url?: string;
+    /** Enable/disable the connection (similar to TanStack Query). When false, no connection will be attempted (default: true) */
+    enabled?: boolean;
+    /** OAuth client name for registration (if dynamic registration is used) */
+    clientName?: string;
+    /** OAuth client URI for registration (if dynamic registration is used) */
+    clientUri?: string;
+    /** Custom callback URL for OAuth redirect (defaults to /oauth/callback on the current origin) */
+    callbackUrl?: string;
+    /** Storage key prefix for OAuth data in localStorage (defaults to "mcp:auth") */
+    storageKeyPrefix?: string;
+    /** Custom configuration for the MCP client identity */
+    clientConfig?: {
+        name?: string;
+        version?: string;
+    };
+    /** Custom headers that can be used to bypass auth */
+    customHeaders?: Record<string, string>;
+    /** Whether to enable verbose debug logging to the console and the log state */
+    debug?: boolean;
+    /** Auto retry connection if initial connection fails, with delay in ms (default: false) */
+    autoRetry?: boolean | number;
+    /** Auto reconnect if an established connection is lost, with delay in ms (default: 3000) */
+    autoReconnect?: boolean | number;
+    /** Popup window features string (dimensions and behavior) for OAuth */
+    popupFeatures?: string;
+    /** Transport type preference: 'auto' (HTTP with SSE fallback), 'http' (HTTP only), 'sse' (SSE only) */
+    transportType?: 'auto' | 'http' | 'sse';
+    /** Prevent automatic authentication popup on initial connection (default: false) */
+    preventAutoAuth?: boolean;
+    /**
+     * Callback function that is invoked just before the authentication popup window is opened.
+     * @param url The URL that will be opened in the popup.
+     * @param features The features string for the popup window.
+     */
+    onPopupWindow?: (url: string, features: string, window: globalThis.Window | null) => void;
+};
+export type UseMcpResult = {
+    /** List of tools available from the connected MCP server */
+    tools: Tool[];
+    /** List of resources available from the connected MCP server */
+    resources: Resource[];
+    /** List of resource templates available from the connected MCP server */
+    resourceTemplates: ResourceTemplate[];
+    /** List of prompts available from the connected MCP server */
+    prompts: Prompt[];
+    /**
+     * The current state of the MCP connection:
+     * - 'discovering': Checking server existence and capabilities (including auth requirements).
+     * - 'pending_auth': Authentication is required but auto-popup was prevented. User action needed.
+     * - 'authenticating': Authentication is required and the process (e.g., popup) has been initiated.
+     * - 'connecting': Establishing the SSE connection to the server.
+     * - 'loading': Connected; loading resources like the tool list.
+     * - 'ready': Connected and ready for tool calls.
+     * - 'failed': Connection or authentication failed. Check the `error` property.
+     */
+    state: 'discovering' | 'pending_auth' | 'authenticating' | 'connecting' | 'loading' | 'ready' | 'failed';
+    /** If the state is 'failed', this provides the error message */
+    error?: string;
+    /**
+     * If authentication requires user interaction (e.g., popup was blocked),
+     * this URL can be presented to the user to complete authentication manually in a new tab.
+     */
+    authUrl?: string;
+    /** Array of internal log messages (useful for debugging) */
+    log: {
+        level: 'debug' | 'info' | 'warn' | 'error';
+        message: string;
+        timestamp: number;
+    }[];
+    /**
+     * Function to call a tool on the MCP server.
+     * @param name The name of the tool to call.
+     * @param args Optional arguments for the tool.
+     * @returns A promise that resolves with the tool's result.
+     * @throws If the client is not in the 'ready' state or the call fails.
+     */
+    callTool: (name: string, args?: Record<string, unknown>) => Promise<any>;
+    /**
+     * Function to list resources from the MCP server.
+     * @returns A promise that resolves when resources are refreshed.
+     * @throws If the client is not in the 'ready' state.
+     */
+    listResources: () => Promise<void>;
+    /**
+     * Function to read a resource from the MCP server.
+     * @param uri The URI of the resource to read.
+     * @returns A promise that resolves with the resource contents.
+     * @throws If the client is not in the 'ready' state or the read fails.
+     */
+    readResource: (uri: string) => Promise<{
+        contents: Array<{
+            uri: string;
+            mimeType?: string;
+            text?: string;
+            blob?: string;
+        }>;
+    }>;
+    /**
+     * Function to list prompts from the MCP server.
+     * @returns A promise that resolves when prompts are refreshed.
+     * @throws If the client is not in the 'ready' state.
+     */
+    listPrompts: () => Promise<void>;
+    /**
+     * Function to get a specific prompt from the MCP server.
+     * @param name The name of the prompt to get.
+     * @param args Optional arguments for the prompt.
+     * @returns A promise that resolves with the prompt messages.
+     * @throws If the client is not in the 'ready' state or the get fails.
+     */
+    getPrompt: (name: string, args?: Record<string, string>) => Promise<{
+        messages: Array<{
+            role: 'user' | 'assistant';
+            content: {
+                type: string;
+                text?: string;
+                [key: string]: any;
+            };
+        }>;
+    }>;
+    /** Manually attempts to reconnect if the state is 'failed'. */
+    retry: () => void;
+    /** Disconnects the client from the MCP server. */
+    disconnect: () => void;
+    /**
+     * Manually triggers the authentication process. Useful if the initial attempt failed
+     * due to a blocked popup, allowing the user to initiate it via a button click.
+     * @returns A promise that resolves with the authorization URL opened (or intended to be opened),
+     *          or undefined if auth cannot be started.
+     */
+    authenticate: () => void;
+    /** Clears all stored authentication data (tokens, client info, etc.) for this server URL from localStorage. */
+    clearStorage: () => void;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/src/react/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/react/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,oCAAoC,CAAA;AAElG,MAAM,MAAM,aAAa,GAAG;IAC1B,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,6HAA6H;IAC7H,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,2EAA2E;IAC3E,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iGAAiG;IACjG,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,iFAAiF;IACjF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,uDAAuD;IACvD,YAAY,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,qDAAqD;IACrD,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IACtC,+EAA+E;IAC/E,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,2FAA2F;IAC3F,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC5B,4FAA4F;IAC5F,aAAa,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAChC,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,uGAAuG;IACvG,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;IACvC,oFAAoF;IACpF,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,GAAG,IAAI,KAAK,IAAI,CAAA;CAC1F,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,4DAA4D;IAC5D,KAAK,EAAE,IAAI,EAAE,CAAA;IACb,gEAAgE;IAChE,SAAS,EAAE,QAAQ,EAAE,CAAA;IACrB,yEAAyE;IACzE,iBAAiB,EAAE,gBAAgB,EAAE,CAAA;IACrC,8DAA8D;IAC9D,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB;;;;;;;;;OASG;IACH,KAAK,EAAE,aAAa,GAAG,cAAc,GAAG,gBAAgB,GAAG,YAAY,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAA;IACxG,gEAAgE;IAChE,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,4DAA4D;IAC5D,GAAG,EAAE;QAAE,KAAK,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACzF;;;;;;OAMG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IACxE;;;;OAIG;IACH,aAAa,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAClC;;;;;OAKG;IACH,YAAY,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,QAAQ,EAAE,KAAK,CAAC;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC,CAAA;IAC7H;;;;OAIG;IACH,WAAW,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAChC;;;;;;OAMG;IACH,SAAS,EAAE,CACT,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAC1B,OAAO,CAAC;QAAE,QAAQ,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;YAAC,OAAO,EAAE;gBAAE,IAAI,EAAE,MAAM,CAAC;gBAAC,IAAI,CAAC,EAAE,MAAM,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;aAAE,CAAA;SAAE,CAAC,CAAA;KAAE,CAAC,CAAA;IAC/H,+DAA+D;IAC/D,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,kDAAkD;IAClD,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,IAAI,CAAA;IACxB,+GAA+G;IAC/G,YAAY,EAAE,MAAM,IAAI,CAAA;CACzB,CAAA"}

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

@@ -0,0 +1,3 @@
+import type { UseMcpOptions, UseMcpResult } from './types.js';
+export declare function useMcp(options: UseMcpOptions): UseMcpResult;
+//# sourceMappingURL=useMcp.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"useMcp.d.ts","sourceRoot":"","sources":["../../../src/react/useMcp.ts"],"names":[],"mappings":"AAyBA,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAU7D,wBAAgB,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,YAAY,CAouB3D"}