@mastra/client-js 0.0.0-share-agent-metadata-with-cloud-20250718123411 → 0.0.0-stream-vnext-usage-20250908171242

package/README.md

@@ -53,8 +53,10 @@ const client = new MastraClient({
 - `getAgents()`: Get all available agents
 - `getAgent(agentId)`: Get a specific agent instance
   - `agent.details()`: Get agent details
-  - `agent.generate(params)`: Generate a response
-  - `agent.stream(params)`: Stream a response
+  - `agent.generate(params)`: Generate a response (deprecated)
+  - `agent.generateVNext(params)`: Improved API for generating a response
+  - `agent.stream(params)`: Stream a response (deprecated)
+  - `agent.streamVNext(params)`: Improved API for streaming a response
   - `agent.getTool(toolId)`: Get agent tool details
   - `agent.evals()`: Get agent evaluations
   - `agent.liveEvals()`: Get live evaluations
@@ -80,8 +82,9 @@ const client = new MastraClient({
 - `getWorkflow(workflowId)`: Get a workflow instance
   - `workflow.details()`: Get workflow details
   - `workflow.createRun()`: Create workflow run
+  - `workflow.createRunAsync()`: Create workflow run (alias)
   - `workflow.startAsync(params)`: Execute the workflow and wait for execution results
-  - `workflow.resumeAsync(parmas)`: Resume suspended workflow step async
+  - `workflow.resumeAsync(params)`: Resume suspended workflow step async
   - `workflow.watch({runId},(record)=>{})`: Watch the step transitions of the workflow run
   - `workflow.start({runId, triggerData})`: Start a workflow run sync
   - `workflow.resume(params)`: Resume the workflow run sync

package/dist/client.d.ts

@@ -0,0 +1,280 @@
+import type { AITraceRecord, AITracesPaginatedArg, WorkflowInfo } from '@mastra/core';
+import type { ServerDetailInfo } from '@mastra/core/mcp';
+import { Agent, MemoryThread, Tool, Workflow, Vector, BaseResource, Network, A2A, MCPTool, LegacyWorkflow, AgentBuilder } from './resources/index.js';
+import { NetworkMemoryThread } from './resources/network-memory-thread.js';
+import { VNextNetwork } from './resources/vNextNetwork.js';
+import type { ClientOptions, CreateMemoryThreadParams, CreateMemoryThreadResponse, GetAgentResponse, GetLogParams, GetLogsParams, GetLogsResponse, GetMemoryThreadParams, GetMemoryThreadResponse, GetNetworkResponse, GetTelemetryParams, GetTelemetryResponse, GetToolResponse, GetWorkflowResponse, SaveMessageToMemoryParams, SaveMessageToMemoryResponse, McpServerListResponse, McpServerToolListResponse, GetLegacyWorkflowResponse, GetVNextNetworkResponse, GetNetworkMemoryThreadParams, CreateNetworkMemoryThreadParams, SaveNetworkMessageToMemoryParams, GetScorerResponse, GetScoresByScorerIdParams, GetScoresResponse, GetScoresByRunIdParams, GetScoresByEntityIdParams, SaveScoreParams, SaveScoreResponse, GetAITracesResponse } from './types.js';
+export declare class MastraClient extends BaseResource {
+    private observability;
+    constructor(options: ClientOptions);
+    /**
+     * Retrieves all available agents
+     * @returns Promise containing map of agent IDs to agent details
+     */
+    getAgents(): Promise<Record<string, GetAgentResponse>>;
+    /**
+     * Gets an agent instance by ID
+     * @param agentId - ID of the agent to retrieve
+     * @returns Agent instance
+     */
+    getAgent(agentId: string): Agent;
+    /**
+     * Retrieves memory threads for a resource
+     * @param params - Parameters containing the resource ID
+     * @returns Promise containing array of memory threads
+     */
+    getMemoryThreads(params: GetMemoryThreadParams): Promise<GetMemoryThreadResponse>;
+    /**
+     * Creates a new memory thread
+     * @param params - Parameters for creating the memory thread
+     * @returns Promise containing the created memory thread
+     */
+    createMemoryThread(params: CreateMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
+    /**
+     * Gets a memory thread instance by ID
+     * @param threadId - ID of the memory thread to retrieve
+     * @returns MemoryThread instance
+     */
+    getMemoryThread(threadId: string, agentId: string): MemoryThread;
+    /**
+     * Saves messages to memory
+     * @param params - Parameters containing messages to save
+     * @returns Promise containing the saved messages
+     */
+    saveMessageToMemory(params: SaveMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
+    /**
+     * Gets the status of the memory system
+     * @returns Promise containing memory system status
+     */
+    getMemoryStatus(agentId: string): Promise<{
+        result: boolean;
+    }>;
+    /**
+     * Retrieves memory threads for a resource
+     * @param params - Parameters containing the resource ID
+     * @returns Promise containing array of memory threads
+     */
+    getNetworkMemoryThreads(params: GetNetworkMemoryThreadParams): Promise<GetMemoryThreadResponse>;
+    /**
+     * Creates a new memory thread
+     * @param params - Parameters for creating the memory thread
+     * @returns Promise containing the created memory thread
+     */
+    createNetworkMemoryThread(params: CreateNetworkMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
+    /**
+     * Gets a memory thread instance by ID
+     * @param threadId - ID of the memory thread to retrieve
+     * @returns MemoryThread instance
+     */
+    getNetworkMemoryThread(threadId: string, networkId: string): NetworkMemoryThread;
+    /**
+     * Saves messages to memory
+     * @param params - Parameters containing messages to save
+     * @returns Promise containing the saved messages
+     */
+    saveNetworkMessageToMemory(params: SaveNetworkMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
+    /**
+     * Gets the status of the memory system
+     * @returns Promise containing memory system status
+     */
+    getNetworkMemoryStatus(networkId: string): Promise<{
+        result: boolean;
+    }>;
+    /**
+     * Retrieves all available tools
+     * @returns Promise containing map of tool IDs to tool details
+     */
+    getTools(): Promise<Record<string, GetToolResponse>>;
+    /**
+     * Gets a tool instance by ID
+     * @param toolId - ID of the tool to retrieve
+     * @returns Tool instance
+     */
+    getTool(toolId: string): Tool;
+    /**
+     * Retrieves all available legacy workflows
+     * @returns Promise containing map of legacy workflow IDs to legacy workflow details
+     */
+    getLegacyWorkflows(): Promise<Record<string, GetLegacyWorkflowResponse>>;
+    /**
+     * Gets a legacy workflow instance by ID
+     * @param workflowId - ID of the legacy workflow to retrieve
+     * @returns Legacy Workflow instance
+     */
+    getLegacyWorkflow(workflowId: string): LegacyWorkflow;
+    /**
+     * Retrieves all available workflows
+     * @returns Promise containing map of workflow IDs to workflow details
+     */
+    getWorkflows(): Promise<Record<string, GetWorkflowResponse>>;
+    /**
+     * Gets a workflow instance by ID
+     * @param workflowId - ID of the workflow to retrieve
+     * @returns Workflow instance
+     */
+    getWorkflow(workflowId: string): Workflow;
+    /**
+     * Gets all available agent builder actions
+     * @returns Promise containing map of action IDs to action details
+     */
+    getAgentBuilderActions(): Promise<Record<string, WorkflowInfo>>;
+    /**
+     * Gets an agent builder instance for executing agent-builder workflows
+     * @returns AgentBuilder instance
+     */
+    getAgentBuilderAction(actionId: string): AgentBuilder;
+    /**
+     * Gets a vector instance by name
+     * @param vectorName - Name of the vector to retrieve
+     * @returns Vector instance
+     */
+    getVector(vectorName: string): Vector;
+    /**
+     * Retrieves logs
+     * @param params - Parameters for filtering logs
+     * @returns Promise containing array of log messages
+     */
+    getLogs(params: GetLogsParams): Promise<GetLogsResponse>;
+    /**
+     * Gets logs for a specific run
+     * @param params - Parameters containing run ID to retrieve
+     * @returns Promise containing array of log messages
+     */
+    getLogForRun(params: GetLogParams): Promise<GetLogsResponse>;
+    /**
+     * List of all log transports
+     * @returns Promise containing list of log transports
+     */
+    getLogTransports(): Promise<{
+        transports: string[];
+    }>;
+    /**
+     * List of all traces (paged)
+     * @param params - Parameters for filtering traces
+     * @returns Promise containing telemetry data
+     */
+    getTelemetry(params?: GetTelemetryParams): Promise<GetTelemetryResponse>;
+    /**
+     * Retrieves all available networks
+     * @returns Promise containing map of network IDs to network details
+     */
+    getNetworks(): Promise<Array<GetNetworkResponse>>;
+    /**
+     * Retrieves all available vNext networks
+     * @returns Promise containing map of vNext network IDs to vNext network details
+     */
+    getVNextNetworks(): Promise<Array<GetVNextNetworkResponse>>;
+    /**
+     * Gets a network instance by ID
+     * @param networkId - ID of the network to retrieve
+     * @returns Network instance
+     */
+    getNetwork(networkId: string): Network;
+    /**
+     * Gets a vNext network instance by ID
+     * @param networkId - ID of the vNext network to retrieve
+     * @returns vNext Network instance
+     */
+    getVNextNetwork(networkId: string): VNextNetwork;
+    /**
+     * Retrieves a list of available MCP servers.
+     * @param params - Optional parameters for pagination (limit, offset).
+     * @returns Promise containing the list of MCP servers and pagination info.
+     */
+    getMcpServers(params?: {
+        limit?: number;
+        offset?: number;
+    }): Promise<McpServerListResponse>;
+    /**
+     * Retrieves detailed information for a specific MCP server.
+     * @param serverId - The ID of the MCP server to retrieve.
+     * @param params - Optional parameters, e.g., specific version.
+     * @returns Promise containing the detailed MCP server information.
+     */
+    getMcpServerDetails(serverId: string, params?: {
+        version?: string;
+    }): Promise<ServerDetailInfo>;
+    /**
+     * Retrieves a list of tools for a specific MCP server.
+     * @param serverId - The ID of the MCP server.
+     * @returns Promise containing the list of tools.
+     */
+    getMcpServerTools(serverId: string): Promise<McpServerToolListResponse>;
+    /**
+     * Gets an MCPTool resource instance for a specific tool on an MCP server.
+     * This instance can then be used to fetch details or execute the tool.
+     * @param serverId - The ID of the MCP server.
+     * @param toolId - The ID of the tool.
+     * @returns MCPTool instance.
+     */
+    getMcpServerTool(serverId: string, toolId: string): MCPTool;
+    /**
+     * Gets an A2A client for interacting with an agent via the A2A protocol
+     * @param agentId - ID of the agent to interact with
+     * @returns A2A client instance
+     */
+    getA2A(agentId: string): A2A;
+    /**
+     * Retrieves the working memory for a specific thread (optionally resource-scoped).
+     * @param agentId - ID of the agent.
+     * @param threadId - ID of the thread.
+     * @param resourceId - Optional ID of the resource.
+     * @returns Working memory for the specified thread or resource.
+     */
+    getWorkingMemory({ agentId, threadId, resourceId, }: {
+        agentId: string;
+        threadId: string;
+        resourceId?: string;
+    }): Promise<unknown>;
+    /**
+     * Updates the working memory for a specific thread (optionally resource-scoped).
+     * @param agentId - ID of the agent.
+     * @param threadId - ID of the thread.
+     * @param workingMemory - The new working memory content.
+     * @param resourceId - Optional ID of the resource.
+     */
+    updateWorkingMemory({ agentId, threadId, workingMemory, resourceId, }: {
+        agentId: string;
+        threadId: string;
+        workingMemory: string;
+        resourceId?: string;
+    }): Promise<unknown>;
+    /**
+     * Retrieves all available scorers
+     * @returns Promise containing list of available scorers
+     */
+    getScorers(): Promise<Record<string, GetScorerResponse>>;
+    /**
+     * Retrieves a scorer by ID
+     * @param scorerId - ID of the scorer to retrieve
+     * @returns Promise containing the scorer
+     */
+    getScorer(scorerId: string): Promise<GetScorerResponse>;
+    getScoresByScorerId(params: GetScoresByScorerIdParams): Promise<GetScoresResponse>;
+    /**
+     * Retrieves scores by run ID
+     * @param params - Parameters containing run ID and pagination options
+     * @returns Promise containing scores and pagination info
+     */
+    getScoresByRunId(params: GetScoresByRunIdParams): Promise<GetScoresResponse>;
+    /**
+     * Retrieves scores by entity ID and type
+     * @param params - Parameters containing entity ID, type, and pagination options
+     * @returns Promise containing scores and pagination info
+     */
+    getScoresByEntityId(params: GetScoresByEntityIdParams): Promise<GetScoresResponse>;
+    /**
+     * Saves a score
+     * @param params - Parameters containing the score data to save
+     * @returns Promise containing the saved score
+     */
+    saveScore(params: SaveScoreParams): Promise<SaveScoreResponse>;
+    /**
+     * Retrieves model providers with available keys
+     * @returns Promise containing model providers with available keys
+     */
+    getModelProviders(): Promise<string[]>;
+    getAITrace(traceId: string): Promise<AITraceRecord>;
+    getAITraces(params: AITracesPaginatedArg): Promise<GetAITracesResponse>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACtF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EACL,KAAK,EACL,YAAY,EACZ,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,YAAY,EACZ,OAAO,EACP,GAAG,EACH,OAAO,EACP,cAAc,EACd,YAAY,EAEb,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,EACV,aAAa,EACb,wBAAwB,EACxB,0BAA0B,EAC1B,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,mBAAmB,EACnB,yBAAyB,EACzB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,4BAA4B,EAC5B,+BAA+B,EAC/B,gCAAgC,EAChC,iBAAiB,EACjB,yBAAyB,EACzB,iBAAiB,EACjB,sBAAsB,EACtB,yBAAyB,EACzB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB,qBAAa,YAAa,SAAQ,YAAY;IAC5C,OAAO,CAAC,aAAa,CAAgB;gBACzB,OAAO,EAAE,aAAa;IAKlC;;;OAGG;IACI,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;IAI7D;;;;OAIG;IACI,QAAQ,CAAC,OAAO,EAAE,MAAM;IAI/B;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAIxF;;;;OAIG;IACI,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAIhG;;;;OAIG;IACI,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIxD;;;;OAIG;IACI,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAOnG;;;OAGG;IACI,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAIrE;;;;OAIG;IACI,uBAAuB,CAAC,MAAM,EAAE,4BAA4B,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAItG;;;;OAIG;IACI,yBAAyB,CAAC,MAAM,EAAE,+BAA+B,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAI9G;;;;OAIG;IACI,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAIjE;;;;OAIG;IACI,0BAA0B,CAAC,MAAM,EAAE,gCAAgC,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAOjH;;;OAGG;IACI,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC;IAI9E;;;OAGG;IACI,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAI3D;;;;OAIG;IACI,OAAO,CAAC,MAAM,EAAE,MAAM;IAI7B;;;OAGG;IACI,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC;IAI/E;;;;OAIG;IACI,iBAAiB,CAAC,UAAU,EAAE,MAAM;IAI3C;;;OAGG;IACI,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAInE;;;;OAIG;IACI,WAAW,CAAC,UAAU,EAAE,MAAM;IAIrC;;;OAGG;IACI,sBAAsB,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAItE;;;OAGG;IACI,qBAAqB,CAAC,QAAQ,EAAE,MAAM;IAI7C;;;;OAIG;IACI,SAAS,CAAC,UAAU,EAAE,MAAM;IAInC;;;;OAIG;IACI,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC;IAwC/D;;;;OAIG;IACI,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC;IA4CnE;;;OAGG;IACI,gBAAgB,IAAI,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAI5D;;;;OAIG;IACI,YAAY,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAwC/E;;;OAGG;IACI,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAIxD;;;OAGG;IACI,gBAAgB,IAAI,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAIlE;;;;OAIG;IACI,UAAU,CAAC,SAAS,EAAE,MAAM;IAInC;;;;OAIG;IACI,eAAe,CAAC,SAAS,EAAE,MAAM;IAIxC;;;;OAIG;IACI,aAAa,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAYlG;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAStG;;;;OAIG;IACI,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAI9E;;;;;;OAMG;IACI,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAIlE;;;;OAIG;IACI,MAAM,CAAC,OAAO,EAAE,MAAM;IAI7B;;;;;;OAMG;IACI,gBAAgB,CAAC,EACtB,OAAO,EACP,QAAQ,EACR,UAAU,GACX,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAID;;;;;;OAMG;IACI,mBAAmB,CAAC,EACzB,OAAO,EACP,QAAQ,EACR,aAAa,EACb,UAAU,GACX,EAAE;QACD,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAUD;;;OAGG;IACI,UAAU,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IAI/D;;;;OAIG;IACI,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIvD,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAqBzF;;;;OAIG;IACI,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAenF;;;;OAIG;IACI,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAezF;;;;OAIG;IACI,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAOrE;;;OAGG;IACH,iBAAiB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAItC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAInD,WAAW,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CAGxE"}

package/dist/example.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=example.d.ts.map

package/dist/example.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.d.ts","sourceRoot":"","sources":["../src/example.ts"],"names":[],"mappings":""}