@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
@@ -0,0 +1,27 @@
1
+ ---
2
+ title: "Quickstart | Getting Started"
3
+ description: Choose how to get started with Mastra - standalone server or Next.js integration.
4
+ ---
5
+
6
+ import { CardGrid, CardGridItem } from "@site/src/components/cards/card-grid";
7
+
8
+ # Quickstart
9
+
10
+ Choose how you want to get started with Mastra:
11
+
12
+ <CardGrid columns={2}>
13
+ <CardGridItem
14
+ title="Standalone Server (Recommended)"
15
+ href="/guides/v1/quickstarts/standalone-server"
16
+ >
17
+ The fastest way to get started - spin up a standalone Mastra server and interact with your agents in Studio
18
+ </CardGridItem>
19
+ <CardGridItem
20
+ title="Next.js"
21
+ href="/guides/v1/quickstarts/nextjs"
22
+ >
23
+ Integrate Mastra into a Next.js app and use the AI SDK UI to build an in-app chat interface for your agents
24
+ </CardGridItem>
25
+ </CardGrid>
26
+
27
+ For more control over setup, or to add Mastra to an existing project, see the [manual installation guide](/guides/v1/guide/manual-install). You can also use [`mastra init`](/reference/v1/cli/mastra#mastra-init) for existing projects.
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Studio | Getting Started | Mastra Docs"
2
+ title: "Studio | Getting Started"
3
3
  description: Guide on installing Mastra and setting up the necessary prerequisites for running it with various LLM providers.
4
4
  ---
5
5
 
@@ -73,7 +73,7 @@ Visualize your workflow as a graph and run it step by step with a custom input.
73
73
 
74
74
  <VideoPlayer src="https://res.cloudinary.com/mastra-assets/video/upload/v1751406027/local-dev-workflows-playground_100_rbc466.mp4" />
75
75
 
76
- When running a workflow, you can also view detailed traces showing tool calls, raw JSON outputs, and any errors that might have occured along the way.
76
+ When running a workflow, you can also view detailed traces showing tool calls, raw JSON outputs, and any errors that might have occurred along the way.
77
77
 
78
78
  ### Tools
79
79
 
@@ -99,7 +99,7 @@ The Scorers tab displays the results of your agent's scorers as they run. When m
99
99
 
100
100
  ## REST API
101
101
 
102
- The local development server exposes a complete set of REST API routes, allowing you to programmatically interact with your agents, workflows, and tools during development. This is particularly helpful if you plan to deploy the Mastra server, since the local development server uses the exact same API routes as the [production server](/docs/v1/server-db/production-server), allowing you to develop and test against it with full parity.
102
+ The local development server exposes a complete set of REST API routes, allowing you to programmatically interact with your agents, workflows, and tools during development. This is particularly helpful if you plan to deploy the Mastra server, since the local development server uses the exact same API routes as the [Mastra Server](/docs/v1/server-db/mastra-server), allowing you to develop and test against it with full parity.
103
103
 
104
104
  You can explore all available endpoints in the OpenAPI specification at http://localhost:4111/openapi.json, which details every endpoint and its request and response schemas.
105
105
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Templates | Getting Started | Mastra Docs"
2
+ title: "Templates | Getting Started"
3
3
  description: Pre-built project structures that demonstrate common Mastra use cases and patterns
4
4
  ---
5
5
 
@@ -16,7 +16,7 @@ You'll create a workflow that gathers information from a candidate's resume, the
16
16
 
17
17
  - Node.js `v22.13.0` or later installed
18
18
  - An API key from a supported [Model Provider](/models/v1)
19
- - An existing Mastra project (Follow the [installation guide](/docs/v1/getting-started/installation) to set up a new project)
19
+ - An existing Mastra project (Follow the [installation guide](/guides/v1/quickstarts/standalone-server) to set up a new project)
20
20
 
21
21
  ## Building the Workflow
22
22
 
@@ -19,7 +19,7 @@ You'll learn how to create the agent and register it with Mastra. Next, you'll i
19
19
 
20
20
  - Node.js `v22.13.0` or later installed
21
21
  - An API key from a supported [Model Provider](/models/v1)
22
- - An existing Mastra project (Follow the [installation guide](/docs/v1/getting-started/installation) to set up a new project)
22
+ - An existing Mastra project (Follow the [installation guide](/guides/v1/quickstarts/standalone-server) to set up a new project)
23
23
 
24
24
  ## Creating the Agent
25
25
 
@@ -1,94 +1,20 @@
1
1
  ---
2
- title: "Install Mastra | Getting Started | Mastra Docs"
3
- description: Guide on installing Mastra and setting up the necessary prerequisites for running it with various LLM providers.
2
+ title: "Manual Install | Guides"
3
+ description: Set up a Mastra project manually without using the create mastra CLI.
4
4
  ---
5
5
 
6
6
  import Tabs from "@theme/Tabs";
7
7
  import TabItem from "@theme/TabItem";
8
8
  import Steps from "@site/src/components/Steps";
9
9
  import StepItem from "@site/src/components/StepItem";
10
- import { VideoPlayer } from "@site/src/components/video-player";
11
10
 
12
- # Install Mastra
13
-
14
- The `create mastra` CLI command is the quickest way to start a new Mastra project. It walks you through setup and creates example agents, workflows, and tools for you to learn from or adapt.
15
-
16
- For more control over setup, or to add Mastra to an existing project, see the [manual installation guide](#install-manually). You can also use [`mastra init`](/reference/v1/cli/mastra#mastra-init) for existing projects.
17
-
18
- ## Before you start
19
-
20
- - You'll need an API key from a [model provider](/models/v1) to complete setup. We suggest starting with [OpenAI](https://platform.openai.com/api-keys), but if you need a provider that doesn't require a credit card, Google's [Gemini](https://aistudio.google.com/app/api-keys) is also an option.
21
- - [Install](https://nodejs.org/en/download) Node.js 22.13.0 or later.
22
-
23
- ## Install with `create mastra`
24
-
25
- You can run `create mastra` anywhere on your machine.
26
-
27
- The wizard will guide you through setup, create a new directory for your project, and generate a weather agent with example workflows and tools to get you started.
28
-
29
- <Tabs>
30
- <TabItem value="npm" label="npm">
31
-
32
- ```bash copy
33
- npm create mastra@beta
34
- ```
35
-
36
- </TabItem>
37
- <TabItem value="pnpm" label="pnpm">
38
-
39
- ```bash copy
40
- pnpm create mastra@beta
41
- ```
42
-
43
- </TabItem>
44
- <TabItem value="yarn" label="yarn">
45
-
46
- ```bash copy
47
- yarn create mastra@beta
48
- ```
49
-
50
- </TabItem>
51
- <TabItem value="bun" label="bun">
52
-
53
- ```bash copy
54
- bun create mastra@beta
55
- ```
56
-
57
- </TabItem>
58
- </Tabs>
59
-
60
- :::note
61
-
62
- You can use flags with `create mastra` like `--no-example` to skip the example weather agent or `--template` to start from a specific [template](/docs/v1/getting-started/templates). Read the [CLI reference](/reference/v1/cli/create-mastra) for all options.
63
-
64
- :::
65
-
66
- ### Test your agent
67
-
68
- Once setup is complete, follow the instructions in your terminal to start the Mastra dev server, then open Studio at http://localhost:4111.
69
-
70
- Try asking about the weather. If your API key is set up correctly, you'll get a response:
71
-
72
- <VideoPlayer src="https://res.cloudinary.com/mastra-assets/video/upload/v1751406022/local-dev-agents-playground_100_m3begx.mp4" />
73
-
74
- :::note
75
-
76
- If you encounter an error, your API key may not be configured correctly. Double-check your setup and try again. Need more help? [Join our Discord](https://discord.gg/BTYqqHKUrf) and talk to the team directly.
11
+ # Manual Install
77
12
 
13
+ :::info
14
+ Use this guide to manually build a standalone Mastra server step by step. In most cases, it's quicker to follow the [Standalone Server Quickstart](/guides/v1/quickstarts/standalone-server), which achieves the same result using the [`mastra create`](/reference/v1/cli/create-mastra) command. For existing projects, you can also use [`mastra init`](/reference/v1/cli/mastra#mastra-init).
78
15
  :::
79
16
 
80
- [Studio](/docs/v1/getting-started/studio) lets you rapidly build and prototype agents without needing to build a UI. Once you're ready, you can integrate your Mastra agent into your application using the guides below.
81
-
82
- ### Next steps
83
-
84
- - Read more about [Mastra's features](/docs/v1#why-mastra).
85
- - Integrate Mastra with your frontend framework: [Next.js](/docs/v1/frameworks/web-frameworks/next-js), [React](/docs/v1/frameworks/web-frameworks/vite-react), or [Astro](/docs/v1/frameworks/web-frameworks/astro).
86
- - Build an agent from scratch following one of our [guides](/guides/v1).
87
- - Watch conceptual guides on our [YouTube channel](https://www.youtube.com/@mastra-ai) and [subscribe](https://www.youtube.com/@mastra-ai?sub_confirmation=1)!
88
-
89
- ## Install manually
90
-
91
- If you prefer not to use our automatic `create mastra` CLI tool, you can set up your project yourself by following the guide below.
17
+ If you prefer not to use our automatic CLI tool, you can set up your project yourself by following the guide below.
92
18
 
93
19
  <Steps>
94
20
 
@@ -18,7 +18,7 @@ In this guide, you'll learn how to build a complete MCP (Model Context Protocol)
18
18
 
19
19
  - Node.js `v22.13.0` or later installed
20
20
  - An API key from a supported [Model Provider](/models/v1)
21
- - An existing Mastra project (Follow the [installation guide](/docs/v1/getting-started/installation) to set up a new project)
21
+ - An existing Mastra project (Follow the [installation guide](/guides/v1/quickstarts/standalone-server) to set up a new project)
22
22
 
23
23
  ## Adding necessary dependencies & files
24
24
 
@@ -38,7 +38,7 @@ npm install @mastra/mcp@beta
38
38
 
39
39
  <StepItem>
40
40
 
41
- After following the default [installation guide](/docs/v1/getting-started/installation) your project will include files that are not relevant for this guide. You can safely remove them:
41
+ After following the default [installation guide](/guides/v1/quickstarts/standalone-server) your project will include files that are not relevant for this guide. You can safely remove them:
42
42
 
43
43
  ```bash copy
44
44
  rm -rf src/mastra/agents src/mastra/workflows src/mastra/tools/weather-tool.ts
@@ -16,7 +16,7 @@ You'll use the foundational Transformer paper ["Attention Is All You Need"](http
16
16
 
17
17
  - Node.js `v22.13.0` or later installed
18
18
  - An API key from a supported [Model Provider](/models/v1)
19
- - An existing Mastra project (Follow the [installation guide](/docs/v1/getting-started/installation) to set up a new project)
19
+ - An existing Mastra project (Follow the [installation guide](/guides/v1/quickstarts/standalone-server) to set up a new project)
20
20
 
21
21
  ## How RAG works
22
22
 
@@ -57,7 +57,7 @@ Let's define the agent's behavior, connect it to your Mastra project, and create
57
57
 
58
58
  Install additional dependencies
59
59
 
60
- After running the [installation guide](/docs/v1/getting-started/installation) you'll need to install additional dependencies:
60
+ After running the [installation guide](/guides/v1/quickstarts/standalone-server) you'll need to install additional dependencies:
61
61
 
62
62
  ```bash copy
63
63
  npm install @mastra/rag@beta ai@^4.0.0
@@ -17,7 +17,7 @@ In this guide, you're going to create a simple agent that fetches the last day's
17
17
 
18
18
  - Node.js `v22.13.0` or later installed
19
19
  - An API key from a supported [Model Provider](/models/v1)
20
- - An existing Mastra project (Follow the [installation guide](/docs/v1/getting-started/installation) to set up a new project)
20
+ - An existing Mastra project (Follow the [installation guide](/guides/v1/quickstarts/standalone-server) to set up a new project)
21
21
 
22
22
  ## Creating the Agent
23
23
 
@@ -19,7 +19,7 @@ When building a web search agent, you have two main strategies to consider:
19
19
 
20
20
  - Node.js `v22.13.0` or later installed
21
21
  - An API key from a supported [Model Provider](/models/v1)
22
- - An existing Mastra project (Follow the [installation guide](/docs/v1/getting-started/installation) to set up a new project)
22
+ - An existing Mastra project (Follow the [installation guide](/guides/v1/quickstarts/standalone-server) to set up a new project)
23
23
 
24
24
  ## Using native search tools
25
25
 
@@ -0,0 +1,119 @@
1
+ ---
2
+ title: "Migration: AI SDK v4 to v5 | Migration Guide"
3
+ description: "Mastra-specific guidance for upgrading from AI SDK v4 to v5."
4
+ ---
5
+
6
+ # Migrate from AI SDK v4 to v5
7
+
8
+ Looking for integration docs? See [Using AI SDK](/docs/v1/frameworks/agentic-uis/ai-sdk).
9
+
10
+ Follow the official [AI SDK v5 Migration Guide](https://v5.ai-sdk.dev/docs/migration-guides/migration-guide-5-0) for all AI SDK core breaking changes, package updates, and API changes.
11
+
12
+ This guide covers only the Mastra-specific aspects of the migration.
13
+
14
+ - **Data compatibility**: New data stored in v5 format will no longer work if you downgrade from v5 to v4
15
+ - **Backup recommendation**: Keep DB backups from before you upgrade to v5
16
+
17
+ ### Memory and Storage
18
+
19
+ Mastra automatically handles AI SDK v4 data using its internal `MessageList` class, which manages format conversion—including v4 to v5. No database migrations are required; your existing messages are translated on the fly and continue working after you upgrade.
20
+
21
+ ### Message Format Conversion
22
+
23
+ For cases where you need to manually convert messages between AI SDK and Mastra formats, use the `convertMessages()` utility:
24
+
25
+ ```typescript
26
+ import { convertMessages } from "@mastra/core/agent";
27
+
28
+ // Convert AI SDK v4 messages to v5
29
+ const aiv5Messages = convertMessages(aiv4Messages).to("AIV5.UI");
30
+
31
+ // Convert Mastra messages to AI SDK v5
32
+ const aiv5Messages = convertMessages(mastraMessages).to("AIV5.Core");
33
+
34
+ // Supported output formats:
35
+ // 'Mastra.V2', 'AIV4.UI', 'AIV5.UI', 'AIV5.Core', 'AIV5.Model'
36
+ ```
37
+
38
+ This utility is helpful when you want to fetch messages directly from your storage DB and convert them for use in AI SDK.
39
+
40
+ ### Type Inference for Tools
41
+
42
+ When using tools with TypeScript in AI SDK v5, Mastra provides type inference helpers to ensure type safety for your tool inputs and outputs.
43
+
44
+ #### `InferUITool`
45
+
46
+ The `InferUITool` type helper infers the input and output types of a single Mastra tool:
47
+
48
+ ```typescript title="app/types.ts" copy
49
+ import { InferUITool, createTool } from "@mastra/core/tools";
50
+ import { z } from "zod";
51
+
52
+ const weatherTool = createTool({
53
+ id: "get-weather",
54
+ description: "Get the current weather",
55
+ inputSchema: z.object({
56
+ location: z.string().describe("The city and state"),
57
+ }),
58
+ outputSchema: z.object({
59
+ temperature: z.number(),
60
+ conditions: z.string(),
61
+ }),
62
+ execute: async (inputData) => {
63
+ return {
64
+ temperature: 72,
65
+ conditions: "sunny",
66
+ };
67
+ },
68
+ });
69
+
70
+ // Infer the types from the tool
71
+ type WeatherUITool = InferUITool<typeof weatherTool>;
72
+ // This creates:
73
+ // {
74
+ // input: { location: string };
75
+ // output: { temperature: number; conditions: string };
76
+ // }
77
+ ```
78
+
79
+ #### `InferUITools`
80
+
81
+ The `InferUITools` type helper infers the input and output types of multiple tools:
82
+
83
+ ```typescript title="app/mastra/tools.ts" copy
84
+ import { InferUITools, createTool } from "@mastra/core/tools";
85
+ import { z } from "zod";
86
+
87
+ // Using weatherTool from the previous example
88
+ const tools = {
89
+ weather: weatherTool,
90
+ calculator: createTool({
91
+ id: "calculator",
92
+ description: "Perform basic arithmetic",
93
+ inputSchema: z.object({
94
+ operation: z.enum(["add", "subtract", "multiply", "divide"]),
95
+ a: z.number(),
96
+ b: z.number(),
97
+ }),
98
+ outputSchema: z.object({
99
+ result: z.number(),
100
+ }),
101
+ execute: async (inputData) => {
102
+ // implementation...
103
+ return { result: 0 };
104
+ },
105
+ }),
106
+ };
107
+
108
+ // Infer types from the tool set
109
+ export type MyUITools = InferUITools<typeof tools>;
110
+ // This creates:
111
+ // {
112
+ // weather: { input: { location: string }; output: { temperature: number; conditions: string } };
113
+ // calculator: { input: { operation: "add" | "subtract" | "multiply" | "divide"; a: number; b: number }; output: { result: number } };
114
+ // }
115
+ ```
116
+
117
+ These type helpers provide full TypeScript support when using Mastra tools with AI SDK v5 UI components, ensuring type safety across your application.
118
+
119
+
@@ -134,7 +134,7 @@ npx @mastra/codemod@beta v1/mastra-plural-apis .
134
134
 
135
135
  :::
136
136
 
137
- ### Each primtive has a `getById` and a `get` function
137
+ ### Each primitive has a `getById` and a `get` function
138
138
 
139
139
  ```typescript
140
140
  mastra.getMCPServer('myServer'); // Works (registry key)
@@ -13,10 +13,18 @@ Need help with the migration? Join our [Discord community](https://discord.gg/BT
13
13
 
14
14
  ## Migration Strategy
15
15
 
16
- ### Update all Mastra packages
16
+ ### Update all Mastra packages to `beta` tag
17
17
 
18
18
  Use your package manager to update your project's versions. Be sure to update **all** Mastra packages at the same time to ensure compatibility.
19
19
 
20
+ Here's how you update the most commonly used packages:
21
+
22
+ ```shell
23
+ npm install @mastra/core@beta mastra@beta @mastra/loggers@beta @mastra/memory@beta
24
+ ```
25
+
26
+ Install any other Mastra package with the `@beta` tag and you'll get the latest beta version available. Be sure to update all Mastra packages (especially if you're in a monorepo) to avoid version mismatches.
27
+
20
28
  ### Update Node.js version
21
29
 
22
30
  Mastra v1 requires Node.js **22.13.0** or higher. Update your development and production environments accordingly.
@@ -113,3 +113,63 @@ npx @mastra/codemod@beta v1/runtime-context .
113
113
  ```
114
114
 
115
115
  :::
116
+
117
+ This applies to all tool executions, whether called directly or through agents and workflows. The type narrowing ensures you handle validation errors appropriately and prevents runtime errors when accessing output properties.
118
+
119
+ ### Tool output validation with `outputSchema`
120
+
121
+ Tools with an `outputSchema` now validate their return values at runtime. Previously, `outputSchema` was only used for type inference - the output was never validated.
122
+
123
+ If your tool returns data that doesn't match its `outputSchema`, it will now return a `ValidationError` instead of the invalid data.
124
+
125
+ To fix validation errors, ensure the tool's output matches the schema definition:
126
+
127
+ ```diff
128
+ const getUserTool = createTool({
129
+ id: "get-user",
130
+ outputSchema: z.object({
131
+ id: z.string(),
132
+ name: z.string(),
133
+ email: z.string().email(),
134
+ }),
135
+ execute: async (inputData) => {
136
+ - return { id: "123", name: "John" }; // Missing email
137
+ + return { id: "123", name: "John", email: "john@example.com" };
138
+ },
139
+ });
140
+ ```
141
+
142
+ When validation fails, the tool returns a `ValidationError`:
143
+
144
+ ```diff
145
+ + // Before v1 - invalid output would silently pass through
146
+ await getUserTool.execute({});
147
+ - // { id: "123", name: "John" } - missing email
148
+ + // {
149
+ + // error: true,
150
+ + // message: "Tool output validation failed for get-user. The tool returned invalid output:\n- email: Required\n\nReturned output: {...}",
151
+ + // validationErrors: { ... }
152
+ + // }
153
+ ```
154
+
155
+ ### `tool.execute` return type includes `ValidationError`
156
+
157
+ The return type of `tool.execute` now includes `ValidationError` to handle validation failures. You must narrow the result type before accessing output schema properties to satisfy TypeScript's type checking.
158
+
159
+ When calling `tool.execute`, check if the result contains an error before accessing output properties:
160
+
161
+ ```typescript
162
+ const result = await getUserTool.execute({});
163
+
164
+ // Type-safe check for validation errors
165
+ if ('error' in result && result.error) {
166
+ console.error('Validation failed:', result.message);
167
+ console.error('Details:', result.validationErrors);
168
+ return;
169
+ }
170
+
171
+ // TypeScript knows result is valid here
172
+ console.log(result.id, result.name, result.email);
173
+ ```
174
+
175
+ Alternatively, update the `outputSchema` to match your actual output, or remove `outputSchema` entirely if you don't need validation.
@@ -124,6 +124,18 @@ npx @mastra/codemod@beta v1/workflow-list-runs .
124
124
 
125
125
  :::
126
126
 
127
+ ### Inputs are validated by default
128
+
129
+ Previously, inputs weren't validated by default. The [`validateInputs`](/reference/v1/workflows/workflow#workflowoptions) flag determines whether to validate the workflow inputs or not. This boolean has been flipped to `true`. If you want the old behavior or have workflows whose schemas don't need to be validated, set `validateInputs: false`.
130
+
131
+ ```diff
132
+ createWorkflow({
133
+ + options: {
134
+ + validateInputs: false
135
+ + }
136
+ })
137
+ ```
138
+
127
139
  ## Removed
128
140
 
129
141
  ### Legacy workflows export
@@ -5,11 +5,11 @@ description: "Get started with Mastra, Next.js, and AS SDK UI. Quickly."
5
5
 
6
6
  # Next.js Quickstart
7
7
 
8
- In this quickstart, you'll build an AI agent with tool-calling capabilities using [Mastra](/docs/v1), then connect it to Next.js by importing and calling the agent directly within your routes.
8
+ In this quickstart, you'll build a tool-calling AI agent using Mastra, then connect it to Next.js by importing and calling the agent directly from your routes.
9
9
 
10
- You'll use [AI SDK UI](https://ai-sdk.dev/docs/ai-sdk-ui/overview) and [AI Elements](https://ai-sdk.dev/elements) to create a beautiful, interactive chat experience.
10
+ You'll use [AI SDK UI](https://ai-sdk.dev/docs/ai-sdk-ui/overview) and [AI Elements](https://ai-sdk.dev/elements) to create a beautiful, interactive chat experience.
11
11
 
12
- In ~5 minutes, you'll have a functional AI-powered app ready to extend with your own tools and logic.
12
+ In about 5 minutes, you'll have a functional AI-powered app ready to extend with your own tools and logic.
13
13
 
14
14
  <figure>
15
15
  ![Screenshot of a chat-style web app displaying a completed "weatherTool" tool call, answering "What is the weather in London?" with a JSON result. A message suggests offering activity ideas, and a text input field is at the bottom.](/img/nextjs-quickstart.png)
@@ -18,7 +18,7 @@ In ~5 minutes, you'll have a functional AI-powered app ready to extend with your
18
18
 
19
19
  ## Before you begin
20
20
 
21
- * You'll need an API key from a supported [model provider](/models/v1). If you don't have a preference, use [OpenAI](https://platform.openai.com/api-keys).
21
+ * You'll need an API key from a supported [model provider](/models/v1). If you don't have a preference, use [OpenAI](/models/v1/providers/openai).
22
22
 
23
23
  ## Create a new Next.js app
24
24
 
@@ -41,7 +41,7 @@ npx create-next-app \
41
41
  This creates a project called `my-nextjs-agent`, but you can replace it with any name you want.
42
42
 
43
43
  ## Initialize Mastra
44
- `cd` and run [`mastra init`](/reference/v1/cli/create-mastra).
44
+ `cd` and run [`mastra init`](/reference/v1/cli/create-mastra).
45
45
 
46
46
  When prompted, choose a provider (e.g. OpenAI) and enter your key:
47
47
 
@@ -58,14 +58,15 @@ This creates a `src/mastra` folder with an example weather agent and the followi
58
58
  You'll call `weather-agent.ts` from your Next.js routes in the next steps.
59
59
 
60
60
 
61
- ## Install AI SDK UI and AI Elements
61
+ ## Install AI SDK and AI Elements
62
62
 
63
- Install AI SDK UI along with the Mastra adapter:
63
+ Install AI SDK along with the Mastra adapter:
64
64
 
65
65
  ```bash
66
66
  npm install \
67
67
  @mastra/ai-sdk \
68
- @ai-sdk/react
68
+ @ai-sdk/react \
69
+ ai
69
70
  ```
70
71
 
71
72
  Next, initialize AI Elements. When prompted, choose the default options:
@@ -112,7 +113,7 @@ export async function GET() {
112
113
  resourceId: "weather-chat",
113
114
  });
114
115
 
115
- const uiMessages =
116
+ const uiMessages =
116
117
  convertMessages(response?.uiMessages ?? []).to("AIV5.UI");
117
118
  return NextResponse.json(uiMessages);
118
119
  }
@@ -190,8 +191,8 @@ function Chat() {
190
191
  {message.parts?.map((part: any, i: number) => {
191
192
  if (part.type === 'text') {
192
193
  return (
193
- <Message
194
- key={`${message.id}-${i}`}
194
+ <Message
195
+ key={`${message.id}-${i}`}
195
196
  from={message.role}>
196
197
  <MessageContent>
197
198
  <MessageResponse>{part.text}</MessageResponse>
@@ -251,16 +252,16 @@ This component connects [`useChat()`](https://ai-sdk.dev/docs/reference/ai-sdk-u
251
252
  It renders the response text using the [`<MessageResponse>`](https://ai-sdk.dev/elements/components/message#messageresponse-) component, and shows any tool invocations with the [`<Tool>`](https://ai-sdk.dev/elements/components/tool) component.
252
253
 
253
254
 
254
- ## Test your agent
255
+ ## Test your agent
255
256
  1. Run your Next.js app with `npm run dev`
256
257
 
257
258
  2. Open the chat at http://localhost:3000/chat
258
259
 
259
- 3. Try asking about the weather. If your API key is set up correctly, you'll get a response.
260
+ 3. Try asking about the weather. If your API key is set up correctly, you'll get a response
260
261
 
261
262
  ## Next steps
262
263
 
263
- Congratulations on building your Mastra agent with Next.js! 🎉
264
+ Congratulations on building your Mastra agent with Next.js! 🎉
264
265
 
265
266
  From here, you can extend the project with your own tools and logic:
266
267
 
@@ -268,8 +269,8 @@ From here, you can extend the project with your own tools and logic:
268
269
  - Give your agent its own [tools](/docs/v1/agents/using-tools)
269
270
  - Add human-like [memory](/docs/v1/agents/agent-memory) to your agent
270
271
 
271
- When you're ready, read more about how Mastra integrates with AI SDK and Next.js, and how to deploy to Vercel:
272
+ When you're ready, read more about how Mastra integrates with AI SDK and Next.js, and how to deploy your agent anywhere, including Vercel:
272
273
 
273
274
  - Integrate Mastra with [AI SDK](/docs/v1/frameworks/agentic-uis/ai-sdk)
274
- - Use Mastra in your [Next.js app](/docs/v1/frameworks/web-frameworks/next-js)
275
- - Deploy your agent to [Vercel](/docs/v1/deployment/serverless-platforms/vercel-deployer)
275
+ - Deploy your agent to [Vercel](/docs/v1/deployment/cloud-providers/vercel-deployer)
276
+ - Deploy your agent [anywhere](/docs/v1/deployment/overview)