@mastra/mcp 0.13.3 → 0.13.4

package/dist/client/resourceActions.d.ts

@@ -5,24 +5,67 @@ interface ResourceClientActionsConfig {
     client: InternalMastraMCPClient;
     logger: IMastraLogger;
 }
+/**
+ * Client-side resource actions for interacting with MCP server resources.
+ *
+ * Provides methods to list, read, subscribe to, and manage resources exposed by an MCP server.
+ * Resources represent any kind of data that a server wants to make available (files, database
+ * records, API responses, etc.).
+ */
 export declare class ResourceClientActions {
     private readonly client;
     private readonly logger;
+    /**
+     * @internal
+     */
     constructor({ client, logger }: ResourceClientActionsConfig);
     /**
-     * Get all resources from the connected MCP server.
-     * @returns A list of resources.
+     * Retrieves all available resources from the connected MCP server.
+     *
+     * Returns an empty array if the server doesn't support resources (MethodNotFound error).
+     *
+     * @returns Promise resolving to array of resources
+     * @throws {Error} If fetching resources fails (excluding MethodNotFound)
+     *
+     * @example
+     * ```typescript
+     * const resources = await client.resources.list();
+     * resources.forEach(resource => {
+     *   console.log(`${resource.name}: ${resource.uri}`);
+     * });
+     * ```
      */
     list(): Promise<Resource[]>;
     /**
-     * Get all resource templates from the connected MCP server.
-     * @returns A list of resource templates.
+     * Retrieves all available resource templates from the connected MCP server.
+     *
+     * Resource templates are URI templates (RFC 6570) that describe dynamic resources.
+     * Returns an empty array if the server doesn't support resource templates.
+     *
+     * @returns Promise resolving to array of resource templates
+     * @throws {Error} If fetching resource templates fails (excluding MethodNotFound)
+     *
+     * @example
+     * ```typescript
+     * const templates = await client.resources.templates();
+     * templates.forEach(template => {
+     *   console.log(`${template.name}: ${template.uriTemplate}`);
+     * });
+     * ```
      */
     templates(): Promise<ResourceTemplate[]>;
     /**
-     * Read a specific resource.
-     * @param uri The URI of the resource to read.
-     * @returns The resource content.
+     * Reads the content of a specific resource from the MCP server.
+     *
+     * @param uri - URI of the resource to read (e.g., 'file://path/to/file.txt')
+     * @returns Promise resolving to the resource content
+     * @throws {Error} If reading the resource fails or resource not found
+     *
+     * @example
+     * ```typescript
+     * const result = await client.resources.read('file://data/config.json');
+     * console.log(result.contents[0].text); // Resource text content
+     * ```
      */
     read(uri: string): Promise<import("zod").objectOutputType<{
         _meta: import("zod").ZodOptional<import("zod").ZodObject<{}, "passthrough", import("zod").ZodTypeAny, import("zod").objectOutputType<{}, import("zod").ZodTypeAny, "passthrough">, import("zod").objectInputType<{}, import("zod").ZodTypeAny, "passthrough">>>;
@@ -66,25 +109,72 @@ export declare class ResourceClientActions {
         }>, import("zod").ZodTypeAny, "passthrough">>]>, "many">;
     }, import("zod").ZodTypeAny, "passthrough">>;
     /**
-     * Subscribe to a specific resource.
-     * @param uri The URI of the resource to subscribe to.
+     * Subscribes to updates for a specific resource.
+     *
+     * After subscribing, you'll receive notifications via the `onUpdated` handler
+     * when the resource content changes.
+     *
+     * @param uri - URI of the resource to subscribe to
+     * @returns Promise resolving when subscription is established
+     * @throws {Error} If subscription fails
+     *
+     * @example
+     * ```typescript
+     * await client.resources.subscribe('file://data/config.json');
+     * ```
      */
     subscribe(uri: string): Promise<{}>;
     /**
-     * Unsubscribe from a specific resource.
-     * @param uri The URI of the resource to unsubscribe from.
+     * Unsubscribes from updates for a specific resource.
+     *
+     * Stops receiving notifications for this resource URI.
+     *
+     * @param uri - URI of the resource to unsubscribe from
+     * @returns Promise resolving when unsubscription is complete
+     * @throws {Error} If unsubscription fails
+     *
+     * @example
+     * ```typescript
+     * await client.resources.unsubscribe('file://data/config.json');
+     * ```
      */
     unsubscribe(uri: string): Promise<{}>;
     /**
-     * Set a notification handler for when a specific resource is updated.
-     * @param handler The callback function to handle the notification.
+     * Sets a notification handler for when subscribed resources are updated.
+     *
+     * The handler is called whenever the server sends a resource update notification
+     * for any resource you've subscribed to.
+     *
+     * @param handler - Callback function receiving the updated resource URI
+     *
+     * @example
+     * ```typescript
+     * await client.resources.onUpdated(async (params) => {
+     *   console.log(`Resource updated: ${params.uri}`);
+     *   // Re-fetch the resource
+     *   const content = await client.resources.read(params.uri);
+     *   console.log('New content:', content);
+     * });
+     * ```
      */
     onUpdated(handler: (params: {
         uri: string;
     }) => void): Promise<void>;
     /**
-     * Set a notification handler for when the list of available resources changes.
-     * @param handler The callback function to handle the notification.
+     * Sets a notification handler for when the list of available resources changes.
+     *
+     * The handler is called when resources are added or removed from the server.
+     *
+     * @param handler - Callback function invoked when the resource list changes
+     *
+     * @example
+     * ```typescript
+     * await client.resources.onListChanged(async () => {
+     *   console.log('Resource list changed, re-fetching...');
+     *   const resources = await client.resources.list();
+     *   console.log('Updated resource count:', resources.length);
+     * });
+     * ```
      */
     onListChanged(handler: () => void): Promise<void>;
 }

package/dist/client/resourceActions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resourceActions.d.ts","sourceRoot":"","sources":["../../src/client/resourceActions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAExD,UAAU,2BAA2B;IACnC,MAAM,EAAE,uBAAuB,CAAC;IAChC,MAAM,EAAE,aAAa,CAAC;CACvB;AAED,qBAAa,qBAAqB;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;gBAE3B,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,2BAA2B;IAK3D;;;OAGG;IACU,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBxC;;;OAGG;IACU,SAAS,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IA0BrD;;;;OAIG;IACU,IAAI,CAAC,GAAG,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAI7B;;;OAGG;IACU,SAAS,CAAC,GAAG,EAAE,MAAM;IAIlC;;;OAGG;IACU,WAAW,CAAC,GAAG,EAAE,MAAM;IAIpC;;;OAGG;IACU,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjF;;;OAGG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAG/D"}
+{"version":3,"file":"resourceActions.d.ts","sourceRoot":"","sources":["../../src/client/resourceActions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEzD,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,oCAAoC,CAAC;AACrF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,UAAU,CAAC;AAExD,UAAU,2BAA2B;IACnC,MAAM,EAAE,uBAAuB,CAAC;IAChC,MAAM,EAAE,aAAa,CAAC;CACvB;AAED;;;;;;GAMG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IAEvC;;OAEG;gBACS,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,2BAA2B;IAK3D;;;;;;;;;;;;;;;OAeG;IACU,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAyBxC;;;;;;;;;;;;;;;;OAgBG;IACU,SAAS,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;IA0BrD;;;;;;;;;;;;OAYG;IACU,IAAI,CAAC,GAAG,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAI7B;;;;;;;;;;;;;;OAcG;IACU,SAAS,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;;;;;;;;;;OAaG;IACU,WAAW,CAAC,GAAG,EAAE,MAAM;IAIpC;;;;;;;;;;;;;;;;;OAiBG;IACU,SAAS,CAAC,OAAO,EAAE,CAAC,MAAM,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAIjF;;;;;;;;;;;;;;;OAeG;IACU,aAAa,CAAC,OAAO,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;CAG/D"}