@mastra/mcp-docs-server 0.13.22-alpha.2 → 0.13.22-alpha.4

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.
Files changed (104) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +20 -0
  2. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +9 -0
  3. package/.docs/organized/changelogs/%40mastra%2Fastra.md +11 -11
  4. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +13 -13
  5. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +10 -10
  6. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +23 -23
  7. package/.docs/organized/changelogs/%40mastra%2Fcloud.md +21 -21
  8. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +10 -10
  9. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +10 -10
  10. package/.docs/organized/changelogs/%40mastra%2Fcore.md +56 -56
  11. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +10 -10
  12. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +33 -33
  13. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +28 -28
  14. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +22 -22
  15. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +23 -23
  16. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +61 -61
  17. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +19 -19
  18. package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
  19. package/.docs/organized/changelogs/%40mastra%2Flance.md +11 -11
  20. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
  21. package/.docs/organized/changelogs/%40mastra%2Floggers.md +11 -11
  22. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +19 -19
  23. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +10 -10
  24. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +21 -21
  25. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +21 -21
  26. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +10 -10
  27. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +10 -10
  28. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +10 -10
  29. package/.docs/organized/changelogs/%40mastra%2Fpg.md +13 -13
  30. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +10 -10
  31. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +39 -39
  32. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +11 -11
  33. package/.docs/organized/changelogs/%40mastra%2Frag.md +16 -16
  34. package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +11 -0
  35. package/.docs/organized/changelogs/%40mastra%2Fserver.md +21 -21
  36. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +10 -10
  37. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +11 -11
  38. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +10 -10
  39. package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +10 -10
  40. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +11 -11
  41. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +10 -10
  42. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +10 -10
  43. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +9 -0
  44. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +9 -0
  45. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +10 -10
  46. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +10 -10
  47. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +10 -10
  48. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
  49. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +10 -10
  50. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +10 -10
  51. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +19 -19
  52. package/.docs/organized/changelogs/create-mastra.md +9 -9
  53. package/.docs/organized/changelogs/mastra.md +58 -58
  54. package/.docs/organized/code-examples/agent-network.md +2 -1
  55. package/.docs/organized/code-examples/quick-start.md +2 -1
  56. package/.docs/organized/code-examples/weather-agent.md +11 -4
  57. package/.docs/organized/code-examples/workflow-ai-recruiter.md +2 -1
  58. package/.docs/raw/agents/overview.mdx +1 -1
  59. package/.docs/raw/auth/firebase.mdx +285 -0
  60. package/.docs/raw/auth/index.mdx +3 -3
  61. package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
  62. package/.docs/raw/deployment/overview.mdx +7 -1
  63. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +108 -0
  64. package/.docs/raw/getting-started/installation.mdx +0 -1
  65. package/.docs/raw/memory/overview.mdx +1 -1
  66. package/.docs/raw/reference/agents/network.mdx +258 -0
  67. package/.docs/raw/reference/auth/firebase.mdx +128 -0
  68. package/.docs/raw/reference/cli/dev.mdx +7 -1
  69. package/.docs/raw/reference/client-js/agents.mdx +3 -3
  70. package/.docs/raw/reference/client-js/memory.mdx +1 -1
  71. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  72. package/.docs/raw/reference/core/getWorkflow.mdx +0 -1
  73. package/.docs/raw/reference/core/getWorkflows.mdx +0 -1
  74. package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
  75. package/.docs/raw/reference/storage/dynamodb.mdx +0 -4
  76. package/.docs/raw/reference/{agents → streaming}/ChunkType.mdx +12 -12
  77. package/.docs/raw/reference/{agents → streaming}/MastraModelOutput.mdx +10 -10
  78. package/.docs/raw/reference/tools/mcp-server.mdx +1 -1
  79. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
  80. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  81. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +3 -3
  82. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
  83. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
  84. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  85. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +1 -1
  86. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  87. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +1 -1
  88. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
  89. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
  90. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  91. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
  92. package/.docs/raw/server-db/local-dev-playground.mdx +31 -9
  93. package/.docs/raw/server-db/mastra-client.mdx +189 -73
  94. package/.docs/raw/server-db/snapshots.mdx +155 -114
  95. package/.docs/raw/workflows/inngest-workflow.mdx +82 -0
  96. package/CHANGELOG.md +18 -0
  97. package/package.json +5 -5
  98. package/.docs/organized/changelogs/%40mastra%2Ffirecrawl.md +0 -302
  99. package/.docs/organized/changelogs/%40mastra%2Fgithub.md +0 -302
  100. package/.docs/organized/changelogs/%40mastra%2Fmem0.md +0 -302
  101. package/.docs/organized/changelogs/%40mastra%2Fragie.md +0 -302
  102. package/.docs/organized/code-examples/memory-with-mem0.md +0 -108
  103. /package/.docs/raw/reference/{agents → streaming}/stream.mdx +0 -0
  104. /package/.docs/raw/reference/{agents → streaming}/streamVNext.mdx +0 -0
@@ -0,0 +1,258 @@
1
+ ---
2
+ title: "Reference: Agent.network() (Experimental) | Agents | Mastra Docs"
3
+ description: "Documentation for the `Agent.network()` method in Mastra agents, which enables multi-agent collaboration and routing."
4
+ ---
5
+
6
+ import { NetworkCallout } from "@/components/network-callout.tsx"
7
+
8
+ # Agent.network()
9
+
10
+ <NetworkCallout />
11
+
12
+ The `.network()` method enables multi-agent collaboration and routing. This method accepts messages and optional execution options.
13
+
14
+ ## Usage example
15
+
16
+ ```typescript copy
17
+ import { Agent } from '@mastra/core/agent';
18
+ import { openai } from '@ai-sdk/openai';
19
+ import { agent1, agent2 } from './agents';
20
+ import { workflow1 } from './workflows';
21
+ import { tool1, tool2 } from './tools';
22
+
23
+ const agent = new Agent({
24
+ name: 'network-agent',
25
+ instructions: 'You are a network agent that can help users with a variety of tasks.',
26
+ model: openai('gpt-4o'),
27
+ agents: {
28
+ agent1,
29
+ agent2,
30
+ },
31
+ workflows: {
32
+ workflow1,
33
+ },
34
+ tools: {
35
+ tool1,
36
+ tool2,
37
+ },
38
+ })
39
+
40
+ await agent.network(`
41
+ Find me the weather in Tokyo.
42
+ Based on the weather, plan an activity for me.
43
+ `);
44
+ ```
45
+
46
+ ## Parameters
47
+
48
+ <PropertiesTable
49
+ content={[
50
+ {
51
+ name: "messages",
52
+ type: "string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]",
53
+ description: "The messages to send to the agent. Can be a single string, array of strings, or structured message objects.",
54
+ },
55
+ {
56
+ name: "options",
57
+ type: "MultiPrimitiveExecutionOptions",
58
+ isOptional: true,
59
+ description: "Optional configuration for the network process.",
60
+ },
61
+ ]}
62
+ />
63
+
64
+ ### Options
65
+
66
+ <PropertiesTable
67
+ content={[
68
+ {
69
+ name: "maxSteps",
70
+ type: "number",
71
+ isOptional: true,
72
+ description: "Maximum number of steps to run during execution.",
73
+ },
74
+ {
75
+ name: "memory",
76
+ type: "object",
77
+ isOptional: true,
78
+ description: "Configuration for memory. This is the preferred way to manage memory.",
79
+ properties: [
80
+ {
81
+ parameters: [{
82
+ name: "thread",
83
+ type: "string | { id: string; metadata?: Record<string, any>, title?: string }",
84
+ isOptional: false,
85
+ description: "The conversation thread, as a string ID or an object with an `id` and optional `metadata`."
86
+ }]
87
+ },
88
+ {
89
+ parameters: [{
90
+ name: "resource",
91
+ type: "string",
92
+ isOptional: false,
93
+ description: "Identifier for the user or resource associated with the thread."
94
+ }]
95
+ },
96
+ {
97
+ parameters: [{
98
+ name: "options",
99
+ type: "MemoryConfig",
100
+ isOptional: true,
101
+ description: "Configuration for memory behavior, like message history and semantic recall."
102
+ }]
103
+ }
104
+ ]
105
+ },
106
+ {
107
+ name: "tracingContext",
108
+ type: "TracingContext",
109
+ isOptional: true,
110
+ description: "AI tracing context for span hierarchy and metadata.",
111
+ },
112
+ {
113
+ name: "telemetry",
114
+ type: "TelemetrySettings",
115
+ isOptional: true,
116
+ description:
117
+ "Settings for telemetry collection during streaming.",
118
+ properties: [
119
+ {
120
+ parameters: [{
121
+ name: "isEnabled",
122
+ type: "boolean",
123
+ isOptional: true,
124
+ description: "Enable or disable telemetry. Disabled by default while experimental."
125
+ }]
126
+ },
127
+ {
128
+ parameters: [{
129
+ name: "recordInputs",
130
+ type: "boolean",
131
+ isOptional: true,
132
+ description: "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information."
133
+ }]
134
+ },
135
+ {
136
+ parameters: [{
137
+ name: "recordOutputs",
138
+ type: "boolean",
139
+ isOptional: true,
140
+ description: "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information."
141
+ }]
142
+ },
143
+ {
144
+ parameters: [{
145
+ name: "functionId",
146
+ type: "string",
147
+ isOptional: true,
148
+ description: "Identifier for this function. Used to group telemetry data by function."
149
+ }]
150
+ }
151
+ ]
152
+ },
153
+ {
154
+ name: "modelSettings",
155
+ type: "CallSettings",
156
+ isOptional: true,
157
+ description:
158
+ "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
159
+ properties: [
160
+ {
161
+ parameters: [{
162
+ name: "temperature",
163
+ type: "number",
164
+ isOptional: true,
165
+ description: "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic."
166
+ }]
167
+ },
168
+ {
169
+ parameters: [{
170
+ name: "maxRetries",
171
+ type: "number",
172
+ isOptional: true,
173
+ description: "Maximum number of retries for failed requests."
174
+ }]
175
+ },
176
+ {
177
+ parameters: [{
178
+ name: "topP",
179
+ type: "number",
180
+ isOptional: true,
181
+ description: "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both."
182
+ }]
183
+ },
184
+ {
185
+ parameters: [{
186
+ name: "topK",
187
+ type: "number",
188
+ isOptional: true,
189
+ description: "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses."
190
+ }]
191
+ },
192
+ {
193
+ parameters: [{
194
+ name: "presencePenalty",
195
+ type: "number",
196
+ isOptional: true,
197
+ description: "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition)."
198
+ }]
199
+ },
200
+ {
201
+ parameters: [{
202
+ name: "frequencyPenalty",
203
+ type: "number",
204
+ isOptional: true,
205
+ description: "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition)."
206
+ }]
207
+ },
208
+ {
209
+ parameters: [{
210
+ name: "stopSequences",
211
+ type: "string[]",
212
+ isOptional: true,
213
+ description: "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated."
214
+ }]
215
+ },
216
+ ]
217
+ },
218
+ {
219
+ name: "runId",
220
+ type: "string",
221
+ isOptional: true,
222
+ description: "Unique ID for this generation run. Useful for tracking and debugging purposes.",
223
+ },
224
+ {
225
+ name: "runtimeContext",
226
+ type: "RuntimeContext",
227
+ isOptional: true,
228
+ description: "Runtime context for dependency injection and contextual information.",
229
+ },
230
+ ]}
231
+ />
232
+
233
+ ## Returns
234
+
235
+ <PropertiesTable
236
+ content={[
237
+ {
238
+ name: "stream",
239
+ type: "MastraAgentNetworkStream<NetworkChunkType>",
240
+ description: "A custom stream that extends ReadableStream<NetworkChunkType> with additional network-specific properties",
241
+ },
242
+ {
243
+ name: "status",
244
+ type: "Promise<RunStatus>",
245
+ description: "A promise that resolves to the current workflow run status",
246
+ },
247
+ {
248
+ name: "result",
249
+ type: "Promise<WorkflowResult<TOutput, TSteps>>",
250
+ description: "A promise that resolves to the final workflow result",
251
+ },
252
+ {
253
+ name: "usage",
254
+ type: "Promise<{ promptTokens: number; completionTokens: number; totalTokens: number }>",
255
+ description: "A promise that resolves to token usage statistics",
256
+ },
257
+ ]}
258
+ />
@@ -0,0 +1,128 @@
1
+ ---
2
+ title: "MastraAuthFirebase Class"
3
+ description: "API reference for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication."
4
+ ---
5
+
6
+ # MastraAuthFirebase Class
7
+
8
+ The `MastraAuthFirebase` class provides authentication for Mastra using Firebase Authentication. It verifies incoming requests using Firebase ID tokens and integrates with the Mastra server using the `experimental_auth` option.
9
+
10
+ ## Usage examples
11
+
12
+ ### Basic usage with environment variables
13
+
14
+ ```typescript filename="src/mastra/index.ts" showLineNumbers copy
15
+ import { Mastra } from "@mastra/core/mastra";
16
+ import { MastraAuthFirebase } from '@mastra/auth-firebase';
17
+
18
+ // Automatically uses FIREBASE_SERVICE_ACCOUNT and FIRESTORE_DATABASE_ID env vars
19
+ export const mastra = new Mastra({
20
+ // ..
21
+ server: {
22
+ experimental_auth: new MastraAuthFirebase(),
23
+ },
24
+ });
25
+ ```
26
+
27
+ ### Custom configuration
28
+
29
+ ```typescript filename="src/mastra/index.ts" showLineNumbers copy
30
+ import { Mastra } from "@mastra/core/mastra";
31
+ import { MastraAuthFirebase } from '@mastra/auth-firebase';
32
+
33
+ export const mastra = new Mastra({
34
+ // ..
35
+ server: {
36
+ experimental_auth: new MastraAuthFirebase({
37
+ serviceAccount: "/path/to/service-account-key.json",
38
+ databaseId: "your-database-id"
39
+ }),
40
+ },
41
+ });
42
+ ```
43
+
44
+ ## Constructor parameters
45
+
46
+ <PropertiesTable
47
+ content={[
48
+ {
49
+ name: "serviceAccount",
50
+ type: "string",
51
+ description: "Path to the Firebase service account JSON file. This file contains the credentials needed to verify Firebase ID tokens on the server side.",
52
+ isOptional: true,
53
+ defaultValue: "process.env.FIREBASE_SERVICE_ACCOUNT"
54
+ },
55
+ {
56
+ name: "databaseId",
57
+ type: "string",
58
+ description: "The Firestore database ID to use. Typically '(default)' for the default database.",
59
+ isOptional: true,
60
+ defaultValue: "process.env.FIRESTORE_DATABASE_ID || process.env.FIREBASE_DATABASE_ID"
61
+ },
62
+ {
63
+ name: "name",
64
+ type: "string",
65
+ description: "Custom name for the auth provider instance.",
66
+ isOptional: true,
67
+ defaultValue: '"firebase"'
68
+ },
69
+ {
70
+ name: "authorizeUser",
71
+ type: "(user: FirebaseUser) => Promise<boolean> | boolean",
72
+ description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks for the presence of a document in the 'user_access' collection keyed by the user's UID.",
73
+ isOptional: true,
74
+ },
75
+ ]}
76
+ />
77
+
78
+ ## Environment Variables
79
+
80
+ The following environment variables are automatically used when constructor options are not provided:
81
+
82
+ <PropertiesTable
83
+ content={[
84
+ {
85
+ name: "FIREBASE_SERVICE_ACCOUNT",
86
+ type: "string",
87
+ description: "Path to Firebase service account JSON file. Used if serviceAccount option is not provided.",
88
+ isOptional: true,
89
+ },
90
+ {
91
+ name: "FIRESTORE_DATABASE_ID",
92
+ type: "string",
93
+ description: "Firestore database ID. Primary environment variable for database configuration.",
94
+ isOptional: true,
95
+ },
96
+ {
97
+ name: "FIREBASE_DATABASE_ID",
98
+ type: "string",
99
+ description: "Alternative environment variable for Firestore database ID. Used if FIRESTORE_DATABASE_ID is not set.",
100
+ isOptional: true,
101
+ },
102
+ ]}
103
+ />
104
+
105
+ ## Default Authorization Behavior
106
+
107
+ By default, `MastraAuthFirebase` uses Firestore to manage user access:
108
+
109
+ 1. After successfully verifying a Firebase ID token, the `authorizeUser` method is called
110
+ 2. It checks for the existence of a document in the `user_access` collection with the user's UID as the document ID
111
+ 3. If the document exists, the user is authorized; otherwise, access is denied
112
+ 4. The Firestore database used is determined by the `databaseId` parameter or environment variables
113
+
114
+ ## Firebase User Type
115
+
116
+ The `FirebaseUser` type used in the `authorizeUser` function corresponds to Firebase's `DecodedIdToken` interface, which includes:
117
+
118
+ - `uid`: The user's unique identifier
119
+ - `email`: The user's email address (if available)
120
+ - `email_verified`: Whether the email is verified
121
+ - `name`: The user's display name (if available)
122
+ - `picture`: URL to the user's profile picture (if available)
123
+ - `auth_time`: When the user authenticated
124
+ - And other standard JWT claims
125
+
126
+ ## Related
127
+
128
+ [MastraAuthFirebase Class](/docs/auth/firebase.mdx)
@@ -72,6 +72,12 @@ mastra dev [options]
72
72
  description: "display help for command",
73
73
  isOptional: true,
74
74
  },
75
+ {
76
+ name: "--https",
77
+ type: "boolean",
78
+ description: "Enable local HTTPS",
79
+ isOptional: true,
80
+ },
75
81
  ]}
76
82
  />
77
83
 
@@ -161,7 +167,7 @@ Workflows are expected to be exported from `src/mastra/workflows` (or the config
161
167
 
162
168
  ## Additional Notes
163
169
 
164
- The port defaults to 4111. Both the port and hostname can be configured via the mastra server config. See [Launch Development Server](/docs/server-db/local-dev-playground) for configuration details.
170
+ The port defaults to `4111`. The port, hostname, and HTTPS settings can also be configured via the Mastra server configuration. See [Launch Development Server](/docs/server-db/local-dev-playground) for configuration details.
165
171
 
166
172
  Make sure you have your environment variables set up in your `.env.development` or `.env` file for any providers you use (e.g., `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.).
167
173
 
@@ -47,7 +47,7 @@ const response = await agent.generate({
47
47
  },
48
48
  ],
49
49
  threadId: "thread-1", // Optional: Thread ID for conversation context
50
- resourceid: "resource-1", // Optional: Resource ID
50
+ resourceId: "resource-1", // Optional: Resource ID
51
51
  output: {}, // Optional: Output configuration
52
52
  });
53
53
  ```
@@ -207,7 +207,7 @@ const response = await agent.generateVNext(
207
207
  "Hello, how are you?",
208
208
  {
209
209
  threadId: "thread-1",
210
- resourceid: "resource-1",
210
+ resourceId: "resource-1",
211
211
  }
212
212
  );
213
- ```
213
+ ```
@@ -57,7 +57,7 @@ Update thread properties:
57
57
  const updated = await thread.update({
58
58
  title: "Updated Title",
59
59
  metadata: { status: "resolved" },
60
- resourceid: "resource-1",
60
+ resourceId: "resource-1",
61
61
  });
62
62
  ```
63
63
 
@@ -44,6 +44,6 @@ const result = await tool.execute({
44
44
  param2: "value2",
45
45
  },
46
46
  threadId: "thread-1", // Optional: Thread context
47
- resourceid: "resource-1", // Optional: Resource identifier
47
+ resourceId: "resource-1", // Optional: Resource identifier
48
48
  });
49
49
  ```
@@ -46,4 +46,3 @@ mastra.getWorkflow("testWorkflow");
46
46
  ## Related
47
47
 
48
48
  - [Workflows overview](../../docs/workflows/overview.mdx)
49
- - [Dynamic workflows](../../docs/workflows/dynamic-workflows.mdx)
@@ -41,4 +41,3 @@ mastra.getWorkflows();
41
41
  ## Related
42
42
 
43
43
  - [Workflows overview](../../docs/workflows/overview.mdx)
44
- - [Dynamic workflows](../../docs/workflows/dynamic-workflows.mdx)
@@ -31,5 +31,5 @@ This method does not return a value.
31
31
 
32
32
  ## Related
33
33
 
34
- - [Telemetry overview](../../docs/observability/telemetry.mdx)
35
- - [Telemetry reference](../../reference/observability/telemetry.mdx)
34
+ - [Logging](../../docs/observability/logging.mdx)
35
+ - [PinoLogger](../../reference/observability/logger.mdx)
@@ -194,7 +194,3 @@ This implementation uses a single-table design pattern with ElectroDB, which off
194
194
  3. **Simplified administration:** Fewer distinct tables to monitor, back up, and manage.
195
195
  4. **Reduced complexity in access patterns:** ElectroDB helps manage the complexity of item types and access patterns on a single table.
196
196
  5. **Transaction support:** DynamoDB transactions can be used across different "entity" types stored within the same table if needed.
197
-
198
- ## License
199
-
200
- This package is distributed under the MIT License. See [LICENSE.md](https://github.com/mastra-ai/mastra/blob/main/LICENSE.md) for more information.
@@ -1,15 +1,15 @@
1
1
  ---
2
- title: "Reference: ChunkType | Agents | Mastra Docs"
2
+ title: "Reference: ChunkType (Experimental) | Agents | Mastra Docs"
3
3
  description: "Documentation for the ChunkType type used in Mastra streaming responses, defining all possible chunk types and their payloads."
4
4
  ---
5
5
 
6
6
  import { Callout } from "nextra/components";
7
7
  import { PropertiesTable } from "@/components/properties-table";
8
-
9
- # ChunkType
10
8
 
11
- <Callout type="warning">
12
- **Experimental API**: This type is part of the experimental [`streamVNext()`](../streamVNext) method. The API may change as we refine the feature based on feedback.
9
+ # ChunkType (Experimental)
10
+
11
+ <Callout type="important">
12
+ <strong className="block">Experimental API: </strong>This type is part of the experimental `.streamVNext()` method. The API may change as we refine the feature based on feedback.
13
13
  </Callout>
14
14
 
15
15
  The `ChunkType` type defines the mastra format of stream chunks that can be emitted during streaming responses from agents.
@@ -826,24 +826,24 @@ for await (const chunk of stream.fullStream) {
826
826
  case 'text-delta':
827
827
  console.log('Text:', chunk.payload.text);
828
828
  break;
829
-
829
+
830
830
  case 'tool-call':
831
831
  console.log('Calling tool:', chunk.payload.toolName);
832
832
  break;
833
-
833
+
834
834
  case 'tool-result':
835
835
  console.log('Tool result:', chunk.payload.result);
836
836
  break;
837
-
837
+
838
838
  case 'reasoning-delta':
839
839
  console.log('Reasoning:', chunk.payload.text);
840
840
  break;
841
-
841
+
842
842
  case 'finish':
843
843
  console.log('Finished:', chunk.payload.stepResult.reason);
844
844
  console.log('Usage:', chunk.payload.output.usage);
845
845
  break;
846
-
846
+
847
847
  case 'error':
848
848
  console.error('Error:', chunk.payload.error);
849
849
  break;
@@ -853,5 +853,5 @@ for await (const chunk of stream.fullStream) {
853
853
 
854
854
  ## Related Types
855
855
 
856
- - [MastraModelOutput](/reference/agents/MastraModelOutput) - The stream object that emits these chunks
857
- - [Agent.streamVNext()](/reference/agents/streamVNext) - Method that returns streams emitting these chunks
856
+ - [MastraModelOutput](./MastraModelOutput.mdx) - The stream object that emits these chunks
857
+ - [.streamVNext()](./streamVNext.mdx) - Method that returns streams emitting these chunks
@@ -1,25 +1,25 @@
1
1
  ---
2
- title: "Reference: MastraModelOutput | Agents | Mastra Docs"
2
+ title: "Reference: MastraModelOutput (Experimental) | Agents | Mastra Docs"
3
3
  description: "Complete reference for MastraModelOutput - the stream object returned by agent.streamVNext() with streaming and promise-based access to model outputs."
4
4
  ---
5
5
 
6
6
  import { Callout } from "nextra/components";
7
7
  import { PropertiesTable } from "@/components/properties-table";
8
8
 
9
- # MastraModelOutput
9
+ # MastraModelOutput (Experimental)
10
10
 
11
- <Callout type="warning">
12
- **Experimental API**: This type is part of the experimental [`streamVNext()`](/reference/agents/streamVNext) method. The API may change as we refine the feature based on feedback.
11
+ <Callout type="important">
12
+ <strong className="block">Experimental API: </strong>This type is part of the experimental `.streamVNext()` method. The API may change as we refine the feature based on feedback.
13
13
  </Callout>
14
14
 
15
- The `MastraModelOutput` class is returned by [`agent.streamVNext()`](/reference/agents/streamVNext) and provides both streaming and promise-based access to model outputs. It supports structured output generation, tool calls, reasoning, and comprehensive usage tracking.
15
+ The `MastraModelOutput` class is returned by [.streamVNext()](./streamVNext.mdx) and provides both streaming and promise-based access to model outputs. It supports structured output generation, tool calls, reasoning, and comprehensive usage tracking.
16
16
 
17
17
  ```typescript
18
18
  // MastraModelOutput is returned by agent.streamVNext()
19
19
  const stream = await agent.streamVNext("Hello world");
20
20
  ```
21
21
 
22
- For setup and basic usage, see the [streamVNext() method documentation](/reference/agents/streamVNext).
22
+ For setup and basic usage, see the [.streamVNext()](./streamVNext.mdx) method documentation.
23
23
 
24
24
  ## Streaming Properties
25
25
 
@@ -113,7 +113,7 @@ These properties resolve to final values after the stream completes:
113
113
  type: "Promise<ToolResultChunk[]>",
114
114
  description: "Array of all tool result chunks corresponding to the tool calls. Contains execution results and error information.",
115
115
  properties: [{
116
- type: "ToolResultChunk",
116
+ type: "ToolResultChunk",
117
117
  parameters: [
118
118
  { name: "type", type: "'tool-result'", description: "Chunk type identifier" },
119
119
  { name: "runId", type: "string", description: "Execution run identifier" },
@@ -302,7 +302,7 @@ try {
302
302
  console.error("Stream error:", error);
303
303
  }
304
304
  });
305
-
305
+
306
306
  const result = await stream.text;
307
307
  } catch (error) {
308
308
  console.error("Failed to get result:", error);
@@ -317,5 +317,5 @@ if (stream.error) {
317
317
 
318
318
  ## Related Types
319
319
 
320
- - [ChunkType](/reference/agents/ChunkType) - All possible chunk types in the full stream
321
- - [Agent.streamVNext()](/reference/agents/streamVNext) - Method that returns MastraModelOutput
320
+ - [ChunkType](./ChunkType.mdx) - All possible chunk types in the full stream
321
+ - [.streamVNext()](./streamVNext.mdx) - Method that returns MastraModelOutput
@@ -86,7 +86,7 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
86
86
  type: "Record<string, Workflow>",
87
87
  isOptional: true,
88
88
  description:
89
- "An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named `run_<workflowKey>`. The workflow's `inputSchema` becomes the tool's input schema. The workflow **must** have a non-empty `description` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling `workflow.createRun().start({ inputData: <tool_input> })`. If a tool name derived from an agent or workflow (e.g., `ask_myAgent` or `run_myWorkflow`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.",
89
+ "An object where keys are workflow identifiers and values are Mastra Workflow instances. Each workflow is converted into a tool named `run_<workflowKey>`. The workflow's `inputSchema` becomes the tool's input schema. The workflow **must** have a non-empty `description` string property, which is used for the tool's description. If a workflow's description is missing or empty, an error will be thrown. The tool executes the workflow by calling `workflow.createRunAsync()` followed by `run.start({ inputData: <tool_input> })`. If a tool name derived from an agent or workflow (e.g., `ask_myAgent` or `run_myWorkflow`) collides with an explicitly defined tool name or another derived name, the explicitly defined tool takes precedence, and a warning is logged. Agents/workflows leading to subsequent collisions are skipped.",
90
90
  },
91
91
  {
92
92
  name: "id",
@@ -44,5 +44,5 @@ workflow.branch([
44
44
 
45
45
  ## Related
46
46
 
47
- - [Conditional branching](../../docs/workflows/control-flow.mdx)
48
- - [Conditional branching example](../../examples/workflows/conditional-branching.mdx)
47
+ - [Conditional Branching Logic](../../../docs/workflows/control-flow#conditional-logic-with-branch)
48
+ - [Conditional Branching Example](../../../examples/workflows/conditional-branching)
@@ -27,4 +27,4 @@ workflow.then(step1).commit();
27
27
 
28
28
  ## Related
29
29
 
30
- - [Control flow](../../docs/workflows/control-flow.mdx)
30
+ - [Control Flow](../../../docs/workflows/control-flow.mdx)
@@ -10,7 +10,7 @@ import { Callout } from "nextra/components";
10
10
  The `.createRunAsync()` method creates a new workflow run instance, allowing you to execute the workflow with specific input data. This is the current API that returns a `Run` instance.
11
11
 
12
12
  <Callout>
13
- For the legacy `createRun()` method that returns an object with methods, see the [Legacy Workflows](../legacyWorkflows/createRun.mdx) section.
13
+ For the legacy `createRun()` method that returns an object with methods, see the [Legacy Workflows](../../legacyWorkflows/createRun.mdx) section.
14
14
  </Callout>
15
15
 
16
16
  ## Usage example
@@ -61,5 +61,5 @@ const result = await run.start({
61
61
 
62
62
  ## Related
63
63
 
64
- - [Run Class](./run.mdx)
65
- - [Running workflows](../../examples/workflows/running-workflows.mdx)
64
+ - [Run Class](../run.mdx)
65
+ - [Running workflows](../../../examples/workflows/running-workflows.mdx)
@@ -47,4 +47,4 @@ workflow.dountil(step1, async ({ inputData }) => true);
47
47
 
48
48
  ## Related
49
49
 
50
- - [Control flow](../../docs/workflows/control-flow.mdx)
50
+ - [Control Flow](../../../docs/workflows/control-flow.mdx)
@@ -47,4 +47,4 @@ workflow.dowhile(step1, async ({ inputData }) => true);
47
47
 
48
48
  ## Related
49
49
 
50
- - [Control flow](../../docs/workflows/control-flow.mdx)
50
+ - [Control Flow](../../../docs/workflows/control-flow.mdx)
@@ -57,4 +57,4 @@ workflow.foreach(step1, { concurrency: 2 });
57
57
 
58
58
  ## Related
59
59
 
60
- - [For each](../../docs/workflows/control-flow.mdx)
60
+ - [Repeating with foreach](../../../docs/workflows/control-flow.mdx#repeating-with-foreach)
@@ -40,4 +40,4 @@ workflow.map(async ({ inputData }) => `${inputData.value} - map`
40
40
 
41
41
  ## Related
42
42
 
43
- - [Input data mapping](../../docs/workflows/input-data-mapping.mdx)
43
+ - [Input data mapping](../../../docs/workflows/input-data-mapping.mdx)