@mastra/client-js 0.0.0-mcp-schema-serializer-20250430202337 → 0.0.0-mcp-changeset-20250707162621
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +19 -0
- package/CHANGELOG.md +796 -3
- package/README.md +1 -1
- package/dist/index.cjs +1414 -116
- package/dist/index.d.cts +533 -84
- package/dist/index.d.ts +533 -84
- package/dist/index.js +1421 -127
- package/package.json +22 -15
- package/src/adapters/agui.test.ts +180 -0
- package/src/adapters/agui.ts +239 -0
- package/src/client.ts +271 -23
- package/src/example.ts +33 -31
- package/src/index.test.ts +121 -1
- package/src/resources/a2a.ts +88 -0
- package/src/resources/agent.ts +603 -44
- package/src/resources/base.ts +2 -1
- package/src/resources/index.ts +4 -2
- package/src/resources/{vnext-workflow.ts → legacy-workflow.ts} +140 -132
- package/src/resources/mcp-tool.ts +48 -0
- package/src/resources/memory-thread.ts +13 -3
- package/src/resources/network-memory-thread.ts +63 -0
- package/src/resources/network.ts +6 -13
- package/src/resources/tool.ts +9 -2
- package/src/resources/vNextNetwork.ts +177 -0
- package/src/resources/workflow.ts +268 -95
- package/src/types.ts +192 -22
- package/src/utils/index.ts +11 -0
- package/src/utils/process-client-tools.ts +32 -0
- package/src/utils/zod-to-json-schema.ts +10 -0
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,16 @@
|
|
|
1
|
+
import { AbstractAgent } from '@ag-ui/client';
|
|
2
|
+
import { ServerInfo, MCPToolType, ServerDetailInfo } from '@mastra/core/mcp';
|
|
1
3
|
import { processDataStream } from '@ai-sdk/ui-utils';
|
|
2
|
-
import { CoreMessage, AiMessageType, StorageThreadType,
|
|
4
|
+
import { CoreMessage, AiMessageType, StorageThreadType, MastraMessageV1, LegacyWorkflowRuns, WorkflowRuns, WorkflowRun, QueryResult, GenerateReturn } from '@mastra/core';
|
|
3
5
|
import { JSONSchema7 } from 'json-schema';
|
|
4
6
|
import { ZodSchema } from 'zod';
|
|
5
|
-
import { AgentGenerateOptions, AgentStreamOptions } from '@mastra/core/agent';
|
|
6
|
-
import {
|
|
7
|
+
import { AgentGenerateOptions, AgentStreamOptions, ToolsInput } from '@mastra/core/agent';
|
|
8
|
+
import { LogLevel, BaseLogMessage } from '@mastra/core/logger';
|
|
7
9
|
import { RuntimeContext } from '@mastra/core/runtime-context';
|
|
10
|
+
import { Workflow as Workflow$1, WatchEvent, WorkflowResult } from '@mastra/core/workflows';
|
|
11
|
+
import { StepAction, StepGraph, LegacyWorkflowRunResult as LegacyWorkflowRunResult$1 } from '@mastra/core/workflows/legacy';
|
|
12
|
+
import * as stream_web from 'stream/web';
|
|
13
|
+
import { AgentCard, TaskSendParams, Task, TaskQueryParams, TaskIdParams } from '@mastra/core/a2a';
|
|
8
14
|
|
|
9
15
|
interface ClientOptions {
|
|
10
16
|
/** Base URL for API requests */
|
|
@@ -25,19 +31,35 @@ interface RequestOptions {
|
|
|
25
31
|
stream?: boolean;
|
|
26
32
|
signal?: AbortSignal;
|
|
27
33
|
}
|
|
34
|
+
type WithoutMethods<T> = {
|
|
35
|
+
[K in keyof T as T[K] extends (...args: any[]) => any ? never : T[K] extends {
|
|
36
|
+
(): any;
|
|
37
|
+
} ? never : T[K] extends undefined | ((...args: any[]) => any) ? never : K]: T[K];
|
|
38
|
+
};
|
|
28
39
|
interface GetAgentResponse {
|
|
29
40
|
name: string;
|
|
30
41
|
instructions: string;
|
|
31
42
|
tools: Record<string, GetToolResponse>;
|
|
43
|
+
workflows: Record<string, GetWorkflowResponse>;
|
|
32
44
|
provider: string;
|
|
33
45
|
modelId: string;
|
|
46
|
+
defaultGenerateOptions: WithoutMethods<AgentGenerateOptions>;
|
|
47
|
+
defaultStreamOptions: WithoutMethods<AgentStreamOptions>;
|
|
34
48
|
}
|
|
35
49
|
type GenerateParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
|
|
36
50
|
messages: string | string[] | CoreMessage[] | AiMessageType[];
|
|
37
|
-
|
|
51
|
+
output?: T;
|
|
52
|
+
experimental_output?: T;
|
|
53
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
54
|
+
clientTools?: ToolsInput;
|
|
55
|
+
} & WithoutMethods<Omit<AgentGenerateOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools'>>;
|
|
38
56
|
type StreamParams<T extends JSONSchema7 | ZodSchema | undefined = undefined> = {
|
|
39
57
|
messages: string | string[] | CoreMessage[] | AiMessageType[];
|
|
40
|
-
|
|
58
|
+
output?: T;
|
|
59
|
+
experimental_output?: T;
|
|
60
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
61
|
+
clientTools?: ToolsInput;
|
|
62
|
+
} & WithoutMethods<Omit<AgentStreamOptions<T>, 'output' | 'experimental_output' | 'runtimeContext' | 'clientTools'>>;
|
|
41
63
|
interface GetEvalsByAgentIdResponse extends GetAgentResponse {
|
|
42
64
|
evals: any[];
|
|
43
65
|
instructions: string;
|
|
@@ -50,7 +72,7 @@ interface GetToolResponse {
|
|
|
50
72
|
inputSchema: string;
|
|
51
73
|
outputSchema: string;
|
|
52
74
|
}
|
|
53
|
-
interface
|
|
75
|
+
interface GetLegacyWorkflowResponse {
|
|
54
76
|
name: string;
|
|
55
77
|
triggerSchema: string;
|
|
56
78
|
steps: Record<string, StepAction<any, any, any, any>>;
|
|
@@ -58,19 +80,30 @@ interface GetWorkflowResponse {
|
|
|
58
80
|
stepSubscriberGraph: Record<string, StepGraph>;
|
|
59
81
|
workflowId?: string;
|
|
60
82
|
}
|
|
83
|
+
interface GetWorkflowRunsParams {
|
|
84
|
+
fromDate?: Date;
|
|
85
|
+
toDate?: Date;
|
|
86
|
+
limit?: number;
|
|
87
|
+
offset?: number;
|
|
88
|
+
resourceId?: string;
|
|
89
|
+
}
|
|
90
|
+
type GetLegacyWorkflowRunsResponse = LegacyWorkflowRuns;
|
|
61
91
|
type GetWorkflowRunsResponse = WorkflowRuns;
|
|
62
|
-
type
|
|
92
|
+
type GetWorkflowRunByIdResponse = WorkflowRun;
|
|
93
|
+
type GetWorkflowRunExecutionResultResponse = WatchEvent['payload']['workflowState'];
|
|
94
|
+
type LegacyWorkflowRunResult = {
|
|
63
95
|
activePaths: Record<string, {
|
|
64
96
|
status: string;
|
|
65
97
|
suspendPayload?: any;
|
|
66
98
|
stepPath: string[];
|
|
67
99
|
}>;
|
|
68
|
-
results:
|
|
100
|
+
results: LegacyWorkflowRunResult$1<any, any, any>['results'];
|
|
69
101
|
timestamp: number;
|
|
70
102
|
runId: string;
|
|
71
103
|
};
|
|
72
|
-
interface
|
|
104
|
+
interface GetWorkflowResponse {
|
|
73
105
|
name: string;
|
|
106
|
+
description?: string;
|
|
74
107
|
steps: {
|
|
75
108
|
[key: string]: {
|
|
76
109
|
id: string;
|
|
@@ -81,14 +114,25 @@ interface GetVNextWorkflowResponse {
|
|
|
81
114
|
suspendSchema: string;
|
|
82
115
|
};
|
|
83
116
|
};
|
|
84
|
-
|
|
117
|
+
allSteps: {
|
|
118
|
+
[key: string]: {
|
|
119
|
+
id: string;
|
|
120
|
+
description: string;
|
|
121
|
+
inputSchema: string;
|
|
122
|
+
outputSchema: string;
|
|
123
|
+
resumeSchema: string;
|
|
124
|
+
suspendSchema: string;
|
|
125
|
+
isWorkflow: boolean;
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
stepGraph: Workflow$1['serializedStepGraph'];
|
|
85
129
|
inputSchema: string;
|
|
86
130
|
outputSchema: string;
|
|
87
131
|
}
|
|
88
|
-
type
|
|
132
|
+
type WorkflowWatchResult = WatchEvent & {
|
|
89
133
|
runId: string;
|
|
90
134
|
};
|
|
91
|
-
type
|
|
135
|
+
type WorkflowRunResult = WorkflowResult<any, any>;
|
|
92
136
|
interface UpsertVectorParams {
|
|
93
137
|
indexName: string;
|
|
94
138
|
vectors: number[][];
|
|
@@ -116,40 +160,79 @@ interface GetVectorIndexResponse {
|
|
|
116
160
|
count: number;
|
|
117
161
|
}
|
|
118
162
|
interface SaveMessageToMemoryParams {
|
|
119
|
-
messages:
|
|
163
|
+
messages: MastraMessageV1[];
|
|
120
164
|
agentId: string;
|
|
121
165
|
}
|
|
122
|
-
|
|
166
|
+
interface SaveNetworkMessageToMemoryParams {
|
|
167
|
+
messages: MastraMessageV1[];
|
|
168
|
+
networkId: string;
|
|
169
|
+
}
|
|
170
|
+
type SaveMessageToMemoryResponse = MastraMessageV1[];
|
|
123
171
|
interface CreateMemoryThreadParams {
|
|
124
|
-
title
|
|
125
|
-
metadata
|
|
172
|
+
title?: string;
|
|
173
|
+
metadata?: Record<string, any>;
|
|
126
174
|
resourceId: string;
|
|
127
|
-
threadId
|
|
175
|
+
threadId?: string;
|
|
128
176
|
agentId: string;
|
|
129
177
|
}
|
|
178
|
+
interface CreateNetworkMemoryThreadParams {
|
|
179
|
+
title?: string;
|
|
180
|
+
metadata?: Record<string, any>;
|
|
181
|
+
resourceId: string;
|
|
182
|
+
threadId?: string;
|
|
183
|
+
networkId: string;
|
|
184
|
+
}
|
|
130
185
|
type CreateMemoryThreadResponse = StorageThreadType;
|
|
131
186
|
interface GetMemoryThreadParams {
|
|
132
187
|
resourceId: string;
|
|
133
188
|
agentId: string;
|
|
134
189
|
}
|
|
190
|
+
interface GetNetworkMemoryThreadParams {
|
|
191
|
+
resourceId: string;
|
|
192
|
+
networkId: string;
|
|
193
|
+
}
|
|
135
194
|
type GetMemoryThreadResponse = StorageThreadType[];
|
|
136
195
|
interface UpdateMemoryThreadParams {
|
|
137
196
|
title: string;
|
|
138
197
|
metadata: Record<string, any>;
|
|
139
198
|
resourceId: string;
|
|
140
199
|
}
|
|
200
|
+
interface GetMemoryThreadMessagesParams {
|
|
201
|
+
/**
|
|
202
|
+
* Limit the number of messages to retrieve (default: 40)
|
|
203
|
+
*/
|
|
204
|
+
limit?: number;
|
|
205
|
+
}
|
|
141
206
|
interface GetMemoryThreadMessagesResponse {
|
|
142
207
|
messages: CoreMessage[];
|
|
143
208
|
uiMessages: AiMessageType[];
|
|
144
209
|
}
|
|
145
210
|
interface GetLogsParams {
|
|
146
211
|
transportId: string;
|
|
212
|
+
fromDate?: Date;
|
|
213
|
+
toDate?: Date;
|
|
214
|
+
logLevel?: LogLevel;
|
|
215
|
+
filters?: Record<string, string>;
|
|
216
|
+
page?: number;
|
|
217
|
+
perPage?: number;
|
|
147
218
|
}
|
|
148
219
|
interface GetLogParams {
|
|
149
220
|
runId: string;
|
|
150
221
|
transportId: string;
|
|
222
|
+
fromDate?: Date;
|
|
223
|
+
toDate?: Date;
|
|
224
|
+
logLevel?: LogLevel;
|
|
225
|
+
filters?: Record<string, string>;
|
|
226
|
+
page?: number;
|
|
227
|
+
perPage?: number;
|
|
151
228
|
}
|
|
152
|
-
type GetLogsResponse =
|
|
229
|
+
type GetLogsResponse = {
|
|
230
|
+
logs: BaseLogMessage[];
|
|
231
|
+
total: number;
|
|
232
|
+
page: number;
|
|
233
|
+
perPage: number;
|
|
234
|
+
hasMore: boolean;
|
|
235
|
+
};
|
|
153
236
|
type RequestFunction = (path: string, options?: RequestOptions) => Promise<any>;
|
|
154
237
|
type SpanStatus = {
|
|
155
238
|
code: number;
|
|
@@ -197,8 +280,11 @@ interface GetTelemetryParams {
|
|
|
197
280
|
page?: number;
|
|
198
281
|
perPage?: number;
|
|
199
282
|
attribute?: Record<string, string>;
|
|
283
|
+
fromDate?: Date;
|
|
284
|
+
toDate?: Date;
|
|
200
285
|
}
|
|
201
286
|
interface GetNetworkResponse {
|
|
287
|
+
id: string;
|
|
202
288
|
name: string;
|
|
203
289
|
instructions: string;
|
|
204
290
|
agents: Array<{
|
|
@@ -212,6 +298,69 @@ interface GetNetworkResponse {
|
|
|
212
298
|
};
|
|
213
299
|
state?: Record<string, any>;
|
|
214
300
|
}
|
|
301
|
+
interface GetVNextNetworkResponse {
|
|
302
|
+
id: string;
|
|
303
|
+
name: string;
|
|
304
|
+
instructions: string;
|
|
305
|
+
agents: Array<{
|
|
306
|
+
name: string;
|
|
307
|
+
provider: string;
|
|
308
|
+
modelId: string;
|
|
309
|
+
}>;
|
|
310
|
+
routingModel: {
|
|
311
|
+
provider: string;
|
|
312
|
+
modelId: string;
|
|
313
|
+
};
|
|
314
|
+
workflows: Array<{
|
|
315
|
+
name: string;
|
|
316
|
+
description: string;
|
|
317
|
+
inputSchema: string | undefined;
|
|
318
|
+
outputSchema: string | undefined;
|
|
319
|
+
}>;
|
|
320
|
+
tools: Array<{
|
|
321
|
+
id: string;
|
|
322
|
+
description: string;
|
|
323
|
+
}>;
|
|
324
|
+
}
|
|
325
|
+
interface GenerateVNextNetworkResponse {
|
|
326
|
+
task: string;
|
|
327
|
+
result: string;
|
|
328
|
+
resourceId: string;
|
|
329
|
+
resourceType: 'none' | 'tool' | 'agent' | 'workflow';
|
|
330
|
+
}
|
|
331
|
+
interface GenerateOrStreamVNextNetworkParams {
|
|
332
|
+
message: string;
|
|
333
|
+
threadId?: string;
|
|
334
|
+
resourceId?: string;
|
|
335
|
+
}
|
|
336
|
+
interface LoopStreamVNextNetworkParams {
|
|
337
|
+
message: string;
|
|
338
|
+
threadId?: string;
|
|
339
|
+
resourceId?: string;
|
|
340
|
+
maxIterations?: number;
|
|
341
|
+
}
|
|
342
|
+
interface LoopVNextNetworkResponse {
|
|
343
|
+
status: 'success';
|
|
344
|
+
result: {
|
|
345
|
+
text: string;
|
|
346
|
+
};
|
|
347
|
+
steps: WorkflowResult<any, any>['steps'];
|
|
348
|
+
}
|
|
349
|
+
interface McpServerListResponse {
|
|
350
|
+
servers: ServerInfo[];
|
|
351
|
+
next: string | null;
|
|
352
|
+
total_count: number;
|
|
353
|
+
}
|
|
354
|
+
interface McpToolInfo {
|
|
355
|
+
id: string;
|
|
356
|
+
name: string;
|
|
357
|
+
description?: string;
|
|
358
|
+
inputSchema: string;
|
|
359
|
+
toolType?: MCPToolType;
|
|
360
|
+
}
|
|
361
|
+
interface McpServerToolListResponse {
|
|
362
|
+
tools: McpToolInfo[];
|
|
363
|
+
}
|
|
215
364
|
|
|
216
365
|
declare class BaseResource {
|
|
217
366
|
readonly options: ClientOptions;
|
|
@@ -244,7 +393,9 @@ declare class AgentVoice extends BaseResource {
|
|
|
244
393
|
* @param options - Optional provider-specific options
|
|
245
394
|
* @returns Promise containing the transcribed text
|
|
246
395
|
*/
|
|
247
|
-
listen(audio: Blob, options?: Record<string, any>): Promise<
|
|
396
|
+
listen(audio: Blob, options?: Record<string, any>): Promise<{
|
|
397
|
+
text: string;
|
|
398
|
+
}>;
|
|
248
399
|
/**
|
|
249
400
|
* Get available speakers for the agent's voice provider
|
|
250
401
|
* @returns Promise containing list of available speakers
|
|
@@ -253,6 +404,13 @@ declare class AgentVoice extends BaseResource {
|
|
|
253
404
|
voiceId: string;
|
|
254
405
|
[key: string]: any;
|
|
255
406
|
}>>;
|
|
407
|
+
/**
|
|
408
|
+
* Get the listener configuration for the agent's voice provider
|
|
409
|
+
* @returns Promise containing a check if the agent has listening capabilities
|
|
410
|
+
*/
|
|
411
|
+
getListener(): Promise<{
|
|
412
|
+
enabled: boolean;
|
|
413
|
+
}>;
|
|
256
414
|
}
|
|
257
415
|
declare class Agent extends BaseResource {
|
|
258
416
|
private agentId;
|
|
@@ -268,7 +426,19 @@ declare class Agent extends BaseResource {
|
|
|
268
426
|
* @param params - Generation parameters including prompt
|
|
269
427
|
* @returns Promise containing the generated response
|
|
270
428
|
*/
|
|
271
|
-
generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T>
|
|
429
|
+
generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
|
|
430
|
+
output?: never;
|
|
431
|
+
experimental_output?: never;
|
|
432
|
+
}): Promise<GenerateReturn<T>>;
|
|
433
|
+
generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
|
|
434
|
+
output: T;
|
|
435
|
+
experimental_output?: never;
|
|
436
|
+
}): Promise<GenerateReturn<T>>;
|
|
437
|
+
generate<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: GenerateParams<T> & {
|
|
438
|
+
output?: never;
|
|
439
|
+
experimental_output: T;
|
|
440
|
+
}): Promise<GenerateReturn<T>>;
|
|
441
|
+
private processChatResponse;
|
|
272
442
|
/**
|
|
273
443
|
* Streams a response from the agent
|
|
274
444
|
* @param params - Stream parameters including prompt
|
|
@@ -277,12 +447,26 @@ declare class Agent extends BaseResource {
|
|
|
277
447
|
stream<T extends JSONSchema7 | ZodSchema | undefined = undefined>(params: StreamParams<T>): Promise<Response & {
|
|
278
448
|
processDataStream: (options?: Omit<Parameters<typeof processDataStream>[0], 'stream'>) => Promise<void>;
|
|
279
449
|
}>;
|
|
450
|
+
/**
|
|
451
|
+
* Processes the stream response and handles tool calls
|
|
452
|
+
*/
|
|
453
|
+
private processStreamResponse;
|
|
280
454
|
/**
|
|
281
455
|
* Gets details about a specific tool available to the agent
|
|
282
456
|
* @param toolId - ID of the tool to retrieve
|
|
283
457
|
* @returns Promise containing tool details
|
|
284
458
|
*/
|
|
285
459
|
getTool(toolId: string): Promise<GetToolResponse>;
|
|
460
|
+
/**
|
|
461
|
+
* Executes a tool for the agent
|
|
462
|
+
* @param toolId - ID of the tool to execute
|
|
463
|
+
* @param params - Parameters required for tool execution
|
|
464
|
+
* @returns Promise containing the tool execution results
|
|
465
|
+
*/
|
|
466
|
+
executeTool(toolId: string, params: {
|
|
467
|
+
data: any;
|
|
468
|
+
runtimeContext?: RuntimeContext;
|
|
469
|
+
}): Promise<any>;
|
|
286
470
|
/**
|
|
287
471
|
* Retrieves evaluation results for the agent
|
|
288
472
|
* @returns Promise containing agent evaluations
|
|
@@ -343,9 +527,10 @@ declare class MemoryThread extends BaseResource {
|
|
|
343
527
|
}>;
|
|
344
528
|
/**
|
|
345
529
|
* Retrieves messages associated with the thread
|
|
530
|
+
* @param params - Optional parameters including limit for number of messages to retrieve
|
|
346
531
|
* @returns Promise containing thread messages and UI messages
|
|
347
532
|
*/
|
|
348
|
-
getMessages(): Promise<GetMemoryThreadMessagesResponse>;
|
|
533
|
+
getMessages(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse>;
|
|
349
534
|
}
|
|
350
535
|
|
|
351
536
|
declare class Vector extends BaseResource {
|
|
@@ -394,28 +579,22 @@ declare class Vector extends BaseResource {
|
|
|
394
579
|
query(params: QueryVectorParams): Promise<QueryVectorResponse>;
|
|
395
580
|
}
|
|
396
581
|
|
|
397
|
-
declare class
|
|
582
|
+
declare class LegacyWorkflow extends BaseResource {
|
|
398
583
|
private workflowId;
|
|
399
584
|
constructor(options: ClientOptions, workflowId: string);
|
|
400
585
|
/**
|
|
401
|
-
* Retrieves details about the workflow
|
|
402
|
-
* @returns Promise containing workflow details including steps and graphs
|
|
403
|
-
*/
|
|
404
|
-
details(): Promise<GetWorkflowResponse>;
|
|
405
|
-
/**
|
|
406
|
-
* Retrieves all runs for a workflow
|
|
407
|
-
* @returns Promise containing workflow runs array
|
|
586
|
+
* Retrieves details about the legacy workflow
|
|
587
|
+
* @returns Promise containing legacy workflow details including steps and graphs
|
|
408
588
|
*/
|
|
409
|
-
|
|
589
|
+
details(): Promise<GetLegacyWorkflowResponse>;
|
|
410
590
|
/**
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
* @
|
|
414
|
-
* @returns Promise containing the workflow execution results
|
|
591
|
+
* Retrieves all runs for a legacy workflow
|
|
592
|
+
* @param params - Parameters for filtering runs
|
|
593
|
+
* @returns Promise containing legacy workflow runs array
|
|
415
594
|
*/
|
|
416
|
-
|
|
595
|
+
runs(params?: GetWorkflowRunsParams): Promise<GetLegacyWorkflowRunsResponse>;
|
|
417
596
|
/**
|
|
418
|
-
* Creates a new workflow run
|
|
597
|
+
* Creates a new legacy workflow run
|
|
419
598
|
* @returns Promise containing the generated run ID
|
|
420
599
|
*/
|
|
421
600
|
createRun(params?: {
|
|
@@ -424,7 +603,7 @@ declare class Workflow extends BaseResource {
|
|
|
424
603
|
runId: string;
|
|
425
604
|
}>;
|
|
426
605
|
/**
|
|
427
|
-
* Starts a workflow run synchronously without waiting for the workflow to complete
|
|
606
|
+
* Starts a legacy workflow run synchronously without waiting for the workflow to complete
|
|
428
607
|
* @param params - Object containing the runId and triggerData
|
|
429
608
|
* @returns Promise containing success message
|
|
430
609
|
*/
|
|
@@ -435,11 +614,11 @@ declare class Workflow extends BaseResource {
|
|
|
435
614
|
message: string;
|
|
436
615
|
}>;
|
|
437
616
|
/**
|
|
438
|
-
* Resumes a suspended workflow step synchronously without waiting for the workflow to complete
|
|
617
|
+
* Resumes a suspended legacy workflow step synchronously without waiting for the workflow to complete
|
|
439
618
|
* @param stepId - ID of the step to resume
|
|
440
|
-
* @param runId - ID of the workflow run
|
|
441
|
-
* @param context - Context to resume the workflow with
|
|
442
|
-
* @returns Promise containing the workflow resume results
|
|
619
|
+
* @param runId - ID of the legacy workflow run
|
|
620
|
+
* @param context - Context to resume the legacy workflow with
|
|
621
|
+
* @returns Promise containing the legacy workflow resume results
|
|
443
622
|
*/
|
|
444
623
|
resume({ stepId, runId, context, }: {
|
|
445
624
|
stepId: string;
|
|
@@ -456,9 +635,9 @@ declare class Workflow extends BaseResource {
|
|
|
456
635
|
startAsync(params: {
|
|
457
636
|
runId?: string;
|
|
458
637
|
triggerData: Record<string, any>;
|
|
459
|
-
}): Promise<
|
|
638
|
+
}): Promise<LegacyWorkflowRunResult>;
|
|
460
639
|
/**
|
|
461
|
-
* Resumes a suspended workflow step asynchronously and returns a promise that resolves when the workflow is complete
|
|
640
|
+
* Resumes a suspended legacy workflow step asynchronously and returns a promise that resolves when the workflow is complete
|
|
462
641
|
* @param params - Object containing the runId, stepId, and context
|
|
463
642
|
* @returns Promise containing the workflow resume results
|
|
464
643
|
*/
|
|
@@ -466,7 +645,7 @@ declare class Workflow extends BaseResource {
|
|
|
466
645
|
runId: string;
|
|
467
646
|
stepId: string;
|
|
468
647
|
context: Record<string, any>;
|
|
469
|
-
}): Promise<
|
|
648
|
+
}): Promise<LegacyWorkflowRunResult>;
|
|
470
649
|
/**
|
|
471
650
|
* Creates an async generator that processes a readable stream and yields records
|
|
472
651
|
* separated by the Record Separator character (\x1E)
|
|
@@ -476,13 +655,13 @@ declare class Workflow extends BaseResource {
|
|
|
476
655
|
*/
|
|
477
656
|
private streamProcessor;
|
|
478
657
|
/**
|
|
479
|
-
* Watches workflow transitions in real-time
|
|
658
|
+
* Watches legacy workflow transitions in real-time
|
|
480
659
|
* @param runId - Optional run ID to filter the watch stream
|
|
481
|
-
* @returns AsyncGenerator that yields parsed records from the workflow watch stream
|
|
660
|
+
* @returns AsyncGenerator that yields parsed records from the legacy workflow watch stream
|
|
482
661
|
*/
|
|
483
662
|
watch({ runId }: {
|
|
484
663
|
runId?: string;
|
|
485
|
-
}, onRecord: (record:
|
|
664
|
+
}, onRecord: (record: LegacyWorkflowRunResult) => void): Promise<void>;
|
|
486
665
|
}
|
|
487
666
|
|
|
488
667
|
declare class Tool extends BaseResource {
|
|
@@ -501,14 +680,15 @@ declare class Tool extends BaseResource {
|
|
|
501
680
|
execute(params: {
|
|
502
681
|
data: any;
|
|
503
682
|
runId?: string;
|
|
683
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
504
684
|
}): Promise<any>;
|
|
505
685
|
}
|
|
506
686
|
|
|
507
|
-
declare class
|
|
687
|
+
declare class Workflow extends BaseResource {
|
|
508
688
|
private workflowId;
|
|
509
689
|
constructor(options: ClientOptions, workflowId: string);
|
|
510
690
|
/**
|
|
511
|
-
* Creates an async generator that processes a readable stream and yields
|
|
691
|
+
* Creates an async generator that processes a readable stream and yields workflow records
|
|
512
692
|
* separated by the Record Separator character (\x1E)
|
|
513
693
|
*
|
|
514
694
|
* @param stream - The readable stream to process
|
|
@@ -516,17 +696,50 @@ declare class VNextWorkflow extends BaseResource {
|
|
|
516
696
|
*/
|
|
517
697
|
private streamProcessor;
|
|
518
698
|
/**
|
|
519
|
-
* Retrieves details about the
|
|
520
|
-
* @returns Promise containing
|
|
699
|
+
* Retrieves details about the workflow
|
|
700
|
+
* @returns Promise containing workflow details including steps and graphs
|
|
521
701
|
*/
|
|
522
|
-
details(): Promise<
|
|
702
|
+
details(): Promise<GetWorkflowResponse>;
|
|
523
703
|
/**
|
|
524
|
-
* Retrieves all runs for a
|
|
525
|
-
* @
|
|
704
|
+
* Retrieves all runs for a workflow
|
|
705
|
+
* @param params - Parameters for filtering runs
|
|
706
|
+
* @returns Promise containing workflow runs array
|
|
526
707
|
*/
|
|
527
|
-
runs(): Promise<GetWorkflowRunsResponse>;
|
|
708
|
+
runs(params?: GetWorkflowRunsParams): Promise<GetWorkflowRunsResponse>;
|
|
528
709
|
/**
|
|
529
|
-
*
|
|
710
|
+
* Retrieves a specific workflow run by its ID
|
|
711
|
+
* @param runId - The ID of the workflow run to retrieve
|
|
712
|
+
* @returns Promise containing the workflow run details
|
|
713
|
+
*/
|
|
714
|
+
runById(runId: string): Promise<GetWorkflowRunByIdResponse>;
|
|
715
|
+
/**
|
|
716
|
+
* Retrieves the execution result for a specific workflow run by its ID
|
|
717
|
+
* @param runId - The ID of the workflow run to retrieve the execution result for
|
|
718
|
+
* @returns Promise containing the workflow run execution result
|
|
719
|
+
*/
|
|
720
|
+
runExecutionResult(runId: string): Promise<GetWorkflowRunExecutionResultResponse>;
|
|
721
|
+
/**
|
|
722
|
+
* Cancels a specific workflow run by its ID
|
|
723
|
+
* @param runId - The ID of the workflow run to cancel
|
|
724
|
+
* @returns Promise containing a success message
|
|
725
|
+
*/
|
|
726
|
+
cancelRun(runId: string): Promise<{
|
|
727
|
+
message: string;
|
|
728
|
+
}>;
|
|
729
|
+
/**
|
|
730
|
+
* Sends an event to a specific workflow run by its ID
|
|
731
|
+
* @param params - Object containing the runId, event and data
|
|
732
|
+
* @returns Promise containing a success message
|
|
733
|
+
*/
|
|
734
|
+
sendRunEvent(params: {
|
|
735
|
+
runId: string;
|
|
736
|
+
event: string;
|
|
737
|
+
data: unknown;
|
|
738
|
+
}): Promise<{
|
|
739
|
+
message: string;
|
|
740
|
+
}>;
|
|
741
|
+
/**
|
|
742
|
+
* Creates a new workflow run
|
|
530
743
|
* @param params - Optional object containing the optional runId
|
|
531
744
|
* @returns Promise containing the runId of the created run
|
|
532
745
|
*/
|
|
@@ -536,59 +749,212 @@ declare class VNextWorkflow extends BaseResource {
|
|
|
536
749
|
runId: string;
|
|
537
750
|
}>;
|
|
538
751
|
/**
|
|
539
|
-
* Starts a
|
|
752
|
+
* Starts a workflow run synchronously without waiting for the workflow to complete
|
|
540
753
|
* @param params - Object containing the runId, inputData and runtimeContext
|
|
541
754
|
* @returns Promise containing success message
|
|
542
755
|
*/
|
|
543
756
|
start(params: {
|
|
544
757
|
runId: string;
|
|
545
758
|
inputData: Record<string, any>;
|
|
546
|
-
runtimeContext?: RuntimeContext
|
|
759
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
547
760
|
}): Promise<{
|
|
548
761
|
message: string;
|
|
549
762
|
}>;
|
|
550
763
|
/**
|
|
551
|
-
* Resumes a suspended
|
|
764
|
+
* Resumes a suspended workflow step synchronously without waiting for the workflow to complete
|
|
552
765
|
* @param params - Object containing the runId, step, resumeData and runtimeContext
|
|
553
766
|
* @returns Promise containing success message
|
|
554
767
|
*/
|
|
555
|
-
resume({ step, runId, resumeData,
|
|
768
|
+
resume({ step, runId, resumeData, ...rest }: {
|
|
556
769
|
step: string | string[];
|
|
557
770
|
runId: string;
|
|
558
771
|
resumeData?: Record<string, any>;
|
|
559
|
-
runtimeContext?: RuntimeContext
|
|
772
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
560
773
|
}): Promise<{
|
|
561
774
|
message: string;
|
|
562
775
|
}>;
|
|
563
776
|
/**
|
|
564
|
-
* Starts a
|
|
777
|
+
* Starts a workflow run asynchronously and returns a promise that resolves when the workflow is complete
|
|
565
778
|
* @param params - Object containing the optional runId, inputData and runtimeContext
|
|
566
|
-
* @returns Promise containing the
|
|
779
|
+
* @returns Promise containing the workflow execution results
|
|
567
780
|
*/
|
|
568
781
|
startAsync(params: {
|
|
782
|
+
runId?: string;
|
|
783
|
+
inputData: Record<string, any>;
|
|
784
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
785
|
+
}): Promise<WorkflowRunResult>;
|
|
786
|
+
/**
|
|
787
|
+
* Starts a workflow run and returns a stream
|
|
788
|
+
* @param params - Object containing the optional runId, inputData and runtimeContext
|
|
789
|
+
* @returns Promise containing the workflow execution results
|
|
790
|
+
*/
|
|
791
|
+
stream(params: {
|
|
569
792
|
runId?: string;
|
|
570
793
|
inputData: Record<string, any>;
|
|
571
794
|
runtimeContext?: RuntimeContext;
|
|
572
|
-
}): Promise<
|
|
795
|
+
}): Promise<stream_web.ReadableStream<{
|
|
796
|
+
type: string;
|
|
797
|
+
payload: any;
|
|
798
|
+
}>>;
|
|
573
799
|
/**
|
|
574
|
-
* Resumes a suspended
|
|
800
|
+
* Resumes a suspended workflow step asynchronously and returns a promise that resolves when the workflow is complete
|
|
575
801
|
* @param params - Object containing the runId, step, resumeData and runtimeContext
|
|
576
|
-
* @returns Promise containing the
|
|
802
|
+
* @returns Promise containing the workflow resume results
|
|
577
803
|
*/
|
|
578
804
|
resumeAsync(params: {
|
|
579
805
|
runId: string;
|
|
580
806
|
step: string | string[];
|
|
581
807
|
resumeData?: Record<string, any>;
|
|
582
|
-
runtimeContext?: RuntimeContext
|
|
583
|
-
}): Promise<
|
|
808
|
+
runtimeContext?: RuntimeContext | Record<string, any>;
|
|
809
|
+
}): Promise<WorkflowRunResult>;
|
|
584
810
|
/**
|
|
585
|
-
* Watches
|
|
811
|
+
* Watches workflow transitions in real-time
|
|
586
812
|
* @param runId - Optional run ID to filter the watch stream
|
|
587
|
-
* @returns AsyncGenerator that yields parsed records from the
|
|
813
|
+
* @returns AsyncGenerator that yields parsed records from the workflow watch stream
|
|
588
814
|
*/
|
|
589
815
|
watch({ runId }: {
|
|
590
816
|
runId?: string;
|
|
591
|
-
}, onRecord: (record:
|
|
817
|
+
}, onRecord: (record: WorkflowWatchResult) => void): Promise<void>;
|
|
818
|
+
/**
|
|
819
|
+
* Creates a new ReadableStream from an iterable or async iterable of objects,
|
|
820
|
+
* serializing each as JSON and separating them with the record separator (\x1E).
|
|
821
|
+
*
|
|
822
|
+
* @param records - An iterable or async iterable of objects to stream
|
|
823
|
+
* @returns A ReadableStream emitting the records as JSON strings separated by the record separator
|
|
824
|
+
*/
|
|
825
|
+
static createRecordStream(records: Iterable<any> | AsyncIterable<any>): ReadableStream;
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* Class for interacting with an agent via the A2A protocol
|
|
830
|
+
*/
|
|
831
|
+
declare class A2A extends BaseResource {
|
|
832
|
+
private agentId;
|
|
833
|
+
constructor(options: ClientOptions, agentId: string);
|
|
834
|
+
/**
|
|
835
|
+
* Get the agent card with metadata about the agent
|
|
836
|
+
* @returns Promise containing the agent card information
|
|
837
|
+
*/
|
|
838
|
+
getCard(): Promise<AgentCard>;
|
|
839
|
+
/**
|
|
840
|
+
* Send a message to the agent and get a response
|
|
841
|
+
* @param params - Parameters for the task
|
|
842
|
+
* @returns Promise containing the task response
|
|
843
|
+
*/
|
|
844
|
+
sendMessage(params: TaskSendParams): Promise<{
|
|
845
|
+
task: Task;
|
|
846
|
+
}>;
|
|
847
|
+
/**
|
|
848
|
+
* Get the status and result of a task
|
|
849
|
+
* @param params - Parameters for querying the task
|
|
850
|
+
* @returns Promise containing the task response
|
|
851
|
+
*/
|
|
852
|
+
getTask(params: TaskQueryParams): Promise<Task>;
|
|
853
|
+
/**
|
|
854
|
+
* Cancel a running task
|
|
855
|
+
* @param params - Parameters identifying the task to cancel
|
|
856
|
+
* @returns Promise containing the task response
|
|
857
|
+
*/
|
|
858
|
+
cancelTask(params: TaskIdParams): Promise<{
|
|
859
|
+
task: Task;
|
|
860
|
+
}>;
|
|
861
|
+
/**
|
|
862
|
+
* Send a message and subscribe to streaming updates (not fully implemented)
|
|
863
|
+
* @param params - Parameters for the task
|
|
864
|
+
* @returns Promise containing the task response
|
|
865
|
+
*/
|
|
866
|
+
sendAndSubscribe(params: TaskSendParams): Promise<Response>;
|
|
867
|
+
}
|
|
868
|
+
|
|
869
|
+
/**
|
|
870
|
+
* Represents a specific tool available on a specific MCP server.
|
|
871
|
+
* Provides methods to get details and execute the tool.
|
|
872
|
+
*/
|
|
873
|
+
declare class MCPTool extends BaseResource {
|
|
874
|
+
private serverId;
|
|
875
|
+
private toolId;
|
|
876
|
+
constructor(options: ClientOptions, serverId: string, toolId: string);
|
|
877
|
+
/**
|
|
878
|
+
* Retrieves details about this specific tool from the MCP server.
|
|
879
|
+
* @returns Promise containing the tool's information (name, description, schema).
|
|
880
|
+
*/
|
|
881
|
+
details(): Promise<McpToolInfo>;
|
|
882
|
+
/**
|
|
883
|
+
* Executes this specific tool on the MCP server.
|
|
884
|
+
* @param params - Parameters for tool execution, including data/args and optional runtimeContext.
|
|
885
|
+
* @returns Promise containing the result of the tool execution.
|
|
886
|
+
*/
|
|
887
|
+
execute(params: {
|
|
888
|
+
data?: any;
|
|
889
|
+
runtimeContext?: RuntimeContext;
|
|
890
|
+
}): Promise<any>;
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
declare class VNextNetwork extends BaseResource {
|
|
894
|
+
private networkId;
|
|
895
|
+
constructor(options: ClientOptions, networkId: string);
|
|
896
|
+
/**
|
|
897
|
+
* Retrieves details about the network
|
|
898
|
+
* @returns Promise containing vNext network details
|
|
899
|
+
*/
|
|
900
|
+
details(): Promise<GetVNextNetworkResponse>;
|
|
901
|
+
/**
|
|
902
|
+
* Generates a response from the v-next network
|
|
903
|
+
* @param params - Generation parameters including message
|
|
904
|
+
* @returns Promise containing the generated response
|
|
905
|
+
*/
|
|
906
|
+
generate(params: GenerateOrStreamVNextNetworkParams): Promise<GenerateVNextNetworkResponse>;
|
|
907
|
+
/**
|
|
908
|
+
* Generates a response from the v-next network using multiple primitives
|
|
909
|
+
* @param params - Generation parameters including message
|
|
910
|
+
* @returns Promise containing the generated response
|
|
911
|
+
*/
|
|
912
|
+
loop(params: {
|
|
913
|
+
message: string;
|
|
914
|
+
}): Promise<LoopVNextNetworkResponse>;
|
|
915
|
+
private streamProcessor;
|
|
916
|
+
/**
|
|
917
|
+
* Streams a response from the v-next network
|
|
918
|
+
* @param params - Stream parameters including message
|
|
919
|
+
* @returns Promise containing the results
|
|
920
|
+
*/
|
|
921
|
+
stream(params: GenerateOrStreamVNextNetworkParams, onRecord: (record: WatchEvent) => void): Promise<void>;
|
|
922
|
+
/**
|
|
923
|
+
* Streams a response from the v-next network loop
|
|
924
|
+
* @param params - Stream parameters including message
|
|
925
|
+
* @returns Promise containing the results
|
|
926
|
+
*/
|
|
927
|
+
loopStream(params: LoopStreamVNextNetworkParams, onRecord: (record: WatchEvent) => void): Promise<void>;
|
|
928
|
+
}
|
|
929
|
+
|
|
930
|
+
declare class NetworkMemoryThread extends BaseResource {
|
|
931
|
+
private threadId;
|
|
932
|
+
private networkId;
|
|
933
|
+
constructor(options: ClientOptions, threadId: string, networkId: string);
|
|
934
|
+
/**
|
|
935
|
+
* Retrieves the memory thread details
|
|
936
|
+
* @returns Promise containing thread details including title and metadata
|
|
937
|
+
*/
|
|
938
|
+
get(): Promise<StorageThreadType>;
|
|
939
|
+
/**
|
|
940
|
+
* Updates the memory thread properties
|
|
941
|
+
* @param params - Update parameters including title and metadata
|
|
942
|
+
* @returns Promise containing updated thread details
|
|
943
|
+
*/
|
|
944
|
+
update(params: UpdateMemoryThreadParams): Promise<StorageThreadType>;
|
|
945
|
+
/**
|
|
946
|
+
* Deletes the memory thread
|
|
947
|
+
* @returns Promise containing deletion result
|
|
948
|
+
*/
|
|
949
|
+
delete(): Promise<{
|
|
950
|
+
result: string;
|
|
951
|
+
}>;
|
|
952
|
+
/**
|
|
953
|
+
* Retrieves messages associated with the thread
|
|
954
|
+
* @param params - Optional parameters including limit for number of messages to retrieve
|
|
955
|
+
* @returns Promise containing thread messages and UI messages
|
|
956
|
+
*/
|
|
957
|
+
getMessages(params?: GetMemoryThreadMessagesParams): Promise<GetMemoryThreadMessagesResponse>;
|
|
592
958
|
}
|
|
593
959
|
|
|
594
960
|
declare class MastraClient extends BaseResource {
|
|
@@ -598,6 +964,9 @@ declare class MastraClient extends BaseResource {
|
|
|
598
964
|
* @returns Promise containing map of agent IDs to agent details
|
|
599
965
|
*/
|
|
600
966
|
getAgents(): Promise<Record<string, GetAgentResponse>>;
|
|
967
|
+
getAGUI({ resourceId }: {
|
|
968
|
+
resourceId: string;
|
|
969
|
+
}): Promise<Record<string, AbstractAgent>>;
|
|
601
970
|
/**
|
|
602
971
|
* Gets an agent instance by ID
|
|
603
972
|
* @param agentId - ID of the agent to retrieve
|
|
@@ -635,6 +1004,37 @@ declare class MastraClient extends BaseResource {
|
|
|
635
1004
|
getMemoryStatus(agentId: string): Promise<{
|
|
636
1005
|
result: boolean;
|
|
637
1006
|
}>;
|
|
1007
|
+
/**
|
|
1008
|
+
* Retrieves memory threads for a resource
|
|
1009
|
+
* @param params - Parameters containing the resource ID
|
|
1010
|
+
* @returns Promise containing array of memory threads
|
|
1011
|
+
*/
|
|
1012
|
+
getNetworkMemoryThreads(params: GetNetworkMemoryThreadParams): Promise<GetMemoryThreadResponse>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Creates a new memory thread
|
|
1015
|
+
* @param params - Parameters for creating the memory thread
|
|
1016
|
+
* @returns Promise containing the created memory thread
|
|
1017
|
+
*/
|
|
1018
|
+
createNetworkMemoryThread(params: CreateNetworkMemoryThreadParams): Promise<CreateMemoryThreadResponse>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Gets a memory thread instance by ID
|
|
1021
|
+
* @param threadId - ID of the memory thread to retrieve
|
|
1022
|
+
* @returns MemoryThread instance
|
|
1023
|
+
*/
|
|
1024
|
+
getNetworkMemoryThread(threadId: string, networkId: string): NetworkMemoryThread;
|
|
1025
|
+
/**
|
|
1026
|
+
* Saves messages to memory
|
|
1027
|
+
* @param params - Parameters containing messages to save
|
|
1028
|
+
* @returns Promise containing the saved messages
|
|
1029
|
+
*/
|
|
1030
|
+
saveNetworkMessageToMemory(params: SaveNetworkMessageToMemoryParams): Promise<SaveMessageToMemoryResponse>;
|
|
1031
|
+
/**
|
|
1032
|
+
* Gets the status of the memory system
|
|
1033
|
+
* @returns Promise containing memory system status
|
|
1034
|
+
*/
|
|
1035
|
+
getNetworkMemoryStatus(networkId: string): Promise<{
|
|
1036
|
+
result: boolean;
|
|
1037
|
+
}>;
|
|
638
1038
|
/**
|
|
639
1039
|
* Retrieves all available tools
|
|
640
1040
|
* @returns Promise containing map of tool IDs to tool details
|
|
@@ -646,6 +1046,17 @@ declare class MastraClient extends BaseResource {
|
|
|
646
1046
|
* @returns Tool instance
|
|
647
1047
|
*/
|
|
648
1048
|
getTool(toolId: string): Tool;
|
|
1049
|
+
/**
|
|
1050
|
+
* Retrieves all available legacy workflows
|
|
1051
|
+
* @returns Promise containing map of legacy workflow IDs to legacy workflow details
|
|
1052
|
+
*/
|
|
1053
|
+
getLegacyWorkflows(): Promise<Record<string, GetLegacyWorkflowResponse>>;
|
|
1054
|
+
/**
|
|
1055
|
+
* Gets a legacy workflow instance by ID
|
|
1056
|
+
* @param workflowId - ID of the legacy workflow to retrieve
|
|
1057
|
+
* @returns Legacy Workflow instance
|
|
1058
|
+
*/
|
|
1059
|
+
getLegacyWorkflow(workflowId: string): LegacyWorkflow;
|
|
649
1060
|
/**
|
|
650
1061
|
* Retrieves all available workflows
|
|
651
1062
|
* @returns Promise containing map of workflow IDs to workflow details
|
|
@@ -657,17 +1068,6 @@ declare class MastraClient extends BaseResource {
|
|
|
657
1068
|
* @returns Workflow instance
|
|
658
1069
|
*/
|
|
659
1070
|
getWorkflow(workflowId: string): Workflow;
|
|
660
|
-
/**
|
|
661
|
-
* Retrieves all available vNext workflows
|
|
662
|
-
* @returns Promise containing map of vNext workflow IDs to vNext workflow details
|
|
663
|
-
*/
|
|
664
|
-
getVNextWorkflows(): Promise<Record<string, GetVNextWorkflowResponse>>;
|
|
665
|
-
/**
|
|
666
|
-
* Gets a vNext workflow instance by ID
|
|
667
|
-
* @param workflowId - ID of the vNext workflow to retrieve
|
|
668
|
-
* @returns vNext Workflow instance
|
|
669
|
-
*/
|
|
670
|
-
getVNextWorkflow(workflowId: string): VNextWorkflow;
|
|
671
1071
|
/**
|
|
672
1072
|
* Gets a vector instance by name
|
|
673
1073
|
* @param vectorName - Name of the vector to retrieve
|
|
@@ -703,13 +1103,62 @@ declare class MastraClient extends BaseResource {
|
|
|
703
1103
|
* Retrieves all available networks
|
|
704
1104
|
* @returns Promise containing map of network IDs to network details
|
|
705
1105
|
*/
|
|
706
|
-
getNetworks(): Promise<
|
|
1106
|
+
getNetworks(): Promise<Array<GetNetworkResponse>>;
|
|
1107
|
+
/**
|
|
1108
|
+
* Retrieves all available vNext networks
|
|
1109
|
+
* @returns Promise containing map of vNext network IDs to vNext network details
|
|
1110
|
+
*/
|
|
1111
|
+
getVNextNetworks(): Promise<Array<GetVNextNetworkResponse>>;
|
|
707
1112
|
/**
|
|
708
1113
|
* Gets a network instance by ID
|
|
709
1114
|
* @param networkId - ID of the network to retrieve
|
|
710
1115
|
* @returns Network instance
|
|
711
1116
|
*/
|
|
712
1117
|
getNetwork(networkId: string): Network;
|
|
1118
|
+
/**
|
|
1119
|
+
* Gets a vNext network instance by ID
|
|
1120
|
+
* @param networkId - ID of the vNext network to retrieve
|
|
1121
|
+
* @returns vNext Network instance
|
|
1122
|
+
*/
|
|
1123
|
+
getVNextNetwork(networkId: string): VNextNetwork;
|
|
1124
|
+
/**
|
|
1125
|
+
* Retrieves a list of available MCP servers.
|
|
1126
|
+
* @param params - Optional parameters for pagination (limit, offset).
|
|
1127
|
+
* @returns Promise containing the list of MCP servers and pagination info.
|
|
1128
|
+
*/
|
|
1129
|
+
getMcpServers(params?: {
|
|
1130
|
+
limit?: number;
|
|
1131
|
+
offset?: number;
|
|
1132
|
+
}): Promise<McpServerListResponse>;
|
|
1133
|
+
/**
|
|
1134
|
+
* Retrieves detailed information for a specific MCP server.
|
|
1135
|
+
* @param serverId - The ID of the MCP server to retrieve.
|
|
1136
|
+
* @param params - Optional parameters, e.g., specific version.
|
|
1137
|
+
* @returns Promise containing the detailed MCP server information.
|
|
1138
|
+
*/
|
|
1139
|
+
getMcpServerDetails(serverId: string, params?: {
|
|
1140
|
+
version?: string;
|
|
1141
|
+
}): Promise<ServerDetailInfo>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Retrieves a list of tools for a specific MCP server.
|
|
1144
|
+
* @param serverId - The ID of the MCP server.
|
|
1145
|
+
* @returns Promise containing the list of tools.
|
|
1146
|
+
*/
|
|
1147
|
+
getMcpServerTools(serverId: string): Promise<McpServerToolListResponse>;
|
|
1148
|
+
/**
|
|
1149
|
+
* Gets an MCPTool resource instance for a specific tool on an MCP server.
|
|
1150
|
+
* This instance can then be used to fetch details or execute the tool.
|
|
1151
|
+
* @param serverId - The ID of the MCP server.
|
|
1152
|
+
* @param toolId - The ID of the tool.
|
|
1153
|
+
* @returns MCPTool instance.
|
|
1154
|
+
*/
|
|
1155
|
+
getMcpServerTool(serverId: string, toolId: string): MCPTool;
|
|
1156
|
+
/**
|
|
1157
|
+
* Gets an A2A client for interacting with an agent via the A2A protocol
|
|
1158
|
+
* @param agentId - ID of the agent to interact with
|
|
1159
|
+
* @returns A2A client instance
|
|
1160
|
+
*/
|
|
1161
|
+
getA2A(agentId: string): A2A;
|
|
713
1162
|
}
|
|
714
1163
|
|
|
715
|
-
export { type ClientOptions, type CreateIndexParams, type CreateMemoryThreadParams, type CreateMemoryThreadResponse, type GenerateParams, type GetAgentResponse, type GetEvalsByAgentIdResponse, type GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type
|
|
1164
|
+
export { type ClientOptions, type CreateIndexParams, type CreateMemoryThreadParams, type CreateMemoryThreadResponse, type CreateNetworkMemoryThreadParams, type GenerateOrStreamVNextNetworkParams, type GenerateParams, type GenerateVNextNetworkResponse, type GetAgentResponse, type GetEvalsByAgentIdResponse, type GetLegacyWorkflowResponse, type GetLegacyWorkflowRunsResponse, type GetLogParams, type GetLogsParams, type GetLogsResponse, type GetMemoryThreadMessagesParams, type GetMemoryThreadMessagesResponse, type GetMemoryThreadParams, type GetMemoryThreadResponse, type GetNetworkMemoryThreadParams, type GetNetworkResponse, type GetTelemetryParams, type GetTelemetryResponse, type GetToolResponse, type GetVNextNetworkResponse, type GetVectorIndexResponse, type GetWorkflowResponse, type GetWorkflowRunByIdResponse, type GetWorkflowRunExecutionResultResponse, type GetWorkflowRunsParams, type GetWorkflowRunsResponse, type LegacyWorkflowRunResult, type LoopStreamVNextNetworkParams, type LoopVNextNetworkResponse, MastraClient, type McpServerListResponse, type McpServerToolListResponse, type McpToolInfo, type QueryVectorParams, type QueryVectorResponse, type RequestFunction, type RequestOptions, type SaveMessageToMemoryParams, type SaveMessageToMemoryResponse, type SaveNetworkMessageToMemoryParams, type StreamParams, type UpdateMemoryThreadParams, type UpsertVectorParams, type WorkflowRunResult, type WorkflowWatchResult };
|