@mastra/mcp-docs-server 1.1.4 → 1.1.5

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 (547) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/package.json +5 -5
  3. package/.docs/docs/agents/adding-voice.md +0 -353
  4. package/.docs/docs/agents/agent-approval.md +0 -377
  5. package/.docs/docs/agents/agent-memory.md +0 -212
  6. package/.docs/docs/agents/guardrails.md +0 -382
  7. package/.docs/docs/agents/network-approval.md +0 -275
  8. package/.docs/docs/agents/networks.md +0 -290
  9. package/.docs/docs/agents/overview.md +0 -309
  10. package/.docs/docs/agents/processors.md +0 -632
  11. package/.docs/docs/agents/structured-output.md +0 -271
  12. package/.docs/docs/agents/using-tools.md +0 -214
  13. package/.docs/docs/build-with-ai/mcp-docs-server.md +0 -241
  14. package/.docs/docs/build-with-ai/skills.md +0 -35
  15. package/.docs/docs/community/contributing-templates.md +0 -3
  16. package/.docs/docs/community/discord.md +0 -9
  17. package/.docs/docs/community/licensing.md +0 -66
  18. package/.docs/docs/deployment/cloud-providers.md +0 -15
  19. package/.docs/docs/deployment/mastra-server.md +0 -122
  20. package/.docs/docs/deployment/monorepo.md +0 -142
  21. package/.docs/docs/deployment/overview.md +0 -62
  22. package/.docs/docs/deployment/studio.md +0 -234
  23. package/.docs/docs/deployment/web-framework.md +0 -52
  24. package/.docs/docs/deployment/workflow-runners.md +0 -9
  25. package/.docs/docs/evals/built-in-scorers.md +0 -47
  26. package/.docs/docs/evals/custom-scorers.md +0 -519
  27. package/.docs/docs/evals/overview.md +0 -146
  28. package/.docs/docs/evals/running-in-ci.md +0 -106
  29. package/.docs/docs/getting-started/build-with-ai.md +0 -68
  30. package/.docs/docs/getting-started/manual-install.md +0 -226
  31. package/.docs/docs/getting-started/project-structure.md +0 -60
  32. package/.docs/docs/getting-started/start.md +0 -28
  33. package/.docs/docs/getting-started/studio.md +0 -101
  34. package/.docs/docs/index.md +0 -43
  35. package/.docs/docs/mastra-cloud/deployment.md +0 -77
  36. package/.docs/docs/mastra-cloud/observability.md +0 -38
  37. package/.docs/docs/mastra-cloud/overview.md +0 -23
  38. package/.docs/docs/mastra-cloud/setup.md +0 -42
  39. package/.docs/docs/mastra-cloud/studio.md +0 -24
  40. package/.docs/docs/mcp/overview.md +0 -370
  41. package/.docs/docs/mcp/publishing-mcp-server.md +0 -95
  42. package/.docs/docs/memory/memory-processors.md +0 -316
  43. package/.docs/docs/memory/message-history.md +0 -260
  44. package/.docs/docs/memory/observational-memory.md +0 -246
  45. package/.docs/docs/memory/overview.md +0 -45
  46. package/.docs/docs/memory/semantic-recall.md +0 -272
  47. package/.docs/docs/memory/storage.md +0 -261
  48. package/.docs/docs/memory/working-memory.md +0 -400
  49. package/.docs/docs/observability/datasets/overview.md +0 -188
  50. package/.docs/docs/observability/datasets/running-experiments.md +0 -266
  51. package/.docs/docs/observability/logging.md +0 -99
  52. package/.docs/docs/observability/overview.md +0 -70
  53. package/.docs/docs/observability/tracing/bridges/otel.md +0 -209
  54. package/.docs/docs/observability/tracing/exporters/arize.md +0 -274
  55. package/.docs/docs/observability/tracing/exporters/braintrust.md +0 -111
  56. package/.docs/docs/observability/tracing/exporters/cloud.md +0 -129
  57. package/.docs/docs/observability/tracing/exporters/datadog.md +0 -187
  58. package/.docs/docs/observability/tracing/exporters/default.md +0 -211
  59. package/.docs/docs/observability/tracing/exporters/laminar.md +0 -100
  60. package/.docs/docs/observability/tracing/exporters/langfuse.md +0 -217
  61. package/.docs/docs/observability/tracing/exporters/langsmith.md +0 -202
  62. package/.docs/docs/observability/tracing/exporters/otel.md +0 -479
  63. package/.docs/docs/observability/tracing/exporters/posthog.md +0 -148
  64. package/.docs/docs/observability/tracing/exporters/sentry.md +0 -208
  65. package/.docs/docs/observability/tracing/overview.md +0 -1114
  66. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +0 -303
  67. package/.docs/docs/rag/chunking-and-embedding.md +0 -183
  68. package/.docs/docs/rag/graph-rag.md +0 -215
  69. package/.docs/docs/rag/overview.md +0 -72
  70. package/.docs/docs/rag/retrieval.md +0 -521
  71. package/.docs/docs/rag/vector-databases.md +0 -648
  72. package/.docs/docs/server/auth/auth0.md +0 -222
  73. package/.docs/docs/server/auth/better-auth.md +0 -203
  74. package/.docs/docs/server/auth/clerk.md +0 -132
  75. package/.docs/docs/server/auth/composite-auth.md +0 -234
  76. package/.docs/docs/server/auth/custom-auth-provider.md +0 -513
  77. package/.docs/docs/server/auth/firebase.md +0 -272
  78. package/.docs/docs/server/auth/jwt.md +0 -110
  79. package/.docs/docs/server/auth/simple-auth.md +0 -178
  80. package/.docs/docs/server/auth/supabase.md +0 -117
  81. package/.docs/docs/server/auth/workos.md +0 -190
  82. package/.docs/docs/server/auth.md +0 -38
  83. package/.docs/docs/server/custom-adapters.md +0 -374
  84. package/.docs/docs/server/custom-api-routes.md +0 -267
  85. package/.docs/docs/server/mastra-client.md +0 -243
  86. package/.docs/docs/server/mastra-server.md +0 -71
  87. package/.docs/docs/server/middleware.md +0 -228
  88. package/.docs/docs/server/request-context.md +0 -478
  89. package/.docs/docs/server/server-adapters.md +0 -547
  90. package/.docs/docs/streaming/events.md +0 -247
  91. package/.docs/docs/streaming/overview.md +0 -181
  92. package/.docs/docs/streaming/tool-streaming.md +0 -178
  93. package/.docs/docs/streaming/workflow-streaming.md +0 -109
  94. package/.docs/docs/voice/overview.md +0 -979
  95. package/.docs/docs/voice/speech-to-speech.md +0 -103
  96. package/.docs/docs/voice/speech-to-text.md +0 -80
  97. package/.docs/docs/voice/text-to-speech.md +0 -84
  98. package/.docs/docs/workflows/agents-and-tools.md +0 -170
  99. package/.docs/docs/workflows/control-flow.md +0 -823
  100. package/.docs/docs/workflows/error-handling.md +0 -360
  101. package/.docs/docs/workflows/human-in-the-loop.md +0 -213
  102. package/.docs/docs/workflows/overview.md +0 -372
  103. package/.docs/docs/workflows/snapshots.md +0 -238
  104. package/.docs/docs/workflows/suspend-and-resume.md +0 -205
  105. package/.docs/docs/workflows/time-travel.md +0 -309
  106. package/.docs/docs/workflows/workflow-state.md +0 -181
  107. package/.docs/docs/workspace/filesystem.md +0 -162
  108. package/.docs/docs/workspace/overview.md +0 -239
  109. package/.docs/docs/workspace/sandbox.md +0 -63
  110. package/.docs/docs/workspace/search.md +0 -219
  111. package/.docs/docs/workspace/skills.md +0 -126
  112. package/.docs/guides/agent-frameworks/ai-sdk.md +0 -140
  113. package/.docs/guides/build-your-ui/ai-sdk-ui.md +0 -1463
  114. package/.docs/guides/build-your-ui/assistant-ui.md +0 -156
  115. package/.docs/guides/build-your-ui/copilotkit.md +0 -292
  116. package/.docs/guides/deployment/amazon-ec2.md +0 -130
  117. package/.docs/guides/deployment/aws-lambda.md +0 -248
  118. package/.docs/guides/deployment/azure-app-services.md +0 -114
  119. package/.docs/guides/deployment/cloudflare.md +0 -99
  120. package/.docs/guides/deployment/digital-ocean.md +0 -168
  121. package/.docs/guides/deployment/inngest.md +0 -685
  122. package/.docs/guides/deployment/netlify.md +0 -77
  123. package/.docs/guides/deployment/vercel.md +0 -101
  124. package/.docs/guides/getting-started/astro.md +0 -408
  125. package/.docs/guides/getting-started/electron.md +0 -504
  126. package/.docs/guides/getting-started/express.md +0 -251
  127. package/.docs/guides/getting-started/hono.md +0 -191
  128. package/.docs/guides/getting-started/next-js.md +0 -355
  129. package/.docs/guides/getting-started/nuxt.md +0 -476
  130. package/.docs/guides/getting-started/quickstart.md +0 -67
  131. package/.docs/guides/getting-started/sveltekit.md +0 -300
  132. package/.docs/guides/getting-started/vite-react.md +0 -439
  133. package/.docs/guides/guide/ai-recruiter.md +0 -227
  134. package/.docs/guides/guide/chef-michel.md +0 -215
  135. package/.docs/guides/guide/code-review-bot.md +0 -221
  136. package/.docs/guides/guide/dev-assistant.md +0 -304
  137. package/.docs/guides/guide/docs-manager.md +0 -238
  138. package/.docs/guides/guide/github-actions-pr-description.md +0 -236
  139. package/.docs/guides/guide/notes-mcp-server.md +0 -425
  140. package/.docs/guides/guide/research-assistant.md +0 -349
  141. package/.docs/guides/guide/stock-agent.md +0 -134
  142. package/.docs/guides/guide/web-search.md +0 -326
  143. package/.docs/guides/guide/whatsapp-chat-bot.md +0 -416
  144. package/.docs/guides/index.md +0 -3
  145. package/.docs/guides/migrations/agentnetwork.md +0 -101
  146. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +0 -112
  147. package/.docs/guides/migrations/upgrade-to-v1/agent.md +0 -404
  148. package/.docs/guides/migrations/upgrade-to-v1/cli.md +0 -57
  149. package/.docs/guides/migrations/upgrade-to-v1/client.md +0 -337
  150. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +0 -37
  151. package/.docs/guides/migrations/upgrade-to-v1/evals.md +0 -239
  152. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +0 -143
  153. package/.docs/guides/migrations/upgrade-to-v1/mcp.md +0 -97
  154. package/.docs/guides/migrations/upgrade-to-v1/memory.md +0 -285
  155. package/.docs/guides/migrations/upgrade-to-v1/overview.md +0 -119
  156. package/.docs/guides/migrations/upgrade-to-v1/processors.md +0 -68
  157. package/.docs/guides/migrations/upgrade-to-v1/rag.md +0 -42
  158. package/.docs/guides/migrations/upgrade-to-v1/storage.md +0 -553
  159. package/.docs/guides/migrations/upgrade-to-v1/tools.md +0 -180
  160. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +0 -417
  161. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +0 -87
  162. package/.docs/guides/migrations/upgrade-to-v1/voice.md +0 -30
  163. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +0 -341
  164. package/.docs/guides/migrations/vnext-to-standard-apis.md +0 -364
  165. package/.docs/models/embeddings.md +0 -161
  166. package/.docs/models/gateways/azure-openai.md +0 -128
  167. package/.docs/models/gateways/custom-gateways.md +0 -545
  168. package/.docs/models/gateways/netlify.md +0 -88
  169. package/.docs/models/gateways/openrouter.md +0 -219
  170. package/.docs/models/gateways/vercel.md +0 -225
  171. package/.docs/models/gateways.md +0 -14
  172. package/.docs/models/index.md +0 -286
  173. package/.docs/models/providers/302ai.md +0 -134
  174. package/.docs/models/providers/abacus.md +0 -125
  175. package/.docs/models/providers/agentrouter.md +0 -90
  176. package/.docs/models/providers/aihubmix.md +0 -107
  177. package/.docs/models/providers/alibaba-cn.md +0 -135
  178. package/.docs/models/providers/alibaba.md +0 -111
  179. package/.docs/models/providers/amazon-bedrock.md +0 -33
  180. package/.docs/models/providers/anthropic.md +0 -153
  181. package/.docs/models/providers/azure.md +0 -33
  182. package/.docs/models/providers/bailing.md +0 -72
  183. package/.docs/models/providers/baseten.md +0 -77
  184. package/.docs/models/providers/berget.md +0 -78
  185. package/.docs/models/providers/cerebras.md +0 -101
  186. package/.docs/models/providers/chutes.md +0 -136
  187. package/.docs/models/providers/cloudflare-ai-gateway.md +0 -33
  188. package/.docs/models/providers/cloudflare-workers-ai.md +0 -109
  189. package/.docs/models/providers/cohere.md +0 -33
  190. package/.docs/models/providers/cortecs.md +0 -91
  191. package/.docs/models/providers/deepinfra.md +0 -112
  192. package/.docs/models/providers/deepseek.md +0 -88
  193. package/.docs/models/providers/fastrouter.md +0 -84
  194. package/.docs/models/providers/fireworks-ai.md +0 -89
  195. package/.docs/models/providers/firmware.md +0 -85
  196. package/.docs/models/providers/friendli.md +0 -78
  197. package/.docs/models/providers/github-models.md +0 -125
  198. package/.docs/models/providers/google-vertex.md +0 -33
  199. package/.docs/models/providers/google.md +0 -159
  200. package/.docs/models/providers/groq.md +0 -107
  201. package/.docs/models/providers/helicone.md +0 -161
  202. package/.docs/models/providers/huggingface.md +0 -90
  203. package/.docs/models/providers/iflowcn.md +0 -84
  204. package/.docs/models/providers/inception.md +0 -72
  205. package/.docs/models/providers/inference.md +0 -79
  206. package/.docs/models/providers/io-intelligence.md +0 -87
  207. package/.docs/models/providers/io-net.md +0 -87
  208. package/.docs/models/providers/jiekou.md +0 -131
  209. package/.docs/models/providers/kilo.md +0 -333
  210. package/.docs/models/providers/kimi-for-coding.md +0 -100
  211. package/.docs/models/providers/kuae-cloud-coding-plan.md +0 -71
  212. package/.docs/models/providers/llama.md +0 -77
  213. package/.docs/models/providers/lmstudio.md +0 -73
  214. package/.docs/models/providers/lucidquery.md +0 -72
  215. package/.docs/models/providers/minimax-cn-coding-plan.md +0 -102
  216. package/.docs/models/providers/minimax-cn.md +0 -102
  217. package/.docs/models/providers/minimax-coding-plan.md +0 -102
  218. package/.docs/models/providers/minimax.md +0 -104
  219. package/.docs/models/providers/mistral.md +0 -124
  220. package/.docs/models/providers/moark.md +0 -72
  221. package/.docs/models/providers/modelscope.md +0 -77
  222. package/.docs/models/providers/moonshotai-cn.md +0 -76
  223. package/.docs/models/providers/moonshotai.md +0 -76
  224. package/.docs/models/providers/morph.md +0 -73
  225. package/.docs/models/providers/nano-gpt.md +0 -103
  226. package/.docs/models/providers/nebius.md +0 -116
  227. package/.docs/models/providers/nova.md +0 -72
  228. package/.docs/models/providers/novita-ai.md +0 -154
  229. package/.docs/models/providers/nvidia.md +0 -141
  230. package/.docs/models/providers/ollama-cloud.md +0 -103
  231. package/.docs/models/providers/ollama.md +0 -33
  232. package/.docs/models/providers/openai.md +0 -193
  233. package/.docs/models/providers/opencode.md +0 -100
  234. package/.docs/models/providers/ovhcloud.md +0 -83
  235. package/.docs/models/providers/perplexity.md +0 -100
  236. package/.docs/models/providers/poe.md +0 -183
  237. package/.docs/models/providers/privatemode-ai.md +0 -75
  238. package/.docs/models/providers/requesty.md +0 -90
  239. package/.docs/models/providers/scaleway.md +0 -84
  240. package/.docs/models/providers/siliconflow-cn.md +0 -138
  241. package/.docs/models/providers/siliconflow.md +0 -140
  242. package/.docs/models/providers/stackit.md +0 -78
  243. package/.docs/models/providers/stepfun.md +0 -73
  244. package/.docs/models/providers/submodel.md +0 -79
  245. package/.docs/models/providers/synthetic.md +0 -96
  246. package/.docs/models/providers/togetherai.md +0 -115
  247. package/.docs/models/providers/upstage.md +0 -73
  248. package/.docs/models/providers/venice.md +0 -95
  249. package/.docs/models/providers/vivgrid.md +0 -106
  250. package/.docs/models/providers/vultr.md +0 -75
  251. package/.docs/models/providers/wandb.md +0 -80
  252. package/.docs/models/providers/xai.md +0 -141
  253. package/.docs/models/providers/xiaomi.md +0 -71
  254. package/.docs/models/providers/zai-coding-plan.md +0 -80
  255. package/.docs/models/providers/zai.md +0 -79
  256. package/.docs/models/providers/zenmux.md +0 -161
  257. package/.docs/models/providers/zhipuai-coding-plan.md +0 -79
  258. package/.docs/models/providers/zhipuai.md +0 -79
  259. package/.docs/models/providers.md +0 -81
  260. package/.docs/reference/agents/agent.md +0 -142
  261. package/.docs/reference/agents/generate.md +0 -174
  262. package/.docs/reference/agents/generateLegacy.md +0 -176
  263. package/.docs/reference/agents/getDefaultGenerateOptions.md +0 -36
  264. package/.docs/reference/agents/getDefaultOptions.md +0 -34
  265. package/.docs/reference/agents/getDefaultStreamOptions.md +0 -36
  266. package/.docs/reference/agents/getDescription.md +0 -21
  267. package/.docs/reference/agents/getInstructions.md +0 -34
  268. package/.docs/reference/agents/getLLM.md +0 -37
  269. package/.docs/reference/agents/getMemory.md +0 -34
  270. package/.docs/reference/agents/getModel.md +0 -34
  271. package/.docs/reference/agents/getTools.md +0 -29
  272. package/.docs/reference/agents/getVoice.md +0 -34
  273. package/.docs/reference/agents/listAgents.md +0 -35
  274. package/.docs/reference/agents/listScorers.md +0 -34
  275. package/.docs/reference/agents/listTools.md +0 -34
  276. package/.docs/reference/agents/listWorkflows.md +0 -34
  277. package/.docs/reference/agents/network.md +0 -134
  278. package/.docs/reference/ai-sdk/chat-route.md +0 -82
  279. package/.docs/reference/ai-sdk/handle-chat-stream.md +0 -53
  280. package/.docs/reference/ai-sdk/handle-network-stream.md +0 -37
  281. package/.docs/reference/ai-sdk/handle-workflow-stream.md +0 -55
  282. package/.docs/reference/ai-sdk/network-route.md +0 -74
  283. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +0 -232
  284. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +0 -79
  285. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +0 -73
  286. package/.docs/reference/ai-sdk/with-mastra.md +0 -59
  287. package/.docs/reference/ai-sdk/workflow-route.md +0 -79
  288. package/.docs/reference/auth/auth0.md +0 -73
  289. package/.docs/reference/auth/better-auth.md +0 -71
  290. package/.docs/reference/auth/clerk.md +0 -36
  291. package/.docs/reference/auth/firebase.md +0 -80
  292. package/.docs/reference/auth/jwt.md +0 -26
  293. package/.docs/reference/auth/supabase.md +0 -33
  294. package/.docs/reference/auth/workos.md +0 -84
  295. package/.docs/reference/cli/create-mastra.md +0 -137
  296. package/.docs/reference/cli/mastra.md +0 -336
  297. package/.docs/reference/client-js/agents.md +0 -438
  298. package/.docs/reference/client-js/error-handling.md +0 -16
  299. package/.docs/reference/client-js/logs.md +0 -24
  300. package/.docs/reference/client-js/mastra-client.md +0 -63
  301. package/.docs/reference/client-js/memory.md +0 -225
  302. package/.docs/reference/client-js/observability.md +0 -72
  303. package/.docs/reference/client-js/telemetry.md +0 -20
  304. package/.docs/reference/client-js/tools.md +0 -44
  305. package/.docs/reference/client-js/vectors.md +0 -79
  306. package/.docs/reference/client-js/workflows.md +0 -199
  307. package/.docs/reference/configuration.md +0 -749
  308. package/.docs/reference/core/addGateway.md +0 -42
  309. package/.docs/reference/core/getAgent.md +0 -21
  310. package/.docs/reference/core/getAgentById.md +0 -21
  311. package/.docs/reference/core/getDeployer.md +0 -22
  312. package/.docs/reference/core/getGateway.md +0 -38
  313. package/.docs/reference/core/getGatewayById.md +0 -41
  314. package/.docs/reference/core/getLogger.md +0 -22
  315. package/.docs/reference/core/getMCPServer.md +0 -45
  316. package/.docs/reference/core/getMCPServerById.md +0 -53
  317. package/.docs/reference/core/getMemory.md +0 -50
  318. package/.docs/reference/core/getScorer.md +0 -54
  319. package/.docs/reference/core/getScorerById.md +0 -54
  320. package/.docs/reference/core/getServer.md +0 -22
  321. package/.docs/reference/core/getStorage.md +0 -22
  322. package/.docs/reference/core/getStoredAgentById.md +0 -89
  323. package/.docs/reference/core/getTelemetry.md +0 -22
  324. package/.docs/reference/core/getVector.md +0 -22
  325. package/.docs/reference/core/getWorkflow.md +0 -40
  326. package/.docs/reference/core/listAgents.md +0 -21
  327. package/.docs/reference/core/listGateways.md +0 -40
  328. package/.docs/reference/core/listLogs.md +0 -38
  329. package/.docs/reference/core/listLogsByRunId.md +0 -36
  330. package/.docs/reference/core/listMCPServers.md +0 -51
  331. package/.docs/reference/core/listMemory.md +0 -56
  332. package/.docs/reference/core/listScorers.md +0 -29
  333. package/.docs/reference/core/listStoredAgents.md +0 -93
  334. package/.docs/reference/core/listVectors.md +0 -22
  335. package/.docs/reference/core/listWorkflows.md +0 -21
  336. package/.docs/reference/core/mastra-class.md +0 -66
  337. package/.docs/reference/core/mastra-model-gateway.md +0 -153
  338. package/.docs/reference/core/setLogger.md +0 -26
  339. package/.docs/reference/core/setStorage.md +0 -27
  340. package/.docs/reference/datasets/addItem.md +0 -35
  341. package/.docs/reference/datasets/addItems.md +0 -33
  342. package/.docs/reference/datasets/compareExperiments.md +0 -48
  343. package/.docs/reference/datasets/create.md +0 -49
  344. package/.docs/reference/datasets/dataset.md +0 -78
  345. package/.docs/reference/datasets/datasets-manager.md +0 -84
  346. package/.docs/reference/datasets/delete.md +0 -23
  347. package/.docs/reference/datasets/deleteExperiment.md +0 -25
  348. package/.docs/reference/datasets/deleteItem.md +0 -25
  349. package/.docs/reference/datasets/deleteItems.md +0 -27
  350. package/.docs/reference/datasets/get.md +0 -29
  351. package/.docs/reference/datasets/getDetails.md +0 -45
  352. package/.docs/reference/datasets/getExperiment.md +0 -28
  353. package/.docs/reference/datasets/getItem.md +0 -31
  354. package/.docs/reference/datasets/getItemHistory.md +0 -29
  355. package/.docs/reference/datasets/list.md +0 -29
  356. package/.docs/reference/datasets/listExperimentResults.md +0 -37
  357. package/.docs/reference/datasets/listExperiments.md +0 -31
  358. package/.docs/reference/datasets/listItems.md +0 -44
  359. package/.docs/reference/datasets/listVersions.md +0 -31
  360. package/.docs/reference/datasets/startExperiment.md +0 -60
  361. package/.docs/reference/datasets/startExperimentAsync.md +0 -41
  362. package/.docs/reference/datasets/update.md +0 -46
  363. package/.docs/reference/datasets/updateItem.md +0 -36
  364. package/.docs/reference/deployer/cloudflare.md +0 -79
  365. package/.docs/reference/deployer/netlify.md +0 -82
  366. package/.docs/reference/deployer/vercel.md +0 -91
  367. package/.docs/reference/deployer.md +0 -100
  368. package/.docs/reference/evals/answer-relevancy.md +0 -105
  369. package/.docs/reference/evals/answer-similarity.md +0 -99
  370. package/.docs/reference/evals/bias.md +0 -120
  371. package/.docs/reference/evals/completeness.md +0 -137
  372. package/.docs/reference/evals/content-similarity.md +0 -101
  373. package/.docs/reference/evals/context-precision.md +0 -196
  374. package/.docs/reference/evals/context-relevance.md +0 -536
  375. package/.docs/reference/evals/create-scorer.md +0 -270
  376. package/.docs/reference/evals/faithfulness.md +0 -114
  377. package/.docs/reference/evals/hallucination.md +0 -220
  378. package/.docs/reference/evals/keyword-coverage.md +0 -128
  379. package/.docs/reference/evals/mastra-scorer.md +0 -123
  380. package/.docs/reference/evals/noise-sensitivity.md +0 -685
  381. package/.docs/reference/evals/prompt-alignment.md +0 -619
  382. package/.docs/reference/evals/run-evals.md +0 -138
  383. package/.docs/reference/evals/scorer-utils.md +0 -330
  384. package/.docs/reference/evals/textual-difference.md +0 -113
  385. package/.docs/reference/evals/tone-consistency.md +0 -119
  386. package/.docs/reference/evals/tool-call-accuracy.md +0 -533
  387. package/.docs/reference/evals/toxicity.md +0 -123
  388. package/.docs/reference/harness/harness-class.md +0 -645
  389. package/.docs/reference/index.md +0 -276
  390. package/.docs/reference/logging/pino-logger.md +0 -117
  391. package/.docs/reference/memory/clone-utilities.md +0 -199
  392. package/.docs/reference/memory/cloneThread.md +0 -130
  393. package/.docs/reference/memory/createThread.md +0 -68
  394. package/.docs/reference/memory/deleteMessages.md +0 -40
  395. package/.docs/reference/memory/getThreadById.md +0 -24
  396. package/.docs/reference/memory/listThreads.md +0 -145
  397. package/.docs/reference/memory/memory-class.md +0 -147
  398. package/.docs/reference/memory/observational-memory.md +0 -565
  399. package/.docs/reference/memory/recall.md +0 -91
  400. package/.docs/reference/observability/tracing/bridges/otel.md +0 -131
  401. package/.docs/reference/observability/tracing/configuration.md +0 -178
  402. package/.docs/reference/observability/tracing/exporters/arize.md +0 -141
  403. package/.docs/reference/observability/tracing/exporters/braintrust.md +0 -93
  404. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +0 -163
  405. package/.docs/reference/observability/tracing/exporters/console-exporter.md +0 -138
  406. package/.docs/reference/observability/tracing/exporters/datadog.md +0 -116
  407. package/.docs/reference/observability/tracing/exporters/default-exporter.md +0 -174
  408. package/.docs/reference/observability/tracing/exporters/laminar.md +0 -78
  409. package/.docs/reference/observability/tracing/exporters/langfuse.md +0 -134
  410. package/.docs/reference/observability/tracing/exporters/langsmith.md +0 -110
  411. package/.docs/reference/observability/tracing/exporters/otel.md +0 -199
  412. package/.docs/reference/observability/tracing/exporters/posthog.md +0 -92
  413. package/.docs/reference/observability/tracing/exporters/sentry.md +0 -184
  414. package/.docs/reference/observability/tracing/instances.md +0 -109
  415. package/.docs/reference/observability/tracing/interfaces.md +0 -749
  416. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +0 -144
  417. package/.docs/reference/observability/tracing/spans.md +0 -224
  418. package/.docs/reference/processors/batch-parts-processor.md +0 -61
  419. package/.docs/reference/processors/language-detector.md +0 -81
  420. package/.docs/reference/processors/message-history-processor.md +0 -85
  421. package/.docs/reference/processors/moderation-processor.md +0 -104
  422. package/.docs/reference/processors/pii-detector.md +0 -107
  423. package/.docs/reference/processors/processor-interface.md +0 -525
  424. package/.docs/reference/processors/prompt-injection-detector.md +0 -71
  425. package/.docs/reference/processors/semantic-recall-processor.md +0 -123
  426. package/.docs/reference/processors/system-prompt-scrubber.md +0 -80
  427. package/.docs/reference/processors/token-limiter-processor.md +0 -113
  428. package/.docs/reference/processors/tool-call-filter.md +0 -85
  429. package/.docs/reference/processors/tool-search-processor.md +0 -113
  430. package/.docs/reference/processors/unicode-normalizer.md +0 -62
  431. package/.docs/reference/processors/working-memory-processor.md +0 -154
  432. package/.docs/reference/rag/chunk.md +0 -221
  433. package/.docs/reference/rag/database-config.md +0 -264
  434. package/.docs/reference/rag/document.md +0 -114
  435. package/.docs/reference/rag/embeddings.md +0 -92
  436. package/.docs/reference/rag/extract-params.md +0 -168
  437. package/.docs/reference/rag/graph-rag.md +0 -111
  438. package/.docs/reference/rag/metadata-filters.md +0 -216
  439. package/.docs/reference/rag/rerank.md +0 -80
  440. package/.docs/reference/rag/rerankWithScorer.md +0 -80
  441. package/.docs/reference/server/create-route.md +0 -260
  442. package/.docs/reference/server/express-adapter.md +0 -176
  443. package/.docs/reference/server/fastify-adapter.md +0 -90
  444. package/.docs/reference/server/hono-adapter.md +0 -162
  445. package/.docs/reference/server/koa-adapter.md +0 -127
  446. package/.docs/reference/server/mastra-server.md +0 -298
  447. package/.docs/reference/server/register-api-route.md +0 -249
  448. package/.docs/reference/server/routes.md +0 -306
  449. package/.docs/reference/storage/cloudflare-d1.md +0 -218
  450. package/.docs/reference/storage/cloudflare.md +0 -88
  451. package/.docs/reference/storage/composite.md +0 -235
  452. package/.docs/reference/storage/convex.md +0 -161
  453. package/.docs/reference/storage/dynamodb.md +0 -282
  454. package/.docs/reference/storage/lance.md +0 -131
  455. package/.docs/reference/storage/libsql.md +0 -135
  456. package/.docs/reference/storage/mongodb.md +0 -262
  457. package/.docs/reference/storage/mssql.md +0 -155
  458. package/.docs/reference/storage/overview.md +0 -121
  459. package/.docs/reference/storage/postgresql.md +0 -529
  460. package/.docs/reference/storage/upstash.md +0 -160
  461. package/.docs/reference/streaming/ChunkType.md +0 -292
  462. package/.docs/reference/streaming/agents/MastraModelOutput.md +0 -182
  463. package/.docs/reference/streaming/agents/stream.md +0 -212
  464. package/.docs/reference/streaming/agents/streamLegacy.md +0 -142
  465. package/.docs/reference/streaming/workflows/observeStream.md +0 -42
  466. package/.docs/reference/streaming/workflows/resumeStream.md +0 -61
  467. package/.docs/reference/streaming/workflows/stream.md +0 -88
  468. package/.docs/reference/streaming/workflows/timeTravelStream.md +0 -142
  469. package/.docs/reference/templates/overview.md +0 -194
  470. package/.docs/reference/tools/create-tool.md +0 -237
  471. package/.docs/reference/tools/document-chunker-tool.md +0 -89
  472. package/.docs/reference/tools/graph-rag-tool.md +0 -185
  473. package/.docs/reference/tools/mcp-client.md +0 -962
  474. package/.docs/reference/tools/mcp-server.md +0 -1275
  475. package/.docs/reference/tools/vector-query-tool.md +0 -459
  476. package/.docs/reference/vectors/astra.md +0 -121
  477. package/.docs/reference/vectors/chroma.md +0 -267
  478. package/.docs/reference/vectors/convex.md +0 -303
  479. package/.docs/reference/vectors/couchbase.md +0 -226
  480. package/.docs/reference/vectors/duckdb.md +0 -318
  481. package/.docs/reference/vectors/elasticsearch.md +0 -189
  482. package/.docs/reference/vectors/lance.md +0 -220
  483. package/.docs/reference/vectors/libsql.md +0 -305
  484. package/.docs/reference/vectors/mongodb.md +0 -295
  485. package/.docs/reference/vectors/opensearch.md +0 -99
  486. package/.docs/reference/vectors/pg.md +0 -408
  487. package/.docs/reference/vectors/pinecone.md +0 -168
  488. package/.docs/reference/vectors/qdrant.md +0 -222
  489. package/.docs/reference/vectors/s3vectors.md +0 -277
  490. package/.docs/reference/vectors/turbopuffer.md +0 -157
  491. package/.docs/reference/vectors/upstash.md +0 -294
  492. package/.docs/reference/vectors/vectorize.md +0 -147
  493. package/.docs/reference/voice/azure.md +0 -148
  494. package/.docs/reference/voice/cloudflare.md +0 -83
  495. package/.docs/reference/voice/composite-voice.md +0 -121
  496. package/.docs/reference/voice/deepgram.md +0 -79
  497. package/.docs/reference/voice/elevenlabs.md +0 -98
  498. package/.docs/reference/voice/google-gemini-live.md +0 -378
  499. package/.docs/reference/voice/google.md +0 -228
  500. package/.docs/reference/voice/mastra-voice.md +0 -313
  501. package/.docs/reference/voice/murf.md +0 -122
  502. package/.docs/reference/voice/openai-realtime.md +0 -203
  503. package/.docs/reference/voice/openai.md +0 -88
  504. package/.docs/reference/voice/playai.md +0 -80
  505. package/.docs/reference/voice/sarvam.md +0 -126
  506. package/.docs/reference/voice/speechify.md +0 -75
  507. package/.docs/reference/voice/voice.addInstructions.md +0 -56
  508. package/.docs/reference/voice/voice.addTools.md +0 -67
  509. package/.docs/reference/voice/voice.answer.md +0 -54
  510. package/.docs/reference/voice/voice.close.md +0 -51
  511. package/.docs/reference/voice/voice.connect.md +0 -94
  512. package/.docs/reference/voice/voice.events.md +0 -37
  513. package/.docs/reference/voice/voice.getSpeakers.md +0 -129
  514. package/.docs/reference/voice/voice.listen.md +0 -164
  515. package/.docs/reference/voice/voice.off.md +0 -54
  516. package/.docs/reference/voice/voice.on.md +0 -111
  517. package/.docs/reference/voice/voice.send.md +0 -65
  518. package/.docs/reference/voice/voice.speak.md +0 -157
  519. package/.docs/reference/voice/voice.updateConfig.md +0 -60
  520. package/.docs/reference/workflows/run-methods/cancel.md +0 -86
  521. package/.docs/reference/workflows/run-methods/restart.md +0 -33
  522. package/.docs/reference/workflows/run-methods/resume.md +0 -59
  523. package/.docs/reference/workflows/run-methods/start.md +0 -58
  524. package/.docs/reference/workflows/run-methods/startAsync.md +0 -67
  525. package/.docs/reference/workflows/run-methods/timeTravel.md +0 -142
  526. package/.docs/reference/workflows/run.md +0 -59
  527. package/.docs/reference/workflows/step.md +0 -119
  528. package/.docs/reference/workflows/workflow-methods/branch.md +0 -25
  529. package/.docs/reference/workflows/workflow-methods/commit.md +0 -17
  530. package/.docs/reference/workflows/workflow-methods/create-run.md +0 -63
  531. package/.docs/reference/workflows/workflow-methods/dountil.md +0 -25
  532. package/.docs/reference/workflows/workflow-methods/dowhile.md +0 -25
  533. package/.docs/reference/workflows/workflow-methods/foreach.md +0 -118
  534. package/.docs/reference/workflows/workflow-methods/map.md +0 -93
  535. package/.docs/reference/workflows/workflow-methods/parallel.md +0 -21
  536. package/.docs/reference/workflows/workflow-methods/sleep.md +0 -35
  537. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +0 -35
  538. package/.docs/reference/workflows/workflow-methods/then.md +0 -21
  539. package/.docs/reference/workflows/workflow.md +0 -157
  540. package/.docs/reference/workspace/e2b-sandbox.md +0 -288
  541. package/.docs/reference/workspace/filesystem.md +0 -202
  542. package/.docs/reference/workspace/gcs-filesystem.md +0 -170
  543. package/.docs/reference/workspace/local-filesystem.md +0 -327
  544. package/.docs/reference/workspace/local-sandbox.md +0 -285
  545. package/.docs/reference/workspace/s3-filesystem.md +0 -169
  546. package/.docs/reference/workspace/sandbox.md +0 -81
  547. package/.docs/reference/workspace/workspace-class.md +0 -226
@@ -1,823 +0,0 @@
1
- # Control Flow
2
-
3
- Workflows run a sequence of predefined tasks, and you can control how that flow is executed. Tasks are divided into **steps**, which can be executed in different ways depending on your requirements. They can run sequentially, in parallel, or follow different paths based on conditions.
4
-
5
- Each step connects to the next in the workflow through defined schemas that keep data controlled and consistent.
6
-
7
- ## Core principles
8
-
9
- - The first step’s `inputSchema` must match the workflow’s `inputSchema`.
10
- - The final step’s `outputSchema` must match the workflow’s `outputSchema`.
11
- - Each step’s `outputSchema` must match the next step’s `inputSchema`.
12
- - If it doesn’t, use [Input data mapping](#input-data-mapping) to transform the data into the required shape.
13
-
14
- ## Chaining steps with `.then()`
15
-
16
- Use `.then()` to run steps in order, allowing each step to access the result of the step before it.
17
-
18
- ![Chaining steps with .then()](/assets/images/workflows-control-flow-then-bde5e0fbefe5c64c19a8c3471c0e8439.jpg)
19
-
20
- ```typescript
21
- const step1 = createStep({
22
- inputSchema: z.object({
23
- message: z.string()
24
- }),
25
- outputSchema: z.object({
26
- formatted: z.string()
27
- })
28
- });
29
-
30
- const step2 = createStep({
31
- inputSchema: z.object({
32
- formatted: z.string()
33
- }),
34
- outputSchema: z.object({
35
- emphasized: z.string()
36
- })
37
- });
38
-
39
- export const testWorkflow = createWorkflow({
40
- inputSchema: z.object({
41
- message: z.string()
42
- }),
43
- outputSchema: z.object({
44
- emphasized: z.string()
45
- })
46
- })
47
- .then(step1)
48
- .then(step2)
49
- .commit();
50
- ```
51
-
52
- ## Simultaneous steps with `.parallel()`
53
-
54
- Use `.parallel()` to run steps at the same time. All parallel steps must complete before the workflow continues to the next step. Each step's `id` is used when defining a following step's `inputSchema` and becomes the key on the `inputData` object used to access the previous step's values. The outputs of parallel steps can then be referenced or combined by a following step.
55
-
56
- ![Concurrent steps with .parallel()](/assets/images/workflows-control-flow-parallel-8e7fe60f1c4daa510431b37c973f6f8d.jpg)
57
-
58
- ```typescript
59
- const step1 = createStep({
60
- id: "step-1",
61
- });
62
-
63
- const step2 = createStep({
64
- id: "step-2",
65
- });
66
-
67
- const step3 = createStep({
68
- id: "step-3",
69
- inputSchema: z.object({
70
- "step-1": z.object({
71
- formatted: z.string()
72
- }),
73
- "step-2": z.object({
74
- emphasized: z.string()
75
- })
76
- }),
77
- outputSchema: z.object({
78
- combined: z.string()
79
- }),
80
- execute: async ({ inputData }) => {
81
- const { formatted } = inputData["step-1"];
82
- const { emphasized } = inputData["step-2"];
83
- return {
84
- combined: `${formatted} | ${emphasized}`
85
- };
86
- }
87
- });
88
-
89
- export const testWorkflow = createWorkflow({
90
- inputSchema: z.object({
91
- message: z.string()
92
- }),
93
- outputSchema: z.object({
94
- combined: z.string()
95
- })
96
- })
97
- .parallel([step1, step2])
98
- .then(step3)
99
- .commit();
100
- ```
101
-
102
- > 📹 Watch: How to run steps in parallel and optimize your Mastra workflow → [YouTube (3 minutes)](https://youtu.be/GQJxve5Hki4)
103
-
104
- ### Output structure
105
-
106
- When steps run in parallel, the output is an object where each key is the step's `id` and the value is that step's output. This allows you to access each parallel step's result independently.
107
-
108
- ```typescript
109
- const step1 = createStep({
110
- id: "format-step",
111
- inputSchema: z.object({ message: z.string() }),
112
- outputSchema: z.object({ formatted: z.string() }),
113
- execute: async ({ inputData }) => ({
114
- formatted: inputData.message.toUpperCase()
115
- })
116
- });
117
-
118
- const step2 = createStep({
119
- id: "count-step",
120
- inputSchema: z.object({ message: z.string() }),
121
- outputSchema: z.object({ count: z.number() }),
122
- execute: async ({ inputData }) => ({
123
- count: inputData.message.length
124
- })
125
- });
126
-
127
- const step3 = createStep({
128
- id: "combine-step",
129
- // The inputSchema must match the structure of parallel outputs
130
- inputSchema: z.object({
131
- "format-step": z.object({ formatted: z.string() }),
132
- "count-step": z.object({ count: z.number() })
133
- }),
134
- outputSchema: z.object({ result: z.string() }),
135
- execute: async ({ inputData }) => {
136
- // Access each parallel step's output by its id
137
- const formatted = inputData["format-step"].formatted;
138
- const count = inputData["count-step"].count;
139
- return {
140
- result: `${formatted} (${count} characters)`
141
- };
142
- }
143
- });
144
-
145
- export const testWorkflow = createWorkflow({
146
- id: "parallel-output-example",
147
- inputSchema: z.object({ message: z.string() }),
148
- outputSchema: z.object({ result: z.string() })
149
- })
150
- .parallel([step1, step2])
151
- .then(step3)
152
- .commit();
153
-
154
- // When executed with { message: "hello" }
155
- // The parallel output structure will be:
156
- // {
157
- // "format-step": { formatted: "HELLO" },
158
- // "count-step": { count: 5 }
159
- // }
160
- ```
161
-
162
- **Key points:**
163
-
164
- - Each parallel step's output is keyed by its `id`
165
- - All parallel steps execute simultaneously
166
- - The next step receives an object containing all parallel step outputs
167
- - You must define the `inputSchema` of the following step to match this structure
168
-
169
- > **Info:** Visit [Choosing the right pattern](#choosing-the-right-pattern) to understand when to use `.parallel()` vs `.foreach()`.
170
-
171
- ## Conditional logic with `.branch()`
172
-
173
- Use `.branch()` to choose which step to run based on a condition. All steps in a branch need the same `inputSchema` and `outputSchema` because branching requires consistent schemas so workflows can follow different paths.
174
-
175
- ![Conditional branching with .branch()](/assets/images/workflows-control-flow-branch-1913ef107ba0198d73aa3c0a65145b7a.jpg)
176
-
177
- ```typescript
178
- const step1 = createStep({...})
179
-
180
- const stepA = createStep({
181
- inputSchema: z.object({
182
- value: z.number()
183
- }),
184
- outputSchema: z.object({
185
- result: z.string()
186
- })
187
- });
188
-
189
- const stepB = createStep({
190
- inputSchema: z.object({
191
- value: z.number()
192
- }),
193
- outputSchema: z.object({
194
- result: z.string()
195
- })
196
- });
197
-
198
- export const testWorkflow = createWorkflow({
199
- inputSchema: z.object({
200
- value: z.number()
201
- }),
202
- outputSchema: z.object({
203
- result: z.string()
204
- })
205
- })
206
- .then(step1)
207
- .branch([
208
- [async ({ inputData: { value } }) => value > 10, stepA],
209
- [async ({ inputData: { value } }) => value <= 10, stepB]
210
- ])
211
- .commit();
212
- ```
213
-
214
- ### Output structure
215
-
216
- When using conditional branching, only one branch executes based on which condition evaluates to `true` first. The output structure is similar to `.parallel()`, where the result is keyed by the executed step's `id`.
217
-
218
- ```typescript
219
- const step1 = createStep({
220
- id: "initial-step",
221
- inputSchema: z.object({ value: z.number() }),
222
- outputSchema: z.object({ value: z.number() }),
223
- execute: async ({ inputData }) => inputData
224
- });
225
-
226
- const highValueStep = createStep({
227
- id: "high-value-step",
228
- inputSchema: z.object({ value: z.number() }),
229
- outputSchema: z.object({ result: z.string() }),
230
- execute: async ({ inputData }) => ({
231
- result: `High value: ${inputData.value}`
232
- })
233
- });
234
-
235
- const lowValueStep = createStep({
236
- id: "low-value-step",
237
- inputSchema: z.object({ value: z.number() }),
238
- outputSchema: z.object({ result: z.string() }),
239
- execute: async ({ inputData }) => ({
240
- result: `Low value: ${inputData.value}`
241
- })
242
- });
243
-
244
- const finalStep = createStep({
245
- id: "final-step",
246
- // The inputSchema must account for either branch's output
247
- inputSchema: z.object({
248
- "high-value-step": z.object({ result: z.string() }).optional(),
249
- "low-value-step": z.object({ result: z.string() }).optional()
250
- }),
251
- outputSchema: z.object({ message: z.string() }),
252
- execute: async ({ inputData }) => {
253
- // Only one branch will have executed
254
- const result = inputData["high-value-step"]?.result ||
255
- inputData["low-value-step"]?.result;
256
- return { message: result };
257
- }
258
- });
259
-
260
- export const testWorkflow = createWorkflow({
261
- id: "branch-output-example",
262
- inputSchema: z.object({ value: z.number() }),
263
- outputSchema: z.object({ message: z.string() })
264
- })
265
- .then(step1)
266
- .branch([
267
- [async ({ inputData }) => inputData.value > 10, highValueStep],
268
- [async ({ inputData }) => inputData.value <= 10, lowValueStep]
269
- ])
270
- .then(finalStep)
271
- .commit();
272
-
273
- // When executed with { value: 15 }
274
- // Only the high-value-step executes, output structure:
275
- // {
276
- // "high-value-step": { result: "High value: 15" }
277
- // }
278
-
279
- // When executed with { value: 5 }
280
- // Only the low-value-step executes, output structure:
281
- // {
282
- // "low-value-step": { result: "Low value: 5" }
283
- // }
284
- ```
285
-
286
- **Key points:**
287
-
288
- - Only one branch executes based on condition evaluation order
289
- - The output is keyed by the executed step's `id`
290
- - Subsequent steps should handle all possible branch outputs
291
- - Use optional fields in the `inputSchema` when the next step needs to handle multiple possible branches
292
- - Conditions are evaluated in the order they're defined
293
-
294
- ## Input data mapping
295
-
296
- When using `.then()`, `.parallel()`, or `.branch()`, it is sometimes necessary to transform the output of a previous step to match the input of the next. In these cases you can use `.map()` to access the `inputData` and transform it to create a suitable data shape for the next step.
297
-
298
- ![Mapping with .map()](/assets/images/workflows-data-mapping-map-87fd84a06b4bbf4b93868a5db99ca179.jpg)
299
-
300
- ```typescript
301
- const step1 = createStep({...});
302
- const step2 = createStep({...});
303
-
304
- export const testWorkflow = createWorkflow({...})
305
- .then(step1)
306
- .map(async ({ inputData }) => {
307
- const { foo } = inputData;
308
- return {
309
- bar: `new ${foo}`,
310
- };
311
- })
312
- .then(step2)
313
- .commit();
314
- ```
315
-
316
- The `.map()` method provides additional helper functions for more complex mapping scenarios.
317
-
318
- **Available helper functions:**
319
-
320
- - [`getStepResult()`](https://mastra.ai/reference/workflows/workflow-methods/map): Access a specific step's full output
321
- - [`getInitData<any>()`](https://mastra.ai/reference/workflows/workflow-methods/map): Access the workflow's initial input data
322
- - [`mapVariable()`](https://mastra.ai/reference/workflows/workflow-methods/map): Use declarative object syntax to extract and rename fields
323
-
324
- ### Parallel and Branch outputs
325
-
326
- When working with `.parallel()` or `.branch()` outputs, you can use `.map()` to transform the data structure before passing it to the next step. This is especially useful when you need to flatten or restructure the output.
327
-
328
- ```typescript
329
- export const testWorkflow = createWorkflow({...})
330
- .parallel([step1, step2])
331
- .map(async ({ inputData }) => {
332
- // Transform the parallel output structure
333
- return {
334
- combined: `${inputData["step1"].value} - ${inputData["step2"].value}`
335
- };
336
- })
337
- .then(nextStep)
338
- .commit();
339
- ```
340
-
341
- You can also use the helper functions provided by `.map()`:
342
-
343
- ```typescript
344
- export const testWorkflow = createWorkflow({...})
345
- .branch([
346
- [condition1, stepA],
347
- [condition2, stepB]
348
- ])
349
- .map(async ({ inputData, getStepResult }) => {
350
- // Access specific step results
351
- const stepAResult = getStepResult("stepA");
352
- const stepBResult = getStepResult("stepB");
353
-
354
- // Return the result from whichever branch executed
355
- return stepAResult || stepBResult;
356
- })
357
- .then(nextStep)
358
- .commit();
359
- ```
360
-
361
- ## Looping steps
362
-
363
- Workflows support different looping methods that let you repeat steps until or while a condition is met, or iterate over arrays. Loops can be combined with other control methods like `.then()`.
364
-
365
- ### Looping with `.dountil()`
366
-
367
- Use `.dountil()` to run a step repeatedly until a condition becomes true.
368
-
369
- ![Repeating with .dountil()](/assets/images/workflows-control-flow-dountil-6b7b06e872f3bd878f69c716b0e38ae6.jpg)
370
-
371
- ```typescript
372
- const step1 = createStep({...});
373
-
374
- const step2 = createStep({
375
- execute: async ({ inputData }) => {
376
- const { number } = inputData;
377
- return {
378
- number: number + 1
379
- };
380
- }
381
- });
382
-
383
- export const testWorkflow = createWorkflow({})
384
- .then(step1)
385
- .dountil(step2, async ({ inputData: { number } }) => number > 10)
386
- .commit();
387
- ```
388
-
389
- ### Looping with `.dowhile()`
390
-
391
- Use `.dowhile()` to run a step repeatedly while a condition remains true.
392
-
393
- ![Repeating with .dowhile()](/assets/images/workflows-control-flow-dowhile-09bba2d43fb44352f458c144484326ed.jpg)
394
-
395
- ```typescript
396
- const step1 = createStep({...});
397
-
398
- const step2 = createStep({
399
- execute: async ({ inputData }) => {
400
- const { number } = inputData;
401
- return {
402
- number: number + 1
403
- };
404
- }
405
- });
406
-
407
- export const testWorkflow = createWorkflow({})
408
- .then(step1)
409
- .dowhile(step2, async ({ inputData: { number } }) => number < 10)
410
- .commit();
411
- ```
412
-
413
- ### Looping with `.foreach()`
414
-
415
- Use `.foreach()` to run the same step for each item in an array. The input must be of type `array` so the loop can iterate over its values, applying the step's logic to each one. See [Choosing the right pattern](#choosing-the-right-pattern) for guidance on when to use `.foreach()` vs other methods.
416
-
417
- ![Repeating with .foreach()](/assets/images/workflows-control-flow-foreach-a5b6f38d8797c4d1b7dca93879d709f7.jpg)
418
-
419
- ```typescript
420
- const step1 = createStep({
421
- inputSchema: z.string(),
422
- outputSchema: z.string(),
423
- execute: async ({ inputData }) => {
424
- return inputData.toUpperCase();
425
- }
426
- });
427
-
428
- const step2 = createStep({...});
429
-
430
- export const testWorkflow = createWorkflow({
431
- inputSchema: z.array(z.string()),
432
- outputSchema: z.array(z.string())
433
- })
434
- .foreach(step1)
435
- .then(step2)
436
- .commit();
437
- ```
438
-
439
- #### Output structure
440
-
441
- The `.foreach()` method always returns an array containing the output of each iteration. The order of outputs matches the order of inputs.
442
-
443
- ```typescript
444
- const addTenStep = createStep({
445
- id: "add-ten",
446
- inputSchema: z.object({ value: z.number() }),
447
- outputSchema: z.object({ value: z.number() }),
448
- execute: async ({ inputData }) => ({
449
- value: inputData.value + 10
450
- })
451
- });
452
-
453
- export const testWorkflow = createWorkflow({
454
- id: "foreach-output-example",
455
- inputSchema: z.array(z.object({ value: z.number() })),
456
- outputSchema: z.array(z.object({ value: z.number() }))
457
- })
458
- .foreach(addTenStep)
459
- .commit();
460
-
461
- // When executed with [{ value: 1 }, { value: 22 }, { value: 333 }]
462
- // Output: [{ value: 11 }, { value: 32 }, { value: 343 }]
463
- ```
464
-
465
- #### Concurrency limits
466
-
467
- Use `concurrency` to control the number of array items processed at the same time. The default is `1`, which runs steps sequentially. Increasing the value allows `.foreach()` to process multiple items simultaneously.
468
-
469
- ```typescript
470
- const step1 = createStep({...})
471
-
472
- export const testWorkflow = createWorkflow({...})
473
- .foreach(step1, { concurrency: 4 })
474
- .commit();
475
- ```
476
-
477
- #### Aggregating results after `.foreach()`
478
-
479
- Since `.foreach()` outputs an array, you can use `.then()` or `.map()` to aggregate or transform the results. The step following `.foreach()` receives the entire array as its input.
480
-
481
- ```typescript
482
- const processItemStep = createStep({
483
- id: "process-item",
484
- inputSchema: z.object({ value: z.number() }),
485
- outputSchema: z.object({ processed: z.number() }),
486
- execute: async ({ inputData }) => ({
487
- processed: inputData.value * 2
488
- })
489
- });
490
-
491
- const aggregateStep = createStep({
492
- id: "aggregate",
493
- // Input is an array of outputs from foreach
494
- inputSchema: z.array(z.object({ processed: z.number() })),
495
- outputSchema: z.object({ total: z.number() }),
496
- execute: async ({ inputData }) => ({
497
- // Sum all processed values
498
- total: inputData.reduce((sum, item) => sum + item.processed, 0)
499
- })
500
- });
501
-
502
- export const testWorkflow = createWorkflow({
503
- id: "foreach-aggregate-example",
504
- inputSchema: z.array(z.object({ value: z.number() })),
505
- outputSchema: z.object({ total: z.number() })
506
- })
507
- .foreach(processItemStep)
508
- .then(aggregateStep) // Receives the full array from foreach
509
- .commit();
510
-
511
- // When executed with [{ value: 1 }, { value: 2 }, { value: 3 }]
512
- // After foreach: [{ processed: 2 }, { processed: 4 }, { processed: 6 }]
513
- // After aggregate: { total: 12 }
514
- ```
515
-
516
- You can also use `.map()` to transform the array output:
517
-
518
- ```typescript
519
- export const testWorkflow = createWorkflow({...})
520
- .foreach(processItemStep)
521
- .map(async ({ inputData }) => ({
522
- // Transform the array into a different structure
523
- values: inputData.map(item => item.processed),
524
- count: inputData.length
525
- }))
526
- .then(nextStep)
527
- .commit();
528
- ```
529
-
530
- #### Chaining multiple `.foreach()` calls
531
-
532
- When you chain `.foreach()` calls, each operates on the array output of the previous step. This is useful when each item in your array needs to be transformed by multiple steps in sequence.
533
-
534
- ```typescript
535
- const chunkStep = createStep({
536
- id: "chunk",
537
- // Takes a document, returns an array of chunks
538
- inputSchema: z.object({ content: z.string() }),
539
- outputSchema: z.array(z.object({ chunk: z.string() })),
540
- execute: async ({ inputData }) => {
541
- // Split document into chunks
542
- const chunks = inputData.content.match(/.{1,100}/g) || [];
543
- return chunks.map(chunk => ({ chunk }));
544
- }
545
- });
546
-
547
- const embedStep = createStep({
548
- id: "embed",
549
- // Takes a single chunk, returns embedding
550
- inputSchema: z.object({ chunk: z.string() }),
551
- outputSchema: z.object({ embedding: z.array(z.number()) }),
552
- execute: async ({ inputData }) => ({
553
- embedding: [/* vector embedding */]
554
- })
555
- });
556
-
557
- // For a single document that produces multiple chunks:
558
- export const singleDocWorkflow = createWorkflow({
559
- id: "single-doc-rag",
560
- inputSchema: z.object({ content: z.string() }),
561
- outputSchema: z.array(z.object({ embedding: z.array(z.number()) }))
562
- })
563
- .then(chunkStep) // Returns array of chunks
564
- .foreach(embedStep) // Process each chunk -> array of embeddings
565
- .commit();
566
- ```
567
-
568
- For processing multiple documents where each produces multiple chunks, you have options:
569
-
570
- **Option 1: Process all documents in a single step with batching control**
571
-
572
- ```typescript
573
- const downloadAndChunkStep = createStep({
574
- id: "download-and-chunk",
575
- inputSchema: z.array(z.string()), // Array of URLs
576
- outputSchema: z.array(z.object({ chunk: z.string(), source: z.string() })),
577
- execute: async ({ inputData: urls }) => {
578
- // Control batching/parallelization within the step
579
- const allChunks = [];
580
- for (const url of urls) {
581
- const content = await fetch(url).then(r => r.text());
582
- const chunks = content.match(/.{1,100}/g) || [];
583
- allChunks.push(...chunks.map(chunk => ({ chunk, source: url })));
584
- }
585
- return allChunks;
586
- }
587
- });
588
-
589
- export const multiDocWorkflow = createWorkflow({...})
590
- .then(downloadAndChunkStep) // Returns flat array of all chunks
591
- .foreach(embedStep, { concurrency: 10 }) // Embed each chunk in parallel
592
- .commit();
593
- ```
594
-
595
- **Option 2: Use foreach for documents, aggregate chunks, then foreach for embeddings**
596
-
597
- ```typescript
598
- const downloadStep = createStep({
599
- id: "download",
600
- inputSchema: z.string(), // Single URL
601
- outputSchema: z.object({ content: z.string(), source: z.string() }),
602
- execute: async ({ inputData: url }) => ({
603
- content: await fetch(url).then(r => r.text()),
604
- source: url
605
- })
606
- });
607
-
608
- const chunkDocStep = createStep({
609
- id: "chunk-doc",
610
- inputSchema: z.object({ content: z.string(), source: z.string() }),
611
- outputSchema: z.array(z.object({ chunk: z.string(), source: z.string() })),
612
- execute: async ({ inputData }) => {
613
- const chunks = inputData.content.match(/.{1,100}/g) || [];
614
- return chunks.map(chunk => ({ chunk, source: inputData.source }));
615
- }
616
- });
617
-
618
- export const multiDocWorkflow = createWorkflow({
619
- id: "multi-doc-rag",
620
- inputSchema: z.array(z.string()), // Array of URLs
621
- outputSchema: z.array(z.object({ embedding: z.array(z.number()) }))
622
- })
623
- .foreach(downloadStep, { concurrency: 5 }) // Download docs in parallel
624
- .foreach(chunkDocStep) // Chunk each doc -> array of chunk arrays
625
- .map(async ({ inputData }) => {
626
- // Flatten nested arrays: [[chunks], [chunks]] -> [chunks]
627
- return inputData.flat();
628
- })
629
- .foreach(embedStep, { concurrency: 10 }) // Embed all chunks
630
- .commit();
631
- ```
632
-
633
- **Key points about chaining `.foreach()`:**
634
-
635
- - Each `.foreach()` operates on the array from the previous step
636
- - If a step inside `.foreach()` returns an array, the output becomes an array of arrays
637
- - Use `.map()` with `.flat()` to flatten nested arrays when needed
638
- - For complex RAG pipelines, Option 1 (handling batching in a single step) often provides better control
639
-
640
- #### Nested workflows inside foreach
641
-
642
- The step after `.foreach()` only executes after all iterations complete. If you need to run multiple sequential operations per item, use a nested workflow instead of chaining multiple `.foreach()` calls. This keeps all operations for each item together and makes the data flow clearer.
643
-
644
- ```typescript
645
- // Define a workflow that processes a single document
646
- const processDocumentWorkflow = createWorkflow({
647
- id: "process-document",
648
- inputSchema: z.object({ url: z.string() }),
649
- outputSchema: z.object({
650
- embeddings: z.array(z.array(z.number())),
651
- metadata: z.object({ url: z.string(), chunkCount: z.number() })
652
- })
653
- })
654
- .then(downloadStep) // Download the document
655
- .then(chunkStep) // Split into chunks
656
- .then(embedChunksStep) // Embed all chunks for this document
657
- .then(formatResultStep) // Format the final output
658
- .commit();
659
-
660
- // Use the nested workflow inside foreach
661
- export const batchProcessWorkflow = createWorkflow({
662
- id: "batch-process-documents",
663
- inputSchema: z.array(z.object({ url: z.string() })),
664
- outputSchema: z.array(z.object({
665
- embeddings: z.array(z.array(z.number())),
666
- metadata: z.object({ url: z.string(), chunkCount: z.number() })
667
- }))
668
- })
669
- .foreach(processDocumentWorkflow, { concurrency: 3 })
670
- .commit();
671
-
672
- // Each document goes through all 4 steps before the next document starts (with concurrency: 1)
673
- // With concurrency: 3, up to 3 documents process their full pipelines in parallel
674
- ```
675
-
676
- **Why use nested workflows:**
677
-
678
- - **Better parallelism**: With `concurrency: N`, multiple items run their full pipelines simultaneously. Chained `.foreach().foreach()` processes all items through step 1, waits, then all through step 2 - nested workflows let each item progress independently
679
- - All steps for one item complete together before results are collected
680
- - Cleaner than multiple `.foreach()` calls which create nested arrays
681
- - Each nested workflow execution is independent with its own data flow
682
- - Easier to test and reuse the per-item logic separately
683
-
684
- **How it works:**
685
-
686
- 1. The parent workflow passes each array item to an instance of the nested workflow
687
- 2. Each nested workflow runs its full step sequence for that item
688
- 3. With `concurrency > 1`, multiple nested workflows execute in parallel
689
- 4. The nested workflow's final output becomes one element in the result array
690
- 5. After all nested workflows complete, the next step in the parent receives the full array
691
-
692
- ## Choosing the right pattern
693
-
694
- Use this section as a reference for selecting the appropriate control flow method.
695
-
696
- ### Quick reference
697
-
698
- | Method | Purpose | Input | Output | Concurrency |
699
- | ------------------- | ---------------------------------- | ----- | --------------------- | ------------------------- |
700
- | `.then(step)` | Sequential processing | `T` | `U` | N/A (one at a time) |
701
- | `.parallel([a, b])` | Different operations on same input | `T` | `{ a: U, b: V }` | All run simultaneously |
702
- | `.foreach(step)` | Same operation on each array item | `T[]` | `U[]` | Configurable (default: 1) |
703
- | `.branch([...])` | Conditional path selection | `T` | `{ selectedStep: U }` | Only one branch runs |
704
-
705
- ### `.parallel()` vs `.foreach()`
706
-
707
- **Use `.parallel()` when you have one input that needs different processing:**
708
-
709
- ```typescript
710
- // Same user data processed differently in parallel
711
- workflow
712
- .parallel([validateStep, enrichStep, scoreStep])
713
- .then(combineResultsStep)
714
- ```
715
-
716
- **Use `.foreach()` when you have many inputs that need the same processing:**
717
-
718
- ```typescript
719
- // Multiple URLs each processed the same way
720
- workflow
721
- .foreach(downloadStep, { concurrency: 5 })
722
- .then(aggregateStep)
723
- ```
724
-
725
- ### When to use nested workflows
726
-
727
- **Inside `.foreach()`** - when each array item needs multiple sequential steps:
728
-
729
- ```typescript
730
- // Each document goes through a full pipeline
731
- const processDocWorkflow = createWorkflow({...})
732
- .then(downloadStep)
733
- .then(parseStep)
734
- .then(embedStep)
735
- .commit();
736
-
737
- workflow.foreach(processDocWorkflow, { concurrency: 3 })
738
- ```
739
-
740
- This is cleaner than chaining `.foreach().foreach()`, which creates nested arrays.
741
-
742
- **Inside `.parallel()`** - when a parallel branch needs its own multi-step pipeline:
743
-
744
- ```typescript
745
- const pipelineA = createWorkflow({...}).then(step1).then(step2).commit();
746
- const pipelineB = createWorkflow({...}).then(step3).then(step4).commit();
747
-
748
- workflow.parallel([pipelineA, pipelineB])
749
- ```
750
-
751
- ### Chaining patterns
752
-
753
- | Pattern | What happens | Common use case |
754
- | ---------------------- | --------------------------------- | ------------------------------------------------------ |
755
- | `.then().then()` | Sequential steps | Simple pipelines |
756
- | `.parallel().then()` | Run in parallel, then combine | Fan-out/fan-in |
757
- | `.foreach().then()` | Process all items, then aggregate | Map-reduce |
758
- | `.foreach().foreach()` | Creates array of arrays | Avoid - use nested workflow or `.map()` with `.flat()` |
759
- | `.foreach(workflow)` | Full pipeline per item | Multi-step processing per array item |
760
-
761
- ### Synchronization: when does the next step run?
762
-
763
- Both `.parallel()` and `.foreach()` are synchronization points. The next step in the workflow only executes after all parallel branches or all array iterations have completed.
764
-
765
- ```typescript
766
- workflow
767
- .parallel([stepA, stepB, stepC]) // All 3 run simultaneously
768
- .then(combineStep) // Waits for ALL 3 to finish before running
769
- .commit();
770
-
771
- workflow
772
- .foreach(processStep, { concurrency: 5 }) // Up to 5 items process at once
773
- .then(aggregateStep) // Waits for ALL items to finish before running
774
- .commit();
775
- ```
776
-
777
- This means:
778
-
779
- - `.parallel()` collects all branch outputs into an object, then passes it to the next step
780
- - `.foreach()` collects all iteration outputs into an array, then passes it to the next step
781
- - There is no way to "stream" results to the next step as they complete
782
-
783
- ### Concurrency behavior
784
-
785
- | Method | Behavior |
786
- | ------------------------------- | --------------------------------------------------------------- |
787
- | `.then()` | Sequential - one step at a time |
788
- | `.parallel()` | All branches run simultaneously (no limit option) |
789
- | `.foreach()` | Controlled via `{ concurrency: N }` - default is 1 (sequential) |
790
- | Nested workflow in `.foreach()` | Respects parent's concurrency setting |
791
-
792
- **Performance tip:** For I/O-bound operations in `.foreach()`, increase concurrency to process items in parallel:
793
-
794
- ```typescript
795
- // Process up to 10 items simultaneously
796
- workflow.foreach(fetchDataStep, { concurrency: 10 })
797
- ```
798
-
799
- ## Loop management
800
-
801
- Loop conditions can be implemented in different ways depending on how you want the loop to end. Common patterns include checking values returned in `inputData`, setting a maximum number of iterations, or aborting execution when a limit is reached.
802
-
803
- ### Aborting loops
804
-
805
- Use `iterationCount` to limit how many times a loop runs. If the count exceeds your threshold, throw an error to fail the step and stop the workflow.
806
-
807
- ```typescript
808
- const step1 = createStep({...});
809
-
810
- export const testWorkflow = createWorkflow({...})
811
- .dountil(step1, async ({ inputData: { userResponse, iterationCount } }) => {
812
- if (iterationCount >= 10) {
813
- throw new Error("Maximum iterations reached");
814
- }
815
- return userResponse === "yes";
816
- })
817
- .commit();
818
- ```
819
-
820
- ## Related
821
-
822
- - [Suspend & Resume](https://mastra.ai/docs/workflows/suspend-and-resume)
823
- - [Human-in-the-loop](https://mastra.ai/docs/workflows/human-in-the-loop)