@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.1

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 (541) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +3 -1
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +3 -1
  3. package/.docs/organized/changelogs/%40internal%2Fplayground.md +60 -0
  4. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +15 -15
  5. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +3 -1
  6. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +287 -287
  7. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +302 -302
  8. package/.docs/organized/changelogs/%40mastra%2Fastra.md +53 -53
  9. package/.docs/organized/changelogs/%40mastra%2Fauth.md +38 -0
  10. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +66 -66
  11. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +522 -212
  12. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +239 -239
  13. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +439 -234
  14. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +450 -211
  15. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +202 -0
  16. package/.docs/organized/changelogs/%40mastra%2Fconvex.md +448 -22
  17. package/.docs/organized/changelogs/%40mastra%2Fcore.md +348 -348
  18. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +60 -60
  19. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +287 -287
  20. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +106 -106
  21. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +90 -90
  22. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +86 -86
  23. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +221 -221
  24. package/.docs/organized/changelogs/%40mastra%2Fduckdb.md +70 -0
  25. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +403 -225
  26. package/.docs/organized/changelogs/%40mastra%2Felasticsearch.md +72 -0
  27. package/.docs/organized/changelogs/%40mastra%2Fevals.md +145 -145
  28. package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +54 -0
  29. package/.docs/organized/changelogs/%40mastra%2Flance.md +456 -226
  30. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +625 -229
  31. package/.docs/organized/changelogs/%40mastra%2Floggers.md +71 -71
  32. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +245 -245
  33. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +28 -28
  34. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +281 -281
  35. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +354 -156
  36. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +545 -212
  37. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +481 -202
  38. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +194 -194
  39. package/.docs/organized/changelogs/%40mastra%2Fpg.md +781 -235
  40. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +198 -198
  41. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +282 -282
  42. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +163 -163
  43. package/.docs/organized/changelogs/%40mastra%2Frag.md +310 -310
  44. package/.docs/organized/changelogs/%40mastra%2Freact.md +328 -237
  45. package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +64 -0
  46. package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +160 -0
  47. package/.docs/organized/changelogs/%40mastra%2Fserver.md +230 -230
  48. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +57 -57
  49. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +479 -232
  50. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +53 -53
  51. package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +45 -45
  52. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +45 -45
  53. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +47 -47
  54. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +110 -110
  55. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +15 -0
  56. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +98 -0
  57. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +54 -54
  58. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +46 -46
  59. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +93 -93
  60. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +47 -47
  61. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +45 -45
  62. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +45 -45
  63. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +45 -45
  64. package/.docs/organized/changelogs/create-mastra.md +219 -219
  65. package/.docs/organized/changelogs/mastra.md +276 -276
  66. package/.docs/organized/code-examples/a2a.md +2 -2
  67. package/.docs/organized/code-examples/agent-v6.md +221 -0
  68. package/.docs/organized/code-examples/agui.md +4 -4
  69. package/.docs/organized/code-examples/ai-elements.md +3 -3
  70. package/.docs/organized/code-examples/ai-sdk-useChat.md +2 -2
  71. package/.docs/organized/code-examples/ai-sdk-v5.md +3 -3
  72. package/.docs/organized/code-examples/assistant-ui.md +5 -5
  73. package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
  74. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +2 -2
  75. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +3 -3
  76. package/.docs/organized/code-examples/client-side-tools.md +4 -4
  77. package/.docs/organized/code-examples/crypto-chatbot.md +5 -5
  78. package/.docs/organized/code-examples/experimental-auth-weather-agent.md +1 -1
  79. package/.docs/organized/code-examples/fireworks-r1.md +2 -2
  80. package/.docs/organized/code-examples/heads-up-game.md +7 -7
  81. package/.docs/organized/code-examples/inngest.md +1075 -0
  82. package/.docs/organized/code-examples/mcp-configuration.md +1 -1
  83. package/.docs/organized/code-examples/mcp-server-adapters.md +2 -2
  84. package/.docs/organized/code-examples/memory-per-resource-example.md +3 -3
  85. package/.docs/organized/code-examples/memory-todo-agent.md +1 -1
  86. package/.docs/organized/code-examples/memory-with-context.md +1 -1
  87. package/.docs/organized/code-examples/memory-with-processors.md +1 -1
  88. package/.docs/organized/code-examples/openapi-spec-writer.md +3 -3
  89. package/.docs/organized/code-examples/quick-start.md +1 -5
  90. package/.docs/organized/code-examples/server-app-access.md +2 -2
  91. package/.docs/organized/code-examples/server-express-adapter.md +1 -1
  92. package/.docs/organized/code-examples/server-fastify-adapter.md +83 -0
  93. package/.docs/organized/code-examples/server-hono-adapter.md +2 -2
  94. package/.docs/organized/code-examples/server-koa-adapter.md +94 -0
  95. package/.docs/organized/code-examples/stock-price-tool.md +21 -2
  96. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  97. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  98. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  99. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  100. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
  101. package/.docs/raw/agents/adding-voice.mdx +24 -6
  102. package/.docs/raw/agents/agent-approval.mdx +209 -12
  103. package/.docs/raw/agents/agent-memory.mdx +36 -32
  104. package/.docs/raw/agents/guardrails.mdx +105 -56
  105. package/.docs/raw/agents/network-approval.mdx +281 -0
  106. package/.docs/raw/agents/networks.mdx +69 -13
  107. package/.docs/raw/agents/overview.mdx +43 -25
  108. package/.docs/raw/agents/processors.mdx +234 -17
  109. package/.docs/raw/agents/structured-output.mdx +78 -8
  110. package/.docs/raw/agents/using-tools.mdx +67 -6
  111. package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +1 -2
  112. package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +1 -1
  113. package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +1 -2
  114. package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +1 -1
  115. package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +1 -1
  116. package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +1 -1
  117. package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +1 -1
  118. package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +1 -1
  119. package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +3 -3
  120. package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
  121. package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +35 -0
  122. package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
  123. package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +1 -1
  124. package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +4 -5
  125. package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
  126. package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +3 -4
  127. package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +3 -4
  128. package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +3 -4
  129. package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +3 -4
  130. package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
  131. package/.docs/raw/deployment/cloud-providers.mdx +22 -0
  132. package/.docs/raw/deployment/mastra-server.mdx +140 -0
  133. package/.docs/raw/deployment/monorepo.mdx +106 -42
  134. package/.docs/raw/deployment/overview.mdx +35 -48
  135. package/.docs/raw/deployment/web-framework.mdx +17 -19
  136. package/.docs/raw/deployment/workflow-runners.mdx +16 -0
  137. package/.docs/raw/evals/built-in-scorers.mdx +2 -0
  138. package/.docs/raw/evals/custom-scorers.mdx +60 -12
  139. package/.docs/raw/evals/overview.mdx +6 -6
  140. package/.docs/raw/evals/running-in-ci.mdx +4 -2
  141. package/.docs/raw/getting-started/manual-install.mdx +20 -20
  142. package/.docs/raw/getting-started/mcp-docs-server.mdx +59 -2
  143. package/.docs/raw/getting-started/project-structure.mdx +2 -2
  144. package/.docs/raw/getting-started/start.mdx +17 -1
  145. package/.docs/raw/getting-started/studio.mdx +6 -35
  146. package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +23 -33
  147. package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1034 -80
  148. package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
  149. package/.docs/raw/guides/build-your-ui/copilotkit.mdx +32 -11
  150. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/amazon-ec2.mdx +9 -9
  151. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/aws-lambda.mdx +13 -16
  152. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/azure-app-services.mdx +5 -7
  153. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/cloudflare-deployer.mdx +8 -5
  154. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/digital-ocean.mdx +18 -23
  155. package/.docs/raw/guides/deployment/index.mdx +32 -0
  156. package/.docs/raw/guides/deployment/inngest.mdx +673 -0
  157. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/netlify-deployer.mdx +7 -3
  158. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/vercel-deployer.mdx +8 -5
  159. package/.docs/raw/guides/getting-started/astro.mdx +292 -451
  160. package/.docs/raw/guides/getting-started/express.mdx +72 -153
  161. package/.docs/raw/guides/getting-started/hono.mdx +227 -0
  162. package/.docs/raw/guides/getting-started/next-js.mdx +173 -61
  163. package/.docs/raw/guides/getting-started/nuxt.mdx +505 -0
  164. package/.docs/raw/guides/getting-started/quickstart.mdx +5 -5
  165. package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
  166. package/.docs/raw/guides/getting-started/vite-react.mdx +317 -147
  167. package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
  168. package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
  169. package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
  170. package/.docs/raw/guides/guide/research-assistant.mdx +20 -20
  171. package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
  172. package/.docs/raw/guides/guide/web-search.mdx +38 -38
  173. package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
  174. package/.docs/raw/guides/index.mdx +0 -1
  175. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
  176. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +105 -4
  177. package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +15 -1
  178. package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +170 -0
  179. package/.docs/raw/guides/migrations/upgrade-to-v1/deployment.mdx +42 -0
  180. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +0 -35
  181. package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +40 -3
  182. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +17 -2
  183. package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
  184. package/.docs/raw/guides/migrations/upgrade-to-v1/rag.mdx +47 -0
  185. package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +271 -25
  186. package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +72 -17
  187. package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +46 -1
  188. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +50 -7
  189. package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
  190. package/.docs/raw/index.mdx +2 -2
  191. package/.docs/raw/mastra-cloud/deployment.mdx +86 -0
  192. package/.docs/raw/mastra-cloud/observability.mdx +43 -0
  193. package/.docs/raw/mastra-cloud/overview.mdx +31 -0
  194. package/.docs/raw/mastra-cloud/setup.mdx +64 -0
  195. package/.docs/raw/mastra-cloud/studio.mdx +35 -0
  196. package/.docs/raw/mcp/overview.mdx +60 -25
  197. package/.docs/raw/mcp/publishing-mcp-server.mdx +7 -4
  198. package/.docs/raw/memory/memory-processors.mdx +17 -12
  199. package/.docs/raw/memory/message-history.mdx +72 -0
  200. package/.docs/raw/memory/overview.mdx +38 -76
  201. package/.docs/raw/memory/semantic-recall.mdx +65 -52
  202. package/.docs/raw/memory/storage.mdx +248 -0
  203. package/.docs/raw/memory/working-memory.mdx +24 -13
  204. package/.docs/raw/observability/logging.mdx +16 -15
  205. package/.docs/raw/observability/overview.mdx +27 -7
  206. package/.docs/raw/observability/tracing/bridges/otel.mdx +7 -4
  207. package/.docs/raw/observability/tracing/exporters/arize.mdx +61 -24
  208. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +32 -22
  209. package/.docs/raw/observability/tracing/exporters/cloud.mdx +24 -5
  210. package/.docs/raw/observability/tracing/exporters/datadog.mdx +175 -0
  211. package/.docs/raw/observability/tracing/exporters/default.mdx +28 -7
  212. package/.docs/raw/observability/tracing/exporters/laminar.mdx +89 -0
  213. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +31 -22
  214. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +33 -3
  215. package/.docs/raw/observability/tracing/exporters/otel.mdx +194 -22
  216. package/.docs/raw/observability/tracing/exporters/posthog.mdx +32 -22
  217. package/.docs/raw/observability/tracing/exporters/sentry.mdx +198 -0
  218. package/.docs/raw/observability/tracing/overview.mdx +388 -108
  219. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +27 -7
  220. package/.docs/raw/rag/chunking-and-embedding.mdx +22 -33
  221. package/.docs/raw/rag/graph-rag.mdx +223 -0
  222. package/.docs/raw/rag/overview.mdx +6 -3
  223. package/.docs/raw/rag/retrieval.mdx +53 -57
  224. package/.docs/raw/rag/vector-databases.mdx +55 -31
  225. package/.docs/raw/reference/agents/agent.mdx +17 -14
  226. package/.docs/raw/reference/agents/generate.mdx +172 -44
  227. package/.docs/raw/reference/agents/generateLegacy.mdx +5 -3
  228. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +5 -3
  229. package/.docs/raw/reference/agents/getDefaultOptions.mdx +5 -3
  230. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +5 -3
  231. package/.docs/raw/reference/agents/getDescription.mdx +3 -1
  232. package/.docs/raw/reference/agents/getInstructions.mdx +5 -3
  233. package/.docs/raw/reference/agents/getLLM.mdx +5 -3
  234. package/.docs/raw/reference/agents/getMemory.mdx +5 -3
  235. package/.docs/raw/reference/agents/getModel.mdx +5 -3
  236. package/.docs/raw/reference/agents/getTools.mdx +4 -2
  237. package/.docs/raw/reference/agents/getVoice.mdx +4 -2
  238. package/.docs/raw/reference/agents/listAgents.mdx +4 -2
  239. package/.docs/raw/reference/agents/listScorers.mdx +5 -3
  240. package/.docs/raw/reference/agents/listTools.mdx +4 -2
  241. package/.docs/raw/reference/agents/listWorkflows.mdx +4 -2
  242. package/.docs/raw/reference/agents/network.mdx +113 -1
  243. package/.docs/raw/reference/ai-sdk/chat-route.mdx +6 -3
  244. package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +4 -2
  245. package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +4 -2
  246. package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +5 -3
  247. package/.docs/raw/reference/ai-sdk/network-route.mdx +6 -3
  248. package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +10 -6
  249. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +130 -0
  250. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +110 -0
  251. package/.docs/raw/reference/ai-sdk/with-mastra.mdx +122 -0
  252. package/.docs/raw/reference/ai-sdk/workflow-route.mdx +7 -4
  253. package/.docs/raw/reference/auth/auth0.mdx +5 -3
  254. package/.docs/raw/reference/auth/clerk.mdx +5 -3
  255. package/.docs/raw/reference/auth/firebase.mdx +6 -5
  256. package/.docs/raw/reference/auth/jwt.mdx +5 -3
  257. package/.docs/raw/reference/auth/supabase.mdx +5 -3
  258. package/.docs/raw/reference/auth/workos.mdx +5 -3
  259. package/.docs/raw/reference/cli/create-mastra.mdx +12 -10
  260. package/.docs/raw/reference/cli/mastra.mdx +63 -15
  261. package/.docs/raw/reference/client-js/agents.mdx +77 -35
  262. package/.docs/raw/reference/client-js/error-handling.mdx +3 -3
  263. package/.docs/raw/reference/client-js/logs.mdx +2 -0
  264. package/.docs/raw/reference/client-js/mastra-client.mdx +4 -2
  265. package/.docs/raw/reference/client-js/memory.mdx +43 -1
  266. package/.docs/raw/reference/client-js/observability.mdx +2 -0
  267. package/.docs/raw/reference/client-js/telemetry.mdx +2 -0
  268. package/.docs/raw/reference/client-js/tools.mdx +2 -0
  269. package/.docs/raw/reference/client-js/vectors.mdx +2 -0
  270. package/.docs/raw/reference/client-js/workflows.mdx +47 -3
  271. package/.docs/raw/reference/configuration.mdx +761 -0
  272. package/.docs/raw/reference/core/addGateway.mdx +2 -0
  273. package/.docs/raw/reference/core/getAgent.mdx +3 -1
  274. package/.docs/raw/reference/core/getAgentById.mdx +3 -1
  275. package/.docs/raw/reference/core/getDeployer.mdx +3 -1
  276. package/.docs/raw/reference/core/getGateway.mdx +2 -0
  277. package/.docs/raw/reference/core/getGatewayById.mdx +2 -0
  278. package/.docs/raw/reference/core/getLogger.mdx +3 -1
  279. package/.docs/raw/reference/core/getMCPServer.mdx +3 -1
  280. package/.docs/raw/reference/core/getMCPServerById.mdx +3 -1
  281. package/.docs/raw/reference/core/getMemory.mdx +7 -3
  282. package/.docs/raw/reference/core/getScorer.mdx +2 -0
  283. package/.docs/raw/reference/core/getScorerById.mdx +2 -0
  284. package/.docs/raw/reference/core/getServer.mdx +6 -4
  285. package/.docs/raw/reference/core/getStorage.mdx +5 -3
  286. package/.docs/raw/reference/core/getStoredAgentById.mdx +6 -4
  287. package/.docs/raw/reference/core/getTelemetry.mdx +3 -1
  288. package/.docs/raw/reference/core/getVector.mdx +3 -1
  289. package/.docs/raw/reference/core/getWorkflow.mdx +3 -1
  290. package/.docs/raw/reference/core/listAgents.mdx +3 -1
  291. package/.docs/raw/reference/core/listGateways.mdx +2 -0
  292. package/.docs/raw/reference/core/listLogs.mdx +3 -1
  293. package/.docs/raw/reference/core/listLogsByRunId.mdx +3 -1
  294. package/.docs/raw/reference/core/listMCPServers.mdx +3 -1
  295. package/.docs/raw/reference/core/listMemory.mdx +8 -4
  296. package/.docs/raw/reference/core/listScorers.mdx +2 -0
  297. package/.docs/raw/reference/core/listStoredAgents.mdx +7 -5
  298. package/.docs/raw/reference/core/listVectors.mdx +3 -1
  299. package/.docs/raw/reference/core/listWorkflows.mdx +3 -1
  300. package/.docs/raw/reference/core/mastra-class.mdx +27 -20
  301. package/.docs/raw/reference/core/mastra-model-gateway.mdx +2 -0
  302. package/.docs/raw/reference/core/setLogger.mdx +3 -1
  303. package/.docs/raw/reference/core/setStorage.mdx +6 -4
  304. package/.docs/raw/reference/deployer/cloudflare.mdx +22 -53
  305. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  306. package/.docs/raw/reference/deployer/netlify.mdx +4 -1
  307. package/.docs/raw/reference/deployer/vercel.mdx +5 -4
  308. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -1
  309. package/.docs/raw/reference/evals/answer-similarity.mdx +4 -1
  310. package/.docs/raw/reference/evals/bias.mdx +4 -1
  311. package/.docs/raw/reference/evals/completeness.mdx +4 -1
  312. package/.docs/raw/reference/evals/content-similarity.mdx +4 -1
  313. package/.docs/raw/reference/evals/context-precision.mdx +4 -1
  314. package/.docs/raw/reference/evals/context-relevance.mdx +2 -0
  315. package/.docs/raw/reference/evals/create-scorer.mdx +11 -3
  316. package/.docs/raw/reference/evals/faithfulness.mdx +4 -1
  317. package/.docs/raw/reference/evals/hallucination.mdx +4 -1
  318. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -1
  319. package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
  320. package/.docs/raw/reference/evals/noise-sensitivity.mdx +2 -0
  321. package/.docs/raw/reference/evals/prompt-alignment.mdx +9 -7
  322. package/.docs/raw/reference/evals/run-evals.mdx +3 -1
  323. package/.docs/raw/reference/evals/scorer-utils.mdx +3 -0
  324. package/.docs/raw/reference/evals/textual-difference.mdx +4 -1
  325. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -1
  326. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +25 -23
  327. package/.docs/raw/reference/evals/toxicity.mdx +4 -1
  328. package/.docs/raw/reference/index.mdx +2 -1
  329. package/.docs/raw/reference/logging/pino-logger.mdx +10 -8
  330. package/.docs/raw/reference/memory/clone-utilities.mdx +345 -0
  331. package/.docs/raw/reference/memory/cloneThread.mdx +237 -0
  332. package/.docs/raw/reference/memory/createThread.mdx +6 -4
  333. package/.docs/raw/reference/memory/deleteMessages.mdx +4 -2
  334. package/.docs/raw/reference/memory/getThreadById.mdx +3 -1
  335. package/.docs/raw/reference/memory/listThreads.mdx +187 -0
  336. package/.docs/raw/reference/memory/memory-class.mdx +27 -20
  337. package/.docs/raw/reference/memory/recall.mdx +6 -4
  338. package/.docs/raw/reference/observability/tracing/bridges/otel.mdx +6 -2
  339. package/.docs/raw/reference/observability/tracing/configuration.mdx +51 -0
  340. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +25 -6
  341. package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +23 -2
  342. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +10 -0
  343. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +3 -0
  344. package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx +172 -0
  345. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +10 -0
  346. package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx +139 -0
  347. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +26 -4
  348. package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +10 -0
  349. package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +51 -34
  350. package/.docs/raw/reference/observability/tracing/exporters/posthog.mdx +25 -4
  351. package/.docs/raw/reference/observability/tracing/exporters/sentry.mdx +224 -0
  352. package/.docs/raw/reference/observability/tracing/instances.mdx +2 -0
  353. package/.docs/raw/reference/observability/tracing/interfaces.mdx +20 -0
  354. package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +2 -0
  355. package/.docs/raw/reference/observability/tracing/spans.mdx +2 -0
  356. package/.docs/raw/reference/processors/batch-parts-processor.mdx +4 -2
  357. package/.docs/raw/reference/processors/language-detector.mdx +6 -3
  358. package/.docs/raw/reference/processors/message-history-processor.mdx +5 -2
  359. package/.docs/raw/reference/processors/moderation-processor.mdx +6 -4
  360. package/.docs/raw/reference/processors/pii-detector.mdx +6 -4
  361. package/.docs/raw/reference/processors/processor-interface.mdx +326 -23
  362. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +5 -3
  363. package/.docs/raw/reference/processors/semantic-recall-processor.mdx +7 -2
  364. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +5 -3
  365. package/.docs/raw/reference/processors/token-limiter-processor.mdx +62 -19
  366. package/.docs/raw/reference/processors/tool-call-filter.mdx +5 -3
  367. package/.docs/raw/reference/processors/unicode-normalizer.mdx +6 -3
  368. package/.docs/raw/reference/processors/working-memory-processor.mdx +6 -3
  369. package/.docs/raw/reference/rag/chunk.mdx +7 -6
  370. package/.docs/raw/reference/rag/database-config.mdx +8 -6
  371. package/.docs/raw/reference/rag/document.mdx +2 -0
  372. package/.docs/raw/reference/rag/embeddings.mdx +2 -0
  373. package/.docs/raw/reference/rag/extract-params.mdx +57 -3
  374. package/.docs/raw/reference/rag/graph-rag.mdx +2 -0
  375. package/.docs/raw/reference/rag/metadata-filters.mdx +27 -7
  376. package/.docs/raw/reference/rag/rerank.mdx +2 -0
  377. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -0
  378. package/.docs/raw/reference/server/create-route.mdx +34 -18
  379. package/.docs/raw/reference/server/express-adapter.mdx +27 -51
  380. package/.docs/raw/reference/server/fastify-adapter.mdx +130 -0
  381. package/.docs/raw/reference/server/hono-adapter.mdx +27 -51
  382. package/.docs/raw/reference/server/koa-adapter.mdx +129 -0
  383. package/.docs/raw/reference/server/mastra-server.mdx +52 -34
  384. package/.docs/raw/reference/server/routes.mdx +73 -10
  385. package/.docs/raw/reference/storage/cloudflare-d1.mdx +10 -5
  386. package/.docs/raw/reference/storage/cloudflare.mdx +12 -2
  387. package/.docs/raw/reference/storage/composite.mdx +245 -0
  388. package/.docs/raw/reference/storage/convex.mdx +8 -6
  389. package/.docs/raw/reference/storage/dynamodb.mdx +134 -8
  390. package/.docs/raw/reference/storage/lance.mdx +9 -5
  391. package/.docs/raw/reference/storage/libsql.mdx +76 -54
  392. package/.docs/raw/reference/storage/mongodb.mdx +115 -16
  393. package/.docs/raw/reference/storage/mssql.mdx +11 -6
  394. package/.docs/raw/{server-db/storage.mdx → reference/storage/overview.mdx} +15 -111
  395. package/.docs/raw/reference/storage/postgresql.mdx +228 -83
  396. package/.docs/raw/reference/storage/upstash.mdx +78 -2
  397. package/.docs/raw/reference/streaming/ChunkType.mdx +31 -3
  398. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +67 -6
  399. package/.docs/raw/reference/streaming/agents/stream.mdx +48 -51
  400. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +5 -3
  401. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -1
  402. package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +3 -1
  403. package/.docs/raw/reference/streaming/workflows/stream.mdx +37 -22
  404. package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +6 -4
  405. package/.docs/raw/reference/templates/overview.mdx +3 -2
  406. package/.docs/raw/reference/tools/client.mdx +3 -0
  407. package/.docs/raw/reference/tools/create-tool.mdx +127 -5
  408. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -0
  409. package/.docs/raw/reference/tools/graph-rag-tool.mdx +40 -3
  410. package/.docs/raw/reference/tools/mcp-client.mdx +110 -1
  411. package/.docs/raw/reference/tools/mcp-server.mdx +278 -24
  412. package/.docs/raw/reference/tools/vector-query-tool.mdx +68 -4
  413. package/.docs/raw/reference/vectors/astra.mdx +5 -3
  414. package/.docs/raw/reference/vectors/chroma.mdx +5 -3
  415. package/.docs/raw/reference/vectors/convex.mdx +14 -12
  416. package/.docs/raw/reference/vectors/couchbase.mdx +7 -5
  417. package/.docs/raw/reference/vectors/duckdb.mdx +12 -10
  418. package/.docs/raw/reference/vectors/elasticsearch.mdx +12 -4
  419. package/.docs/raw/reference/vectors/lance.mdx +6 -4
  420. package/.docs/raw/reference/vectors/libsql.mdx +66 -13
  421. package/.docs/raw/reference/vectors/mongodb.mdx +90 -10
  422. package/.docs/raw/reference/vectors/opensearch.mdx +30 -3
  423. package/.docs/raw/reference/vectors/pg.mdx +58 -6
  424. package/.docs/raw/reference/vectors/pinecone.mdx +23 -8
  425. package/.docs/raw/reference/vectors/qdrant.mdx +148 -4
  426. package/.docs/raw/reference/vectors/s3vectors.mdx +8 -6
  427. package/.docs/raw/reference/vectors/turbopuffer.mdx +6 -4
  428. package/.docs/raw/reference/vectors/upstash.mdx +60 -6
  429. package/.docs/raw/reference/vectors/vectorize.mdx +5 -3
  430. package/.docs/raw/reference/voice/azure.mdx +2 -0
  431. package/.docs/raw/reference/voice/cloudflare.mdx +2 -0
  432. package/.docs/raw/reference/voice/composite-voice.mdx +4 -0
  433. package/.docs/raw/reference/voice/deepgram.mdx +2 -0
  434. package/.docs/raw/reference/voice/elevenlabs.mdx +2 -0
  435. package/.docs/raw/reference/voice/google-gemini-live.mdx +3 -0
  436. package/.docs/raw/reference/voice/google.mdx +2 -0
  437. package/.docs/raw/reference/voice/mastra-voice.mdx +2 -0
  438. package/.docs/raw/reference/voice/murf.mdx +2 -0
  439. package/.docs/raw/reference/voice/openai-realtime.mdx +3 -0
  440. package/.docs/raw/reference/voice/openai.mdx +2 -0
  441. package/.docs/raw/reference/voice/playai.mdx +2 -0
  442. package/.docs/raw/reference/voice/sarvam.mdx +2 -0
  443. package/.docs/raw/reference/voice/speechify.mdx +2 -0
  444. package/.docs/raw/reference/voice/voice.addInstructions.mdx +3 -0
  445. package/.docs/raw/reference/voice/voice.addTools.mdx +3 -0
  446. package/.docs/raw/reference/voice/voice.answer.mdx +4 -0
  447. package/.docs/raw/reference/voice/voice.close.mdx +3 -0
  448. package/.docs/raw/reference/voice/voice.connect.mdx +5 -1
  449. package/.docs/raw/reference/voice/voice.events.mdx +2 -0
  450. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +3 -0
  451. package/.docs/raw/reference/voice/voice.listen.mdx +6 -0
  452. package/.docs/raw/reference/voice/voice.off.mdx +2 -0
  453. package/.docs/raw/reference/voice/voice.on.mdx +5 -1
  454. package/.docs/raw/reference/voice/voice.send.mdx +4 -0
  455. package/.docs/raw/reference/voice/voice.speak.mdx +6 -0
  456. package/.docs/raw/reference/voice/voice.updateConfig.mdx +2 -0
  457. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +55 -5
  458. package/.docs/raw/reference/workflows/run-methods/restart.mdx +3 -3
  459. package/.docs/raw/reference/workflows/run-methods/resume.mdx +6 -4
  460. package/.docs/raw/reference/workflows/run-methods/start.mdx +7 -5
  461. package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +145 -0
  462. package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +10 -8
  463. package/.docs/raw/reference/workflows/run.mdx +11 -3
  464. package/.docs/raw/reference/workflows/step.mdx +56 -3
  465. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +3 -1
  466. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +3 -1
  467. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +39 -2
  468. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +3 -1
  469. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +3 -1
  470. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +71 -4
  471. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +9 -7
  472. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +3 -1
  473. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +4 -6
  474. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +4 -6
  475. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +3 -1
  476. package/.docs/raw/reference/workflows/workflow.mdx +193 -2
  477. package/.docs/raw/{auth → server/auth}/auth0.mdx +40 -21
  478. package/.docs/raw/{auth → server/auth}/clerk.mdx +37 -16
  479. package/.docs/raw/{auth → server/auth}/firebase.mdx +47 -25
  480. package/.docs/raw/{auth → server/auth}/index.mdx +8 -6
  481. package/.docs/raw/{auth → server/auth}/jwt.mdx +22 -10
  482. package/.docs/raw/{auth → server/auth}/supabase.mdx +45 -25
  483. package/.docs/raw/{auth → server/auth}/workos.mdx +39 -20
  484. package/.docs/raw/{server-db → server}/custom-adapters.mdx +40 -24
  485. package/.docs/raw/{server-db → server}/custom-api-routes.mdx +6 -6
  486. package/.docs/raw/{server-db → server}/mastra-client.mdx +35 -38
  487. package/.docs/raw/server/mastra-server.mdx +86 -0
  488. package/.docs/raw/{server-db → server}/middleware.mdx +11 -9
  489. package/.docs/raw/{server-db → server}/request-context.mdx +85 -43
  490. package/.docs/raw/{server-db → server}/server-adapters.mdx +154 -33
  491. package/.docs/raw/streaming/events.mdx +16 -7
  492. package/.docs/raw/streaming/overview.mdx +30 -17
  493. package/.docs/raw/streaming/tool-streaming.mdx +8 -6
  494. package/.docs/raw/streaming/workflow-streaming.mdx +8 -8
  495. package/.docs/raw/tools-mcp/advanced-usage.mdx +4 -2
  496. package/.docs/raw/tools-mcp/mcp-overview.mdx +46 -12
  497. package/.docs/raw/tools-mcp/overview.mdx +14 -13
  498. package/.docs/raw/voice/overview.mdx +17 -2
  499. package/.docs/raw/voice/speech-to-speech.mdx +5 -0
  500. package/.docs/raw/voice/speech-to-text.mdx +4 -0
  501. package/.docs/raw/voice/text-to-speech.mdx +3 -0
  502. package/.docs/raw/workflows/agents-and-tools.mdx +70 -21
  503. package/.docs/raw/workflows/control-flow.mdx +369 -34
  504. package/.docs/raw/workflows/error-handling.mdx +192 -18
  505. package/.docs/raw/workflows/human-in-the-loop.mdx +8 -7
  506. package/.docs/raw/workflows/input-data-mapping.mdx +9 -7
  507. package/.docs/raw/workflows/overview.mdx +80 -34
  508. package/.docs/raw/workflows/snapshots.mdx +19 -45
  509. package/.docs/raw/workflows/suspend-and-resume.mdx +14 -14
  510. package/.docs/raw/workflows/time-travel.mdx +25 -21
  511. package/.docs/raw/workflows/workflow-state.mdx +7 -8
  512. package/CHANGELOG.md +260 -0
  513. package/README.md +36 -0
  514. package/dist/index.d.ts.map +1 -1
  515. package/dist/logger.d.ts +3 -0
  516. package/dist/logger.d.ts.map +1 -1
  517. package/dist/stdio.js +746 -49
  518. package/dist/tools/course.d.ts.map +1 -1
  519. package/dist/tools/embedded-docs.d.ts +276 -0
  520. package/dist/tools/embedded-docs.d.ts.map +1 -0
  521. package/package.json +9 -8
  522. package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
  523. package/.docs/raw/deployment/building-mastra.mdx +0 -73
  524. package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
  525. package/.docs/raw/deployment/mastra-cloud/dashboard.mdx +0 -100
  526. package/.docs/raw/deployment/mastra-cloud/observability.mdx +0 -53
  527. package/.docs/raw/deployment/mastra-cloud/overview.mdx +0 -65
  528. package/.docs/raw/deployment/mastra-cloud/setting-up.mdx +0 -105
  529. package/.docs/raw/memory/conversation-history.mdx +0 -24
  530. package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
  531. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
  532. package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
  533. package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
  534. package/.docs/raw/memory/threads-and-resources.mdx +0 -95
  535. package/.docs/raw/reference/core/setTelemetry.mdx +0 -36
  536. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +0 -110
  537. package/.docs/raw/reference/memory/query.mdx +0 -189
  538. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
  539. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
  540. package/.docs/raw/server-db/mastra-server.mdx +0 -97
  541. package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
@@ -1,16 +1,17 @@
1
1
  ---
2
2
  title: "Reference: Mastra Class | Core"
3
3
  description: "Documentation for the `Mastra` class in Mastra, the core entry point for managing agents, workflows, MCP servers, and server endpoints."
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/libsql"
7
+ - "@mastra/loggers"
4
8
  ---
5
9
 
6
10
  # Mastra Class
7
11
 
8
- The `Mastra` class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, telemetry, and more. Typically, you create a single instance of `Mastra` to coordinate your application.
12
+ The `Mastra` class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, observability, and more. Typically, you create a single instance of `Mastra` to coordinate your application.
9
13
 
10
- Think of `Mastra` as a top-level registry:
11
-
12
- - Registering **integrations** makes them accessible to **agents**, **workflows**, and **tools** alike.
13
- - **tools** aren’t registered on `Mastra` directly but are associated with agents and discovered automatically.
14
+ Think of `Mastra` as a top-level registry where you register agents, workflows, tools, and other components that need to be accessible throughout your application.
14
15
 
15
16
  ## Usage example
16
17
 
@@ -37,14 +38,16 @@ export const mastra = new Mastra({
37
38
 
38
39
  ## Constructor parameters
39
40
 
41
+ Visit the [Configuration reference](/reference/v1/configuration) for detailed documentation on all available configuration options.
42
+
40
43
  <PropertiesTable
41
44
  content={[
42
45
  {
43
46
  name: "agents",
44
- type: "Agent[]",
45
- description: "Array of Agent instances to register",
47
+ type: "Record<string, Agent>",
48
+ description: "Agent instances to register, keyed by name",
46
49
  isOptional: true,
47
- defaultValue: "[]",
50
+ defaultValue: "{}",
48
51
  },
49
52
  {
50
53
  name: "tools",
@@ -56,7 +59,7 @@ export const mastra = new Mastra({
56
59
  },
57
60
  {
58
61
  name: "storage",
59
- type: "MastraStorage",
62
+ type: "MastraCompositeStore",
60
63
  description: "Storage engine instance for persisting data",
61
64
  isOptional: true,
62
65
  },
@@ -91,15 +94,15 @@ export const mastra = new Mastra({
91
94
  },
92
95
  {
93
96
  name: "tts",
94
- type: "Record<string, MastraTTS>",
97
+ type: "Record<string, MastraVoice>",
95
98
  isOptional: true,
96
- description: "An object for registering Text-To-Speech services.",
99
+ description: "Text-to-speech providers for voice synthesis",
97
100
  },
98
101
  {
99
- name: "telemetry",
100
- type: "OtelConfig",
102
+ name: "observability",
103
+ type: "ObservabilityEntrypoint",
101
104
  isOptional: true,
102
- description: "Configuration for OpenTelemetry integration.",
105
+ description: "Observability configuration for tracing and monitoring",
103
106
  },
104
107
  {
105
108
  name: "deployer",
@@ -113,8 +116,6 @@ export const mastra = new Mastra({
113
116
  description:
114
117
  "Server configuration including port, host, timeout, API routes, middleware, CORS settings, and build options for Swagger UI, API request logging, and OpenAPI docs.",
115
118
  isOptional: true,
116
- defaultValue:
117
- "{ port: 4111, host: localhost, cors: { origin: '*', allowMethods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'], allowHeaders: ['Content-Type', 'Authorization', 'x-mastra-client-type'], exposeHeaders: ['Content-Length', 'X-Requested-With'], credentials: false } }",
118
119
  },
119
120
  {
120
121
  name: "mcpServers",
@@ -129,14 +130,20 @@ export const mastra = new Mastra({
129
130
  description:
130
131
  "Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.",
131
132
  isOptional: true,
132
- defaultValue:
133
- "{ externals: [], sourcemap: false, transpilePackages: [] }",
134
133
  },
135
134
  {
136
135
  name: "scorers",
137
- type: "Record<string, MastraScorer>",
136
+ type: "Record<string, Scorer>",
137
+ description:
138
+ "Scorers for evaluating agent responses and workflow outputs",
139
+ isOptional: true,
140
+ defaultValue: "{}",
141
+ },
142
+ {
143
+ name: "processors",
144
+ type: "Record<string, Processor>",
138
145
  description:
139
- "Scorers to register for scoring traces and overriding default scorers used during agent generation or workflow execution. Structured as a key-value pair, with keys being the scorer name and values being the scorer instance.",
146
+ "Input/output processors for transforming agent inputs and outputs",
140
147
  isOptional: true,
141
148
  defaultValue: "{}",
142
149
  },
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: MastraModelGateway | Core"
3
3
  description: "Base class for creating custom model gateways"
4
+ packages:
5
+ - "@mastra/core"
4
6
  ---
5
7
 
6
8
  # MastraModelGateway
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Mastra.setLogger() | Core"
3
3
  description: "Documentation for the `Mastra.setLogger()` method in Mastra, which sets the logger for all components (agents, workflows, etc.)."
4
+ packages:
5
+ - "@mastra/core"
4
6
  ---
5
7
 
6
8
  # Mastra.setLogger()
@@ -9,7 +11,7 @@ The `.setLogger()` method is used to set the logger for all components (agents,
9
11
 
10
12
  ## Usage example
11
13
 
12
- ```typescript copy
14
+ ```typescript
13
15
  mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
14
16
  ```
15
17
 
@@ -1,15 +1,17 @@
1
1
  ---
2
2
  title: "Reference: Mastra.setStorage() | Core"
3
3
  description: "Documentation for the `Mastra.setStorage()` method in Mastra, which sets the storage instance for the Mastra instance."
4
+ packages:
5
+ - "@mastra/core"
4
6
  ---
5
7
 
6
8
  # Mastra.setStorage()
7
9
 
8
- The `.setStorage()` method is used to set the storage instance for the Mastra instance. This method accepts a single `MastraStorage` parameter.
10
+ The `.setStorage()` method is used to set the storage instance for the Mastra instance. This method accepts a single `MastraCompositeStore` parameter.
9
11
 
10
12
  ## Usage example
11
13
 
12
- ```typescript copy
14
+ ```typescript
13
15
  mastra.setStorage(
14
16
  new LibSQLStore({
15
17
  id: 'mastra-storage',
@@ -24,7 +26,7 @@ mastra.setStorage(
24
26
  content={[
25
27
  {
26
28
  name: "storage",
27
- type: "MastraStorage",
29
+ type: "MastraCompositeStore",
28
30
  description: "The storage instance to set for the Mastra instance.",
29
31
  },
30
32
  ]}
@@ -36,5 +38,5 @@ This method does not return a value.
36
38
 
37
39
  ## Related
38
40
 
39
- - [Storage overview](/docs/v1/server-db/storage)
41
+ - [Storage overview](/reference/v1/storage/overview)
40
42
  - [Storage reference](/reference/v1/storage/libsql)
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: CloudflareDeployer | Deployer"
3
3
  description: "Documentation for the CloudflareDeployer class, which deploys Mastra applications to Cloudflare Workers."
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/deployer-cloudflare"
4
7
  ---
5
8
 
6
9
  # CloudflareDeployer
@@ -9,14 +12,13 @@ The `CloudflareDeployer` class handles deployment of standalone Mastra applicati
9
12
 
10
13
  ## Usage example
11
14
 
12
- ```typescript title="src/mastra/index.ts" showLineNumbers copy
15
+ ```typescript title="src/mastra/index.ts"
13
16
  import { Mastra } from "@mastra/core";
14
17
  import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
15
18
 
16
19
  export const mastra = new Mastra({
17
- // ...
18
20
  deployer: new CloudflareDeployer({
19
- projectName: "hello-mastra",
21
+ name: "hello-mastra",
20
22
  routes: [
21
23
  {
22
24
  pattern: "example.com/*",
@@ -24,12 +26,11 @@ export const mastra = new Mastra({
24
26
  custom_domain: true
25
27
  }
26
28
  ],
27
- workerNamespace: "my-namespace",
28
- env: {
29
+ vars: {
29
30
  NODE_ENV: "production",
30
31
  API_KEY: "<api-key>"
31
32
  },
32
- d1Databases: [
33
+ d1_databases: [
33
34
  {
34
35
  binding: "DB",
35
36
  database_name: "my-database",
@@ -37,59 +38,27 @@ export const mastra = new Mastra({
37
38
  preview_database_id: "your-preview-database-id"
38
39
  }
39
40
  ],
40
- kvNamespaces: [
41
+ kv_namespaces: [
41
42
  {
42
43
  binding: "CACHE",
43
44
  id: "kv-namespace-id"
44
45
  }
45
46
  ]
47
+ })
46
48
  });
47
49
  ```
48
50
 
49
- ## Parameters
51
+ ## Constructor options
50
52
 
51
- <PropertiesTable
52
- content={[
53
- {
54
- name: "projectName",
55
- type: "string",
56
- description: "Name of your worker project.",
57
- isOptional: true,
58
- defaultValue: "'mastra'",
59
- },
60
- {
61
- name: "routes",
62
- type: "CFRoute[]",
63
- description:
64
- "Array of route configurations for your worker. Each route requires: pattern (string), zone_name (string), custom_domain (boolean, optional).",
65
- isOptional: true,
66
- },
67
- {
68
- name: "workerNamespace",
69
- type: "string",
70
- description: "Namespace for your worker.",
71
- isOptional: true,
72
- },
73
- {
74
- name: "env",
75
- type: "Record<string, any>",
76
- description:
77
- "Environment variables to be included in the worker configuration.",
78
- isOptional: true,
79
- },
80
- {
81
- name: "d1Databases",
82
- type: "D1DatabaseBinding[]",
83
- description:
84
- "Array of D1 database bindings. Each binding requires: binding (string), database_name (string), database_id (string), preview_database_id (string, optional).",
85
- isOptional: true,
86
- },
87
- {
88
- name: "kvNamespaces",
89
- type: "KVNamespaceBinding[]",
90
- description:
91
- "Array of KV namespace bindings. Each binding requires: binding (string), id (string).",
92
- isOptional: true,
93
- },
94
- ]}
95
- />
53
+ The `CloudflareDeployer` constructor accepts the same configuration options as `wrangler.json`. See the [Wrangler configuration documentation](https://developers.cloudflare.com/workers/wrangler/configuration/) for all available options.
54
+
55
+ ### Migrating from earlier versions
56
+
57
+ The following fields are deprecated and should be replaced with their standard `wrangler.json` equivalents:
58
+
59
+ | Deprecated | Use instead |
60
+ |------------|-------------|
61
+ | `projectName` | `name` |
62
+ | `d1Databases` | `d1_databases` |
63
+ | `kvNamespaces` | `kv_namespaces` |
64
+ | `workerNamespace` | *(removed, no longer used)* |
@@ -2,6 +2,8 @@
2
2
  title: "Reference: Deployer | Deployer"
3
3
  description: Documentation for the Deployer abstract class, which handles packaging and deployment of Mastra applications.
4
4
  asIndexPage: true
5
+ packages:
6
+ - "@mastra/deployer"
5
7
  ---
6
8
 
7
9
  # Deployer
@@ -28,7 +30,6 @@ class CustomDeployer extends Deployer {
28
30
  await this._bundle("server.ts", "mastra.ts", outputDirectory);
29
31
 
30
32
  // Custom deployment logic
31
- // ...
32
33
  }
33
34
  }
34
35
  ```
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: NetlifyDeployer | Deployer"
3
3
  description: "Documentation for the NetlifyDeployer class, which deploys Mastra applications to Netlify Functions."
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/deployer-netlify"
4
7
  ---
5
8
 
6
9
  # NetlifyDeployer
@@ -9,7 +12,7 @@ The `NetlifyDeployer` class handles deployment of standalone Mastra applications
9
12
 
10
13
  ## Usage example
11
14
 
12
- ```typescript title="src/mastra/index.ts" copy
15
+ ```typescript title="src/mastra/index.ts"
13
16
  import { Mastra } from "@mastra/core";
14
17
  import { NetlifyDeployer } from "@mastra/deployer-netlify";
15
18
 
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: VercelDeployer | Deployer"
3
3
  description: "Documentation for the VercelDeployer class, which deploys Mastra applications to Vercel."
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/deployer-vercel"
4
7
  ---
5
8
 
6
9
  # VercelDeployer
@@ -9,12 +12,11 @@ The `VercelDeployer` class handles deployment of standalone Mastra applications
9
12
 
10
13
  ## Usage example
11
14
 
12
- ```typescript title="src/mastra/index.ts" showLineNumbers copy
15
+ ```typescript title="src/mastra/index.ts"
13
16
  import { Mastra } from "@mastra/core";
14
17
  import { VercelDeployer } from "@mastra/deployer-vercel";
15
18
 
16
19
  export const mastra = new Mastra({
17
- // ...
18
20
  deployer: new VercelDeployer(),
19
21
  });
20
22
  ```
@@ -31,12 +33,11 @@ These options are merged into `.vercel/output/functions/index.func/.vc-config.js
31
33
 
32
34
  ### Example with overrides
33
35
 
34
- ```typescript title="src/mastra/index.ts" showLineNumbers copy
36
+ ```typescript title="src/mastra/index.ts"
35
37
  import { Mastra } from "@mastra/core";
36
38
  import { VercelDeployer } from "@mastra/deployer-vercel";
37
39
 
38
40
  export const mastra = new Mastra({
39
- // ...
40
41
  deployer: new VercelDeployer({
41
42
  maxDuration: 600,
42
43
  memory: 1536,
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Answer Relevancy Scorer | Evals"
3
3
  description: Documentation for the Answer Relevancy Scorer in Mastra, which evaluates how well LLM outputs address the input query.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Answer Relevancy Scorer
@@ -116,7 +119,7 @@ A relevancy score between 0 and 1:
116
119
 
117
120
  Evaluate agent responses for relevancy across different scenarios:
118
121
 
119
- ```typescript title="src/example-answer-relevancy.ts" showLineNumbers copy
122
+ ```typescript title="src/example-answer-relevancy.ts"
120
123
  import { runEvals } from "@mastra/core/evals";
121
124
  import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/prebuilt";
122
125
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Answer Similarity Scorer | Evals"
3
3
  description: Documentation for the Answer Similarity Scorer in Mastra, which compares agent outputs against ground truth answers for CI/CD testing.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Answer Similarity Scorer
@@ -153,7 +156,7 @@ Score calculation: `max(0, base_score - contradiction_penalty - missing_penalty
153
156
 
154
157
  Evaluate agent responses for similarity to ground truth across different scenarios:
155
158
 
156
- ```typescript title="src/example-answer-similarity.ts" showLineNumbers copy
159
+ ```typescript title="src/example-answer-similarity.ts"
157
160
  import { runEvals } from "@mastra/core/evals";
158
161
  import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/prebuilt";
159
162
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Bias Scorer | Evals"
3
3
  description: Documentation for the Bias Scorer in Mastra, which evaluates LLM outputs for various forms of bias, including gender, political, racial/ethnic, or geographical bias.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Bias Scorer
@@ -127,7 +130,7 @@ A bias score between 0 and 1:
127
130
 
128
131
  Evaluate agent responses for bias across different types of questions:
129
132
 
130
- ```typescript title="src/example-bias.ts" showLineNumbers copy
133
+ ```typescript title="src/example-bias.ts"
131
134
  import { runEvals } from "@mastra/core/evals";
132
135
  import { createBiasScorer } from "@mastra/evals/scorers/prebuilt";
133
136
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Completeness Scorer | Evals"
3
3
  description: Documentation for the Completeness Scorer in Mastra, which evaluates how thoroughly LLM outputs cover key elements present in the input.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Completeness Scorer
@@ -109,7 +112,7 @@ A completeness score between 0 and 1:
109
112
 
110
113
  Evaluate agent responses for completeness across different query complexities:
111
114
 
112
- ```typescript title="src/example-completeness.ts" showLineNumbers copy
115
+ ```typescript title="src/example-completeness.ts"
113
116
  import { runEvals } from "@mastra/core/evals";
114
117
  import { createCompletenessScorer } from "@mastra/evals/scorers/prebuilt";
115
118
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Content Similarity Scorer | Evals"
3
3
  description: Documentation for the Content Similarity Scorer in Mastra, which measures textual similarity between strings and provides a matching score.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Content Similarity Scorer
@@ -82,7 +85,7 @@ Final score: `similarity_value * scale`
82
85
 
83
86
  Evaluate textual similarity between expected and actual agent outputs:
84
87
 
85
- ```typescript title="src/example-content-similarity.ts" showLineNumbers copy
88
+ ```typescript title="src/example-content-similarity.ts"
86
89
  import { runEvals } from "@mastra/core/evals";
87
90
  import { createContentSimilarityScorer } from "@mastra/evals/scorers/prebuilt";
88
91
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Context Precision Scorer | Evals"
3
3
  description: Documentation for the Context Precision Scorer in Mastra. Evaluates the relevance and precision of retrieved context for generating expected outputs using Mean Average Precision.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -190,7 +193,7 @@ const scorer = createContextPrecisionScorer({
190
193
 
191
194
  Evaluate RAG system context retrieval precision for different queries:
192
195
 
193
- ```typescript title="src/example-context-precision.ts" showLineNumbers copy
196
+ ```typescript title="src/example-context-precision.ts"
194
197
  import { runEvals } from "@mastra/core/evals";
195
198
  import { createContextPrecisionScorer } from "@mastra/evals/scorers/prebuilt";
196
199
  import { myAgent } from "./agent";
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Context Relevance Scorer | Evals"
3
3
  description: Documentation for the Context Relevance Scorer in Mastra. Evaluates the relevance and utility of provided context for generating agent responses using weighted relevance scoring.
4
+ packages:
5
+ - "@mastra/evals"
4
6
  ---
5
7
 
6
8
  import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: createScorer | Evals"
3
3
  description: Documentation for creating custom scorers in Mastra, allowing users to define their own evaluation logic using either JavaScript functions or LLM-based prompts.
4
+ packages:
5
+ - "@mastra/core"
4
6
  ---
5
7
 
6
8
  # createScorer
@@ -11,6 +13,8 @@ Mastra provides a unified `createScorer` factory that allows you to define custo
11
13
 
12
14
  Use the `createScorer` factory to define your scorer with a name, description, and optional judge configuration. Then chain step methods to build your evaluation pipeline. You must provide at least a `generateScore` step.
13
15
 
16
+ **Prompt object steps** are step configurations expressed as objects with `description` + `createPrompt` (and `outputSchema` for `preprocess`/`analyze`). These steps invoke the judge LLM. **Function steps** are plain functions and never call the judge.
17
+
14
18
  ```typescript
15
19
  import { createScorer } from "@mastra/core/evals";
16
20
 
@@ -98,6 +102,10 @@ This function returns a scorer builder that you can chain step methods onto. See
98
102
  ]}
99
103
  />
100
104
 
105
+ The judge only runs for steps defined as **prompt objects** (`preprocess`, `analyze`, `generateScore`, `generateReason` in prompt mode). If you use function steps only, the judge is never called and there is no LLM output to inspect. In that case, any score/reason must be produced by your functions.
106
+
107
+ When a prompt-object step runs, its structured LLM output is stored in the corresponding result field (`preprocessStepResult`, `analyzeStepResult`, or the value consumed by `calculateScore` in `generateScore`).
108
+
101
109
  ## Type Safety
102
110
 
103
111
  You can specify input/output types when creating scorers for better type inference and IntelliSense support:
@@ -111,7 +119,7 @@ import { createScorer } from "@mastra/core/evals";
111
119
 
112
120
  // Agent scorer with automatic typing
113
121
  const agentScorer = createScorer({
114
- name: "Agent Response Quality",
122
+ id: "agent-response-quality",
115
123
  description: "Evaluates agent responses",
116
124
  type: "agent", // Automatically provides ScorerRunInputForAgent/ScorerRunOutputForAgent
117
125
  })
@@ -138,7 +146,7 @@ type CustomInput = { query: string; context: string[] };
138
146
  type CustomOutput = { answer: string; confidence: number };
139
147
 
140
148
  const customScorer = createScorer<CustomInput, CustomOutput>({
141
- name: "Custom Scorer",
149
+ id: "custom-scorer",
142
150
  description: "Evaluates custom data",
143
151
  }).generateScore(({ run }) => {
144
152
  // run.input is typed as CustomInput
@@ -160,7 +168,7 @@ When you use `type: 'agent'`, your scorer is compatible for both adding directly
160
168
 
161
169
  ```typescript
162
170
  const agentTraceScorer = createScorer({
163
- name: "Agent Trace Length",
171
+ id: "agent-trace-length",
164
172
  description: "Evaluates agent response length",
165
173
  type: "agent",
166
174
  }).generateScore(({ run }) => {
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Faithfulness Scorer | Evals"
3
3
  description: Documentation for the Faithfulness Scorer in Mastra, which evaluates the factual accuracy of LLM outputs compared to the provided context.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Faithfulness Scorer
@@ -126,7 +129,7 @@ A faithfulness score between 0 and 1:
126
129
 
127
130
  Evaluate agent responses for faithfulness to provided context:
128
131
 
129
- ```typescript title="src/example-faithfulness.ts" showLineNumbers copy
132
+ ```typescript title="src/example-faithfulness.ts"
130
133
  import { runEvals } from "@mastra/core/evals";
131
134
  import { createFaithfulnessScorer } from "@mastra/evals/scorers/prebuilt";
132
135
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Hallucination Scorer | Evals"
3
3
  description: Documentation for the Hallucination Scorer in Mastra, which evaluates the factual correctness of LLM outputs by identifying contradictions with provided context.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Hallucination Scorer
@@ -135,7 +138,7 @@ A hallucination score between 0 and 1:
135
138
 
136
139
  Evaluate agent responses for hallucinations against provided context:
137
140
 
138
- ```typescript title="src/example-hallucination.ts" showLineNumbers copy
141
+ ```typescript title="src/example-hallucination.ts"
139
142
  import { runEvals } from "@mastra/core/evals";
140
143
  import { createHallucinationScorer } from "@mastra/evals/scorers/prebuilt";
141
144
  import { myAgent } from "./agent";
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Keyword Coverage Scorer | Evals"
3
3
  description: Documentation for the Keyword Coverage Scorer in Mastra, which evaluates how well LLM outputs cover important keywords from the input.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/evals"
4
7
  ---
5
8
 
6
9
  # Keyword Coverage Scorer
@@ -106,7 +109,7 @@ The scorer handles several special cases:
106
109
 
107
110
  Evaluate keyword coverage between input queries and agent responses:
108
111
 
109
- ```typescript title="src/example-keyword-coverage.ts" showLineNumbers copy
112
+ ```typescript title="src/example-keyword-coverage.ts"
110
113
  import { runEvals } from "@mastra/core/evals";
111
114
  import { createKeywordCoverageScorer } from "@mastra/evals/scorers/prebuilt";
112
115
  import { myAgent } from "./agent";
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: MastraScorer | Evals"
3
3
  description: Documentation for the MastraScorer base class in Mastra, which provides the foundation for all custom and built-in scorers.
4
+ packages:
5
+ - "@mastra/core"
4
6
  ---
5
7
 
6
8
  # MastraScorer
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Noise Sensitivity Scorer | Evals"
3
3
  description: Documentation for the Noise Sensitivity Scorer in Mastra. A CI/testing scorer that evaluates agent robustness by comparing responses between clean and noisy inputs in controlled test environments.
4
+ packages:
5
+ - "@mastra/evals"
4
6
  ---
5
7
 
6
8
  import PropertiesTable from "@site/src/components/PropertiesTable";