@mastra/mcp-docs-server 1.1.5 → 1.1.6-alpha.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 (556) hide show
  1. package/.docs/docs/agents/adding-voice.md +349 -0
  2. package/.docs/docs/agents/agent-approval.md +558 -0
  3. package/.docs/docs/agents/agent-memory.md +209 -0
  4. package/.docs/docs/agents/guardrails.md +374 -0
  5. package/.docs/docs/agents/network-approval.md +275 -0
  6. package/.docs/docs/agents/networks.md +299 -0
  7. package/.docs/docs/agents/overview.md +304 -0
  8. package/.docs/docs/agents/processors.md +622 -0
  9. package/.docs/docs/agents/structured-output.md +273 -0
  10. package/.docs/docs/agents/supervisor-agents.md +304 -0
  11. package/.docs/docs/agents/using-tools.md +214 -0
  12. package/.docs/docs/build-with-ai/mcp-docs-server.md +238 -0
  13. package/.docs/docs/build-with-ai/skills.md +35 -0
  14. package/.docs/docs/community/contributing-templates.md +3 -0
  15. package/.docs/docs/community/discord.md +9 -0
  16. package/.docs/docs/community/licensing.md +66 -0
  17. package/.docs/docs/deployment/cloud-providers.md +15 -0
  18. package/.docs/docs/deployment/mastra-server.md +122 -0
  19. package/.docs/docs/deployment/monorepo.md +142 -0
  20. package/.docs/docs/deployment/overview.md +62 -0
  21. package/.docs/docs/deployment/studio.md +239 -0
  22. package/.docs/docs/deployment/web-framework.md +52 -0
  23. package/.docs/docs/deployment/workflow-runners.md +9 -0
  24. package/.docs/docs/evals/built-in-scorers.md +47 -0
  25. package/.docs/docs/evals/custom-scorers.md +519 -0
  26. package/.docs/docs/evals/overview.md +141 -0
  27. package/.docs/docs/evals/running-in-ci.md +124 -0
  28. package/.docs/docs/getting-started/build-with-ai.md +68 -0
  29. package/.docs/docs/getting-started/manual-install.md +226 -0
  30. package/.docs/docs/getting-started/project-structure.md +60 -0
  31. package/.docs/docs/getting-started/start.md +28 -0
  32. package/.docs/docs/getting-started/studio.md +101 -0
  33. package/.docs/docs/index.md +43 -0
  34. package/.docs/docs/mastra-cloud/deployment.md +77 -0
  35. package/.docs/docs/mastra-cloud/observability.md +38 -0
  36. package/.docs/docs/mastra-cloud/overview.md +23 -0
  37. package/.docs/docs/mastra-cloud/setup.md +42 -0
  38. package/.docs/docs/mastra-cloud/studio.md +24 -0
  39. package/.docs/docs/mastra-code/configuration.md +299 -0
  40. package/.docs/docs/mastra-code/customization.md +228 -0
  41. package/.docs/docs/mastra-code/modes.md +104 -0
  42. package/.docs/docs/mastra-code/overview.md +135 -0
  43. package/.docs/docs/mastra-code/tools.md +229 -0
  44. package/.docs/docs/mcp/overview.md +373 -0
  45. package/.docs/docs/mcp/publishing-mcp-server.md +95 -0
  46. package/.docs/docs/memory/memory-processors.md +314 -0
  47. package/.docs/docs/memory/message-history.md +260 -0
  48. package/.docs/docs/memory/observational-memory.md +248 -0
  49. package/.docs/docs/memory/overview.md +45 -0
  50. package/.docs/docs/memory/semantic-recall.md +272 -0
  51. package/.docs/docs/memory/storage.md +261 -0
  52. package/.docs/docs/memory/working-memory.md +400 -0
  53. package/.docs/docs/observability/datasets/overview.md +198 -0
  54. package/.docs/docs/observability/datasets/running-experiments.md +274 -0
  55. package/.docs/docs/observability/logging.md +99 -0
  56. package/.docs/docs/observability/overview.md +70 -0
  57. package/.docs/docs/observability/tracing/bridges/otel.md +209 -0
  58. package/.docs/docs/observability/tracing/exporters/arize.md +272 -0
  59. package/.docs/docs/observability/tracing/exporters/braintrust.md +111 -0
  60. package/.docs/docs/observability/tracing/exporters/cloud.md +127 -0
  61. package/.docs/docs/observability/tracing/exporters/datadog.md +187 -0
  62. package/.docs/docs/observability/tracing/exporters/default.md +209 -0
  63. package/.docs/docs/observability/tracing/exporters/laminar.md +100 -0
  64. package/.docs/docs/observability/tracing/exporters/langfuse.md +213 -0
  65. package/.docs/docs/observability/tracing/exporters/langsmith.md +198 -0
  66. package/.docs/docs/observability/tracing/exporters/otel.md +476 -0
  67. package/.docs/docs/observability/tracing/exporters/posthog.md +148 -0
  68. package/.docs/docs/observability/tracing/exporters/sentry.md +208 -0
  69. package/.docs/docs/observability/tracing/overview.md +1112 -0
  70. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +300 -0
  71. package/.docs/docs/rag/chunking-and-embedding.md +183 -0
  72. package/.docs/docs/rag/graph-rag.md +215 -0
  73. package/.docs/docs/rag/overview.md +72 -0
  74. package/.docs/docs/rag/retrieval.md +515 -0
  75. package/.docs/docs/rag/vector-databases.md +645 -0
  76. package/.docs/docs/server/auth/auth0.md +220 -0
  77. package/.docs/docs/server/auth/better-auth.md +203 -0
  78. package/.docs/docs/server/auth/clerk.md +132 -0
  79. package/.docs/docs/server/auth/composite-auth.md +234 -0
  80. package/.docs/docs/server/auth/custom-auth-provider.md +513 -0
  81. package/.docs/docs/server/auth/firebase.md +272 -0
  82. package/.docs/docs/server/auth/jwt.md +110 -0
  83. package/.docs/docs/server/auth/simple-auth.md +180 -0
  84. package/.docs/docs/server/auth/supabase.md +117 -0
  85. package/.docs/docs/server/auth/workos.md +186 -0
  86. package/.docs/docs/server/auth.md +38 -0
  87. package/.docs/docs/server/custom-adapters.md +378 -0
  88. package/.docs/docs/server/custom-api-routes.md +267 -0
  89. package/.docs/docs/server/mastra-client.md +243 -0
  90. package/.docs/docs/server/mastra-server.md +71 -0
  91. package/.docs/docs/server/middleware.md +225 -0
  92. package/.docs/docs/server/request-context.md +471 -0
  93. package/.docs/docs/server/server-adapters.md +547 -0
  94. package/.docs/docs/streaming/events.md +237 -0
  95. package/.docs/docs/streaming/overview.md +175 -0
  96. package/.docs/docs/streaming/tool-streaming.md +175 -0
  97. package/.docs/docs/streaming/workflow-streaming.md +109 -0
  98. package/.docs/docs/voice/overview.md +959 -0
  99. package/.docs/docs/voice/speech-to-speech.md +102 -0
  100. package/.docs/docs/voice/speech-to-text.md +79 -0
  101. package/.docs/docs/voice/text-to-speech.md +83 -0
  102. package/.docs/docs/workflows/agents-and-tools.md +166 -0
  103. package/.docs/docs/workflows/control-flow.md +822 -0
  104. package/.docs/docs/workflows/error-handling.md +360 -0
  105. package/.docs/docs/workflows/human-in-the-loop.md +215 -0
  106. package/.docs/docs/workflows/overview.md +370 -0
  107. package/.docs/docs/workflows/snapshots.md +238 -0
  108. package/.docs/docs/workflows/suspend-and-resume.md +205 -0
  109. package/.docs/docs/workflows/time-travel.md +309 -0
  110. package/.docs/docs/workflows/workflow-state.md +181 -0
  111. package/.docs/docs/workspace/filesystem.md +164 -0
  112. package/.docs/docs/workspace/overview.md +239 -0
  113. package/.docs/docs/workspace/sandbox.md +63 -0
  114. package/.docs/docs/workspace/search.md +243 -0
  115. package/.docs/docs/workspace/skills.md +169 -0
  116. package/.docs/guides/agent-frameworks/ai-sdk.md +140 -0
  117. package/.docs/guides/build-your-ui/ai-sdk-ui.md +1499 -0
  118. package/.docs/guides/build-your-ui/assistant-ui.md +156 -0
  119. package/.docs/guides/build-your-ui/copilotkit.md +289 -0
  120. package/.docs/guides/deployment/amazon-ec2.md +130 -0
  121. package/.docs/guides/deployment/aws-lambda.md +248 -0
  122. package/.docs/guides/deployment/azure-app-services.md +114 -0
  123. package/.docs/guides/deployment/cloudflare.md +99 -0
  124. package/.docs/guides/deployment/digital-ocean.md +168 -0
  125. package/.docs/guides/deployment/inngest.md +682 -0
  126. package/.docs/guides/deployment/netlify.md +77 -0
  127. package/.docs/guides/deployment/vercel.md +101 -0
  128. package/.docs/guides/getting-started/astro.md +398 -0
  129. package/.docs/guides/getting-started/electron.md +504 -0
  130. package/.docs/guides/getting-started/express.md +251 -0
  131. package/.docs/guides/getting-started/hono.md +190 -0
  132. package/.docs/guides/getting-started/next-js.md +347 -0
  133. package/.docs/guides/getting-started/nuxt.md +497 -0
  134. package/.docs/guides/getting-started/quickstart.md +67 -0
  135. package/.docs/guides/getting-started/sveltekit.md +296 -0
  136. package/.docs/guides/getting-started/vite-react.md +425 -0
  137. package/.docs/guides/guide/ai-recruiter.md +226 -0
  138. package/.docs/guides/guide/chef-michel.md +211 -0
  139. package/.docs/guides/guide/code-review-bot.md +226 -0
  140. package/.docs/guides/guide/dev-assistant.md +307 -0
  141. package/.docs/guides/guide/docs-manager.md +238 -0
  142. package/.docs/guides/guide/github-actions-pr-description.md +236 -0
  143. package/.docs/guides/guide/notes-mcp-server.md +416 -0
  144. package/.docs/guides/guide/research-assistant.md +348 -0
  145. package/.docs/guides/guide/research-coordinator.md +416 -0
  146. package/.docs/guides/guide/stock-agent.md +132 -0
  147. package/.docs/guides/guide/web-search.md +320 -0
  148. package/.docs/guides/guide/whatsapp-chat-bot.md +405 -0
  149. package/.docs/guides/index.md +3 -0
  150. package/.docs/guides/migrations/agentnetwork.md +97 -0
  151. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +112 -0
  152. package/.docs/guides/migrations/network-to-supervisor.md +261 -0
  153. package/.docs/guides/migrations/upgrade-to-v1/agent.md +404 -0
  154. package/.docs/guides/migrations/upgrade-to-v1/cli.md +57 -0
  155. package/.docs/guides/migrations/upgrade-to-v1/client.md +337 -0
  156. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +37 -0
  157. package/.docs/guides/migrations/upgrade-to-v1/evals.md +239 -0
  158. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +143 -0
  159. package/.docs/guides/migrations/upgrade-to-v1/mcp.md +97 -0
  160. package/.docs/guides/migrations/upgrade-to-v1/memory.md +285 -0
  161. package/.docs/guides/migrations/upgrade-to-v1/overview.md +119 -0
  162. package/.docs/guides/migrations/upgrade-to-v1/processors.md +68 -0
  163. package/.docs/guides/migrations/upgrade-to-v1/rag.md +42 -0
  164. package/.docs/guides/migrations/upgrade-to-v1/storage.md +553 -0
  165. package/.docs/guides/migrations/upgrade-to-v1/tools.md +180 -0
  166. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +412 -0
  167. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +87 -0
  168. package/.docs/guides/migrations/upgrade-to-v1/voice.md +30 -0
  169. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +341 -0
  170. package/.docs/guides/migrations/vnext-to-standard-apis.md +362 -0
  171. package/.docs/models/embeddings.md +161 -0
  172. package/.docs/models/gateways/azure-openai.md +128 -0
  173. package/.docs/models/gateways/custom-gateways.md +545 -0
  174. package/.docs/models/gateways/netlify.md +88 -0
  175. package/.docs/models/gateways/openrouter.md +219 -0
  176. package/.docs/models/gateways/vercel.md +225 -0
  177. package/.docs/models/gateways.md +14 -0
  178. package/.docs/models/index.md +286 -0
  179. package/.docs/models/providers/302ai.md +134 -0
  180. package/.docs/models/providers/abacus.md +125 -0
  181. package/.docs/models/providers/agentrouter.md +90 -0
  182. package/.docs/models/providers/aihubmix.md +107 -0
  183. package/.docs/models/providers/alibaba-cn.md +135 -0
  184. package/.docs/models/providers/alibaba.md +111 -0
  185. package/.docs/models/providers/amazon-bedrock.md +33 -0
  186. package/.docs/models/providers/anthropic.md +153 -0
  187. package/.docs/models/providers/azure.md +33 -0
  188. package/.docs/models/providers/bailing.md +72 -0
  189. package/.docs/models/providers/baseten.md +77 -0
  190. package/.docs/models/providers/berget.md +78 -0
  191. package/.docs/models/providers/cerebras.md +101 -0
  192. package/.docs/models/providers/chutes.md +136 -0
  193. package/.docs/models/providers/cloudflare-ai-gateway.md +33 -0
  194. package/.docs/models/providers/cloudflare-workers-ai.md +109 -0
  195. package/.docs/models/providers/cohere.md +33 -0
  196. package/.docs/models/providers/cortecs.md +91 -0
  197. package/.docs/models/providers/deepinfra.md +112 -0
  198. package/.docs/models/providers/deepseek.md +88 -0
  199. package/.docs/models/providers/fastrouter.md +84 -0
  200. package/.docs/models/providers/fireworks-ai.md +89 -0
  201. package/.docs/models/providers/firmware.md +85 -0
  202. package/.docs/models/providers/friendli.md +78 -0
  203. package/.docs/models/providers/github-models.md +125 -0
  204. package/.docs/models/providers/google-vertex.md +33 -0
  205. package/.docs/models/providers/google.md +159 -0
  206. package/.docs/models/providers/groq.md +107 -0
  207. package/.docs/models/providers/helicone.md +161 -0
  208. package/.docs/models/providers/huggingface.md +90 -0
  209. package/.docs/models/providers/iflowcn.md +84 -0
  210. package/.docs/models/providers/inception.md +72 -0
  211. package/.docs/models/providers/inference.md +79 -0
  212. package/.docs/models/providers/io-intelligence.md +87 -0
  213. package/.docs/models/providers/io-net.md +87 -0
  214. package/.docs/models/providers/jiekou.md +131 -0
  215. package/.docs/models/providers/kilo.md +333 -0
  216. package/.docs/models/providers/kimi-for-coding.md +100 -0
  217. package/.docs/models/providers/kuae-cloud-coding-plan.md +71 -0
  218. package/.docs/models/providers/llama.md +77 -0
  219. package/.docs/models/providers/lmstudio.md +73 -0
  220. package/.docs/models/providers/lucidquery.md +72 -0
  221. package/.docs/models/providers/minimax-cn-coding-plan.md +102 -0
  222. package/.docs/models/providers/minimax-cn.md +102 -0
  223. package/.docs/models/providers/minimax-coding-plan.md +102 -0
  224. package/.docs/models/providers/minimax.md +104 -0
  225. package/.docs/models/providers/mistral.md +124 -0
  226. package/.docs/models/providers/moark.md +72 -0
  227. package/.docs/models/providers/modelscope.md +77 -0
  228. package/.docs/models/providers/moonshotai-cn.md +76 -0
  229. package/.docs/models/providers/moonshotai.md +76 -0
  230. package/.docs/models/providers/morph.md +73 -0
  231. package/.docs/models/providers/nano-gpt.md +103 -0
  232. package/.docs/models/providers/nebius.md +116 -0
  233. package/.docs/models/providers/nova.md +72 -0
  234. package/.docs/models/providers/novita-ai.md +154 -0
  235. package/.docs/models/providers/nvidia.md +141 -0
  236. package/.docs/models/providers/ollama-cloud.md +103 -0
  237. package/.docs/models/providers/ollama.md +33 -0
  238. package/.docs/models/providers/openai.md +193 -0
  239. package/.docs/models/providers/opencode.md +100 -0
  240. package/.docs/models/providers/ovhcloud.md +83 -0
  241. package/.docs/models/providers/perplexity.md +100 -0
  242. package/.docs/models/providers/poe.md +183 -0
  243. package/.docs/models/providers/privatemode-ai.md +75 -0
  244. package/.docs/models/providers/requesty.md +90 -0
  245. package/.docs/models/providers/scaleway.md +84 -0
  246. package/.docs/models/providers/siliconflow-cn.md +138 -0
  247. package/.docs/models/providers/siliconflow.md +140 -0
  248. package/.docs/models/providers/stackit.md +78 -0
  249. package/.docs/models/providers/stepfun.md +73 -0
  250. package/.docs/models/providers/submodel.md +79 -0
  251. package/.docs/models/providers/synthetic.md +96 -0
  252. package/.docs/models/providers/togetherai.md +115 -0
  253. package/.docs/models/providers/upstage.md +73 -0
  254. package/.docs/models/providers/venice.md +95 -0
  255. package/.docs/models/providers/vivgrid.md +106 -0
  256. package/.docs/models/providers/vultr.md +75 -0
  257. package/.docs/models/providers/wandb.md +80 -0
  258. package/.docs/models/providers/xai.md +141 -0
  259. package/.docs/models/providers/xiaomi.md +71 -0
  260. package/.docs/models/providers/zai-coding-plan.md +80 -0
  261. package/.docs/models/providers/zai.md +79 -0
  262. package/.docs/models/providers/zenmux.md +161 -0
  263. package/.docs/models/providers/zhipuai-coding-plan.md +79 -0
  264. package/.docs/models/providers/zhipuai.md +79 -0
  265. package/.docs/models/providers.md +81 -0
  266. package/.docs/reference/agents/agent.md +141 -0
  267. package/.docs/reference/agents/generate.md +186 -0
  268. package/.docs/reference/agents/generateLegacy.md +173 -0
  269. package/.docs/reference/agents/getDefaultGenerateOptions.md +36 -0
  270. package/.docs/reference/agents/getDefaultOptions.md +34 -0
  271. package/.docs/reference/agents/getDefaultStreamOptions.md +36 -0
  272. package/.docs/reference/agents/getDescription.md +21 -0
  273. package/.docs/reference/agents/getInstructions.md +34 -0
  274. package/.docs/reference/agents/getLLM.md +37 -0
  275. package/.docs/reference/agents/getMemory.md +34 -0
  276. package/.docs/reference/agents/getModel.md +34 -0
  277. package/.docs/reference/agents/getTools.md +29 -0
  278. package/.docs/reference/agents/getVoice.md +34 -0
  279. package/.docs/reference/agents/listAgents.md +35 -0
  280. package/.docs/reference/agents/listScorers.md +34 -0
  281. package/.docs/reference/agents/listTools.md +34 -0
  282. package/.docs/reference/agents/listWorkflows.md +34 -0
  283. package/.docs/reference/agents/network.md +133 -0
  284. package/.docs/reference/ai-sdk/chat-route.md +82 -0
  285. package/.docs/reference/ai-sdk/handle-chat-stream.md +53 -0
  286. package/.docs/reference/ai-sdk/handle-network-stream.md +37 -0
  287. package/.docs/reference/ai-sdk/handle-workflow-stream.md +55 -0
  288. package/.docs/reference/ai-sdk/network-route.md +74 -0
  289. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +231 -0
  290. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +79 -0
  291. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +76 -0
  292. package/.docs/reference/ai-sdk/with-mastra.md +59 -0
  293. package/.docs/reference/ai-sdk/workflow-route.md +79 -0
  294. package/.docs/reference/auth/auth0.md +73 -0
  295. package/.docs/reference/auth/better-auth.md +71 -0
  296. package/.docs/reference/auth/clerk.md +36 -0
  297. package/.docs/reference/auth/firebase.md +80 -0
  298. package/.docs/reference/auth/jwt.md +26 -0
  299. package/.docs/reference/auth/supabase.md +33 -0
  300. package/.docs/reference/auth/workos.md +84 -0
  301. package/.docs/reference/cli/create-mastra.md +137 -0
  302. package/.docs/reference/cli/mastra.md +336 -0
  303. package/.docs/reference/client-js/agents.md +437 -0
  304. package/.docs/reference/client-js/error-handling.md +16 -0
  305. package/.docs/reference/client-js/logs.md +24 -0
  306. package/.docs/reference/client-js/mastra-client.md +63 -0
  307. package/.docs/reference/client-js/memory.md +221 -0
  308. package/.docs/reference/client-js/observability.md +72 -0
  309. package/.docs/reference/client-js/telemetry.md +20 -0
  310. package/.docs/reference/client-js/tools.md +44 -0
  311. package/.docs/reference/client-js/vectors.md +79 -0
  312. package/.docs/reference/client-js/workflows.md +199 -0
  313. package/.docs/reference/configuration.md +752 -0
  314. package/.docs/reference/core/addGateway.md +42 -0
  315. package/.docs/reference/core/getAgent.md +21 -0
  316. package/.docs/reference/core/getAgentById.md +21 -0
  317. package/.docs/reference/core/getDeployer.md +22 -0
  318. package/.docs/reference/core/getGateway.md +38 -0
  319. package/.docs/reference/core/getGatewayById.md +41 -0
  320. package/.docs/reference/core/getLogger.md +22 -0
  321. package/.docs/reference/core/getMCPServer.md +47 -0
  322. package/.docs/reference/core/getMCPServerById.md +55 -0
  323. package/.docs/reference/core/getMemory.md +50 -0
  324. package/.docs/reference/core/getScorer.md +54 -0
  325. package/.docs/reference/core/getScorerById.md +54 -0
  326. package/.docs/reference/core/getServer.md +22 -0
  327. package/.docs/reference/core/getStorage.md +22 -0
  328. package/.docs/reference/core/getStoredAgentById.md +89 -0
  329. package/.docs/reference/core/getTelemetry.md +22 -0
  330. package/.docs/reference/core/getVector.md +22 -0
  331. package/.docs/reference/core/getWorkflow.md +42 -0
  332. package/.docs/reference/core/listAgents.md +21 -0
  333. package/.docs/reference/core/listGateways.md +40 -0
  334. package/.docs/reference/core/listLogs.md +38 -0
  335. package/.docs/reference/core/listLogsByRunId.md +36 -0
  336. package/.docs/reference/core/listMCPServers.md +55 -0
  337. package/.docs/reference/core/listMemory.md +56 -0
  338. package/.docs/reference/core/listScorers.md +29 -0
  339. package/.docs/reference/core/listStoredAgents.md +93 -0
  340. package/.docs/reference/core/listVectors.md +22 -0
  341. package/.docs/reference/core/listWorkflows.md +21 -0
  342. package/.docs/reference/core/mastra-class.md +66 -0
  343. package/.docs/reference/core/mastra-model-gateway.md +153 -0
  344. package/.docs/reference/core/setLogger.md +26 -0
  345. package/.docs/reference/core/setStorage.md +27 -0
  346. package/.docs/reference/datasets/addItem.md +37 -0
  347. package/.docs/reference/datasets/addItems.md +35 -0
  348. package/.docs/reference/datasets/compareExperiments.md +52 -0
  349. package/.docs/reference/datasets/create.md +51 -0
  350. package/.docs/reference/datasets/dataset.md +82 -0
  351. package/.docs/reference/datasets/datasets-manager.md +94 -0
  352. package/.docs/reference/datasets/delete.md +25 -0
  353. package/.docs/reference/datasets/deleteExperiment.md +27 -0
  354. package/.docs/reference/datasets/deleteItem.md +27 -0
  355. package/.docs/reference/datasets/deleteItems.md +29 -0
  356. package/.docs/reference/datasets/get.md +31 -0
  357. package/.docs/reference/datasets/getDetails.md +47 -0
  358. package/.docs/reference/datasets/getExperiment.md +30 -0
  359. package/.docs/reference/datasets/getItem.md +33 -0
  360. package/.docs/reference/datasets/getItemHistory.md +31 -0
  361. package/.docs/reference/datasets/list.md +31 -0
  362. package/.docs/reference/datasets/listExperimentResults.md +39 -0
  363. package/.docs/reference/datasets/listExperiments.md +33 -0
  364. package/.docs/reference/datasets/listItems.md +46 -0
  365. package/.docs/reference/datasets/listVersions.md +33 -0
  366. package/.docs/reference/datasets/startExperiment.md +62 -0
  367. package/.docs/reference/datasets/startExperimentAsync.md +43 -0
  368. package/.docs/reference/datasets/update.md +48 -0
  369. package/.docs/reference/datasets/updateItem.md +38 -0
  370. package/.docs/reference/deployer/cloudflare.md +79 -0
  371. package/.docs/reference/deployer/netlify.md +80 -0
  372. package/.docs/reference/deployer/vercel.md +91 -0
  373. package/.docs/reference/deployer.md +100 -0
  374. package/.docs/reference/evals/answer-relevancy.md +105 -0
  375. package/.docs/reference/evals/answer-similarity.md +99 -0
  376. package/.docs/reference/evals/bias.md +120 -0
  377. package/.docs/reference/evals/completeness.md +136 -0
  378. package/.docs/reference/evals/content-similarity.md +101 -0
  379. package/.docs/reference/evals/context-precision.md +196 -0
  380. package/.docs/reference/evals/context-relevance.md +531 -0
  381. package/.docs/reference/evals/create-scorer.md +270 -0
  382. package/.docs/reference/evals/faithfulness.md +114 -0
  383. package/.docs/reference/evals/hallucination.md +213 -0
  384. package/.docs/reference/evals/keyword-coverage.md +128 -0
  385. package/.docs/reference/evals/mastra-scorer.md +123 -0
  386. package/.docs/reference/evals/noise-sensitivity.md +675 -0
  387. package/.docs/reference/evals/prompt-alignment.md +614 -0
  388. package/.docs/reference/evals/run-evals.md +179 -0
  389. package/.docs/reference/evals/scorer-utils.md +326 -0
  390. package/.docs/reference/evals/textual-difference.md +113 -0
  391. package/.docs/reference/evals/tone-consistency.md +119 -0
  392. package/.docs/reference/evals/tool-call-accuracy.md +533 -0
  393. package/.docs/reference/evals/toxicity.md +123 -0
  394. package/.docs/reference/harness/harness-class.md +708 -0
  395. package/.docs/reference/index.md +277 -0
  396. package/.docs/reference/logging/pino-logger.md +117 -0
  397. package/.docs/reference/mastra-code/createMastraCode.md +108 -0
  398. package/.docs/reference/memory/clone-utilities.md +199 -0
  399. package/.docs/reference/memory/cloneThread.md +130 -0
  400. package/.docs/reference/memory/createThread.md +68 -0
  401. package/.docs/reference/memory/deleteMessages.md +38 -0
  402. package/.docs/reference/memory/getThreadById.md +24 -0
  403. package/.docs/reference/memory/listThreads.md +145 -0
  404. package/.docs/reference/memory/memory-class.md +147 -0
  405. package/.docs/reference/memory/observational-memory.md +565 -0
  406. package/.docs/reference/memory/recall.md +91 -0
  407. package/.docs/reference/observability/tracing/bridges/otel.md +131 -0
  408. package/.docs/reference/observability/tracing/configuration.md +178 -0
  409. package/.docs/reference/observability/tracing/exporters/arize.md +141 -0
  410. package/.docs/reference/observability/tracing/exporters/braintrust.md +93 -0
  411. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +163 -0
  412. package/.docs/reference/observability/tracing/exporters/console-exporter.md +138 -0
  413. package/.docs/reference/observability/tracing/exporters/datadog.md +116 -0
  414. package/.docs/reference/observability/tracing/exporters/default-exporter.md +174 -0
  415. package/.docs/reference/observability/tracing/exporters/laminar.md +78 -0
  416. package/.docs/reference/observability/tracing/exporters/langfuse.md +134 -0
  417. package/.docs/reference/observability/tracing/exporters/langsmith.md +108 -0
  418. package/.docs/reference/observability/tracing/exporters/otel.md +199 -0
  419. package/.docs/reference/observability/tracing/exporters/posthog.md +92 -0
  420. package/.docs/reference/observability/tracing/exporters/sentry.md +184 -0
  421. package/.docs/reference/observability/tracing/instances.md +107 -0
  422. package/.docs/reference/observability/tracing/interfaces.md +743 -0
  423. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +144 -0
  424. package/.docs/reference/observability/tracing/spans.md +224 -0
  425. package/.docs/reference/processors/batch-parts-processor.md +61 -0
  426. package/.docs/reference/processors/language-detector.md +82 -0
  427. package/.docs/reference/processors/message-history-processor.md +85 -0
  428. package/.docs/reference/processors/moderation-processor.md +104 -0
  429. package/.docs/reference/processors/pii-detector.md +108 -0
  430. package/.docs/reference/processors/processor-interface.md +521 -0
  431. package/.docs/reference/processors/prompt-injection-detector.md +72 -0
  432. package/.docs/reference/processors/semantic-recall-processor.md +117 -0
  433. package/.docs/reference/processors/system-prompt-scrubber.md +80 -0
  434. package/.docs/reference/processors/token-limiter-processor.md +115 -0
  435. package/.docs/reference/processors/tool-call-filter.md +85 -0
  436. package/.docs/reference/processors/tool-search-processor.md +111 -0
  437. package/.docs/reference/processors/unicode-normalizer.md +62 -0
  438. package/.docs/reference/processors/working-memory-processor.md +152 -0
  439. package/.docs/reference/rag/chunk.md +221 -0
  440. package/.docs/reference/rag/database-config.md +261 -0
  441. package/.docs/reference/rag/document.md +114 -0
  442. package/.docs/reference/rag/embeddings.md +92 -0
  443. package/.docs/reference/rag/extract-params.md +168 -0
  444. package/.docs/reference/rag/graph-rag.md +111 -0
  445. package/.docs/reference/rag/metadata-filters.md +216 -0
  446. package/.docs/reference/rag/rerank.md +75 -0
  447. package/.docs/reference/rag/rerankWithScorer.md +80 -0
  448. package/.docs/reference/server/create-route.md +262 -0
  449. package/.docs/reference/server/express-adapter.md +176 -0
  450. package/.docs/reference/server/fastify-adapter.md +90 -0
  451. package/.docs/reference/server/hono-adapter.md +162 -0
  452. package/.docs/reference/server/koa-adapter.md +127 -0
  453. package/.docs/reference/server/mastra-server.md +298 -0
  454. package/.docs/reference/server/register-api-route.md +249 -0
  455. package/.docs/reference/server/routes.md +306 -0
  456. package/.docs/reference/storage/cloudflare-d1.md +218 -0
  457. package/.docs/reference/storage/cloudflare.md +88 -0
  458. package/.docs/reference/storage/composite.md +235 -0
  459. package/.docs/reference/storage/convex.md +161 -0
  460. package/.docs/reference/storage/dynamodb.md +282 -0
  461. package/.docs/reference/storage/lance.md +131 -0
  462. package/.docs/reference/storage/libsql.md +135 -0
  463. package/.docs/reference/storage/mongodb.md +262 -0
  464. package/.docs/reference/storage/mssql.md +157 -0
  465. package/.docs/reference/storage/overview.md +121 -0
  466. package/.docs/reference/storage/postgresql.md +526 -0
  467. package/.docs/reference/storage/upstash.md +160 -0
  468. package/.docs/reference/streaming/ChunkType.md +292 -0
  469. package/.docs/reference/streaming/agents/MastraModelOutput.md +182 -0
  470. package/.docs/reference/streaming/agents/stream.md +221 -0
  471. package/.docs/reference/streaming/agents/streamLegacy.md +142 -0
  472. package/.docs/reference/streaming/workflows/observeStream.md +42 -0
  473. package/.docs/reference/streaming/workflows/resumeStream.md +61 -0
  474. package/.docs/reference/streaming/workflows/stream.md +88 -0
  475. package/.docs/reference/streaming/workflows/timeTravelStream.md +142 -0
  476. package/.docs/reference/templates/overview.md +194 -0
  477. package/.docs/reference/tools/create-tool.md +237 -0
  478. package/.docs/reference/tools/document-chunker-tool.md +89 -0
  479. package/.docs/reference/tools/graph-rag-tool.md +182 -0
  480. package/.docs/reference/tools/mcp-client.md +954 -0
  481. package/.docs/reference/tools/mcp-server.md +1271 -0
  482. package/.docs/reference/tools/vector-query-tool.md +459 -0
  483. package/.docs/reference/vectors/astra.md +121 -0
  484. package/.docs/reference/vectors/chroma.md +264 -0
  485. package/.docs/reference/vectors/convex.md +300 -0
  486. package/.docs/reference/vectors/couchbase.md +226 -0
  487. package/.docs/reference/vectors/duckdb.md +318 -0
  488. package/.docs/reference/vectors/elasticsearch.md +189 -0
  489. package/.docs/reference/vectors/lance.md +220 -0
  490. package/.docs/reference/vectors/libsql.md +305 -0
  491. package/.docs/reference/vectors/mongodb.md +295 -0
  492. package/.docs/reference/vectors/opensearch.md +99 -0
  493. package/.docs/reference/vectors/pg.md +408 -0
  494. package/.docs/reference/vectors/pinecone.md +168 -0
  495. package/.docs/reference/vectors/qdrant.md +222 -0
  496. package/.docs/reference/vectors/s3vectors.md +277 -0
  497. package/.docs/reference/vectors/turbopuffer.md +157 -0
  498. package/.docs/reference/vectors/upstash.md +294 -0
  499. package/.docs/reference/vectors/vectorize.md +147 -0
  500. package/.docs/reference/voice/azure.md +148 -0
  501. package/.docs/reference/voice/cloudflare.md +83 -0
  502. package/.docs/reference/voice/composite-voice.md +121 -0
  503. package/.docs/reference/voice/deepgram.md +79 -0
  504. package/.docs/reference/voice/elevenlabs.md +98 -0
  505. package/.docs/reference/voice/google-gemini-live.md +378 -0
  506. package/.docs/reference/voice/google.md +228 -0
  507. package/.docs/reference/voice/mastra-voice.md +311 -0
  508. package/.docs/reference/voice/murf.md +122 -0
  509. package/.docs/reference/voice/openai-realtime.md +203 -0
  510. package/.docs/reference/voice/openai.md +88 -0
  511. package/.docs/reference/voice/playai.md +80 -0
  512. package/.docs/reference/voice/sarvam.md +126 -0
  513. package/.docs/reference/voice/speechify.md +75 -0
  514. package/.docs/reference/voice/voice.addInstructions.md +55 -0
  515. package/.docs/reference/voice/voice.addTools.md +67 -0
  516. package/.docs/reference/voice/voice.answer.md +54 -0
  517. package/.docs/reference/voice/voice.close.md +51 -0
  518. package/.docs/reference/voice/voice.connect.md +94 -0
  519. package/.docs/reference/voice/voice.events.md +37 -0
  520. package/.docs/reference/voice/voice.getSpeakers.md +129 -0
  521. package/.docs/reference/voice/voice.listen.md +164 -0
  522. package/.docs/reference/voice/voice.off.md +54 -0
  523. package/.docs/reference/voice/voice.on.md +111 -0
  524. package/.docs/reference/voice/voice.send.md +65 -0
  525. package/.docs/reference/voice/voice.speak.md +157 -0
  526. package/.docs/reference/voice/voice.updateConfig.md +60 -0
  527. package/.docs/reference/workflows/run-methods/cancel.md +86 -0
  528. package/.docs/reference/workflows/run-methods/restart.md +33 -0
  529. package/.docs/reference/workflows/run-methods/resume.md +59 -0
  530. package/.docs/reference/workflows/run-methods/start.md +58 -0
  531. package/.docs/reference/workflows/run-methods/startAsync.md +67 -0
  532. package/.docs/reference/workflows/run-methods/timeTravel.md +142 -0
  533. package/.docs/reference/workflows/run.md +59 -0
  534. package/.docs/reference/workflows/step.md +119 -0
  535. package/.docs/reference/workflows/workflow-methods/branch.md +25 -0
  536. package/.docs/reference/workflows/workflow-methods/commit.md +17 -0
  537. package/.docs/reference/workflows/workflow-methods/create-run.md +63 -0
  538. package/.docs/reference/workflows/workflow-methods/dountil.md +25 -0
  539. package/.docs/reference/workflows/workflow-methods/dowhile.md +25 -0
  540. package/.docs/reference/workflows/workflow-methods/foreach.md +118 -0
  541. package/.docs/reference/workflows/workflow-methods/map.md +93 -0
  542. package/.docs/reference/workflows/workflow-methods/parallel.md +21 -0
  543. package/.docs/reference/workflows/workflow-methods/sleep.md +35 -0
  544. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +35 -0
  545. package/.docs/reference/workflows/workflow-methods/then.md +21 -0
  546. package/.docs/reference/workflows/workflow.md +157 -0
  547. package/.docs/reference/workspace/e2b-sandbox.md +289 -0
  548. package/.docs/reference/workspace/filesystem.md +255 -0
  549. package/.docs/reference/workspace/gcs-filesystem.md +174 -0
  550. package/.docs/reference/workspace/local-filesystem.md +343 -0
  551. package/.docs/reference/workspace/local-sandbox.md +301 -0
  552. package/.docs/reference/workspace/s3-filesystem.md +175 -0
  553. package/.docs/reference/workspace/sandbox.md +87 -0
  554. package/.docs/reference/workspace/workspace-class.md +244 -0
  555. package/CHANGELOG.md +8 -0
  556. package/package.json +5 -5
@@ -0,0 +1,143 @@
1
+ # Mastra Class
2
+
3
+ The Mastra class has been restructured to restrict top-level imports and replace direct property access with getter methods.
4
+
5
+ ## Changed
6
+
7
+ ### Top-level imports to subpath imports
8
+
9
+ The main `@mastra/core` index file now only exports `Mastra` and `Config`. All other exports have been moved to subpath imports. This change improves tree-shaking and reduces bundle size by allowing bundlers to eliminate unused code.
10
+
11
+ To migrate, update all imports from `@mastra/core` to use the appropriate subpath.
12
+
13
+ ```diff
14
+ - import { Mastra, Agent, Workflow, createTool } from '@mastra/core';
15
+ + import { Mastra, type Config } from '@mastra/core';
16
+ + import { Agent } from '@mastra/core/agent';
17
+ + import { Workflow } from '@mastra/core/workflows';
18
+ + import { createTool } from '@mastra/core/tools';
19
+ ```
20
+
21
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
22
+ >
23
+ > ```bash
24
+ > npx @mastra/codemod@latest v1/mastra-core-imports .
25
+ > ```
26
+
27
+ ### `experimental_auth` to `auth`
28
+
29
+ The experimental auth configuration has been promoted to stable. This change reflects that the auth API is now stable and production-ready.
30
+
31
+ To migrate, rename the `experimental_auth` key to `auth` in your Mastra configuration.
32
+
33
+ ```diff
34
+ const mastra = new Mastra({
35
+ - experimental_auth: {
36
+ + auth: {
37
+ provider: workos,
38
+ },
39
+ });
40
+ ```
41
+
42
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
43
+ >
44
+ > ```bash
45
+ > npx @mastra/codemod@latest v1/experimental-auth .
46
+ > ```
47
+
48
+ ### Required `id` parameter for all mastra primitives
49
+
50
+ All storages, vector stores, agents, workflows, mcpServers, processors, scorers, and tools now require an `id` parameter during initialization. This enables the standardized Mastra API and prevents ID conflicts.
51
+
52
+ All these primitives also now have `get`, `list`, and `add` functions.
53
+
54
+ To migrate, add an `id` parameter to all storage and vector store instantiations. When using the same storage/vector class multiple times, ensure each instance has a unique ID.
55
+
56
+ ```diff
57
+ - const storage = new LibSQLStore({
58
+ - url: ':memory:',
59
+ - });
60
+ + const storage = new LibSQLStore({
61
+ + id: 'my-app-storage',
62
+ + url: ':memory:',
63
+ + });
64
+
65
+ - const vector = new PgVector({
66
+ - connectionString: process.env.DATABASE_URL,
67
+ - });
68
+ + const vector = new PgVector({
69
+ + id: 'my-app-vector',
70
+ + connectionString: process.env.DATABASE_URL,
71
+ + });
72
+ ```
73
+
74
+ When using separate instances for different purposes, use descriptive unique IDs:
75
+
76
+ ```diff
77
+ const agentMemory = new Memory({
78
+ storage: new LibSQLStore({
79
+ - url: 'file:./agent.db',
80
+ + id: 'weather-agent-memory-storage',
81
+ + url: 'file:./agent.db',
82
+ }),
83
+ });
84
+
85
+ const mastra = new Mastra({
86
+ storage: new LibSQLStore({
87
+ + id: 'mastra-storage',
88
+ url: ':memory:',
89
+ }),
90
+ });
91
+ ```
92
+
93
+ ### Primitive plural APIs changes from `get<primitives>` to `list<primitive>`
94
+
95
+ `get*` functions that returned all instances of a primitive have been renamed to `list*` to better reflect their purpose.
96
+
97
+ ```diff
98
+ - const agents = mastra.getAgents();
99
+ + const agents = mastra.listAgents();
100
+ - const vectors = mastra.getVectors();
101
+ + const vectors = mastra.listVectors();
102
+ - const workflows = mastra.getWorkflows();
103
+ + const workflows = mastra.listWorkflows();
104
+ - const scorers = mastra.getScorers();
105
+ + const scorers = mastra.listScorers();
106
+ - const mcpServers = mastra.getMCPServers();
107
+ + const mcpServers = mastra.listMCPServers();
108
+ - const logsByRunId = await mastra.getLogsByRunId({ runId: 'id', transportId: 'id' });
109
+ + const logsByRunId = await mastra.listLogsByRunId({ runId: 'id', transportId: 'id' });
110
+ - const logs = await mastra.getLogs('transportId');
111
+ + const logs = await mastra.listLogs('transportId');
112
+ ```
113
+
114
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
115
+ >
116
+ > ```bash
117
+ > npx @mastra/codemod@latest v1/mastra-plural-apis .
118
+ > ```
119
+
120
+ ### Each primitive has a `getById` and a `get` function
121
+
122
+ ```typescript
123
+ mastra.getMCPServer('myServer') // Works (registry key)
124
+ mastra.getMCPServerById('my-mcp-server') // Works (intrinsic ID)
125
+ ```
126
+
127
+ ### Tool registration now uses intrinsic IDs
128
+
129
+ When tools are auto-registered from agents or MCP servers to the Mastra instance, they now use the tool's intrinsic `id` instead of the configuration object key. This prevents collisions when multiple agents/MCP servers have tools with the same configuration key.
130
+
131
+ To migrate, update any code that references tools by their configuration keys to use the tool's intrinsic ID instead.
132
+
133
+ ```diff
134
+ const agent = new Agent({
135
+ id: 'agent1',
136
+ tools: {
137
+ searchTool: weatherSearchTool,
138
+ },
139
+ });
140
+
141
+ - mastra.getTool('searchTool');
142
+ + mastra.getTool(weatherSearchTool.id);
143
+ ```
@@ -0,0 +1,97 @@
1
+ # MCP
2
+
3
+ MCP (Model Context Protocol) tool execution context has been reorganized, and deprecated client classes have been removed.
4
+
5
+ ## Changed
6
+
7
+ ### `getMCPServers` to `listMCPServers`
8
+
9
+ The `mastra.getMCPServers()` method has been renamed to `mastra.listMCPServers()`. This change aligns with the naming convention used across the API where plural getter methods use the `list` prefix.
10
+
11
+ To migrate, replace all calls to `mastra.getMCPServers()` with `mastra.listMCPServers()`.
12
+
13
+ ```diff
14
+ - const servers = await mastra.getMCPServers();
15
+ + const servers = await mastra.listMCPServers();
16
+ ```
17
+
18
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
19
+ >
20
+ > ```bash
21
+ > npx @mastra/codemod@latest v1/mastra-plural-apis .
22
+ > ```
23
+
24
+ ### `getTools` to `listTools`
25
+
26
+ The `mcp.getTools()` method has been renamed to `mcp.listTools()`. This change aligns with the naming convention used across the API where plural getter methods use the `list` prefix.
27
+
28
+ To migrate, replace all calls to `mcp.getTools()` with `mcp.listTools()`.
29
+
30
+ ```diff
31
+ - const tools = await mcp.getTools();
32
+ + const tools = await mcp.listTools();
33
+ ```
34
+
35
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
36
+ >
37
+ > ```bash
38
+ > npx @mastra/codemod@latest v1/mcp-get-tools .
39
+ > ```
40
+
41
+ ### `getToolsets` to `listToolsets`
42
+
43
+ The `mcp.getToolsets()` method has been renamed to `mcp.listToolsets()`. This change aligns with the naming convention used across the API where plural getter methods use the `list` prefix.
44
+
45
+ To migrate, replace all calls to `mcp.getToolsets()` with `mcp.listToolsets()`.
46
+
47
+ ```diff
48
+ - const toolsets = await mcp.getToolsets();
49
+ + const toolsets = await mcp.listToolsets();
50
+ ```
51
+
52
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
53
+ >
54
+ > ```bash
55
+ > npx @mastra/codemod@latest v1/mcp-get-toolsets .
56
+ > ```
57
+
58
+ ### MCP tool context properties organization
59
+
60
+ Context properties in MCP tools are now organized under the `context.mcp` namespace. This change provides better organization and clearer API surface for MCP-specific functionality.
61
+
62
+ To migrate, access MCP-specific properties like `elicitation` and `extra` through `context.mcp` instead of directly from the context parameter.
63
+
64
+ ```diff
65
+ createTool({
66
+ id: 'account-balance',
67
+ - execute: async ({ context, elicitation, extra }) => {
68
+ - await checkAuth(extra.authInfo);
69
+ - const result = await elicitation.sendRequest({
70
+ - message: `Is it ok to fetch account ${context.accountId}?`,
71
+ - });
72
+ - },
73
+ + execute: async (inputData, context) => {
74
+ + await checkAuth(context?.mcp?.extra.authInfo);
75
+ + const result = await context?.mcp?.elicitation.sendRequest({
76
+ + message: `Is it ok to fetch account ${inputData.accountId}?`,
77
+ + });
78
+ + },
79
+ });
80
+ ```
81
+
82
+ ## Removed
83
+
84
+ ### Deprecated MCP client classes
85
+
86
+ The `MastraMCPClient` and related deprecated APIs have been removed from `@mastra/mcp`. This change consolidates on the new MCP client API.
87
+
88
+ To migrate, use the new `MCPClient` class instead of deprecated classes.
89
+
90
+ ```diff
91
+ - import { MastraMCPClient, MCPConfiguration } from '@mastra/mcp/client';
92
+ + import { MCPClient } from '@mastra/mcp/client';
93
+
94
+ - const client = new MastraMCPClient({ ... });
95
+ - const config = new MCPConfiguration({ ... });
96
+ + const client = new MCPClient({ ... });
97
+ ```
@@ -0,0 +1,285 @@
1
+ # Memory
2
+
3
+ Memory configuration now requires explicit parameters, and default settings have been updated for better performance and predictability.
4
+
5
+ ## Changed
6
+
7
+ ### Default settings for semantic recall and last messages
8
+
9
+ Default settings have changed to more reasonable values based on usage patterns. The `lastMessages` default decreased from 40 to 10, `semanticRecall` is now disabled by default, and thread title generation is disabled by default. These changes improve performance and reduce unexpected LLM API calls.
10
+
11
+ To migrate, if you were relying on the old defaults, explicitly configure these settings.
12
+
13
+ ```diff
14
+ const memory = new Memory({
15
+ storage,
16
+ vector,
17
+ embedder,
18
+ + options: {
19
+ + lastMessages: 40, // Was default before
20
+ + semanticRecall: {
21
+ + topK: 2,
22
+ + messageRange: 2,
23
+ + scope: 'thread',
24
+ + }, // Was enabled by default before
25
+ + generateTitle: true, // Was enabled by default before
26
+ + },
27
+ });
28
+ ```
29
+
30
+ ### Default memory scope from `thread` to `resource`
31
+
32
+ The default scope for both working memory and semantic recall has changed from `'thread'` to `'resource'`. This change aligns with common use cases where applications want to remember user information across conversations. When semantic recall is enabled, it now defaults to searching across all user conversations rather than just the current thread.
33
+
34
+ To migrate, if you want to maintain the old behavior where memory is isolated per conversation thread, explicitly set `scope: 'thread'`.
35
+
36
+ ```diff
37
+ const memory = new Memory({
38
+ storage,
39
+ vector,
40
+ embedder,
41
+ options: {
42
+ workingMemory: {
43
+ enabled: true,
44
+ + scope: 'thread', // Explicitly set to thread-scoped
45
+ template: `# User Profile...`,
46
+ },
47
+ semanticRecall: {
48
+ topK: 3,
49
+ + scope: 'thread', // Explicitly set to thread-scoped
50
+ },
51
+ },
52
+ });
53
+ ```
54
+
55
+ ### Thread title generation location
56
+
57
+ The `generateTitle` option has been moved from `threads.generateTitle` to the top-level of memory options. This change simplifies the API by moving the option to where it logically belongs.
58
+
59
+ To migrate, move `generateTitle` from the `threads` config to the top level of options.
60
+
61
+ ```diff
62
+ const memory = new Memory({
63
+ storage,
64
+ vector,
65
+ embedder,
66
+ options: {
67
+ - threads: {
68
+ - generateTitle: true,
69
+ - },
70
+ + generateTitle: true,
71
+ },
72
+ });
73
+ ```
74
+
75
+ ### Semantic recall default settings optimization
76
+
77
+ The default settings for semantic recall have been optimized based on RAG research. The `topK` increased from 2 to 4, and `messageRange` changed from `{ before: 2, after: 2 }` to `{ before: 1, after: 1 }`. These changes provide better accuracy while only slightly increasing message count.
78
+
79
+ To migrate, if you were relying on the previous defaults, explicitly set these values.
80
+
81
+ ```diff
82
+ const memory = new Memory({
83
+ storage,
84
+ vector,
85
+ embedder,
86
+ options: {
87
+ semanticRecall: {
88
+ + topK: 2, // Was default before
89
+ + messageRange: { before: 2, after: 2 }, // Was default before
90
+ },
91
+ },
92
+ });
93
+ ```
94
+
95
+ ### `memory.readOnly` moved to `memory.options.readOnly`
96
+
97
+ The `readOnly` property has been moved from the top-level of the memory option to inside `options`. This change aligns `readOnly` with other memory configuration options like `lastMessages` and `semanticRecall`.
98
+
99
+ To migrate, move `readOnly` from the top level to inside `options`.
100
+
101
+ ```diff
102
+ agent.stream('Hello', {
103
+ memory: {
104
+ thread: threadId,
105
+ resource: resourceId,
106
+ - readOnly: true,
107
+ + options: {
108
+ + readOnly: true,
109
+ + },
110
+ },
111
+ });
112
+ ```
113
+
114
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
115
+ >
116
+ > ```bash
117
+ > npx @mastra/codemod@latest v1/memory-readonly-to-options .
118
+ > ```
119
+
120
+ ### `Memory.query()` renamed to `Memory.recall()`
121
+
122
+ The `Memory.query()` method has been renamed to `Memory.recall()`. The new method returns a simpler format with just `{ messages: MastraDBMessage[] }` instead of multiple format variations. This change better describes the action of retrieving messages from memory and simplifies the API.
123
+
124
+ To migrate, rename `query()` to `recall()` and update code that expects the old return format.
125
+
126
+ ```diff
127
+ - const result = await memory.query({ threadId: 'thread-123' });
128
+ + const result = await memory.recall({ threadId: 'thread-123' });
129
+ - // result: { messages: CoreMessage[], uiMessages: UIMessageWithMetadata[], messagesV2: MastraMessageV2[] }
130
+ + // result: { messages: MastraDBMessage[] }
131
+ + const messages = result.messages;
132
+ ```
133
+
134
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
135
+ >
136
+ > ```bash
137
+ > npx @mastra/codemod@latest v1/memory-query-to-recall .
138
+ > ```
139
+
140
+ ### `Memory.recall()` parameter changes
141
+
142
+ The `Memory.recall()` method now uses `StorageListMessagesInput` format with pagination, and the `vectorMessageSearch` parameter has been renamed to `vectorSearchString`. These changes align the memory API with the storage pagination API and provide more consistent naming.
143
+
144
+ To migrate, update method name, query parameters, and the vector search parameter.
145
+
146
+ ```diff
147
+ - memory.query({
148
+ + memory.recall({
149
+ threadId: 'thread-123',
150
+ - vectorMessageSearch: 'What did we discuss?',
151
+ - selectBy: { ... },
152
+ + vectorSearchString: 'What did we discuss?',
153
+ + page: 0,
154
+ + perPage: 20,
155
+ + orderBy: 'createdAt',
156
+ + filter: { ... },
157
+ + threadConfig: { semanticRecall: true },
158
+ });
159
+ ```
160
+
161
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
162
+ >
163
+ > ```bash
164
+ > npx @mastra/codemod@latest v1/memory-vector-search-param .
165
+ > ```
166
+
167
+ ### `MastraMessageV2` type renamed to `MastraDBMessage`
168
+
169
+ The `MastraMessageV2` type has been renamed to `MastraDBMessage` for clarity. This change better describes the purpose of this type as the database message format.
170
+
171
+ To migrate, replace all instances of `MastraMessageV2` with `MastraDBMessage`.
172
+
173
+ ```diff
174
+ - import { MastraMessageV2 } from '@mastra/core';
175
+ - function yourCustomFunction(input: MastraMessageV2) {}
176
+ + import { MastraDBMessage } from '@mastra/core';
177
+ + function yourCustomFunction(input: MastraDBMessage) {}
178
+ ```
179
+
180
+ > **Codemod:** You can use Mastra's codemod CLI to update your code automatically:
181
+ >
182
+ > ```bash
183
+ > npx @mastra/codemod@latest v1/memory-message-v2-type .
184
+ > ```
185
+
186
+ ## Removed
187
+
188
+ ### Working memory `text-stream` mode
189
+
190
+ Working memory `use: "text-stream"` option has been removed. Only `tool-call` mode is supported. This change simplifies the working memory API by removing the less reliable streaming mode.
191
+
192
+ To migrate, remove the `use: "text-stream"` option. Working memory will default to tool-call mode.
193
+
194
+ ```diff
195
+ const memory = new Memory({
196
+ storage,
197
+ vector,
198
+ embedder,
199
+ options: {
200
+ workingMemory: {
201
+ enabled: true,
202
+ - use: 'text-stream',
203
+ template: '...',
204
+ },
205
+ },
206
+ });
207
+ ```
208
+
209
+ ### `Memory.rememberMessages()` method
210
+
211
+ The `Memory.rememberMessages()` method has been removed. This method performed the same function as `query()` (now `recall()`), and consolidating to one method simplifies the API.
212
+
213
+ To migrate, replace `rememberMessages()` calls with `recall()`.
214
+
215
+ ```diff
216
+ - const { messages } = await memory.rememberMessages({
217
+ + const { messages } = await memory.recall({
218
+ threadId,
219
+ resourceId,
220
+ });
221
+ ```
222
+
223
+ ### `format` parameter from memory methods
224
+
225
+ The `format` parameter has been removed from all memory get methods. `MastraDBMessage` is now the default return format everywhere. AI SDK format conversion has moved to dedicated utility functions in `@mastra/ai-sdk/ui`. This change improves tree-shaking by moving UI-specific conversion code to a separate package.
226
+
227
+ To migrate, remove the `format` parameter and use conversion functions for AI SDK formats.
228
+
229
+ ```diff
230
+ - const messages = await memory.getMessages({ threadId, format: 'v2' });
231
+ - const uiMessages = await memory.getMessages({ threadId, format: 'ui' });
232
+
233
+ + const result = await memory.recall({ threadId });
234
+ + const messages = result.messages; // Always MastraDBMessage[]
235
+ +
236
+ + // Use conversion functions for AI SDK formats
237
+ + import { toAISdkV5Messages } from '@mastra/ai-sdk/ui';
238
+ + const uiMessages = toAISdkV5Messages(messages);
239
+ ```
240
+
241
+ ### `MastraMessageV3` type
242
+
243
+ The `MastraMessageV3` type and related conversion methods have been removed. Messages now convert directly between `MastraMessageV2` (now `MastraDBMessage`) and AI SDK v5 formats. This change simplifies the architecture by removing an intermediary format.
244
+
245
+ To migrate, use `MastraDBMessage` for storage or AI SDK v5 message formats directly.
246
+
247
+ ```diff
248
+ - import type { MastraMessageV3 } from '@mastra/core/agent';
249
+ - const v3Messages = messageList.get.all.v3();
250
+
251
+ + // For storage
252
+ + const v2Messages = messageList.get.all.v2();
253
+ +
254
+ + // For AI SDK v5
255
+ + const uiMessages = messageList.get.all.aiV5.ui();
256
+ + const modelMessages = messageList.get.all.aiV5.model();
257
+ ```
258
+
259
+ ### `processors` config from Memory constructor
260
+
261
+ The `processors` config option in the Memory constructor has been deprecated and now throws an error. Processors should be configured at the Agent level instead. This change provides clearer configuration boundaries and better encapsulation.
262
+
263
+ To migrate, move processor configuration from Memory to Agent using `inputProcessors` and/or `outputProcessors`.
264
+
265
+ ```diff
266
+ + import { TokenLimiter } from '@mastra/core/processors';
267
+ +
268
+ const memory = new Memory({
269
+ storage,
270
+ vector,
271
+ embedder,
272
+ - processors: [/* ... */],
273
+ });
274
+
275
+ const agent = new Agent({
276
+ memory,
277
+ + inputProcessors: [
278
+ + new TokenLimiter({ limit: 4000 }), // Limits historical messages to fit context window
279
+ + ],
280
+ });
281
+ ```
282
+
283
+ Additionally, the `@mastra/memory/processors` import path has been removed. Import processors from `@mastra/core/processors` instead. See the [processors migration guide](https://mastra.ai/guides/migrations/upgrade-to-v1/processors) for details.
284
+
285
+ For more information on using processors with agents, see the [Processors docs](https://mastra.ai/docs/agents/processors). For a complete example with memory, see the [TokenLimiter reference](https://mastra.ai/reference/processors/token-limiter-processor).
@@ -0,0 +1,119 @@
1
+ # Upgrade to Mastra v1
2
+
3
+ > **Update to latest 0.x version:** Before upgrading to v1, make sure you've updated to the latest 0.x version of Mastra. Follow the [upgrade to latest 0.x guide](https://mastra.ai/guides/v0/migrations/upgrade-to-latest-0x) first, then return here to complete the v1 migration.
4
+
5
+ Mastra v1 was released in January 2026. We recommend starting any new projects with Mastra v1, or upgrading your existing project to continue receiving updates and support.
6
+
7
+ This guide provides a comprehensive overview of breaking changes when upgrading from Mastra 0.x to v1.0. The migration is organized by package and feature area to help you systematically update your codebase.
8
+
9
+ > **Need help?:** Need help with the migration? Join our [Discord community](https://discord.gg/BTYqqHKUrf) to ask questions.
10
+
11
+ ## Migration Strategy
12
+
13
+ ### Update all Mastra packages to `latest` tag
14
+
15
+ Use your package manager to update your project's versions. Be sure to update **all** Mastra packages at the same time to ensure compatibility (all `@mastra/*` packages and `mastra`).
16
+
17
+ Here's how you update the most commonly used packages:
18
+
19
+ **npm**:
20
+
21
+ ```bash
22
+ npm install @mastra/core@latest @mastra/loggers@latest @mastra/memory@latest mastra@latest
23
+ ```
24
+
25
+ **pnpm**:
26
+
27
+ ```bash
28
+ pnpm add @mastra/core@latest @mastra/loggers@latest @mastra/memory@latest mastra@latest
29
+ ```
30
+
31
+ **Yarn**:
32
+
33
+ ```bash
34
+ yarn add @mastra/core@latest @mastra/loggers@latest @mastra/memory@latest mastra@latest
35
+ ```
36
+
37
+ **Bun**:
38
+
39
+ ```bash
40
+ bun add @mastra/core@latest @mastra/loggers@latest @mastra/memory@latest mastra@latest
41
+ ```
42
+
43
+ Install any other Mastra package with the `@latest` tag and you'll get the latest v1 version available. Be sure to update all Mastra packages (especially if you're in a monorepo) to avoid version mismatches.
44
+
45
+ ### Update Node.js version
46
+
47
+ Mastra v1 requires Node.js **22.13.0** or higher. Update your development and production environments accordingly.
48
+
49
+ ### Go through migration checklist
50
+
51
+ Work through the [migration checklist](#migration-checklist) below to update your codebase. Each item links to a detailed guide for that specific change.
52
+
53
+ > **Codemods:** We prepared automated [codemods](https://github.com/mastra-ai/mastra/tree/main/packages/codemod) for you. If you want, you can run all v1 codemods at once:
54
+ >
55
+ > ```bash
56
+ > npx @mastra/codemod@latest v1
57
+ > ```
58
+
59
+ > **Database Migration Required:** If you're using PostgreSQL or LibSQL storage, you'll need to run a database migration. See the [Storage migration guide](https://mastra.ai/guides/migrations/upgrade-to-v1/storage) for details.
60
+
61
+ ## Breaking Changes by Area
62
+
63
+ - **[Mastra Class](https://mastra.ai/guides/migrations/upgrade-to-v1/mastra)** - Import restructuring and property access changes.
64
+ - **[Agent Class](https://mastra.ai/guides/migrations/upgrade-to-v1/agent)** - Voice methods moved to namespace and streaming API updates.
65
+ - **[Tools](https://mastra.ai/guides/migrations/upgrade-to-v1/tools)** - CreateTool execute signature changed to separate input and context.
66
+ - **[Workflows](https://mastra.ai/guides/migrations/upgrade-to-v1/workflows)** - Function name changes and legacy features removed.
67
+ - **[Memory](https://mastra.ai/guides/migrations/upgrade-to-v1/memory)** - Configuration now requires explicit parameters and defaults changed.
68
+ - **[Storage](https://mastra.ai/guides/migrations/upgrade-to-v1/storage)** - Pagination standardized and methods renamed to list pattern.
69
+ - **[Vectors](https://mastra.ai/guides/migrations/upgrade-to-v1/vectors)** - Vector store methods renamed to list pattern.
70
+ - **[RAG](https://mastra.ai/guides/migrations/upgrade-to-v1/rag)** - Parameter naming updated for clarity.
71
+ - **[MCP](https://mastra.ai/guides/migrations/upgrade-to-v1/mcp)** - Tool context reorganized and deprecated client classes removed.
72
+ - **[Tracing](https://mastra.ai/guides/migrations/upgrade-to-v1/tracing)** - OTEL telemetry replaced with dedicated observability package and exporters.
73
+ - **[Evals & Scorers](https://mastra.ai/guides/migrations/upgrade-to-v1/evals)** - Scorers API consolidated with new naming conventions.
74
+ - **[CLI](https://mastra.ai/guides/migrations/upgrade-to-v1/cli)** - Commands and flags removed for simpler interface.
75
+ - **[Deployment](https://mastra.ai/guides/migrations/upgrade-to-v1/deployment)** - CloudflareDeployer configuration updated to use standard wrangler.json property names.
76
+ - **[Client SDKs](https://mastra.ai/guides/migrations/upgrade-to-v1/client)** - Types and utilities renamed for consistency.
77
+ - **[Voice Packages](https://mastra.ai/guides/migrations/upgrade-to-v1/voice)** - Packages renamed from speech to voice.
78
+
79
+ ## Migration Checklist
80
+
81
+ Work through this checklist in order, starting with high-impact changes that affect most applications.
82
+
83
+ > **Codemods:** We prepared automated [codemods](https://github.com/mastra-ai/mastra/tree/main/packages/codemod) for you. Throughout the migration guide you'll find instructions on how to use them for specific changes.
84
+ >
85
+ > If you want, you can run all v1 codemods at once:
86
+ >
87
+ > ```bash
88
+ > npx @mastra/codemod@latest v1
89
+ > ```
90
+
91
+ ### High Impact Changes
92
+
93
+ - Update `createTool` tool signatures to `(inputData, context)` format - [Tools](https://mastra.ai/guides/migrations/upgrade-to-v1/tools)
94
+ - Restructure `@mastra/core` imports to use subpath imports - [Mastra Class](https://mastra.ai/guides/migrations/upgrade-to-v1/mastra)
95
+ - Update pagination from `offset/limit` to `page/perPage` - [Storage](https://mastra.ai/guides/migrations/upgrade-to-v1/storage)
96
+ - Install `@mastra/observability` and wrap configuration with `new Observability()` - [Tracing](https://mastra.ai/guides/migrations/upgrade-to-v1/tracing)
97
+ - Migrate from `telemetry:` to `observability:` configuration (if upgrading from 0.x OTEL) - [Tracing](https://mastra.ai/guides/migrations/upgrade-to-v1/tracing)
98
+
99
+ ### Medium Impact Changes
100
+
101
+ - Rename `RuntimeContext` to `RequestContext` throughout codebase - [Agent Class](https://mastra.ai/guides/migrations/upgrade-to-v1/agent), [Tools](https://mastra.ai/guides/migrations/upgrade-to-v1/tools), [Workflows](https://mastra.ai/guides/migrations/upgrade-to-v1/workflows)
102
+ - Update storage methods from `get*` to `list*` pattern - [Storage](https://mastra.ai/guides/migrations/upgrade-to-v1/storage)
103
+ - Replace direct property access with getter methods - [Mastra Class](https://mastra.ai/guides/migrations/upgrade-to-v1/mastra), [Agent Class](https://mastra.ai/guides/migrations/upgrade-to-v1/agent)
104
+ - Update memory scope if relying on default `thread` scope - [Memory](https://mastra.ai/guides/migrations/upgrade-to-v1/memory)
105
+ - Update vector store calls to use named arguments - [Storage](https://mastra.ai/guides/migrations/upgrade-to-v1/storage)
106
+ - Remove `format` parameter from agent methods - [Agent Class](https://mastra.ai/guides/migrations/upgrade-to-v1/agent)
107
+ - Update voice methods to use `agent.voice` namespace - [Agent Class](https://mastra.ai/guides/migrations/upgrade-to-v1/agent)
108
+ - Rename configuration property `processors` to `spanOutputProcessors` (if using custom processors) - [Tracing](https://mastra.ai/guides/migrations/upgrade-to-v1/tracing)
109
+
110
+ ### Low Impact Changes
111
+
112
+ - Rename `keepSeparator` to `separatorPosition` in chunk options - [RAG](https://mastra.ai/guides/migrations/upgrade-to-v1/rag)
113
+ - Rename `createRunAsync` to `createRun` - [Workflows](https://mastra.ai/guides/migrations/upgrade-to-v1/workflows)
114
+ - Update voice package names from `@mastra/speech-*` to `@mastra/voice-*` - [Voice Packages](https://mastra.ai/guides/migrations/upgrade-to-v1/voice)
115
+ - Update scorer methods: `runExperiment` → `runEvals`, `getScorerByName` → `getScorerById` - [Evals & Scorers](https://mastra.ai/guides/migrations/upgrade-to-v1/evals)
116
+ - Remove deprecated CLI flags - [CLI](https://mastra.ai/guides/migrations/upgrade-to-v1/cli)
117
+ - Update client SDK types from `Get*` to `List*` - [Client SDKs](https://mastra.ai/guides/migrations/upgrade-to-v1/client)
118
+ - Replace `runCount` with `retryCount` - [Workflows](https://mastra.ai/guides/migrations/upgrade-to-v1/workflows)
119
+ - Update custom exporter method `exportEvent` to `exportTracingEvent` (if using custom exporters) - [Tracing](https://mastra.ai/guides/migrations/upgrade-to-v1/tracing)