@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.0

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 (480) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +1 -0
  2. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -10
  3. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +0 -10
  4. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +36 -36
  5. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -10
  6. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +70 -70
  7. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +40 -40
  8. package/.docs/organized/changelogs/%40mastra%2Fastra.md +19 -19
  9. package/.docs/organized/changelogs/%40mastra%2Fauth.md +4 -14
  10. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +18 -18
  11. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +199 -199
  12. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +223 -223
  13. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +190 -190
  14. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +199 -199
  15. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +7 -0
  16. package/.docs/organized/changelogs/%40mastra%2Fcore.md +214 -214
  17. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
  18. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +74 -74
  19. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +67 -67
  20. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +70 -70
  21. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +67 -67
  22. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +209 -209
  23. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +191 -191
  24. package/.docs/organized/changelogs/%40mastra%2Fevals.md +34 -34
  25. package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +5 -13
  26. package/.docs/organized/changelogs/%40mastra%2Flance.md +182 -182
  27. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +199 -199
  28. package/.docs/organized/changelogs/%40mastra%2Floggers.md +20 -20
  29. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +58 -58
  30. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +20 -20
  31. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +65 -65
  32. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +228 -228
  33. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +199 -199
  34. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +206 -206
  35. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +19 -19
  36. package/.docs/organized/changelogs/%40mastra%2Fpg.md +197 -197
  37. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +16 -16
  38. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +217 -217
  39. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +16 -16
  40. package/.docs/organized/changelogs/%40mastra%2Frag.md +61 -61
  41. package/.docs/organized/changelogs/%40mastra%2Freact.md +70 -70
  42. package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -17
  43. package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -30
  44. package/.docs/organized/changelogs/%40mastra%2Fserver.md +206 -206
  45. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +16 -16
  46. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +190 -190
  47. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +18 -18
  48. package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +21 -21
  49. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +20 -20
  50. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +20 -20
  51. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +20 -20
  52. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +20 -20
  53. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +56 -56
  54. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +20 -20
  55. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +20 -20
  56. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +56 -56
  57. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +20 -20
  58. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +20 -20
  59. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +20 -20
  60. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +20 -20
  61. package/.docs/organized/changelogs/create-mastra.md +33 -33
  62. package/.docs/organized/changelogs/mastra.md +86 -86
  63. package/.docs/organized/code-examples/a2a.md +4 -2
  64. package/.docs/organized/code-examples/agui.md +12 -9
  65. package/.docs/organized/code-examples/ai-sdk-useChat.md +12 -18
  66. package/.docs/organized/code-examples/ai-sdk-v5.md +4 -2
  67. package/.docs/organized/code-examples/bird-checker-with-express.md +5 -4
  68. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +4 -3
  69. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +4 -3
  70. package/.docs/organized/code-examples/client-side-tools.md +1 -0
  71. package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
  72. package/.docs/organized/code-examples/experimental-auth-weather-agent.md +8 -177
  73. package/.docs/organized/code-examples/fireworks-r1.md +2 -2
  74. package/.docs/organized/code-examples/heads-up-game.md +10 -7
  75. package/.docs/organized/code-examples/mcp-configuration.md +5 -3
  76. package/.docs/organized/code-examples/mcp-registry-registry.md +3 -2
  77. package/.docs/organized/code-examples/memory-per-resource-example.md +4 -2
  78. package/.docs/organized/code-examples/memory-todo-agent.md +1 -0
  79. package/.docs/organized/code-examples/memory-with-context.md +2 -1
  80. package/.docs/organized/code-examples/memory-with-libsql.md +4 -2
  81. package/.docs/organized/code-examples/memory-with-mongodb.md +4 -2
  82. package/.docs/organized/code-examples/memory-with-pg.md +4 -2
  83. package/.docs/organized/code-examples/memory-with-processors.md +13 -8
  84. package/.docs/organized/code-examples/memory-with-upstash.md +5 -3
  85. package/.docs/organized/code-examples/openapi-spec-writer.md +32 -41
  86. package/.docs/organized/code-examples/quick-start.md +5 -32
  87. package/.docs/organized/code-examples/stock-price-tool.md +6 -5
  88. package/.docs/organized/code-examples/weather-agent.md +21 -16
  89. package/.docs/organized/code-examples/workflow-ai-recruiter.md +3 -2
  90. package/.docs/organized/code-examples/workflow-with-inline-steps.md +9 -12
  91. package/.docs/organized/code-examples/workflow-with-memory.md +16 -15
  92. package/.docs/organized/code-examples/workflow-with-separate-steps.md +2 -2
  93. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +3 -2
  94. package/.docs/raw/agents/adding-voice.mdx +27 -22
  95. package/.docs/raw/agents/agent-memory.mdx +23 -15
  96. package/.docs/raw/agents/guardrails.mdx +33 -12
  97. package/.docs/raw/agents/networks.mdx +8 -4
  98. package/.docs/raw/agents/overview.mdx +21 -15
  99. package/.docs/raw/agents/using-tools.mdx +11 -8
  100. package/.docs/raw/auth/auth0.mdx +8 -8
  101. package/.docs/raw/auth/clerk.mdx +6 -6
  102. package/.docs/raw/auth/firebase.mdx +8 -8
  103. package/.docs/raw/auth/index.mdx +6 -6
  104. package/.docs/raw/auth/jwt.mdx +6 -6
  105. package/.docs/raw/auth/supabase.mdx +7 -7
  106. package/.docs/raw/auth/workos.mdx +8 -8
  107. package/.docs/raw/community/contributing-templates.mdx +3 -3
  108. package/.docs/raw/community/discord.mdx +1 -1
  109. package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +2 -1
  110. package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +2 -1
  111. package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +2 -0
  112. package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -0
  113. package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +2 -3
  114. package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +2 -0
  115. package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +2 -0
  116. package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -0
  117. package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -0
  118. package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +1 -0
  119. package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -0
  120. package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +1 -0
  121. package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
  122. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +5 -5
  123. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +7 -5
  124. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +3 -3
  125. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +4 -4
  126. package/.docs/raw/deployment/cloud-providers/index.mdx +11 -8
  127. package/.docs/raw/deployment/monorepo.mdx +2 -2
  128. package/.docs/raw/deployment/overview.mdx +2 -2
  129. package/.docs/raw/deployment/server-deployment.mdx +2 -10
  130. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +4 -4
  131. package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
  132. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +4 -4
  133. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +4 -4
  134. package/.docs/raw/deployment/web-framework.mdx +8 -8
  135. package/.docs/raw/{scorers → evals}/custom-scorers.mdx +6 -6
  136. package/.docs/raw/evals/off-the-shelf-scorers.mdx +50 -0
  137. package/.docs/raw/{scorers → evals}/overview.mdx +8 -8
  138. package/.docs/raw/evals/running-in-ci.mdx +113 -0
  139. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +22 -21
  140. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +8 -8
  141. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -0
  142. package/.docs/raw/frameworks/servers/express.mdx +10 -9
  143. package/.docs/raw/frameworks/web-frameworks/astro.mdx +6 -6
  144. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +3 -3
  145. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +4 -4
  146. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +2 -2
  147. package/.docs/raw/getting-started/installation.mdx +13 -12
  148. package/.docs/raw/getting-started/mcp-docs-server.mdx +1 -1
  149. package/.docs/raw/getting-started/project-structure.mdx +4 -4
  150. package/.docs/raw/getting-started/studio.mdx +8 -8
  151. package/.docs/raw/getting-started/templates.mdx +1 -1
  152. package/.docs/raw/guides/guide/ai-recruiter.mdx +264 -0
  153. package/.docs/raw/guides/guide/chef-michel.mdx +271 -0
  154. package/.docs/raw/guides/guide/notes-mcp-server.mdx +450 -0
  155. package/.docs/raw/guides/guide/research-assistant.mdx +389 -0
  156. package/.docs/raw/guides/guide/stock-agent.mdx +185 -0
  157. package/.docs/raw/guides/guide/web-search.mdx +291 -0
  158. package/.docs/raw/guides/index.mdx +43 -0
  159. package/.docs/raw/guides/migrations/agentnetwork.mdx +114 -0
  160. package/.docs/raw/guides/migrations/upgrade-to-v1/_template.mdx +50 -0
  161. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +265 -0
  162. package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +48 -0
  163. package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +153 -0
  164. package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +230 -0
  165. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +171 -0
  166. package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +114 -0
  167. package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +241 -0
  168. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +83 -0
  169. package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +62 -0
  170. package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +270 -0
  171. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +115 -0
  172. package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +280 -0
  173. package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +23 -0
  174. package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +39 -0
  175. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +178 -0
  176. package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +367 -0
  177. package/.docs/raw/index.mdx +9 -9
  178. package/.docs/raw/{observability/logging.mdx → logging.mdx} +4 -4
  179. package/.docs/raw/mastra-cloud/dashboard.mdx +2 -2
  180. package/.docs/raw/mastra-cloud/observability.mdx +6 -6
  181. package/.docs/raw/mastra-cloud/overview.mdx +2 -2
  182. package/.docs/raw/mastra-cloud/setting-up.mdx +4 -4
  183. package/.docs/raw/memory/conversation-history.mdx +1 -0
  184. package/.docs/raw/memory/memory-processors.mdx +4 -3
  185. package/.docs/raw/memory/overview.mdx +9 -5
  186. package/.docs/raw/memory/semantic-recall.mdx +12 -7
  187. package/.docs/raw/memory/storage/memory-with-libsql.mdx +10 -5
  188. package/.docs/raw/memory/storage/memory-with-pg.mdx +9 -4
  189. package/.docs/raw/memory/storage/memory-with-upstash.mdx +9 -4
  190. package/.docs/raw/memory/threads-and-resources.mdx +11 -13
  191. package/.docs/raw/memory/working-memory.mdx +30 -14
  192. package/.docs/raw/observability/overview.mdx +13 -30
  193. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/arize.mdx +10 -18
  194. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +7 -16
  195. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/cloud.mdx +11 -17
  196. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/default.mdx +16 -20
  197. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +7 -16
  198. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +7 -16
  199. package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +9 -18
  200. package/.docs/raw/observability/{ai-tracing → tracing}/overview.mdx +107 -142
  201. package/.docs/raw/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +14 -13
  202. package/.docs/raw/rag/chunking-and-embedding.mdx +5 -5
  203. package/.docs/raw/rag/overview.mdx +3 -13
  204. package/.docs/raw/rag/retrieval.mdx +24 -12
  205. package/.docs/raw/rag/vector-databases.mdx +7 -1
  206. package/.docs/raw/reference/agents/agent.mdx +33 -28
  207. package/.docs/raw/reference/agents/generate.mdx +10 -10
  208. package/.docs/raw/reference/agents/generateLegacy.mdx +8 -8
  209. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +21 -15
  210. package/.docs/raw/reference/agents/getDefaultOptions.mdx +69 -0
  211. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +22 -16
  212. package/.docs/raw/reference/agents/getDescription.mdx +1 -1
  213. package/.docs/raw/reference/agents/getInstructions.mdx +8 -8
  214. package/.docs/raw/reference/agents/getLLM.mdx +9 -9
  215. package/.docs/raw/reference/agents/getMemory.mdx +9 -9
  216. package/.docs/raw/reference/agents/getModel.mdx +10 -10
  217. package/.docs/raw/reference/agents/getVoice.mdx +8 -8
  218. package/.docs/raw/reference/agents/listAgents.mdx +9 -9
  219. package/.docs/raw/reference/agents/listScorers.mdx +7 -7
  220. package/.docs/raw/reference/agents/listTools.mdx +7 -7
  221. package/.docs/raw/reference/agents/listWorkflows.mdx +7 -7
  222. package/.docs/raw/reference/agents/network.mdx +11 -10
  223. package/.docs/raw/reference/auth/auth0.mdx +4 -4
  224. package/.docs/raw/reference/auth/clerk.mdx +4 -4
  225. package/.docs/raw/reference/auth/firebase.mdx +6 -6
  226. package/.docs/raw/reference/auth/jwt.mdx +4 -4
  227. package/.docs/raw/reference/auth/supabase.mdx +4 -4
  228. package/.docs/raw/reference/auth/workos.mdx +4 -4
  229. package/.docs/raw/reference/cli/mastra.mdx +7 -7
  230. package/.docs/raw/reference/client-js/agents.mdx +6 -2
  231. package/.docs/raw/reference/client-js/mastra-client.mdx +7 -7
  232. package/.docs/raw/reference/client-js/memory.mdx +24 -16
  233. package/.docs/raw/reference/client-js/observability.mdx +11 -11
  234. package/.docs/raw/reference/client-js/workflows.mdx +6 -34
  235. package/.docs/raw/reference/core/getAgent.mdx +1 -1
  236. package/.docs/raw/reference/core/getAgentById.mdx +1 -1
  237. package/.docs/raw/reference/core/getDeployer.mdx +2 -2
  238. package/.docs/raw/reference/core/getLogger.mdx +2 -2
  239. package/.docs/raw/reference/core/getMCPServer.mdx +31 -15
  240. package/.docs/raw/reference/core/getMCPServerById.mdx +81 -0
  241. package/.docs/raw/reference/core/getScorer.mdx +3 -3
  242. package/.docs/raw/reference/core/getScorerById.mdx +79 -0
  243. package/.docs/raw/reference/core/getServer.mdx +2 -2
  244. package/.docs/raw/reference/core/getStorage.mdx +2 -2
  245. package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
  246. package/.docs/raw/reference/core/getVector.mdx +2 -2
  247. package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
  248. package/.docs/raw/reference/core/listAgents.mdx +1 -1
  249. package/.docs/raw/reference/core/listLogs.mdx +2 -2
  250. package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
  251. package/.docs/raw/reference/core/listMCPServers.mdx +65 -0
  252. package/.docs/raw/reference/core/listScorers.mdx +3 -3
  253. package/.docs/raw/reference/core/listVectors.mdx +36 -0
  254. package/.docs/raw/reference/core/listWorkflows.mdx +6 -6
  255. package/.docs/raw/reference/core/mastra-class.mdx +3 -2
  256. package/.docs/raw/reference/core/setLogger.mdx +2 -2
  257. package/.docs/raw/reference/core/setStorage.mdx +3 -2
  258. package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
  259. package/.docs/raw/reference/deployer/cloudflare.mdx +2 -2
  260. package/.docs/raw/reference/deployer/deployer.mdx +0 -6
  261. package/.docs/raw/reference/deployer/netlify.mdx +2 -2
  262. package/.docs/raw/reference/deployer/vercel.mdx +3 -3
  263. package/.docs/raw/reference/evals/answer-relevancy.mdx +164 -126
  264. package/.docs/raw/reference/{scorers → evals}/answer-similarity.mdx +27 -27
  265. package/.docs/raw/reference/evals/bias.mdx +149 -115
  266. package/.docs/raw/reference/evals/completeness.mdx +148 -117
  267. package/.docs/raw/reference/evals/content-similarity.mdx +126 -113
  268. package/.docs/raw/reference/evals/context-precision.mdx +290 -133
  269. package/.docs/raw/reference/{scorers → evals}/context-relevance.mdx +6 -6
  270. package/.docs/raw/reference/{scorers → evals}/create-scorer.mdx +11 -11
  271. package/.docs/raw/reference/evals/faithfulness.mdx +163 -121
  272. package/.docs/raw/reference/evals/hallucination.mdx +159 -132
  273. package/.docs/raw/reference/evals/keyword-coverage.mdx +169 -125
  274. package/.docs/raw/reference/{scorers → evals}/mastra-scorer.mdx +5 -5
  275. package/.docs/raw/reference/{scorers → evals}/noise-sensitivity.mdx +9 -9
  276. package/.docs/raw/reference/evals/prompt-alignment.mdx +604 -182
  277. package/.docs/raw/reference/{scorers/run-experiment.mdx → evals/run-evals.mdx} +17 -18
  278. package/.docs/raw/reference/evals/textual-difference.mdx +149 -117
  279. package/.docs/raw/reference/evals/tone-consistency.mdx +149 -125
  280. package/.docs/raw/reference/{scorers → evals}/tool-call-accuracy.mdx +8 -6
  281. package/.docs/raw/reference/evals/toxicity.mdx +152 -96
  282. package/.docs/raw/reference/{observability/logging → logging}/pino-logger.mdx +2 -2
  283. package/.docs/raw/reference/memory/createThread.mdx +5 -5
  284. package/.docs/raw/reference/memory/deleteMessages.mdx +7 -7
  285. package/.docs/raw/reference/memory/getThreadById.mdx +4 -4
  286. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +110 -0
  287. package/.docs/raw/reference/memory/memory-class.mdx +13 -9
  288. package/.docs/raw/reference/memory/query.mdx +58 -57
  289. package/.docs/raw/reference/memory/recall.mdx +185 -0
  290. package/.docs/raw/reference/observability/tracing/configuration.mdx +245 -0
  291. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/arize.mdx +13 -13
  292. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +11 -8
  293. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx +21 -19
  294. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx +49 -17
  295. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/default-exporter.mdx +42 -41
  296. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +10 -7
  297. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +10 -7
  298. package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/otel.mdx +5 -5
  299. package/.docs/raw/reference/observability/tracing/instances.mdx +168 -0
  300. package/.docs/raw/reference/observability/{ai-tracing → tracing}/interfaces.mdx +115 -89
  301. package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +3 -3
  302. package/.docs/raw/reference/observability/{ai-tracing/span.mdx → tracing/spans.mdx} +59 -41
  303. package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
  304. package/.docs/raw/reference/processors/language-detector.mdx +1 -1
  305. package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
  306. package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
  307. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
  308. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
  309. package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
  310. package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
  311. package/.docs/raw/reference/rag/chunk.mdx +1 -8
  312. package/.docs/raw/reference/rag/database-config.mdx +7 -7
  313. package/.docs/raw/reference/rag/metadata-filters.mdx +14 -11
  314. package/.docs/raw/reference/storage/libsql.mdx +2 -0
  315. package/.docs/raw/reference/storage/mssql.mdx +5 -0
  316. package/.docs/raw/reference/storage/postgresql.mdx +6 -0
  317. package/.docs/raw/reference/storage/upstash.mdx +1 -0
  318. package/.docs/raw/reference/streaming/agents/stream.mdx +12 -12
  319. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +8 -8
  320. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -3
  321. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +3 -3
  322. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +6 -6
  323. package/.docs/raw/reference/streaming/workflows/stream.mdx +10 -10
  324. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +11 -11
  325. package/.docs/raw/reference/templates/overview.mdx +2 -2
  326. package/.docs/raw/reference/tools/create-tool.mdx +52 -35
  327. package/.docs/raw/reference/tools/graph-rag-tool.mdx +15 -15
  328. package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
  329. package/.docs/raw/reference/tools/mcp-server.mdx +119 -35
  330. package/.docs/raw/reference/tools/vector-query-tool.mdx +27 -26
  331. package/.docs/raw/reference/vectors/libsql.mdx +1 -0
  332. package/.docs/raw/reference/vectors/pg.mdx +3 -0
  333. package/.docs/raw/reference/vectors/upstash.mdx +1 -0
  334. package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
  335. package/.docs/raw/reference/voice/voice.addTools.mdx +3 -3
  336. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -4
  337. package/.docs/raw/reference/workflows/run-methods/resume.mdx +14 -14
  338. package/.docs/raw/reference/workflows/run-methods/start.mdx +17 -17
  339. package/.docs/raw/reference/workflows/run.mdx +1 -8
  340. package/.docs/raw/reference/workflows/step.mdx +5 -5
  341. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
  342. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  343. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -13
  344. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
  345. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
  346. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  347. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +5 -0
  348. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  349. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
  350. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
  351. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
  352. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  353. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
  354. package/.docs/raw/reference/workflows/workflow.mdx +1 -1
  355. package/.docs/raw/server-db/custom-api-routes.mdx +2 -2
  356. package/.docs/raw/server-db/mastra-client.mdx +19 -18
  357. package/.docs/raw/server-db/middleware.mdx +7 -7
  358. package/.docs/raw/server-db/production-server.mdx +4 -4
  359. package/.docs/raw/server-db/{runtime-context.mdx → request-context.mdx} +46 -45
  360. package/.docs/raw/server-db/storage.mdx +29 -21
  361. package/.docs/raw/streaming/events.mdx +3 -3
  362. package/.docs/raw/streaming/overview.mdx +5 -5
  363. package/.docs/raw/streaming/tool-streaming.mdx +18 -17
  364. package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
  365. package/.docs/raw/tools-mcp/advanced-usage.mdx +5 -4
  366. package/.docs/raw/tools-mcp/mcp-overview.mdx +32 -19
  367. package/.docs/raw/tools-mcp/overview.mdx +11 -11
  368. package/.docs/raw/voice/overview.mdx +63 -43
  369. package/.docs/raw/voice/speech-to-speech.mdx +5 -3
  370. package/.docs/raw/voice/speech-to-text.mdx +9 -8
  371. package/.docs/raw/voice/text-to-speech.mdx +12 -11
  372. package/.docs/raw/workflows/agents-and-tools.mdx +9 -5
  373. package/.docs/raw/workflows/control-flow.mdx +3 -3
  374. package/.docs/raw/workflows/error-handling.mdx +2 -21
  375. package/.docs/raw/workflows/human-in-the-loop.mdx +7 -4
  376. package/.docs/raw/workflows/inngest-workflow.mdx +2 -2
  377. package/.docs/raw/workflows/input-data-mapping.mdx +107 -0
  378. package/.docs/raw/workflows/overview.mdx +17 -16
  379. package/.docs/raw/workflows/snapshots.mdx +13 -11
  380. package/.docs/raw/workflows/suspend-and-resume.mdx +23 -15
  381. package/CHANGELOG.md +52 -57
  382. package/README.md +11 -2
  383. package/dist/{chunk-TUAHUTTB.js → chunk-5NJC7NRO.js} +3 -0
  384. package/dist/index.d.ts.map +1 -1
  385. package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
  386. package/dist/prepare-docs/prepare.js +1 -1
  387. package/dist/prompts/migration.d.ts +6 -0
  388. package/dist/prompts/migration.d.ts.map +1 -0
  389. package/dist/stdio.js +402 -30
  390. package/dist/tools/migration.d.ts +40 -0
  391. package/dist/tools/migration.d.ts.map +1 -0
  392. package/package.json +8 -12
  393. package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
  394. package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
  395. package/.docs/raw/observability/otel-tracing.mdx +0 -189
  396. package/.docs/raw/reference/agents/getScorers.mdx +0 -69
  397. package/.docs/raw/reference/agents/getTools.mdx +0 -69
  398. package/.docs/raw/reference/agents/getWorkflows.mdx +0 -69
  399. package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
  400. package/.docs/raw/reference/core/getAgents.mdx +0 -35
  401. package/.docs/raw/reference/core/getLogs.mdx +0 -96
  402. package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -87
  403. package/.docs/raw/reference/core/getMCPServers.mdx +0 -36
  404. package/.docs/raw/reference/core/getMemory.mdx +0 -36
  405. package/.docs/raw/reference/core/getScorerByName.mdx +0 -78
  406. package/.docs/raw/reference/core/getScorers.mdx +0 -43
  407. package/.docs/raw/reference/core/getVectors.mdx +0 -36
  408. package/.docs/raw/reference/core/getWorkflows.mdx +0 -45
  409. package/.docs/raw/reference/evals/context-position.mdx +0 -197
  410. package/.docs/raw/reference/evals/context-relevancy.mdx +0 -196
  411. package/.docs/raw/reference/evals/contextual-recall.mdx +0 -196
  412. package/.docs/raw/reference/evals/summarization.mdx +0 -212
  413. package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
  414. package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
  415. package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
  416. package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
  417. package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
  418. package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
  419. package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
  420. package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
  421. package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
  422. package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
  423. package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
  424. package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
  425. package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
  426. package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
  427. package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
  428. package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
  429. package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
  430. package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
  431. package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
  432. package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
  433. package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
  434. package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
  435. package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
  436. package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -79
  437. package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -110
  438. package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -185
  439. package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -238
  440. package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
  441. package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
  442. package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -121
  443. package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
  444. package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
  445. package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -20
  446. package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
  447. package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
  448. package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
  449. package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
  450. package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
  451. package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
  452. package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
  453. package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
  454. package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -227
  455. package/.docs/raw/reference/scorers/bias.mdx +0 -228
  456. package/.docs/raw/reference/scorers/completeness.mdx +0 -214
  457. package/.docs/raw/reference/scorers/content-similarity.mdx +0 -197
  458. package/.docs/raw/reference/scorers/context-precision.mdx +0 -352
  459. package/.docs/raw/reference/scorers/faithfulness.mdx +0 -241
  460. package/.docs/raw/reference/scorers/hallucination.mdx +0 -252
  461. package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -229
  462. package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -668
  463. package/.docs/raw/reference/scorers/textual-difference.mdx +0 -203
  464. package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -211
  465. package/.docs/raw/reference/scorers/toxicity.mdx +0 -228
  466. package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -73
  467. package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -24
  468. package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
  469. package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
  470. package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
  471. package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -50
  472. package/.docs/raw/workflows-legacy/control-flow.mdx +0 -774
  473. package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -239
  474. package/.docs/raw/workflows-legacy/error-handling.mdx +0 -187
  475. package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -360
  476. package/.docs/raw/workflows-legacy/overview.mdx +0 -182
  477. package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -156
  478. package/.docs/raw/workflows-legacy/steps.mdx +0 -115
  479. package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -406
  480. package/.docs/raw/workflows-legacy/variables.mdx +0 -318
@@ -10,7 +10,7 @@ The `.start()` method starts a workflow run with input data, allowing you to exe
10
10
  ## Usage example
11
11
 
12
12
  ```typescript showLineNumbers copy
13
- const run = await workflow.createRunAsync();
13
+ const run = await workflow.createRun();
14
14
 
15
15
  const result = await run.start({
16
16
  inputData: {
@@ -30,9 +30,9 @@ const result = await run.start({
30
30
  isOptional: true,
31
31
  },
32
32
  {
33
- name: "runtimeContext",
34
- type: "RuntimeContext",
35
- description: "Runtime context data to use during workflow execution",
33
+ name: "requestContext",
34
+ type: "RequestContext",
35
+ description: "Request Context data to use during workflow execution",
36
36
  isOptional: true,
37
37
  },
38
38
  {
@@ -46,16 +46,16 @@ const result = await run.start({
46
46
  type: "TracingContext",
47
47
  isOptional: true,
48
48
  description:
49
- "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
49
+ "Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
50
50
  properties: [
51
51
  {
52
52
  parameters: [
53
53
  {
54
54
  name: "currentSpan",
55
- type: "AISpan",
55
+ type: "Span",
56
56
  isOptional: true,
57
57
  description:
58
- "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
58
+ "Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
59
59
  },
60
60
  ],
61
61
  },
@@ -65,7 +65,7 @@ const result = await run.start({
65
65
  name: "tracingOptions",
66
66
  type: "TracingOptions",
67
67
  isOptional: true,
68
- description: "Options for AI tracing configuration.",
68
+ description: "Options for Tracing configuration.",
69
69
  properties: [
70
70
  {
71
71
  parameters: [
@@ -84,7 +84,7 @@ const result = await run.start({
84
84
  name: "outputOptions",
85
85
  type: "OutputOptions",
86
86
  isOptional: true,
87
- description: "Options for AI tracing configuration.",
87
+ description: "Options for output configuration.",
88
88
  properties: [
89
89
  {
90
90
  parameters: [
@@ -117,7 +117,7 @@ const result = await run.start({
117
117
  type: "string",
118
118
  isOptional: true,
119
119
  description:
120
- "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
120
+ "The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.",
121
121
  },
122
122
  ]}
123
123
  />
@@ -125,22 +125,22 @@ const result = await run.start({
125
125
  ## Extended usage example
126
126
 
127
127
  ```typescript showLineNumbers copy
128
- import { RuntimeContext } from "@mastra/core/runtime-context";
128
+ import { RequestContext } from "@mastra/core/request-context";
129
129
 
130
- const run = await workflow.createRunAsync();
130
+ const run = await workflow.createRun();
131
131
 
132
- const runtimeContext = new RuntimeContext();
133
- runtimeContext.set("variable", false);
132
+ const requestContext = new RequestContext();
133
+ requestContext.set("variable", false);
134
134
 
135
135
  const result = await run.start({
136
136
  inputData: {
137
137
  value: "initial data",
138
138
  },
139
- runtimeContext,
139
+ requestContext,
140
140
  });
141
141
  ```
142
142
 
143
143
  ## Related
144
144
 
145
- - [Workflows overview](/docs/workflows/overview#running-workflows)
146
- - [Workflow.createRunAsync()](../workflow-methods/create-run)
145
+ - [Workflows overview](/docs/v1/workflows/overview#running-workflows)
146
+ - [Workflow.createRun()](../workflow-methods/create-run)
@@ -10,7 +10,7 @@ The `Run` class represents a workflow execution instance, providing methods to s
10
10
  ## Usage example
11
11
 
12
12
  ```typescript showLineNumbers copy
13
- const run = await workflow.createRunAsync();
13
+ const run = await workflow.createRun();
14
14
 
15
15
  const result = await run.start({
16
16
  inputData: { value: "initial data" },
@@ -51,12 +51,6 @@ if (result.status === "suspended") {
51
51
  description: "Enables real-time streaming with enhanced features",
52
52
  required: true,
53
53
  },
54
- {
55
- name: "watch",
56
- type: "(callback: WatchCallback, type?: WatchType) => UnwatchFunction",
57
- description: "Monitors workflow execution with callback-based events",
58
- required: true,
59
- },
60
54
  {
61
55
  name: "cancel",
62
56
  type: "() => Promise<void>",
@@ -97,5 +91,4 @@ A workflow run's `status` indicates its current execution state. The possible va
97
91
 
98
92
  - [Run.start()](./run-methods/start)
99
93
  - [Run.resume()](./run-methods/resume)
100
- - [Run.watch()](./run-methods/watch)
101
94
  - [Run.cancel()](./run-methods/cancel)
@@ -136,11 +136,11 @@ const step1 = createStep({
136
136
  description: "Current run id",
137
137
  },
138
138
  {
139
- name: "runtimeContext",
140
- type: "RuntimeContext",
139
+ name: "requestContext",
140
+ type: "RequestContext",
141
141
  isOptional: true,
142
142
  description:
143
- "Runtime Context for dependency injection and contextual information.",
143
+ "Request Context for dependency injection and contextual information.",
144
144
  },
145
145
  {
146
146
  name: "runCount",
@@ -154,5 +154,5 @@ const step1 = createStep({
154
154
 
155
155
  ## Related
156
156
 
157
- - [Control flow](/docs/workflows/control-flow)
158
- - [Using agents and tools](/docs/workflows/agents-and-tools)
157
+ - [Control flow](/docs/v1/workflows/control-flow)
158
+ - [Using agents and tools](/docs/v1/workflows/agents-and-tools)
@@ -44,5 +44,5 @@ workflow.branch([
44
44
 
45
45
  ## Related
46
46
 
47
- - [Conditional Branching Logic](/docs/workflows/control-flow#conditional-logic-with-branch)
48
- - [Conditional Branching Example](/examples/workflows_legacy/conditional-branching)
47
+ - [Conditional Branching Logic](/docs/v1/workflows/control-flow#conditional-logic-with-branch)
48
+ - [Control Flow](/docs/v1/workflows/control-flow)
@@ -27,4 +27,4 @@ workflow.then(step1).commit();
27
27
 
28
28
  ## Related
29
29
 
30
- - [Control Flow](/docs/workflows/control-flow)
30
+ - [Control Flow](/docs/v1/workflows/control-flow)
@@ -1,22 +1,16 @@
1
1
  ---
2
- title: "Reference: Workflow.createRunAsync() | Workflows | Mastra Docs"
3
- description: Documentation for the `Workflow.createRunAsync()` method in workflows, which creates a new workflow run instance.
2
+ title: "Reference: Workflow.createRun() | Workflows | Mastra Docs"
3
+ description: Documentation for the `Workflow.createRun()` method in workflows, which creates a new workflow run instance.
4
4
  ---
5
5
 
6
- # Workflow.createRunAsync()
6
+ # Workflow.createRun()
7
7
 
8
- The `.createRunAsync()` method creates a new workflow run instance, allowing you to execute the workflow with specific input data. This is the current API that returns a `Run` instance.
9
-
10
- :::note
11
-
12
- For the legacy `createRun()` method that returns an object with methods, see the [Legacy Workflows](../../legacyWorkflows/createRun) section.
13
-
14
- :::
8
+ The `.createRun()` method creates a new workflow run instance, allowing you to execute the workflow with specific input data. This is the current API that returns a `Run` instance.
15
9
 
16
10
  ## Usage example
17
11
 
18
12
  ```typescript copy
19
- await workflow.createRunAsync();
13
+ await workflow.createRun();
20
14
  ```
21
15
 
22
16
  ## Parameters
@@ -50,7 +44,7 @@ await workflow.createRunAsync();
50
44
  ```typescript showLineNumbers copy
51
45
  const workflow = mastra.getWorkflow("workflow");
52
46
 
53
- const run = await workflow.createRunAsync();
47
+ const run = await workflow.createRun();
54
48
 
55
49
  const result = await run.start({
56
50
  inputData: {
@@ -62,4 +56,4 @@ const result = await run.start({
62
56
  ## Related
63
57
 
64
58
  - [Run Class](../run)
65
- - [Workflows overview](/docs/workflows/overview)
59
+ - [Workflows overview](/docs/v1/workflows/overview)
@@ -47,6 +47,6 @@ workflow.dountil(step1, async ({ inputData }) => true);
47
47
 
48
48
  ## Related
49
49
 
50
- - [Control Flow](/docs/workflows/control-flow)
50
+ - [Control Flow](/docs/v1/workflows/control-flow)
51
51
 
52
52
  - [ExecuteParams](../step#executeparams)
@@ -47,6 +47,6 @@ workflow.dowhile(step1, async ({ inputData }) => true);
47
47
 
48
48
  ## Related
49
49
 
50
- - [Control Flow](/docs/workflows/control-flow)
50
+ - [Control Flow](/docs/v1/workflows/control-flow)
51
51
 
52
52
  - [ExecuteParams](../step#executeparams)
@@ -57,4 +57,4 @@ workflow.foreach(step1, { concurrency: 2 });
57
57
 
58
58
  ## Related
59
59
 
60
- - [Repeating with foreach](/docs/workflows/control-flow#looping-with-foreach)
60
+ - [Repeating with foreach](/docs/v1/workflows/control-flow#looping-with-foreach)
@@ -80,6 +80,7 @@ Import `mapVariable()` from the workflows module:
80
80
  ```typescript filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
81
81
  import { mapVariable } from "@mastra/core/workflows";
82
82
  ```
83
+
83
84
  ### Extracting fields from step outputs
84
85
 
85
86
  Use `mapVariable()` with `step` to extract a specific field from a step's output and map it to a new field name. The `path` parameter specifies which field to extract.
@@ -112,3 +113,7 @@ testWorkflow
112
113
  })
113
114
  })
114
115
  ```
116
+
117
+ ## Related
118
+
119
+ - [Input Data Mapping](/docs/v1/workflows/control-flow#input-data-mapping)
@@ -40,4 +40,4 @@ workflow.parallel([step1, step2]);
40
40
 
41
41
  ## Related
42
42
 
43
- - [Simultaneous steps with parallel](/docs/workflows/control-flow#simultaneous-steps-with-parallel)
43
+ - [Simultaneous steps with parallel](/docs/v1/workflows/control-flow#simultaneous-steps-with-parallel)
@@ -49,7 +49,7 @@ run.sendEvent("event-name", { value: "data" });
49
49
  ```typescript showLineNumbers copy
50
50
  import { mastra } from "./mastra";
51
51
 
52
- const run = await mastra.getWorkflow("testWorkflow").createRunAsync();
52
+ const run = await mastra.getWorkflow("testWorkflow").createRun();
53
53
 
54
54
  const result = run.start({
55
55
  inputData: {
@@ -67,4 +67,4 @@ setTimeout(() => {
67
67
  ## Related
68
68
 
69
69
  - [.waitForEvent()](./waitForEvent)
70
- - [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)
70
+ - [Suspend & Resume](/docs/v1/workflows/suspend-and-resume#sleep--events)
@@ -59,4 +59,4 @@ export const testWorkflow = createWorkflow({...})
59
59
 
60
60
  ## Related
61
61
 
62
- - [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)
62
+ - [Suspend & Resume](/docs/v1/workflows/suspend-and-resume#sleep--events)
@@ -59,4 +59,4 @@ export const testWorkflow = createWorkflow({...})
59
59
 
60
60
  ## Related
61
61
 
62
- - [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)
62
+ - [Suspend & Resume](/docs/v1/workflows/suspend-and-resume#sleep--events)
@@ -41,4 +41,4 @@ workflow.then(step1).then(step2);
41
41
 
42
42
  ## Related
43
43
 
44
- - [Control flow](/docs/workflows/control-flow)
44
+ - [Control flow](/docs/v1/workflows/control-flow)
@@ -63,4 +63,4 @@ export const testWorkflow = createWorkflow({...})
63
63
  ## Related
64
64
 
65
65
  - [.sendEvent()](./sendEvent)
66
- - [Suspend & Resume](/docs/workflows/suspend-and-resume#sleep--events)
66
+ - [Suspend & Resume](/docs/v1/workflows/suspend-and-resume#sleep--events)
@@ -118,4 +118,4 @@ A workflow's `status` indicates its current execution state. The possible values
118
118
  ## Related
119
119
 
120
120
  - [Step Class](./step)
121
- - [Control flow](/docs/workflows/control-flow)
121
+ - [Control flow](/docs/v1/workflows/control-flow)
@@ -10,7 +10,7 @@ By default Mastra automatically exposes registered agents and workflows via the
10
10
  Routes are provided with a helper `registerApiRoute` from `@mastra/core/server`. Routes can live in the same file as the `Mastra` instance but separating them helps keep configuration concise.
11
11
 
12
12
  ```typescript title="src/mastra/index.ts" copy showLineNumbers
13
- import { Mastra } from "@mastra/core/mastra";
13
+ import { Mastra } from "@mastra/core";
14
14
  import { registerApiRoute } from "@mastra/core/server";
15
15
 
16
16
  export const mastra = new Mastra({
@@ -42,7 +42,7 @@ Each route's handler receives the Hono `Context`. Within the handler you can acc
42
42
  To add route-specific middleware pass a `middleware` array when calling `registerApiRoute`.
43
43
 
44
44
  ```typescript title="src/mastra/index.ts" copy showLineNumbers
45
- import { Mastra } from "@mastra/core/mastra";
45
+ import { Mastra } from "@mastra/core";
46
46
  import { registerApiRoute } from "@mastra/core/server";
47
47
 
48
48
  export const mastra = new Mastra({
@@ -8,13 +8,13 @@ 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/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/production-server) from your client environment.
12
12
 
13
13
  ## Prerequisites
14
14
 
15
15
  To ensure smooth local development, make sure you have:
16
16
 
17
- - Node.js `v18` or higher
17
+ - Node.js `v22.13.0` or later
18
18
  - TypeScript `v4.7` or higher (if using TypeScript)
19
19
  - Your local Mastra server running (typically on port `4111`)
20
20
 
@@ -73,13 +73,13 @@ export const mastraClient = new MastraClient({
73
73
 
74
74
  The Mastra Client SDK exposes all resources served by the Mastra Server
75
75
 
76
- - **[Agents](/reference/client-js/agents)**: Generate responses and stream conversations.
77
- - **[Memory](/reference/client-js/memory)**: Manage conversation threads and message history.
78
- - **[Tools](/reference/client-js/tools)**: Executed and managed tools.
79
- - **[Workflows](/reference/client-js/workflows)**: Trigger workflows and track their execution.
80
- - **[Vectors](/reference/client-js/vectors)**: Use vector embeddings for semantic search.
81
- - **[Logs](/reference/client-js/logs)**: View logs and debug system behavior.
82
- - **[Telemetry](/reference/client-js/telemetry)**: Monitor app performance and trace activity.
76
+ - **[Agents](/reference/v1/client-js/agents)**: Generate responses and stream conversations.
77
+ - **[Memory](/reference/v1/client-js/memory)**: Manage conversation threads and message history.
78
+ - **[Tools](/reference/v1/client-js/tools)**: Executed and managed tools.
79
+ - **[Workflows](/reference/v1/client-js/workflows)**: Trigger workflows and track their execution.
80
+ - **[Vectors](/reference/v1/client-js/vectors)**: Use vector embeddings for semantic search.
81
+ - **[Logs](/reference/v1/client-js/logs)**: View logs and debug system behavior.
82
+ - **[Telemetry](/reference/v1/client-js/telemetry)**: Monitor app performance and trace activity.
83
83
 
84
84
  ## Generating responses
85
85
 
@@ -108,7 +108,7 @@ const testAgent = async () => {
108
108
  };
109
109
  ```
110
110
 
111
- > See [.generate()](/reference/client-js/agents#generate-response) for more information.
111
+ > See [.generate()](/reference/v1/client-js/agents#generate-response) for more information.
112
112
 
113
113
  ## Streaming responses
114
114
 
@@ -141,7 +141,7 @@ const testAgent = async () => {
141
141
  };
142
142
  ```
143
143
 
144
- > See [.stream()](/reference/client-js/agents#stream-response) for more information.
144
+ > See [.stream()](/reference/v1/client-js/agents#stream-response) for more information.
145
145
 
146
146
  ## Configuration options
147
147
 
@@ -161,7 +161,7 @@ export const mastraClient = new MastraClient({
161
161
  });
162
162
  ```
163
163
 
164
- > See [MastraClient](/reference/client-js/mastra-client) for more configuration options.
164
+ > See [MastraClient](/reference/v1/client-js/mastra-client) for more configuration options.
165
165
 
166
166
  ## Adding request cancelling
167
167
 
@@ -215,8 +215,8 @@ const handleClientTool = async () => {
215
215
  outputSchema: z.object({
216
216
  success: z.boolean(),
217
217
  }),
218
- execute: async ({ context }) => {
219
- const { color } = context;
218
+ execute: async (inputData) => {
219
+ const { color } = inputData;
220
220
 
221
221
  document.body.style.backgroundColor = color;
222
222
  return { success: true };
@@ -244,7 +244,8 @@ import { openai } from "@ai-sdk/openai";
244
244
  import { Agent } from "@mastra/core/agent";
245
245
 
246
246
  export const colorAgent = new Agent({
247
- name: "test-agent",
247
+ id: "color-agent",
248
+ name: "Color Agent",
248
249
  instructions: `You are a helpful CSS assistant.
249
250
  You can change the background color of web pages.
250
251
  Respond with a hex reference for the color requested by the user`,
@@ -270,7 +271,7 @@ export async function action() {
270
271
 
271
272
  ## Best practices
272
273
 
273
- 1. **Error Handling**: Implement proper [error handling](/reference/client-js/error-handling) for development scenarios.
274
+ 1. **Error Handling**: Implement proper [error handling](/reference/v1/client-js/error-handling) for development scenarios.
274
275
  2. **Environment Variables**: Use environment variables for configuration.
275
- 3. **Debugging**: Enable detailed [logging](/reference/client-js/logs) when needed.
276
- 4. **Performance**: Monitor application performance, [telemetry](/reference/client-js/telemetry) and traces.
276
+ 3. **Debugging**: Enable detailed [logging](/reference/v1/client-js/logs) when needed.
277
+ 4. **Performance**: Monitor application performance, [telemetry](/reference/v1/client-js/telemetry) and traces.
@@ -143,13 +143,13 @@ be inspected by middleware to tailor behavior:
143
143
  - `x-mastra-client-type`: identifies the client SDK, e.g. `js` or `python`
144
144
  - `x-studio`: request triggered from Studio
145
145
 
146
- ### Setting `runtimeContext`
146
+ ### Setting `requestContext`
147
147
 
148
- You can populate `runtimeContext` 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.
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
149
 
150
150
  ```typescript title="src/mastra/index.ts" showLineNumbers copy
151
- import { Mastra } from "@mastra/core/mastra";
152
- import { RuntimeContext } from "@mastra/core/runtime-context";
151
+ import { Mastra } from "@mastra/core";
152
+ import { RequestContext } from "@mastra/core/request-context";
153
153
  import { testWeatherAgent } from "./agents/test-weather-agent";
154
154
 
155
155
  export const mastra = new Mastra({
@@ -158,9 +158,9 @@ export const mastra = new Mastra({
158
158
  middleware: [
159
159
  async (context, next) => {
160
160
  const country = context.req.header("CF-IPCountry");
161
- const runtimeContext = context.get("runtimeContext");
161
+ const requestContext = context.get("requestContext");
162
162
 
163
- runtimeContext.set(
163
+ requestContext.set(
164
164
  "temperature-unit",
165
165
  country === "US" ? "fahrenheit" : "celsius",
166
166
  );
@@ -174,4 +174,4 @@ export const mastra = new Mastra({
174
174
 
175
175
  # Related
176
176
 
177
- - [Runtime Context](./runtime-context)
177
+ - [Request Context](./request-context)
@@ -21,8 +21,8 @@ The server provides:
21
21
  - Configuration of port
22
22
  - Configuration of body limit
23
23
 
24
- See the [Middleware](/docs/server-db/middleware) and
25
- [Custom API Routes](/docs/server-db/custom-api-routes) pages for details on
24
+ See the [Middleware](/docs/v1/server-db/middleware) and
25
+ [Custom API Routes](/docs/v1/server-db/custom-api-routes) pages for details on
26
26
  adding additional server behaviour.
27
27
 
28
28
  ## Server configuration
@@ -30,7 +30,7 @@ adding additional server behaviour.
30
30
  You can configure server `port` and `timeout` in the Mastra instance.
31
31
 
32
32
  ```typescript title="src/mastra/index.ts" copy showLineNumbers
33
- import { Mastra } from "@mastra/core/mastra";
33
+ import { Mastra } from "@mastra/core";
34
34
 
35
35
  export const mastra = new Mastra({
36
36
  // ...
@@ -73,7 +73,7 @@ Mastra requires `module` and `moduleResolution` values that support modern Node.
73
73
  Mastra allows you to configure CORS (Cross-Origin Resource Sharing) settings for your server.
74
74
 
75
75
  ```typescript title="src/mastra/index.ts" copy showLineNumbers
76
- import { Mastra } from "@mastra/core/mastra";
76
+ import { Mastra } from "@mastra/core";
77
77
 
78
78
  export const mastra = new Mastra({
79
79
  // ...