@mastra/mcp-docs-server 1.0.0-beta.2 → 1.0.0-beta.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 (391) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +9 -9
  2. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +55 -55
  3. package/.docs/organized/changelogs/%40mastra%2Fauth.md +6 -0
  4. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +11 -11
  5. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +21 -21
  6. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +11 -11
  7. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +11 -11
  8. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +6 -0
  9. package/.docs/organized/changelogs/%40mastra%2Fcore.md +207 -207
  10. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +10 -10
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +20 -20
  12. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +11 -11
  13. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +11 -11
  14. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +34 -34
  15. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +14 -14
  16. package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
  17. package/.docs/organized/changelogs/%40mastra%2Flance.md +14 -14
  18. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
  19. package/.docs/organized/changelogs/%40mastra%2Floggers.md +10 -10
  20. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +24 -24
  21. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +12 -12
  22. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +10 -10
  23. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +11 -11
  24. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +11 -11
  25. package/.docs/organized/changelogs/%40mastra%2Fpg.md +11 -11
  26. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +11 -11
  27. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +44 -44
  28. package/.docs/organized/changelogs/%40mastra%2Frag.md +11 -11
  29. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  30. package/.docs/organized/changelogs/%40mastra%2Fserver.md +19 -19
  31. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +14 -14
  32. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +21 -21
  33. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
  34. package/.docs/organized/changelogs/create-mastra.md +21 -21
  35. package/.docs/organized/changelogs/mastra.md +47 -47
  36. package/.docs/organized/code-examples/ai-elements.md +1 -1
  37. package/.docs/organized/code-examples/ai-sdk-useChat.md +1 -1
  38. package/.docs/organized/code-examples/ai-sdk-v5.md +1 -1
  39. package/.docs/organized/code-examples/assistant-ui.md +1 -1
  40. package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
  41. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +1 -1
  42. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +1 -1
  43. package/.docs/organized/code-examples/client-side-tools.md +1 -1
  44. package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
  45. package/.docs/organized/code-examples/fireworks-r1.md +1 -1
  46. package/.docs/organized/code-examples/heads-up-game.md +1 -1
  47. package/.docs/organized/code-examples/mcp-configuration.md +0 -3
  48. package/.docs/organized/code-examples/memory-per-resource-example.md +1 -1
  49. package/.docs/organized/code-examples/openapi-spec-writer.md +1 -1
  50. package/.docs/organized/code-examples/quick-start.md +1 -1
  51. package/.docs/organized/code-examples/stock-price-tool.md +1 -21
  52. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  53. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  54. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  55. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  56. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
  57. package/.docs/raw/agents/adding-voice.mdx +50 -1
  58. package/.docs/raw/agents/agent-memory.mdx +1 -1
  59. package/.docs/raw/agents/guardrails.mdx +1 -1
  60. package/.docs/raw/agents/human-in-the-loop-with-tools.mdx +90 -0
  61. package/.docs/raw/agents/networks.mdx +1 -1
  62. package/.docs/raw/agents/overview.mdx +8 -13
  63. package/.docs/raw/agents/using-tools.mdx +10 -9
  64. package/.docs/raw/auth/auth0.mdx +1 -1
  65. package/.docs/raw/auth/clerk.mdx +1 -1
  66. package/.docs/raw/auth/firebase.mdx +1 -1
  67. package/.docs/raw/auth/index.mdx +1 -1
  68. package/.docs/raw/auth/jwt.mdx +1 -1
  69. package/.docs/raw/auth/supabase.mdx +1 -1
  70. package/.docs/raw/auth/workos.mdx +1 -1
  71. package/.docs/raw/community/contributing-templates.mdx +1 -1
  72. package/.docs/raw/community/discord.mdx +2 -2
  73. package/.docs/raw/community/licensing.mdx +1 -1
  74. package/.docs/raw/deployment/{server-deployment.mdx → building-mastra.mdx} +4 -4
  75. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +2 -2
  76. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +3 -3
  77. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +2 -2
  78. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/cloudflare-deployer.mdx +1 -1
  79. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +2 -2
  80. package/.docs/raw/deployment/cloud-providers/index.mdx +8 -4
  81. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/netlify-deployer.mdx +1 -1
  82. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/vercel-deployer.mdx +1 -1
  83. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/dashboard.mdx +3 -3
  84. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/observability.mdx +2 -2
  85. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/overview.mdx +3 -3
  86. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/setting-up.mdx +4 -4
  87. package/.docs/raw/deployment/monorepo.mdx +3 -3
  88. package/.docs/raw/deployment/overview.mdx +5 -5
  89. package/.docs/raw/deployment/web-framework.mdx +1 -1
  90. package/.docs/raw/evals/{off-the-shelf-scorers.mdx → built-in-scorers.mdx} +17 -15
  91. package/.docs/raw/evals/custom-scorers.mdx +1 -1
  92. package/.docs/raw/evals/overview.mdx +3 -3
  93. package/.docs/raw/evals/running-in-ci.mdx +2 -2
  94. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +11 -128
  95. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +71 -19
  96. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +8 -29
  97. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +91 -267
  98. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -3
  99. package/.docs/raw/frameworks/servers/express.mdx +1 -1
  100. package/.docs/raw/frameworks/web-frameworks/astro.mdx +1 -1
  101. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +1 -1
  102. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +1 -1
  103. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +1 -1
  104. package/.docs/raw/getting-started/mcp-docs-server.mdx +6 -6
  105. package/.docs/raw/getting-started/project-structure.mdx +1 -1
  106. package/.docs/raw/getting-started/quickstart.mdx +27 -0
  107. package/.docs/raw/getting-started/studio.mdx +3 -3
  108. package/.docs/raw/getting-started/templates.mdx +1 -1
  109. package/.docs/raw/guides/guide/ai-recruiter.mdx +1 -1
  110. package/.docs/raw/guides/guide/chef-michel.mdx +1 -1
  111. package/.docs/raw/{getting-started/installation.mdx → guides/guide/manual-install.mdx} +6 -80
  112. package/.docs/raw/guides/guide/notes-mcp-server.mdx +2 -2
  113. package/.docs/raw/guides/guide/research-assistant.mdx +2 -2
  114. package/.docs/raw/guides/guide/stock-agent.mdx +1 -1
  115. package/.docs/raw/guides/guide/web-search.mdx +1 -1
  116. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +119 -0
  117. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +1 -1
  118. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +9 -1
  119. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +60 -0
  120. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +12 -0
  121. package/.docs/raw/guides/quickstarts/nextjs.mdx +18 -17
  122. package/.docs/raw/guides/quickstarts/standalone-server.mdx +86 -0
  123. package/.docs/raw/index.mdx +3 -3
  124. package/.docs/raw/logging.mdx +7 -7
  125. package/.docs/raw/mcp/overview.mdx +360 -0
  126. package/.docs/raw/mcp/publishing-mcp-server.mdx +139 -0
  127. package/.docs/raw/memory/conversation-history.mdx +1 -1
  128. package/.docs/raw/memory/memory-processors.mdx +1 -1
  129. package/.docs/raw/memory/overview.mdx +1 -1
  130. package/.docs/raw/memory/semantic-recall.mdx +1 -1
  131. package/.docs/raw/memory/storage/memory-with-libsql.mdx +1 -4
  132. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +1 -1
  133. package/.docs/raw/memory/storage/memory-with-pg.mdx +1 -4
  134. package/.docs/raw/memory/storage/memory-with-upstash.mdx +1 -4
  135. package/.docs/raw/memory/threads-and-resources.mdx +1 -1
  136. package/.docs/raw/memory/working-memory.mdx +1 -1
  137. package/.docs/raw/observability/overview.mdx +2 -2
  138. package/.docs/raw/observability/tracing/exporters/arize.mdx +1 -1
  139. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +1 -1
  140. package/.docs/raw/observability/tracing/exporters/cloud.mdx +2 -2
  141. package/.docs/raw/observability/tracing/exporters/default.mdx +1 -1
  142. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -1
  143. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +1 -1
  144. package/.docs/raw/observability/tracing/exporters/otel.mdx +1 -1
  145. package/.docs/raw/observability/tracing/overview.mdx +2 -2
  146. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +2 -2
  147. package/.docs/raw/rag/overview.mdx +1 -1
  148. package/.docs/raw/rag/retrieval.mdx +1 -1
  149. package/.docs/raw/rag/vector-databases.mdx +1 -1
  150. package/.docs/raw/reference/agents/agent.mdx +1 -2
  151. package/.docs/raw/reference/agents/generate.mdx +12 -93
  152. package/.docs/raw/reference/agents/generateLegacy.mdx +1 -1
  153. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +1 -1
  154. package/.docs/raw/reference/agents/getDefaultOptions.mdx +1 -1
  155. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +1 -1
  156. package/.docs/raw/reference/agents/getDescription.mdx +1 -1
  157. package/.docs/raw/reference/agents/getInstructions.mdx +1 -1
  158. package/.docs/raw/reference/agents/getLLM.mdx +1 -1
  159. package/.docs/raw/reference/agents/getMemory.mdx +1 -1
  160. package/.docs/raw/reference/agents/getModel.mdx +1 -1
  161. package/.docs/raw/reference/agents/getTools.mdx +69 -0
  162. package/.docs/raw/reference/agents/getVoice.mdx +1 -1
  163. package/.docs/raw/reference/agents/listAgents.mdx +1 -1
  164. package/.docs/raw/reference/agents/listScorers.mdx +1 -1
  165. package/.docs/raw/reference/agents/listTools.mdx +2 -2
  166. package/.docs/raw/reference/agents/listWorkflows.mdx +1 -1
  167. package/.docs/raw/reference/agents/network.mdx +4 -86
  168. package/.docs/raw/reference/auth/auth0.mdx +1 -1
  169. package/.docs/raw/reference/auth/clerk.mdx +1 -1
  170. package/.docs/raw/reference/auth/firebase.mdx +1 -1
  171. package/.docs/raw/reference/auth/jwt.mdx +1 -1
  172. package/.docs/raw/reference/auth/supabase.mdx +1 -1
  173. package/.docs/raw/reference/auth/workos.mdx +1 -1
  174. package/.docs/raw/reference/cli/create-mastra.mdx +1 -1
  175. package/.docs/raw/reference/cli/mastra.mdx +4 -4
  176. package/.docs/raw/reference/client-js/agents.mdx +1 -1
  177. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  178. package/.docs/raw/reference/client-js/logs.mdx +1 -1
  179. package/.docs/raw/reference/client-js/mastra-client.mdx +2 -2
  180. package/.docs/raw/reference/client-js/memory.mdx +1 -1
  181. package/.docs/raw/reference/client-js/observability.mdx +1 -1
  182. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  183. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  184. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  185. package/.docs/raw/reference/client-js/workflows.mdx +1 -1
  186. package/.docs/raw/reference/core/addGateway.mdx +59 -0
  187. package/.docs/raw/reference/core/getAgent.mdx +1 -1
  188. package/.docs/raw/reference/core/getAgentById.mdx +1 -1
  189. package/.docs/raw/reference/core/getDeployer.mdx +1 -1
  190. package/.docs/raw/reference/core/getGateway.mdx +59 -0
  191. package/.docs/raw/reference/core/getGatewayById.mdx +62 -0
  192. package/.docs/raw/reference/core/getLogger.mdx +1 -1
  193. package/.docs/raw/reference/core/getMCPServer.mdx +2 -2
  194. package/.docs/raw/reference/core/getMCPServerById.mdx +2 -2
  195. package/.docs/raw/reference/core/getScorer.mdx +1 -1
  196. package/.docs/raw/reference/core/getScorerById.mdx +1 -1
  197. package/.docs/raw/reference/core/getServer.mdx +2 -2
  198. package/.docs/raw/reference/core/getStorage.mdx +1 -1
  199. package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
  200. package/.docs/raw/reference/core/getVector.mdx +1 -1
  201. package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
  202. package/.docs/raw/reference/core/listAgents.mdx +1 -1
  203. package/.docs/raw/reference/core/listGateways.mdx +53 -0
  204. package/.docs/raw/reference/core/listLogs.mdx +1 -1
  205. package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
  206. package/.docs/raw/reference/core/listMCPServers.mdx +2 -2
  207. package/.docs/raw/reference/core/listScorers.mdx +1 -1
  208. package/.docs/raw/reference/core/listVectors.mdx +1 -1
  209. package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
  210. package/.docs/raw/reference/core/mastra-class.mdx +9 -1
  211. package/.docs/raw/reference/core/mastra-model-gateway.mdx +241 -0
  212. package/.docs/raw/reference/core/setLogger.mdx +1 -1
  213. package/.docs/raw/reference/core/setStorage.mdx +1 -1
  214. package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
  215. package/.docs/raw/reference/deployer/cloudflare.mdx +1 -1
  216. package/.docs/raw/reference/deployer/deployer.mdx +1 -1
  217. package/.docs/raw/reference/deployer/netlify.mdx +1 -1
  218. package/.docs/raw/reference/deployer/vercel.mdx +1 -1
  219. package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
  220. package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
  221. package/.docs/raw/reference/evals/bias.mdx +1 -1
  222. package/.docs/raw/reference/evals/completeness.mdx +1 -1
  223. package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
  224. package/.docs/raw/reference/evals/context-precision.mdx +1 -1
  225. package/.docs/raw/reference/evals/context-relevance.mdx +1 -1
  226. package/.docs/raw/reference/evals/create-scorer.mdx +1 -1
  227. package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
  228. package/.docs/raw/reference/evals/hallucination.mdx +1 -1
  229. package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
  230. package/.docs/raw/reference/evals/mastra-scorer.mdx +1 -1
  231. package/.docs/raw/reference/evals/noise-sensitivity.mdx +1 -1
  232. package/.docs/raw/reference/evals/prompt-alignment.mdx +1 -1
  233. package/.docs/raw/reference/evals/run-evals.mdx +1 -1
  234. package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
  235. package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
  236. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +1 -1
  237. package/.docs/raw/reference/evals/toxicity.mdx +1 -1
  238. package/.docs/raw/reference/logging/pino-logger.mdx +2 -2
  239. package/.docs/raw/reference/memory/createThread.mdx +1 -1
  240. package/.docs/raw/reference/memory/deleteMessages.mdx +1 -1
  241. package/.docs/raw/reference/memory/getThreadById.mdx +1 -1
  242. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +1 -1
  243. package/.docs/raw/reference/memory/memory-class.mdx +1 -1
  244. package/.docs/raw/reference/memory/query.mdx +1 -1
  245. package/.docs/raw/reference/memory/recall.mdx +1 -1
  246. package/.docs/raw/reference/observability/tracing/configuration.mdx +2 -2
  247. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +1 -1
  248. package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +1 -1
  249. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +1 -1
  250. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +1 -1
  251. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +1 -1
  252. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
  253. package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +1 -1
  254. package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +1 -1
  255. package/.docs/raw/reference/observability/tracing/instances.mdx +2 -2
  256. package/.docs/raw/reference/observability/tracing/interfaces.mdx +2 -2
  257. package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +1 -1
  258. package/.docs/raw/reference/observability/tracing/spans.mdx +2 -2
  259. package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
  260. package/.docs/raw/reference/processors/language-detector.mdx +1 -1
  261. package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
  262. package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
  263. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
  264. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
  265. package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
  266. package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
  267. package/.docs/raw/reference/rag/chunk.mdx +1 -1
  268. package/.docs/raw/reference/rag/database-config.mdx +1 -1
  269. package/.docs/raw/reference/rag/document.mdx +1 -1
  270. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  271. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  272. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  273. package/.docs/raw/reference/rag/metadata-filters.mdx +1 -1
  274. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  275. package/.docs/raw/reference/rag/rerankWithScorer.mdx +1 -1
  276. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  277. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  278. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  279. package/.docs/raw/reference/storage/lance.mdx +1 -1
  280. package/.docs/raw/reference/storage/libsql.mdx +1 -1
  281. package/.docs/raw/reference/storage/mongodb.mdx +1 -1
  282. package/.docs/raw/reference/storage/mssql.mdx +1 -1
  283. package/.docs/raw/reference/storage/postgresql.mdx +1 -1
  284. package/.docs/raw/reference/storage/upstash.mdx +1 -1
  285. package/.docs/raw/reference/streaming/ChunkType.mdx +1 -1
  286. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +1 -1
  287. package/.docs/raw/reference/streaming/agents/stream.mdx +4 -93
  288. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +1 -1
  289. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
  290. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +1 -1
  291. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +1 -1
  292. package/.docs/raw/reference/streaming/workflows/stream.mdx +1 -1
  293. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +1 -1
  294. package/.docs/raw/reference/templates/overview.mdx +1 -1
  295. package/.docs/raw/reference/tools/client.mdx +1 -1
  296. package/.docs/raw/reference/tools/create-tool.mdx +3 -4
  297. package/.docs/raw/reference/tools/document-chunker-tool.mdx +1 -1
  298. package/.docs/raw/reference/tools/graph-rag-tool.mdx +2 -2
  299. package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
  300. package/.docs/raw/reference/tools/mcp-server.mdx +6 -6
  301. package/.docs/raw/reference/tools/vector-query-tool.mdx +2 -2
  302. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  303. package/.docs/raw/reference/vectors/chroma.mdx +1 -1
  304. package/.docs/raw/reference/vectors/couchbase.mdx +1 -1
  305. package/.docs/raw/reference/vectors/lance.mdx +1 -1
  306. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  307. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  308. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  309. package/.docs/raw/reference/vectors/pg.mdx +1 -1
  310. package/.docs/raw/reference/vectors/pinecone.mdx +22 -2
  311. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  312. package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
  313. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  314. package/.docs/raw/reference/vectors/upstash.mdx +1 -1
  315. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  316. package/.docs/raw/reference/voice/azure.mdx +96 -81
  317. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  318. package/.docs/raw/reference/voice/composite-voice.mdx +72 -29
  319. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  320. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  321. package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
  322. package/.docs/raw/reference/voice/google.mdx +1 -1
  323. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  324. package/.docs/raw/reference/voice/murf.mdx +1 -1
  325. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  326. package/.docs/raw/reference/voice/openai.mdx +1 -1
  327. package/.docs/raw/reference/voice/playai.mdx +1 -1
  328. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  329. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  330. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  331. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  332. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  333. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  334. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  335. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  336. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +1 -1
  337. package/.docs/raw/reference/voice/voice.listen.mdx +87 -53
  338. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  339. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  340. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  341. package/.docs/raw/reference/voice/voice.speak.mdx +76 -41
  342. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  343. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +1 -1
  344. package/.docs/raw/reference/workflows/run-methods/resume.mdx +1 -1
  345. package/.docs/raw/reference/workflows/run-methods/start.mdx +1 -1
  346. package/.docs/raw/reference/workflows/run.mdx +1 -1
  347. package/.docs/raw/reference/workflows/step.mdx +1 -1
  348. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
  349. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  350. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +1 -1
  351. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
  352. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
  353. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  354. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +1 -1
  355. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  356. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +1 -1
  357. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
  358. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
  359. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  360. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
  361. package/.docs/raw/reference/workflows/workflow.mdx +2 -2
  362. package/.docs/raw/server-db/custom-api-routes.mdx +1 -1
  363. package/.docs/raw/server-db/mastra-client.mdx +2 -2
  364. package/.docs/raw/server-db/{production-server.mdx → mastra-server.mdx} +2 -2
  365. package/.docs/raw/server-db/middleware.mdx +31 -31
  366. package/.docs/raw/server-db/request-context.mdx +3 -3
  367. package/.docs/raw/server-db/storage.mdx +1 -1
  368. package/.docs/raw/streaming/events.mdx +1 -1
  369. package/.docs/raw/streaming/overview.mdx +1 -1
  370. package/.docs/raw/streaming/tool-streaming.mdx +1 -1
  371. package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
  372. package/.docs/raw/tools-mcp/advanced-usage.mdx +1 -1
  373. package/.docs/raw/tools-mcp/mcp-overview.mdx +1 -1
  374. package/.docs/raw/tools-mcp/overview.mdx +1 -1
  375. package/.docs/raw/voice/overview.mdx +68 -1
  376. package/.docs/raw/voice/speech-to-speech.mdx +1 -1
  377. package/.docs/raw/voice/speech-to-text.mdx +1 -1
  378. package/.docs/raw/voice/text-to-speech.mdx +1 -1
  379. package/.docs/raw/workflows/agents-and-tools.mdx +2 -4
  380. package/.docs/raw/workflows/control-flow.mdx +6 -1
  381. package/.docs/raw/workflows/error-handling.mdx +4 -4
  382. package/.docs/raw/workflows/human-in-the-loop.mdx +160 -213
  383. package/.docs/raw/workflows/inngest-workflow.mdx +1 -1
  384. package/.docs/raw/workflows/input-data-mapping.mdx +1 -1
  385. package/.docs/raw/workflows/overview.mdx +11 -3
  386. package/.docs/raw/workflows/snapshots.mdx +4 -3
  387. package/.docs/raw/workflows/suspend-and-resume.mdx +72 -224
  388. package/CHANGELOG.md +23 -0
  389. package/dist/stdio.js +11 -9
  390. package/package.json +10 -14
  391. package/.docs/raw/deployment/serverless-platforms/index.mdx +0 -58
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.listen() | Voice | Mastra Docs"
2
+ title: "Reference: voice.listen() | Voice"
3
3
  description: "Documentation for the listen() method available in all Mastra voice providers, which converts speech to text."
4
4
  ---
5
5
 
@@ -7,41 +7,6 @@ description: "Documentation for the listen() method available in all Mastra voic
7
7
 
8
8
  The `listen()` method is a core function available in all Mastra voice providers that converts speech to text. It takes an audio stream as input and returns the transcribed text.
9
9
 
10
- ## Usage Example
11
-
12
- ```typescript
13
- import { OpenAIVoice } from "@mastra/voice-openai";
14
- import { getMicrophoneStream } from "@mastra/node-audio";
15
- import { createReadStream } from "fs";
16
- import path from "path";
17
-
18
- // Initialize a voice provider
19
- const voice = new OpenAIVoice({
20
- listeningModel: {
21
- name: "whisper-1",
22
- apiKey: process.env.OPENAI_API_KEY,
23
- },
24
- });
25
-
26
- // Basic usage with a file stream
27
- const audioFilePath = path.join(process.cwd(), "audio.mp3");
28
- const audioStream = createReadStream(audioFilePath);
29
- const transcript = await voice.listen(audioStream, {
30
- filetype: "mp3",
31
- });
32
- console.log("Transcribed text:", transcript);
33
-
34
- // Using a microphone stream
35
- const microphoneStream = getMicrophoneStream(); // Assume this function gets audio input
36
- const transcription = await voice.listen(microphoneStream);
37
-
38
- // With provider-specific options
39
- const transcriptWithOptions = await voice.listen(audioStream, {
40
- language: "en",
41
- prompt: "This is a conversation about artificial intelligence.",
42
- });
43
- ```
44
-
45
10
  ## Parameters
46
11
 
47
12
  <PropertiesTable
@@ -143,30 +108,42 @@ Each voice provider may support additional options specific to their implementat
143
108
  ]}
144
109
  />
145
110
 
146
- ## Realtime Voice Providers
147
-
148
- When using realtime voice providers like `OpenAIRealtimeVoice`, the `listen()` method behaves differently:
149
-
150
- - Instead of returning transcribed text, it emits 'writing' events with the transcribed text
151
- - You need to register an event listener to receive the transcription
111
+ ## Usage Example
152
112
 
153
113
  ```typescript
154
- import { OpenAIRealtimeVoice } from "@mastra/voice-openai-realtime";
114
+ import { OpenAIVoice } from "@mastra/voice-openai";
155
115
  import { getMicrophoneStream } from "@mastra/node-audio";
116
+ import { createReadStream } from "fs";
117
+ import path from "path";
156
118
 
157
- const voice = new OpenAIRealtimeVoice();
158
- await voice.connect();
119
+ // Initialize a voice provider
120
+ const voice = new OpenAIVoice({
121
+ listeningModel: {
122
+ name: "whisper-1",
123
+ apiKey: process.env.OPENAI_API_KEY,
124
+ },
125
+ });
159
126
 
160
- // Register event listener for transcription
161
- voice.on("writing", ({ text, role }) => {
162
- console.log(`${role}: ${text}`);
127
+ // Basic usage with a file stream
128
+ const audioFilePath = path.join(process.cwd(), "audio.mp3");
129
+ const audioStream = createReadStream(audioFilePath);
130
+ const transcript = await voice.listen(audioStream, {
131
+ filetype: "mp3",
163
132
  });
133
+ console.log("Transcribed text:", transcript);
164
134
 
165
- // This will emit 'writing' events instead of returning text
166
- const microphoneStream = getMicrophoneStream();
167
- await voice.listen(microphoneStream);
135
+ // Using a microphone stream
136
+ const microphoneStream = getMicrophoneStream(); // Assume this function gets audio input
137
+ const transcription = await voice.listen(microphoneStream);
138
+
139
+ // With provider-specific options
140
+ const transcriptWithOptions = await voice.listen(audioStream, {
141
+ language: "en",
142
+ prompt: "This is a conversation about artificial intelligence.",
143
+ });
168
144
  ```
169
145
 
146
+
170
147
  ## Using with CompositeVoice
171
148
 
172
149
  When using `CompositeVoice`, the `listen()` method delegates to the configured listening provider:
@@ -177,14 +154,70 @@ import { OpenAIVoice } from "@mastra/voice-openai";
177
154
  import { PlayAIVoice } from "@mastra/voice-playai";
178
155
 
179
156
  const voice = new CompositeVoice({
180
- listenProvider: new OpenAIVoice(),
181
- speakProvider: new PlayAIVoice(),
157
+ input: new OpenAIVoice(),
158
+ output: new PlayAIVoice(),
182
159
  });
183
160
 
184
161
  // This will use the OpenAIVoice provider
185
162
  const transcript = await voice.listen(audioStream);
186
163
  ```
187
164
 
165
+ ### Using AI SDK Model Providers
166
+
167
+ You can also use AI SDK transcription models directly with `CompositeVoice`:
168
+
169
+ ```typescript
170
+ import { CompositeVoice } from "@mastra/core/voice";
171
+ import { openai } from "@ai-sdk/openai";
172
+ import { groq } from "@ai-sdk/groq";
173
+
174
+ // Use AI SDK transcription models
175
+ const voice = new CompositeVoice({
176
+ input: openai.transcription('whisper-1'), // AI SDK model
177
+ output: new PlayAIVoice(), // Mastra provider
178
+ });
179
+
180
+ // Works the same way
181
+ const transcript = await voice.listen(audioStream);
182
+
183
+ // Provider-specific options can be passed through
184
+ const transcriptWithOptions = await voice.listen(audioStream, {
185
+ providerOptions: {
186
+ openai: {
187
+ language: 'en',
188
+ prompt: 'This is about AI',
189
+ }
190
+ }
191
+ });
192
+ ```
193
+
194
+ See the [CompositeVoice reference](/reference/v1/voice/composite-voice) for more details on AI SDK integration.
195
+
196
+
197
+ ## Realtime Voice Providers
198
+
199
+ When using realtime voice providers like `OpenAIRealtimeVoice`, the `listen()` method behaves differently:
200
+
201
+ - Instead of returning transcribed text, it emits 'writing' events with the transcribed text
202
+ - You need to register an event listener to receive the transcription
203
+
204
+ ```typescript
205
+ import { OpenAIRealtimeVoice } from "@mastra/voice-openai-realtime";
206
+ import { getMicrophoneStream } from "@mastra/node-audio";
207
+
208
+ const voice = new OpenAIRealtimeVoice();
209
+ await voice.connect();
210
+
211
+ // Register event listener for transcription
212
+ voice.on("writing", ({ text, role }) => {
213
+ console.log(`${role}: ${text}`);
214
+ });
215
+
216
+ // This will emit 'writing' events instead of returning text
217
+ const microphoneStream = getMicrophoneStream();
218
+ await voice.listen(microphoneStream);
219
+ ```
220
+
188
221
  ## Notes
189
222
 
190
223
  - Not all voice providers support speech-to-text functionality (e.g., PlayAI, Speechify)
@@ -194,6 +227,7 @@ const transcript = await voice.listen(audioStream);
194
227
  - Some providers support streaming transcription, where text is returned as it's transcribed
195
228
  - For best performance, consider closing or ending the audio stream when you're done with it
196
229
 
230
+
197
231
  ## Related Methods
198
232
 
199
233
  - [voice.speak()](./voice.speak) - Converts text to speech
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.off() | Voice | Mastra Docs"
2
+ title: "Reference: voice.off() | Voice"
3
3
  description: "Documentation for the off() method available in voice providers, which removes event listeners for voice events."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.on() | Voice | Mastra Docs"
2
+ title: "Reference: voice.on() | Voice"
3
3
  description: "Documentation for the on() method available in voice providers, which registers event listeners for voice events."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.send() | Voice | Mastra Docs"
2
+ title: "Reference: voice.send() | Voice"
3
3
  description: "Documentation for the send() method available in real-time voice providers, which streams audio data for continuous processing."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.speak() | Voice | Mastra Docs"
2
+ title: "Reference: voice.speak() | Voice"
3
3
  description: "Documentation for the speak() method available in all Mastra voice providers, which converts text to speech."
4
4
  ---
5
5
 
@@ -7,31 +7,6 @@ description: "Documentation for the speak() method available in all Mastra voice
7
7
 
8
8
  The `speak()` method is a core function available in all Mastra voice providers that converts text to speech. It takes text input and returns an audio stream that can be played or saved.
9
9
 
10
- ## Usage Example
11
-
12
- ```typescript
13
- import { OpenAIVoice } from "@mastra/voice-openai";
14
- // Initialize a voice provider
15
- const voice = new OpenAIVoice({
16
- speaker: "alloy", // Default voice
17
- });
18
- // Basic usage with default settings
19
- const audioStream = await voice.speak("Hello, world!");
20
- // Using a different voice for this specific request
21
- const audioStreamWithDifferentVoice = await voice.speak("Hello again!", {
22
- speaker: "nova",
23
- });
24
- // Using provider-specific options
25
- const audioStreamWithOptions = await voice.speak("Hello with options!", {
26
- speaker: "echo",
27
- speed: 1.2, // OpenAI-specific option
28
- });
29
- // Using a text stream as input
30
- import { Readable } from "stream";
31
- const textStream = Readable.from(["Hello", " from", " a", " stream!"]);
32
- const audioStreamFromTextStream = await voice.speak(textStream);
33
- ```
34
-
35
10
  ## Parameters
36
11
 
37
12
  <PropertiesTable
@@ -153,6 +128,81 @@ Each voice provider may support additional options specific to their implementat
153
128
  ]}
154
129
  />
155
130
 
131
+ ## Usage Example
132
+
133
+ ```typescript
134
+ import { OpenAIVoice } from "@mastra/voice-openai";
135
+ // Initialize a voice provider
136
+ const voice = new OpenAIVoice({
137
+ speaker: "alloy", // Default voice
138
+ });
139
+ // Basic usage with default settings
140
+ const audioStream = await voice.speak("Hello, world!");
141
+ // Using a different voice for this specific request
142
+ const audioStreamWithDifferentVoice = await voice.speak("Hello again!", {
143
+ speaker: "nova",
144
+ });
145
+ // Using provider-specific options
146
+ const audioStreamWithOptions = await voice.speak("Hello with options!", {
147
+ speaker: "echo",
148
+ speed: 1.2, // OpenAI-specific option
149
+ });
150
+ // Using a text stream as input
151
+ import { Readable } from "stream";
152
+ const textStream = Readable.from(["Hello", " from", " a", " stream!"]);
153
+ const audioStreamFromTextStream = await voice.speak(textStream);
154
+ ```
155
+
156
+ ## Using with CompositeVoice
157
+
158
+ When using `CompositeVoice`, the `speak()` method delegates to the configured speaking provider:
159
+
160
+ ```typescript
161
+ import { CompositeVoice } from "@mastra/core/voice";
162
+ import { OpenAIVoice } from "@mastra/voice-openai";
163
+ import { PlayAIVoice } from "@mastra/voice-playai";
164
+
165
+ const voice = new CompositeVoice({
166
+ output: new PlayAIVoice(),
167
+ input: new OpenAIVoice(),
168
+ });
169
+
170
+ // This will use the PlayAIVoice provider
171
+ const audioStream = await voice.speak("Hello, world!");
172
+ ```
173
+
174
+ ### Using AI SDK Model Providers
175
+
176
+ You can also use AI SDK speech models directly with `CompositeVoice`:
177
+
178
+ ```typescript
179
+ import { CompositeVoice } from "@mastra/core/voice";
180
+ import { openai } from "@ai-sdk/openai";
181
+ import { elevenlabs } from "@ai-sdk/elevenlabs";
182
+
183
+ // Use AI SDK speech models
184
+ const voice = new CompositeVoice({
185
+ output: elevenlabs.speech('eleven_turbo_v2'), // AI SDK model
186
+ input: openai.transcription('whisper-1'), // AI SDK model
187
+ });
188
+
189
+ // Works the same way
190
+ const audioStream = await voice.speak("Hello from AI SDK!");
191
+
192
+ // Provider-specific options can be passed through
193
+ const audioWithOptions = await voice.speak("Hello with options!", {
194
+ speaker: 'Rachel', // ElevenLabs voice
195
+ providerOptions: {
196
+ elevenlabs: {
197
+ stability: 0.5,
198
+ similarity_boost: 0.75,
199
+ }
200
+ }
201
+ });
202
+ ```
203
+
204
+ See the [CompositeVoice reference](/reference/v1/voice/composite-voice) for more details on AI SDK integration.
205
+
156
206
  ## Realtime Voice Providers
157
207
 
158
208
  When using realtime voice providers like `OpenAIRealtimeVoice`, the `speak()` method behaves differently:
@@ -181,21 +231,6 @@ voice.on("speaker", (stream) => {
181
231
  await voice.speak("Hello, this is realtime speech!");
182
232
  ```
183
233
 
184
- ## Using with CompositeVoice
185
-
186
- When using `CompositeVoice`, the `speak()` method delegates to the configured speaking provider:
187
-
188
- ```typescript
189
- import { CompositeVoice } from "@mastra/core/voice";
190
- import { OpenAIVoice } from "@mastra/voice-openai";
191
- import { PlayAIVoice } from "@mastra/voice-playai";
192
- const voice = new CompositeVoice({
193
- speakProvider: new PlayAIVoice(),
194
- listenProvider: new OpenAIVoice(),
195
- });
196
- // This will use the PlayAIVoice provider
197
- const audioStream = await voice.speak("Hello, world!");
198
- ```
199
234
 
200
235
  ## Notes
201
236
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.updateConfig() | Voice | Mastra Docs"
2
+ title: "Reference: voice.updateConfig() | Voice"
3
3
  description: "Documentation for the updateConfig() method available in voice providers, which updates the configuration of a voice provider at runtime."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Run.cancel() | Workflows | Mastra Docs"
2
+ title: "Reference: Run.cancel() | Workflows"
3
3
  description: Documentation for the `Run.cancel()` method in workflows, which cancels a workflow run.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Run.resume() | Workflows | Mastra Docs"
2
+ title: "Reference: Run.resume() | Workflows"
3
3
  description: Documentation for the `Run.resume()` method in workflows, which resumes a suspended workflow run with new data.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Run.start() | Workflows | Mastra Docs"
2
+ title: "Reference: Run.start() | Workflows"
3
3
  description: Documentation for the `Run.start()` method in workflows, which starts a workflow run with input data.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Run Class | Workflows | Mastra Docs"
2
+ title: "Reference: Run Class | Workflows"
3
3
  description: Documentation for the Run class in Mastra, which represents a workflow execution instance.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Step Class | Workflows | Mastra Docs"
2
+ title: "Reference: Step Class | Workflows"
3
3
  description: Documentation for the Step class in Mastra, which defines individual units of work within a workflow.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.branch() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.branch() | Workflows"
3
3
  description: Documentation for the `Workflow.branch()` method in workflows, which creates conditional branches between steps.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.commit() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.commit() | Workflows"
3
3
  description: Documentation for the `Workflow.commit()` method in workflows, which finalizes the workflow and returns the final result.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.createRun() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.createRun() | Workflows"
3
3
  description: Documentation for the `Workflow.createRun()` method in workflows, which creates a new workflow run instance.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.dountil() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.dountil() | Workflows"
3
3
  description: Documentation for the `Workflow.dountil()` method in workflows, which creates a loop that executes a step until a condition is met.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.dowhile() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.dowhile() | Workflows"
3
3
  description: Documentation for the `Workflow.dowhile()` method in workflows, which creates a loop that executes a step while a condition is met.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.foreach() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.foreach() | Workflows"
3
3
  description: Documentation for the `Workflow.foreach()` method in workflows, which creates a loop that executes a step for each item in an array.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.map() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.map() | Workflows"
3
3
  description: Documentation for the `Workflow.map()` method in workflows, which maps output data from a previous step to the input of a subsequent step.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.parallel() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.parallel() | Workflows"
3
3
  description: Documentation for the `Workflow.parallel()` method in workflows, which executes multiple steps in parallel.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.sendEvent() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.sendEvent() | Workflows"
3
3
  description: Documentation for the `Workflow.sendEvent()` method in workflows, which resumes execution when an event is sent.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.sleep() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.sleep() | Workflows"
3
3
  description: Documentation for the `Workflow.sleep()` method in workflows, which pauses execution for a specified number of milliseconds.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.sleepUntil() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.sleepUntil() | Workflows"
3
3
  description: Documentation for the `Workflow.sleepUntil()` method in workflows, which pauses execution until a specified date.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.then() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.then() | Workflows"
3
3
  description: Documentation for the `Workflow.then()` method in workflows, which creates sequential dependencies between steps.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.waitForEvent() | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow.waitForEvent() | Workflows"
3
3
  description: Documentation for the `Workflow.waitForEvent()` method in workflows, which pauses execution until an event is received.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow Class | Workflows | Mastra Docs"
2
+ title: "Reference: Workflow Class | Workflows"
3
3
  description: Documentation for the `Workflow` class in Mastra, which enables you to create state machines for complex sequences of operations with conditional branching and data validation.
4
4
  ---
5
5
 
@@ -75,7 +75,7 @@ export const workflow = createWorkflow({
75
75
  description:
76
76
  "Optional flag to determine whether to validate the workflow inputs. This also applies default values from zodSchemas on the workflow/step input/resume data. If input/resume data validation fails on start/resume, the workflow will not start/resume, it throws an error instead. If input data validation fails on a step execution, the step fails, causing the workflow to fail and the error is returned.",
77
77
  isOptional: true,
78
- defaultValue: "false",
78
+ defaultValue: "true",
79
79
  },
80
80
  {
81
81
  name: "shouldPersistSnapshot",
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Custom API Routes | Server & DB | Mastra Docs"
2
+ title: "Custom API Routes | Server & DB"
3
3
  description: "Expose additional HTTP endpoints from your Mastra server."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Mastra Client SDK | Server & DB | Mastra Docs"
2
+ title: "Mastra Client SDK | Server & DB"
3
3
  description: "Learn how to set up and use the Mastra Client SDK"
4
4
  ---
5
5
 
@@ -8,7 +8,7 @@ import TabItem from "@theme/TabItem";
8
8
 
9
9
  # Mastra Client SDK
10
10
 
11
- The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/server-db/production-server) from your client environment.
11
+ The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/server-db/mastra-server) from your client environment.
12
12
 
13
13
  ## Prerequisites
14
14
 
@@ -1,9 +1,9 @@
1
1
  ---
2
- title: "Create a Mastra Production Server | Server & DB | Mastra Docs"
2
+ title: "Mastra Server | Server & DB"
3
3
  description: "Learn how to configure and deploy a production-ready Mastra server with custom settings for APIs, CORS, and more"
4
4
  ---
5
5
 
6
- # Create a Mastra Production Server
6
+ # Mastra Server
7
7
 
8
8
  When deploying your Mastra application to production, it runs as an HTTP server that exposes your agents, workflows, and other functionality as API endpoints. This page covers how to configure and customize the server for a production environment.
9
9
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Middleware | Server & DB | Mastra Docs"
2
+ title: "Middleware | Server & DB"
3
3
  description: "Apply custom middleware functions to intercept requests."
4
4
  ---
5
5
 
@@ -64,6 +64,35 @@ registerApiRoute("/my-custom-route", {
64
64
 
65
65
  ## Common examples
66
66
 
67
+ ### Using `RequestContext`
68
+
69
+ You can populate `RequestContext` dynamically in server middleware by extracting information from the request. In this example, the `temperature-unit` is set based on the Cloudflare `CF-IPCountry` header to ensure responses match the user's locale.
70
+
71
+ ```typescript title="src/mastra/index.ts" showLineNumbers copy
72
+ import { Mastra } from "@mastra/core";
73
+ import { RequestContext } from "@mastra/core/request-context";
74
+ import { testWeatherAgent } from "./agents/test-weather-agent";
75
+
76
+ export const mastra = new Mastra({
77
+ agents: { testWeatherAgent },
78
+ server: {
79
+ middleware: [
80
+ async (context, next) => {
81
+ const country = context.req.header("CF-IPCountry");
82
+ const requestContext = context.get("requestContext");
83
+
84
+ requestContext.set(
85
+ "temperature-unit",
86
+ country === "US" ? "fahrenheit" : "celsius",
87
+ );
88
+
89
+ await next();
90
+ },
91
+ ],
92
+ },
93
+ });
94
+ ```
95
+
67
96
  ### Authentication
68
97
 
69
98
  ```typescript copy
@@ -143,35 +172,6 @@ be inspected by middleware to tailor behavior:
143
172
  - `x-mastra-client-type`: identifies the client SDK, e.g. `js` or `python`
144
173
  - `x-studio`: request triggered from Studio
145
174
 
146
- ### Setting `requestContext`
147
-
148
- You can populate `requestContext` dynamically in server middleware by extracting information from the request. In this example, the `temperature-unit` is set based on the Cloudflare `CF-IPCountry` header to ensure responses match the user's locale.
149
-
150
- ```typescript title="src/mastra/index.ts" showLineNumbers copy
151
- import { Mastra } from "@mastra/core";
152
- import { RequestContext } from "@mastra/core/request-context";
153
- import { testWeatherAgent } from "./agents/test-weather-agent";
154
-
155
- export const mastra = new Mastra({
156
- agents: { testWeatherAgent },
157
- server: {
158
- middleware: [
159
- async (context, next) => {
160
- const country = context.req.header("CF-IPCountry");
161
- const requestContext = context.get("requestContext");
162
-
163
- requestContext.set(
164
- "temperature-unit",
165
- country === "US" ? "fahrenheit" : "celsius",
166
- );
167
-
168
- await next();
169
- },
170
- ],
171
- },
172
- });
173
- ```
174
-
175
175
  # Related
176
176
 
177
- - [Request Context](./request-context)
177
+ - [Request Context](/docs/v1/server-db/request-context)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Request Context | Server & DB | Mastra Docs"
2
+ title: "Request Context | Server & DB"
3
3
  description: Learn how to use Mastra's RequestContext to provide dynamic, request-specific configuration to agents.
4
4
  ---
5
5
 
@@ -190,5 +190,5 @@ export const weatherTool = createTool({
190
190
  - [Request Context Example](/examples/v1/agents/request-context)
191
191
  - [Agent Request Context](/docs/v1/agents/overview#using-requestcontext)
192
192
  - [Workflow Request Context](../workflows/overview#using-requestcontext)
193
- - [Tool Request Context](../tools-mcp/overview#using-requestcontext)
194
- - [Server Middleware Request Context](/docs/v1/server-db/middleware)
193
+ - [Tool Request Context](../mcp/overview#using-requestcontext)
194
+ - [Server Middleware](/docs/v1/server-db/middleware)