@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.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 (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 +40 -0
  4. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
  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 +299 -299
  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 +662 -200
  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 +3359 -289
  18. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +60 -60
  19. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +289 -289
  20. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +90 -90
  21. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +74 -74
  22. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +70 -70
  23. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +248 -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 +247 -247
  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 +655 -248
  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 +850 -239
  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 +215 -215
  65. package/.docs/organized/changelogs/mastra.md +278 -278
  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 +246 -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,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: createRoute() | Server"
3
3
  description: "API reference for createRoute() function used to define type-safe routes with validation and OpenAPI generation."
4
+ packages:
5
+ - "@mastra/server"
4
6
  ---
5
7
 
6
8
  import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -11,13 +13,13 @@ The `createRoute()` function creates type-safe routes with Zod validation. When
11
13
 
12
14
  ## Import
13
15
 
14
- ```typescript copy
15
- import { createRoute } from '@mastra/server';
16
+ ```typescript
17
+ import { createRoute } from '@mastra/server/server-adapter';
16
18
  ```
17
19
 
18
20
  ## Signature
19
21
 
20
- ```typescript copy
22
+ ```typescript
21
23
  function createRoute<TPath, TQuery, TBody, TResponse, TResponseType>(
22
24
  config: RouteConfig<TPath, TQuery, TBody, TResponse, TResponseType>
23
25
  ): ServerRoute
@@ -118,7 +120,7 @@ function createRoute<TPath, TQuery, TBody, TResponse, TResponseType>(
118
120
 
119
121
  The handler receives validated parameters plus runtime context:
120
122
 
121
- ```typescript copy showLineNumbers
123
+ ```typescript
122
124
  handler: async (params) => {
123
125
  // From schemas (typed from Zod)
124
126
  params.id; // From pathParamSchema
@@ -142,8 +144,8 @@ Returns a `ServerRoute` object that can be registered with an adapter.
142
144
 
143
145
  ### GET route with path params
144
146
 
145
- ```typescript copy showLineNumbers
146
- import { createRoute } from '@mastra/server';
147
+ ```typescript
148
+ import { createRoute } from '@mastra/server/server-adapter';
147
149
  import { z } from 'zod';
148
150
 
149
151
  const getAgent = createRoute({
@@ -167,7 +169,7 @@ const getAgent = createRoute({
167
169
 
168
170
  ### POST route with body
169
171
 
170
- ```typescript copy showLineNumbers
172
+ ```typescript
171
173
  const createItem = createRoute({
172
174
  method: 'POST',
173
175
  path: '/api/items',
@@ -190,7 +192,7 @@ const createItem = createRoute({
190
192
 
191
193
  ### Query params with coercion
192
194
 
193
- ```typescript copy showLineNumbers
195
+ ```typescript
194
196
  const listItems = createRoute({
195
197
  method: 'GET',
196
198
  path: '/api/items',
@@ -209,7 +211,7 @@ const listItems = createRoute({
209
211
 
210
212
  ### Streaming route
211
213
 
212
- ```typescript copy showLineNumbers
214
+ ```typescript
213
215
  const streamAgent = createRoute({
214
216
  method: 'POST',
215
217
  path: '/api/agents/:agentId/stream',
@@ -223,14 +225,14 @@ const streamAgent = createRoute({
223
225
  }),
224
226
  handler: async ({ agentId, messages, mastra, abortSignal }) => {
225
227
  const agent = mastra.getAgent(agentId);
226
- return agent.stream({ messages, abortSignal });
228
+ return agent.stream(messages, { abortSignal });
227
229
  },
228
230
  });
229
231
  ```
230
232
 
231
233
  ### Custom body size limit
232
234
 
233
- ```typescript copy showLineNumbers
235
+ ```typescript
234
236
  const uploadRoute = createRoute({
235
237
  method: 'POST',
236
238
  path: '/api/upload',
@@ -249,7 +251,7 @@ const uploadRoute = createRoute({
249
251
 
250
252
  ### Passthrough for extensibility
251
253
 
252
- ```typescript copy
254
+ ```typescript
253
255
  const bodySchema = z.object({
254
256
  required: z.string(),
255
257
  }).passthrough(); // Allow unknown fields
@@ -257,7 +259,7 @@ const bodySchema = z.object({
257
259
 
258
260
  ### Date coercion
259
261
 
260
- ```typescript copy
262
+ ```typescript
261
263
  const querySchema = z.object({
262
264
  fromDate: z.coerce.date().optional(),
263
265
  toDate: z.coerce.date().optional(),
@@ -266,7 +268,7 @@ const querySchema = z.object({
266
268
 
267
269
  ### Union types
268
270
 
269
- ```typescript copy
271
+ ```typescript
270
272
  const bodySchema = z.object({
271
273
  messages: z.union([
272
274
  z.array(z.any()),
@@ -277,10 +279,11 @@ const bodySchema = z.object({
277
279
 
278
280
  ## Error handling
279
281
 
280
- Throw `HTTPException` to return specific HTTP status codes from handlers:
282
+ Throw an error with a `status` property to return specific HTTP status codes from handlers. If using Hono, you can use `HTTPException` from `hono/http-exception`:
281
283
 
282
- ```typescript copy showLineNumbers
283
- import { createRoute, HTTPException } from '@mastra/server';
284
+ ```typescript
285
+ import { createRoute } from '@mastra/server/server-adapter';
286
+ import { HTTPException } from 'hono/http-exception';
284
287
 
285
288
  const getAgent = createRoute({
286
289
  method: 'GET',
@@ -297,6 +300,19 @@ const getAgent = createRoute({
297
300
  });
298
301
  ```
299
302
 
303
+ For Express or framework-agnostic code, throw an error with a `status` property:
304
+
305
+ ```typescript
306
+ class HttpError extends Error {
307
+ constructor(public status: number, message: string) {
308
+ super(message);
309
+ }
310
+ }
311
+
312
+ // In handler:
313
+ throw new HttpError(404, `Agent '${agentId}' not found`);
314
+ ```
315
+
300
316
  Common status codes:
301
317
 
302
318
  | Code | Meaning |
@@ -311,4 +327,4 @@ Common status codes:
311
327
 
312
328
  - [Server Routes](/reference/v1/server/routes) - Default Mastra routes
313
329
  - [MastraServer](/reference/v1/server/mastra-server) - Server adapter class
314
- - [Server Adapters](/docs/v1/server-db/server-adapters) - Using adapters
330
+ - [Server Adapters](/docs/v1/server/server-adapters) - Using adapters
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Express Adapter | Server"
3
3
  description: "API reference for the @mastra/express server adapter."
4
+ packages:
5
+ - "@mastra/express"
4
6
  ---
5
7
 
6
8
  import Steps from "@site/src/components/Steps";
@@ -13,29 +15,21 @@ The `@mastra/express` package provides a server adapter for running Mastra with
13
15
 
14
16
  :::info
15
17
 
16
- For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server-db/server-adapters).
18
+ For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server/server-adapters).
17
19
 
18
20
  :::
19
21
 
20
22
  ## Installation
21
23
 
22
- <Steps>
23
-
24
- <StepItem>
25
-
26
24
  Install the Express adapter and Express framework:
27
25
 
28
- ```bash copy
29
- npm install @mastra/express express
26
+ ```bash
27
+ npm install @mastra/express@beta express
30
28
  ```
31
29
 
32
- </StepItem>
33
-
34
- <StepItem>
35
-
36
- Create your server file:
30
+ ## Usage example
37
31
 
38
- ```typescript title="server.ts" copy showLineNumbers
32
+ ```typescript title="server.ts"
39
33
  import express from 'express';
40
34
  import { MastraServer } from '@mastra/express';
41
35
  import { mastra } from './mastra';
@@ -51,43 +45,12 @@ app.listen(4111, () => {
51
45
  });
52
46
  ```
53
47
 
54
- </StepItem>
55
-
56
- </Steps>
57
-
58
48
  :::note
59
49
 
60
50
  Express requires `express.json()` middleware for JSON body parsing. Add it before creating the `MastraServer`.
61
51
 
62
52
  :::
63
53
 
64
- ## Full example
65
-
66
- ```typescript title="server.ts" copy showLineNumbers
67
- import express from 'express';
68
- import { MastraServer } from '@mastra/express';
69
- import { mastra } from './mastra';
70
-
71
- const app = express();
72
- app.use(express.json());
73
-
74
- const server = new MastraServer({
75
- app,
76
- mastra,
77
- prefix: '/api/v2',
78
- openapiPath: '/openapi.json',
79
- bodyLimitOptions: {
80
- maxSize: 10 * 1024 * 1024, // 10MB
81
- onError: (err) => ({ error: 'Payload too large', maxSize: '10MB' }),
82
- },
83
- streamOptions: { redact: true },
84
- });
85
-
86
- await server.init();
87
-
88
- app.listen(4111);
89
- ```
90
-
91
54
  ## Constructor parameters
92
55
 
93
56
  <PropertiesTable
@@ -116,6 +79,7 @@ app.listen(4111);
116
79
  type: "string",
117
80
  description: "Path to serve OpenAPI spec (e.g., `/openapi.json`)",
118
81
  isOptional: true,
82
+ defaultValue: "''",
119
83
  },
120
84
  {
121
85
  name: "bodyLimitOptions",
@@ -136,6 +100,18 @@ app.listen(4111);
136
100
  description: "Per-route auth overrides. Keys are `METHOD:PATH` (e.g., `GET:/api/health`). Value `false` makes route public, `true` requires auth.",
137
101
  isOptional: true,
138
102
  },
103
+ {
104
+ name: "tools",
105
+ type: "Record<string, Tool>",
106
+ description: "Available tools for the server",
107
+ isOptional: true,
108
+ },
109
+ {
110
+ name: "taskStore",
111
+ type: "InMemoryTaskStore",
112
+ description: "Task store for A2A (Agent-to-Agent) operations",
113
+ isOptional: true,
114
+ },
139
115
  ]}
140
116
  />
141
117
 
@@ -153,7 +129,7 @@ app.listen(4111);
153
129
 
154
130
  Add routes directly to the Express app:
155
131
 
156
- ```typescript title="server.ts" copy showLineNumbers
132
+ ```typescript title="server.ts"
157
133
  const app = express();
158
134
  app.use(express.json());
159
135
 
@@ -183,7 +159,7 @@ Routes added before `init()` run without Mastra context. Add routes after `init(
183
159
 
184
160
  In Express middleware and routes, access Mastra context via `res.locals`:
185
161
 
186
- ```typescript copy showLineNumbers
162
+ ```typescript
187
163
  app.get('/custom', (req, res) => {
188
164
  const mastra = res.locals.mastra;
189
165
  const requestContext = res.locals.requestContext;
@@ -202,13 +178,15 @@ Available properties on `res.locals`:
202
178
  | `requestContext` | Request context map |
203
179
  | `abortSignal` | Request cancellation signal |
204
180
  | `tools` | Available tools |
181
+ | `taskStore` | Task store for A2A operations |
182
+ | `customRouteAuthConfig` | Per-route auth overrides |
205
183
  | `user` | Authenticated user (if auth configured) |
206
184
 
207
185
  ## Adding middleware
208
186
 
209
187
  Add Express middleware before or after `init()`:
210
188
 
211
- ```typescript title="server.ts" copy showLineNumbers
189
+ ```typescript title="server.ts"
212
190
  const app = express();
213
191
  app.use(express.json());
214
192
 
@@ -224,14 +202,13 @@ await server.init();
224
202
  // Middleware after init has access to Mastra context
225
203
  app.use((req, res, next) => {
226
204
  const mastra = res.locals.mastra;
227
- // ...
228
205
  next();
229
206
  });
230
207
  ```
231
208
 
232
209
  ## Manual initialization
233
210
 
234
- For custom middleware ordering, call each method separately instead of `init()`. See [Server Adapters: Manual initialization](/docs/v1/server-db/server-adapters#manual-initialization) for details.
211
+ For custom middleware ordering, call each method separately instead of `init()`. See [manual initialization](/docs/v1/server/server-adapters#manual-initialization) for details.
235
212
 
236
213
  ## Examples
237
214
 
@@ -239,7 +216,6 @@ For custom middleware ordering, call each method separately instead of `init()`.
239
216
 
240
217
  ## Related
241
218
 
242
- - [Server Adapters](/docs/v1/server-db/server-adapters) - Shared adapter concepts
243
- - [Hono Adapter](/reference/v1/server/hono-adapter) - Alternative adapter
219
+ - [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
244
220
  - [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
245
221
  - [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes
@@ -0,0 +1,130 @@
1
+ ---
2
+ title: "Reference: Fastify Adapter | Server"
3
+ description: "API reference for the @mastra/fastify server adapter."
4
+ packages:
5
+ - "@mastra/fastify"
6
+ ---
7
+
8
+ import Steps from "@site/src/components/Steps";
9
+ import StepItem from "@site/src/components/StepItem";
10
+ import PropertiesTable from "@site/src/components/PropertiesTable";
11
+
12
+ # Fastify Adapter
13
+
14
+ The `@mastra/fastify` package provides a server adapter for running Mastra with [Fastify](https://fastify.dev).
15
+
16
+ :::info
17
+
18
+ For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server/server-adapters).
19
+
20
+ :::
21
+
22
+ ## Installation
23
+
24
+ Install the Fastify adapter and Fastify framework:
25
+
26
+ ```bash
27
+ npm install @mastra/fastify@beta fastify
28
+ ```
29
+
30
+ ## Usage example
31
+
32
+ ```typescript title="server.ts"
33
+ import Fastify from 'fastify';
34
+ import { MastraServer } from '@mastra/fastify';
35
+ import { mastra } from './mastra';
36
+
37
+ const app = Fastify({ logger: true });
38
+ const server = new MastraServer({ app, mastra });
39
+
40
+ await server.init();
41
+
42
+ app.listen({ port: 3000 }, (err, address) => {
43
+ if (err) {
44
+ console.error(err);
45
+ process.exit(1);
46
+ }
47
+ console.log(`Server running on ${address}`);
48
+ });
49
+ ```
50
+
51
+ ## Constructor parameters
52
+
53
+ <PropertiesTable
54
+ content={[
55
+ {
56
+ name: "app",
57
+ type: "FastifyInstance",
58
+ description: "Fastify app instance",
59
+ isOptional: false,
60
+ },
61
+ {
62
+ name: "mastra",
63
+ type: "Mastra",
64
+ description: "Mastra instance",
65
+ isOptional: false,
66
+ },
67
+ {
68
+ name: "prefix",
69
+ type: "string",
70
+ description: "Route path prefix (e.g., `/api/v2`)",
71
+ isOptional: true,
72
+ defaultValue: "''",
73
+ },
74
+ {
75
+ name: "openapiPath",
76
+ type: "string",
77
+ description: "Path to serve OpenAPI spec (e.g., `/openapi.json`)",
78
+ isOptional: true,
79
+ defaultValue: "''",
80
+ },
81
+ {
82
+ name: "bodyLimitOptions",
83
+ type: "BodyLimitOptions",
84
+ typeDescription: "{ maxSize: number, onError: (error: unknown) => unknown }",
85
+ description: "Request body size limits",
86
+ isOptional: true,
87
+ },
88
+ {
89
+ name: "streamOptions",
90
+ type: "StreamOptions",
91
+ typeDescription: "{ redact?: boolean }",
92
+ description: "Stream redaction config. When true (default), redacts sensitive data (system prompts, tool definitions, API keys) from stream chunks before sending to clients.",
93
+ isOptional: true,
94
+ defaultValue: "{ redact: true }",
95
+ },
96
+ {
97
+ name: "customRouteAuthConfig",
98
+ type: "Map<string, boolean>",
99
+ description: "Per-route auth overrides. Keys are `METHOD:PATH` (e.g., `GET:/api/health`). Value `false` makes route public, `true` requires auth.",
100
+ isOptional: true,
101
+ },
102
+ {
103
+ name: "tools",
104
+ type: "ToolsInput",
105
+ typeDescription: "Record<string, ToolAction | VercelTool>",
106
+ description: "Available tools for the server",
107
+ isOptional: true,
108
+ },
109
+ {
110
+ name: "taskStore",
111
+ type: "InMemoryTaskStore",
112
+ description: "Task store for A2A (Agent-to-Agent) operations",
113
+ isOptional: true,
114
+ },
115
+ ]}
116
+ />
117
+
118
+ ## Manual initialization
119
+
120
+ For custom middleware ordering, call each method separately instead of `init()`. See [manual initialization](/docs/v1/server/server-adapters#manual-initialization) for details.
121
+
122
+ ## Examples
123
+
124
+ - [Fastify Adapter](https://github.com/mastra-ai/mastra/tree/main/examples/server-fastify-adapter) - Basic Fastify server setup
125
+
126
+ ## Related
127
+
128
+ - [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
129
+ - [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
130
+ - [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Hono Adapter | Server"
3
3
  description: "API reference for the @mastra/hono server adapter."
4
+ packages:
5
+ - "@mastra/hono"
4
6
  ---
5
7
 
6
8
  import Steps from "@site/src/components/Steps";
@@ -13,29 +15,21 @@ The `@mastra/hono` package provides a server adapter for running Mastra with [Ho
13
15
 
14
16
  :::info
15
17
 
16
- For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server-db/server-adapters).
18
+ For general adapter concepts (constructor options, initialization flow, etc.), see [Server Adapters](/docs/v1/server/server-adapters).
17
19
 
18
20
  :::
19
21
 
20
22
  ## Installation
21
23
 
22
- <Steps>
23
-
24
- <StepItem>
25
-
26
24
  Install the Hono adapter and Hono framework:
27
25
 
28
- ```bash copy
29
- npm install @mastra/hono hono
26
+ ```bash
27
+ npm install @mastra/hono@beta hono
30
28
  ```
31
29
 
32
- </StepItem>
33
-
34
- <StepItem>
35
-
36
- Create your server file:
30
+ ## Usage example
37
31
 
38
- ```typescript title="server.ts" copy showLineNumbers
32
+ ```typescript title="server.ts"
39
33
  import { Hono } from 'hono';
40
34
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
41
35
  import { mastra } from './mastra';
@@ -48,37 +42,6 @@ await server.init();
48
42
  export default app;
49
43
  ```
50
44
 
51
- </StepItem>
52
-
53
- </Steps>
54
-
55
- ## Full example
56
-
57
- ```typescript title="server.ts" copy showLineNumbers
58
- import { Hono } from 'hono';
59
- import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
60
- import { mastra } from './mastra';
61
-
62
- const app = new Hono<{ Bindings: HonoBindings; Variables: HonoVariables }>();
63
-
64
- const server = new MastraServer({
65
- app,
66
- mastra,
67
- prefix: '/api/v2',
68
- openapiPath: '/openapi.json',
69
- bodyLimitOptions: {
70
- maxSize: 10 * 1024 * 1024, // 10MB
71
- onError: (err) => ({ error: 'Payload too large', maxSize: '10MB' }),
72
- },
73
- streamOptions: { redact: true },
74
- });
75
-
76
- await server.init();
77
-
78
- export default app;
79
- ```
80
-
81
-
82
45
  ## Constructor parameters
83
46
 
84
47
  <PropertiesTable
@@ -107,6 +70,7 @@ export default app;
107
70
  type: "string",
108
71
  description: "Path to serve OpenAPI spec (e.g., `/openapi.json`)",
109
72
  isOptional: true,
73
+ defaultValue: "''",
110
74
  },
111
75
  {
112
76
  name: "bodyLimitOptions",
@@ -127,6 +91,18 @@ export default app;
127
91
  description: "Per-route auth overrides. Keys are `METHOD:PATH` (e.g., `GET:/api/health`). Value `false` makes route public, `true` requires auth.",
128
92
  isOptional: true,
129
93
  },
94
+ {
95
+ name: "tools",
96
+ type: "Record<string, Tool>",
97
+ description: "Available tools for the server",
98
+ isOptional: true,
99
+ },
100
+ {
101
+ name: "taskStore",
102
+ type: "InMemoryTaskStore",
103
+ description: "Task store for A2A (Agent-to-Agent) operations",
104
+ isOptional: true,
105
+ },
130
106
  ]}
131
107
  />
132
108
 
@@ -135,7 +111,7 @@ export default app;
135
111
 
136
112
  Add routes directly to the Hono app:
137
113
 
138
- ```typescript title="server.ts" copy showLineNumbers
114
+ ```typescript title="server.ts"
139
115
  import { Hono } from 'hono';
140
116
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
141
117
 
@@ -164,7 +140,7 @@ Routes added before `init()` run without Mastra context. Add routes after `init(
164
140
 
165
141
  In Hono middleware and route handlers, access Mastra context via `c.get()`:
166
142
 
167
- ```typescript copy showLineNumbers
143
+ ```typescript
168
144
  app.get('/custom', async (c) => {
169
145
  const mastra = c.get('mastra');
170
146
  const requestContext = c.get('requestContext');
@@ -183,13 +159,15 @@ Available context keys:
183
159
  | `requestContext` | Request context map |
184
160
  | `abortSignal` | Request cancellation signal |
185
161
  | `tools` | Available tools |
162
+ | `taskStore` | Task store for A2A operations |
163
+ | `customRouteAuthConfig` | Per-route auth overrides |
186
164
  | `user` | Authenticated user (if auth configured) |
187
165
 
188
166
  ## Adding middleware
189
167
 
190
168
  Add Hono middleware before or after `init()`:
191
169
 
192
- ```typescript title="server.ts" copy showLineNumbers
170
+ ```typescript title="server.ts"
193
171
  import { Hono } from 'hono';
194
172
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
195
173
 
@@ -207,14 +185,13 @@ await server.init();
207
185
  // Middleware after init has access to Mastra context
208
186
  app.use('*', async (c, next) => {
209
187
  const mastra = c.get('mastra');
210
- // ...
211
188
  await next();
212
189
  });
213
190
  ```
214
191
 
215
192
  ## Manual initialization
216
193
 
217
- For custom middleware ordering, call each method separately instead of `init()`. See [Server Adapters: Manual initialization](/docs/v1/server-db/server-adapters#manual-initialization) for details.
194
+ For custom middleware ordering, call each method separately instead of `init()`. See [manual initialization](/docs/v1/server/server-adapters#manual-initialization) for details.
218
195
 
219
196
  ## Examples
220
197
 
@@ -222,7 +199,6 @@ For custom middleware ordering, call each method separately instead of `init()`.
222
199
 
223
200
  ## Related
224
201
 
225
- - [Server Adapters](/docs/v1/server-db/server-adapters) - Shared adapter concepts
226
- - [Express Adapter](/reference/v1/server/express-adapter) - Alternative adapter
202
+ - [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
227
203
  - [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
228
204
  - [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes