@mastra/mcp-docs-server 1.0.0-beta.8 → 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 (544) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +1 -13
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +1 -5
  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 +1 -53
  6. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +287 -287
  7. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +315 -315
  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 +658 -196
  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 +208 -0
  16. package/.docs/organized/changelogs/%40mastra%2Fconvex.md +448 -22
  17. package/.docs/organized/changelogs/%40mastra%2Fcore.md +3341 -271
  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 +247 -220
  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 +604 -208
  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 +285 -285
  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 +759 -213
  40. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +198 -198
  41. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +636 -229
  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 -230
  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 +829 -218
  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 +227 -227
  65. package/.docs/organized/changelogs/mastra.md +277 -277
  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 +3 -4
  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/processors-with-ai-sdk.md +14 -0
  90. package/.docs/organized/code-examples/quick-start.md +1 -5
  91. package/.docs/organized/code-examples/server-app-access.md +3 -3
  92. package/.docs/organized/code-examples/server-express-adapter.md +1 -1
  93. package/.docs/organized/code-examples/server-fastify-adapter.md +83 -0
  94. package/.docs/organized/code-examples/server-hono-adapter.md +3 -3
  95. package/.docs/organized/code-examples/server-koa-adapter.md +94 -0
  96. package/.docs/organized/code-examples/stock-price-tool.md +21 -2
  97. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  98. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  99. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  100. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  101. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
  102. package/.docs/raw/agents/adding-voice.mdx +24 -6
  103. package/.docs/raw/agents/agent-approval.mdx +209 -12
  104. package/.docs/raw/agents/agent-memory.mdx +36 -32
  105. package/.docs/raw/agents/guardrails.mdx +105 -56
  106. package/.docs/raw/agents/network-approval.mdx +281 -0
  107. package/.docs/raw/agents/networks.mdx +69 -13
  108. package/.docs/raw/agents/overview.mdx +43 -25
  109. package/.docs/raw/agents/processors.mdx +234 -17
  110. package/.docs/raw/agents/structured-output.mdx +78 -8
  111. package/.docs/raw/agents/using-tools.mdx +67 -6
  112. package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +1 -2
  113. package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +1 -1
  114. package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +1 -2
  115. package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +1 -1
  116. package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +1 -1
  117. package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +1 -1
  118. package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +1 -1
  119. package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +1 -1
  120. package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +3 -3
  121. package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
  122. package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +35 -0
  123. package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
  124. package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +1 -1
  125. package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +4 -5
  126. package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
  127. package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +3 -4
  128. package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +3 -4
  129. package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +3 -4
  130. package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +3 -4
  131. package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
  132. package/.docs/raw/deployment/cloud-providers.mdx +22 -0
  133. package/.docs/raw/deployment/mastra-server.mdx +140 -0
  134. package/.docs/raw/deployment/monorepo.mdx +106 -42
  135. package/.docs/raw/deployment/overview.mdx +35 -48
  136. package/.docs/raw/deployment/web-framework.mdx +17 -19
  137. package/.docs/raw/deployment/workflow-runners.mdx +16 -0
  138. package/.docs/raw/evals/built-in-scorers.mdx +2 -0
  139. package/.docs/raw/evals/custom-scorers.mdx +60 -12
  140. package/.docs/raw/evals/overview.mdx +6 -6
  141. package/.docs/raw/evals/running-in-ci.mdx +4 -2
  142. package/.docs/raw/getting-started/manual-install.mdx +20 -20
  143. package/.docs/raw/getting-started/mcp-docs-server.mdx +59 -2
  144. package/.docs/raw/getting-started/project-structure.mdx +2 -2
  145. package/.docs/raw/getting-started/start.mdx +17 -1
  146. package/.docs/raw/getting-started/studio.mdx +10 -37
  147. package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +151 -0
  148. package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1034 -80
  149. package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
  150. package/.docs/raw/guides/build-your-ui/copilotkit.mdx +32 -11
  151. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/amazon-ec2.mdx +9 -9
  152. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/aws-lambda.mdx +13 -16
  153. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/azure-app-services.mdx +5 -7
  154. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/cloudflare-deployer.mdx +8 -5
  155. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/digital-ocean.mdx +18 -23
  156. package/.docs/raw/guides/deployment/index.mdx +32 -0
  157. package/.docs/raw/guides/deployment/inngest.mdx +673 -0
  158. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/netlify-deployer.mdx +7 -3
  159. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/vercel-deployer.mdx +8 -5
  160. package/.docs/raw/guides/getting-started/astro.mdx +292 -451
  161. package/.docs/raw/guides/getting-started/express.mdx +72 -153
  162. package/.docs/raw/guides/getting-started/hono.mdx +227 -0
  163. package/.docs/raw/guides/getting-started/next-js.mdx +173 -61
  164. package/.docs/raw/guides/getting-started/nuxt.mdx +505 -0
  165. package/.docs/raw/guides/getting-started/quickstart.mdx +5 -5
  166. package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
  167. package/.docs/raw/guides/getting-started/vite-react.mdx +317 -147
  168. package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
  169. package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
  170. package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
  171. package/.docs/raw/guides/guide/research-assistant.mdx +20 -20
  172. package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
  173. package/.docs/raw/guides/guide/web-search.mdx +38 -38
  174. package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
  175. package/.docs/raw/guides/index.mdx +0 -1
  176. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
  177. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +105 -4
  178. package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +15 -1
  179. package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +170 -0
  180. package/.docs/raw/guides/migrations/upgrade-to-v1/deployment.mdx +42 -0
  181. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +0 -35
  182. package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +40 -3
  183. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +17 -2
  184. package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
  185. package/.docs/raw/guides/migrations/upgrade-to-v1/rag.mdx +47 -0
  186. package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +271 -25
  187. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +3 -3
  188. package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +72 -17
  189. package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +46 -1
  190. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +50 -7
  191. package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
  192. package/.docs/raw/index.mdx +2 -2
  193. package/.docs/raw/mastra-cloud/deployment.mdx +86 -0
  194. package/.docs/raw/mastra-cloud/observability.mdx +43 -0
  195. package/.docs/raw/mastra-cloud/overview.mdx +31 -0
  196. package/.docs/raw/mastra-cloud/setup.mdx +64 -0
  197. package/.docs/raw/mastra-cloud/studio.mdx +35 -0
  198. package/.docs/raw/mcp/overview.mdx +60 -25
  199. package/.docs/raw/mcp/publishing-mcp-server.mdx +7 -4
  200. package/.docs/raw/memory/memory-processors.mdx +17 -12
  201. package/.docs/raw/memory/message-history.mdx +72 -0
  202. package/.docs/raw/memory/overview.mdx +38 -76
  203. package/.docs/raw/memory/semantic-recall.mdx +65 -52
  204. package/.docs/raw/memory/storage.mdx +248 -0
  205. package/.docs/raw/memory/working-memory.mdx +24 -13
  206. package/.docs/raw/observability/logging.mdx +16 -15
  207. package/.docs/raw/observability/overview.mdx +27 -7
  208. package/.docs/raw/observability/tracing/bridges/otel.mdx +7 -4
  209. package/.docs/raw/observability/tracing/exporters/arize.mdx +61 -24
  210. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +32 -22
  211. package/.docs/raw/observability/tracing/exporters/cloud.mdx +24 -5
  212. package/.docs/raw/observability/tracing/exporters/datadog.mdx +175 -0
  213. package/.docs/raw/observability/tracing/exporters/default.mdx +28 -7
  214. package/.docs/raw/observability/tracing/exporters/laminar.mdx +89 -0
  215. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +31 -22
  216. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +33 -3
  217. package/.docs/raw/observability/tracing/exporters/otel.mdx +194 -22
  218. package/.docs/raw/observability/tracing/exporters/posthog.mdx +32 -22
  219. package/.docs/raw/observability/tracing/exporters/sentry.mdx +198 -0
  220. package/.docs/raw/observability/tracing/overview.mdx +388 -108
  221. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +27 -7
  222. package/.docs/raw/rag/chunking-and-embedding.mdx +22 -33
  223. package/.docs/raw/rag/graph-rag.mdx +223 -0
  224. package/.docs/raw/rag/overview.mdx +6 -3
  225. package/.docs/raw/rag/retrieval.mdx +53 -57
  226. package/.docs/raw/rag/vector-databases.mdx +55 -31
  227. package/.docs/raw/reference/agents/agent.mdx +17 -14
  228. package/.docs/raw/reference/agents/generate.mdx +172 -44
  229. package/.docs/raw/reference/agents/generateLegacy.mdx +5 -3
  230. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +5 -3
  231. package/.docs/raw/reference/agents/getDefaultOptions.mdx +5 -3
  232. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +5 -3
  233. package/.docs/raw/reference/agents/getDescription.mdx +3 -1
  234. package/.docs/raw/reference/agents/getInstructions.mdx +5 -3
  235. package/.docs/raw/reference/agents/getLLM.mdx +5 -3
  236. package/.docs/raw/reference/agents/getMemory.mdx +5 -3
  237. package/.docs/raw/reference/agents/getModel.mdx +5 -3
  238. package/.docs/raw/reference/agents/getTools.mdx +4 -2
  239. package/.docs/raw/reference/agents/getVoice.mdx +4 -2
  240. package/.docs/raw/reference/agents/listAgents.mdx +4 -2
  241. package/.docs/raw/reference/agents/listScorers.mdx +5 -3
  242. package/.docs/raw/reference/agents/listTools.mdx +4 -2
  243. package/.docs/raw/reference/agents/listWorkflows.mdx +4 -2
  244. package/.docs/raw/reference/agents/network.mdx +113 -1
  245. package/.docs/raw/reference/ai-sdk/chat-route.mdx +6 -3
  246. package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +4 -2
  247. package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +4 -2
  248. package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +5 -3
  249. package/.docs/raw/reference/ai-sdk/network-route.mdx +6 -3
  250. package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +10 -6
  251. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +130 -0
  252. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +110 -0
  253. package/.docs/raw/reference/ai-sdk/with-mastra.mdx +122 -0
  254. package/.docs/raw/reference/ai-sdk/workflow-route.mdx +7 -4
  255. package/.docs/raw/reference/auth/auth0.mdx +5 -3
  256. package/.docs/raw/reference/auth/clerk.mdx +5 -3
  257. package/.docs/raw/reference/auth/firebase.mdx +6 -5
  258. package/.docs/raw/reference/auth/jwt.mdx +5 -3
  259. package/.docs/raw/reference/auth/supabase.mdx +5 -3
  260. package/.docs/raw/reference/auth/workos.mdx +5 -3
  261. package/.docs/raw/reference/cli/create-mastra.mdx +12 -10
  262. package/.docs/raw/reference/cli/mastra.mdx +63 -15
  263. package/.docs/raw/reference/client-js/agents.mdx +311 -85
  264. package/.docs/raw/reference/client-js/error-handling.mdx +3 -3
  265. package/.docs/raw/reference/client-js/logs.mdx +2 -0
  266. package/.docs/raw/reference/client-js/mastra-client.mdx +6 -4
  267. package/.docs/raw/reference/client-js/memory.mdx +47 -2
  268. package/.docs/raw/reference/client-js/observability.mdx +2 -0
  269. package/.docs/raw/reference/client-js/telemetry.mdx +2 -0
  270. package/.docs/raw/reference/client-js/tools.mdx +2 -0
  271. package/.docs/raw/reference/client-js/vectors.mdx +2 -0
  272. package/.docs/raw/reference/client-js/workflows.mdx +47 -3
  273. package/.docs/raw/reference/configuration.mdx +761 -0
  274. package/.docs/raw/reference/core/addGateway.mdx +2 -0
  275. package/.docs/raw/reference/core/getAgent.mdx +3 -1
  276. package/.docs/raw/reference/core/getAgentById.mdx +3 -1
  277. package/.docs/raw/reference/core/getDeployer.mdx +3 -1
  278. package/.docs/raw/reference/core/getGateway.mdx +2 -0
  279. package/.docs/raw/reference/core/getGatewayById.mdx +2 -0
  280. package/.docs/raw/reference/core/getLogger.mdx +3 -1
  281. package/.docs/raw/reference/core/getMCPServer.mdx +3 -1
  282. package/.docs/raw/reference/core/getMCPServerById.mdx +3 -1
  283. package/.docs/raw/reference/core/getMemory.mdx +77 -0
  284. package/.docs/raw/reference/core/getScorer.mdx +2 -0
  285. package/.docs/raw/reference/core/getScorerById.mdx +2 -0
  286. package/.docs/raw/reference/core/getServer.mdx +6 -4
  287. package/.docs/raw/reference/core/getStorage.mdx +5 -3
  288. package/.docs/raw/reference/core/getStoredAgentById.mdx +185 -0
  289. package/.docs/raw/reference/core/getTelemetry.mdx +3 -1
  290. package/.docs/raw/reference/core/getVector.mdx +3 -1
  291. package/.docs/raw/reference/core/getWorkflow.mdx +3 -1
  292. package/.docs/raw/reference/core/listAgents.mdx +3 -1
  293. package/.docs/raw/reference/core/listGateways.mdx +2 -0
  294. package/.docs/raw/reference/core/listLogs.mdx +3 -1
  295. package/.docs/raw/reference/core/listLogsByRunId.mdx +3 -1
  296. package/.docs/raw/reference/core/listMCPServers.mdx +3 -1
  297. package/.docs/raw/reference/core/listMemory.mdx +74 -0
  298. package/.docs/raw/reference/core/listScorers.mdx +2 -0
  299. package/.docs/raw/reference/core/listStoredAgents.mdx +153 -0
  300. package/.docs/raw/reference/core/listVectors.mdx +3 -1
  301. package/.docs/raw/reference/core/listWorkflows.mdx +3 -1
  302. package/.docs/raw/reference/core/mastra-class.mdx +35 -20
  303. package/.docs/raw/reference/core/mastra-model-gateway.mdx +2 -0
  304. package/.docs/raw/reference/core/setLogger.mdx +3 -1
  305. package/.docs/raw/reference/core/setStorage.mdx +6 -4
  306. package/.docs/raw/reference/deployer/cloudflare.mdx +22 -53
  307. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  308. package/.docs/raw/reference/deployer/netlify.mdx +4 -1
  309. package/.docs/raw/reference/deployer/vercel.mdx +5 -4
  310. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -1
  311. package/.docs/raw/reference/evals/answer-similarity.mdx +4 -1
  312. package/.docs/raw/reference/evals/bias.mdx +4 -1
  313. package/.docs/raw/reference/evals/completeness.mdx +4 -1
  314. package/.docs/raw/reference/evals/content-similarity.mdx +4 -1
  315. package/.docs/raw/reference/evals/context-precision.mdx +4 -1
  316. package/.docs/raw/reference/evals/context-relevance.mdx +2 -0
  317. package/.docs/raw/reference/evals/create-scorer.mdx +11 -3
  318. package/.docs/raw/reference/evals/faithfulness.mdx +4 -1
  319. package/.docs/raw/reference/evals/hallucination.mdx +4 -1
  320. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -1
  321. package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
  322. package/.docs/raw/reference/evals/noise-sensitivity.mdx +2 -0
  323. package/.docs/raw/reference/evals/prompt-alignment.mdx +9 -7
  324. package/.docs/raw/reference/evals/run-evals.mdx +3 -1
  325. package/.docs/raw/reference/evals/scorer-utils.mdx +3 -0
  326. package/.docs/raw/reference/evals/textual-difference.mdx +4 -1
  327. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -1
  328. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +25 -23
  329. package/.docs/raw/reference/evals/toxicity.mdx +4 -1
  330. package/.docs/raw/reference/index.mdx +2 -1
  331. package/.docs/raw/reference/logging/pino-logger.mdx +10 -8
  332. package/.docs/raw/reference/memory/clone-utilities.mdx +345 -0
  333. package/.docs/raw/reference/memory/cloneThread.mdx +237 -0
  334. package/.docs/raw/reference/memory/createThread.mdx +6 -4
  335. package/.docs/raw/reference/memory/deleteMessages.mdx +4 -2
  336. package/.docs/raw/reference/memory/getThreadById.mdx +3 -1
  337. package/.docs/raw/reference/memory/listThreads.mdx +187 -0
  338. package/.docs/raw/reference/memory/memory-class.mdx +27 -20
  339. package/.docs/raw/reference/memory/recall.mdx +6 -4
  340. package/.docs/raw/reference/observability/tracing/bridges/otel.mdx +6 -2
  341. package/.docs/raw/reference/observability/tracing/configuration.mdx +51 -0
  342. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +25 -6
  343. package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +23 -2
  344. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +10 -0
  345. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +3 -0
  346. package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx +172 -0
  347. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +10 -0
  348. package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx +139 -0
  349. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +26 -4
  350. package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +10 -0
  351. package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +51 -34
  352. package/.docs/raw/reference/observability/tracing/exporters/posthog.mdx +25 -4
  353. package/.docs/raw/reference/observability/tracing/exporters/sentry.mdx +224 -0
  354. package/.docs/raw/reference/observability/tracing/instances.mdx +2 -0
  355. package/.docs/raw/reference/observability/tracing/interfaces.mdx +20 -0
  356. package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +2 -0
  357. package/.docs/raw/reference/observability/tracing/spans.mdx +2 -0
  358. package/.docs/raw/reference/processors/batch-parts-processor.mdx +4 -2
  359. package/.docs/raw/reference/processors/language-detector.mdx +6 -3
  360. package/.docs/raw/reference/processors/message-history-processor.mdx +5 -2
  361. package/.docs/raw/reference/processors/moderation-processor.mdx +6 -4
  362. package/.docs/raw/reference/processors/pii-detector.mdx +6 -4
  363. package/.docs/raw/reference/processors/processor-interface.mdx +326 -23
  364. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +5 -3
  365. package/.docs/raw/reference/processors/semantic-recall-processor.mdx +7 -2
  366. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +5 -3
  367. package/.docs/raw/reference/processors/token-limiter-processor.mdx +62 -19
  368. package/.docs/raw/reference/processors/tool-call-filter.mdx +5 -3
  369. package/.docs/raw/reference/processors/unicode-normalizer.mdx +6 -3
  370. package/.docs/raw/reference/processors/working-memory-processor.mdx +6 -3
  371. package/.docs/raw/reference/rag/chunk.mdx +7 -6
  372. package/.docs/raw/reference/rag/database-config.mdx +8 -6
  373. package/.docs/raw/reference/rag/document.mdx +2 -0
  374. package/.docs/raw/reference/rag/embeddings.mdx +2 -0
  375. package/.docs/raw/reference/rag/extract-params.mdx +57 -3
  376. package/.docs/raw/reference/rag/graph-rag.mdx +2 -0
  377. package/.docs/raw/reference/rag/metadata-filters.mdx +27 -7
  378. package/.docs/raw/reference/rag/rerank.mdx +2 -0
  379. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -0
  380. package/.docs/raw/reference/server/create-route.mdx +34 -18
  381. package/.docs/raw/reference/server/express-adapter.mdx +78 -50
  382. package/.docs/raw/reference/server/fastify-adapter.mdx +130 -0
  383. package/.docs/raw/reference/server/hono-adapter.mdx +78 -48
  384. package/.docs/raw/reference/server/koa-adapter.mdx +129 -0
  385. package/.docs/raw/reference/server/mastra-server.mdx +52 -34
  386. package/.docs/raw/reference/server/routes.mdx +73 -10
  387. package/.docs/raw/reference/storage/cloudflare-d1.mdx +10 -5
  388. package/.docs/raw/reference/storage/cloudflare.mdx +12 -2
  389. package/.docs/raw/reference/storage/composite.mdx +245 -0
  390. package/.docs/raw/reference/storage/convex.mdx +8 -6
  391. package/.docs/raw/reference/storage/dynamodb.mdx +134 -8
  392. package/.docs/raw/reference/storage/lance.mdx +9 -5
  393. package/.docs/raw/reference/storage/libsql.mdx +76 -54
  394. package/.docs/raw/reference/storage/mongodb.mdx +115 -16
  395. package/.docs/raw/reference/storage/mssql.mdx +11 -6
  396. package/.docs/raw/{server-db/storage.mdx → reference/storage/overview.mdx} +15 -111
  397. package/.docs/raw/reference/storage/postgresql.mdx +228 -83
  398. package/.docs/raw/reference/storage/upstash.mdx +78 -2
  399. package/.docs/raw/reference/streaming/ChunkType.mdx +31 -3
  400. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +67 -6
  401. package/.docs/raw/reference/streaming/agents/stream.mdx +48 -51
  402. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +5 -3
  403. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -1
  404. package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +3 -1
  405. package/.docs/raw/reference/streaming/workflows/stream.mdx +37 -22
  406. package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +6 -4
  407. package/.docs/raw/reference/templates/overview.mdx +3 -2
  408. package/.docs/raw/reference/tools/client.mdx +3 -0
  409. package/.docs/raw/reference/tools/create-tool.mdx +127 -5
  410. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -0
  411. package/.docs/raw/reference/tools/graph-rag-tool.mdx +40 -3
  412. package/.docs/raw/reference/tools/mcp-client.mdx +110 -1
  413. package/.docs/raw/reference/tools/mcp-server.mdx +278 -24
  414. package/.docs/raw/reference/tools/vector-query-tool.mdx +68 -4
  415. package/.docs/raw/reference/vectors/astra.mdx +5 -3
  416. package/.docs/raw/reference/vectors/chroma.mdx +5 -3
  417. package/.docs/raw/reference/vectors/convex.mdx +14 -12
  418. package/.docs/raw/reference/vectors/couchbase.mdx +7 -5
  419. package/.docs/raw/reference/vectors/duckdb.mdx +12 -10
  420. package/.docs/raw/reference/vectors/elasticsearch.mdx +12 -4
  421. package/.docs/raw/reference/vectors/lance.mdx +6 -4
  422. package/.docs/raw/reference/vectors/libsql.mdx +66 -13
  423. package/.docs/raw/reference/vectors/mongodb.mdx +90 -10
  424. package/.docs/raw/reference/vectors/opensearch.mdx +30 -3
  425. package/.docs/raw/reference/vectors/pg.mdx +58 -6
  426. package/.docs/raw/reference/vectors/pinecone.mdx +23 -8
  427. package/.docs/raw/reference/vectors/qdrant.mdx +148 -4
  428. package/.docs/raw/reference/vectors/s3vectors.mdx +8 -6
  429. package/.docs/raw/reference/vectors/turbopuffer.mdx +6 -4
  430. package/.docs/raw/reference/vectors/upstash.mdx +60 -6
  431. package/.docs/raw/reference/vectors/vectorize.mdx +5 -3
  432. package/.docs/raw/reference/voice/azure.mdx +2 -0
  433. package/.docs/raw/reference/voice/cloudflare.mdx +2 -0
  434. package/.docs/raw/reference/voice/composite-voice.mdx +4 -0
  435. package/.docs/raw/reference/voice/deepgram.mdx +2 -0
  436. package/.docs/raw/reference/voice/elevenlabs.mdx +2 -0
  437. package/.docs/raw/reference/voice/google-gemini-live.mdx +3 -0
  438. package/.docs/raw/reference/voice/google.mdx +2 -0
  439. package/.docs/raw/reference/voice/mastra-voice.mdx +2 -0
  440. package/.docs/raw/reference/voice/murf.mdx +2 -0
  441. package/.docs/raw/reference/voice/openai-realtime.mdx +3 -0
  442. package/.docs/raw/reference/voice/openai.mdx +2 -0
  443. package/.docs/raw/reference/voice/playai.mdx +2 -0
  444. package/.docs/raw/reference/voice/sarvam.mdx +2 -0
  445. package/.docs/raw/reference/voice/speechify.mdx +2 -0
  446. package/.docs/raw/reference/voice/voice.addInstructions.mdx +3 -0
  447. package/.docs/raw/reference/voice/voice.addTools.mdx +3 -0
  448. package/.docs/raw/reference/voice/voice.answer.mdx +4 -0
  449. package/.docs/raw/reference/voice/voice.close.mdx +3 -0
  450. package/.docs/raw/reference/voice/voice.connect.mdx +5 -1
  451. package/.docs/raw/reference/voice/voice.events.mdx +2 -0
  452. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +3 -0
  453. package/.docs/raw/reference/voice/voice.listen.mdx +6 -0
  454. package/.docs/raw/reference/voice/voice.off.mdx +2 -0
  455. package/.docs/raw/reference/voice/voice.on.mdx +5 -1
  456. package/.docs/raw/reference/voice/voice.send.mdx +4 -0
  457. package/.docs/raw/reference/voice/voice.speak.mdx +6 -0
  458. package/.docs/raw/reference/voice/voice.updateConfig.mdx +2 -0
  459. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +55 -5
  460. package/.docs/raw/reference/workflows/run-methods/restart.mdx +3 -3
  461. package/.docs/raw/reference/workflows/run-methods/resume.mdx +6 -4
  462. package/.docs/raw/reference/workflows/run-methods/start.mdx +7 -5
  463. package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +145 -0
  464. package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +10 -8
  465. package/.docs/raw/reference/workflows/run.mdx +11 -3
  466. package/.docs/raw/reference/workflows/step.mdx +56 -3
  467. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +3 -1
  468. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +3 -1
  469. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +39 -2
  470. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +3 -1
  471. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +3 -1
  472. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +71 -4
  473. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +9 -7
  474. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +3 -1
  475. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +4 -6
  476. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +4 -6
  477. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +3 -1
  478. package/.docs/raw/reference/workflows/workflow.mdx +193 -2
  479. package/.docs/raw/{auth → server/auth}/auth0.mdx +40 -21
  480. package/.docs/raw/{auth → server/auth}/clerk.mdx +37 -16
  481. package/.docs/raw/{auth → server/auth}/firebase.mdx +47 -25
  482. package/.docs/raw/{auth → server/auth}/index.mdx +8 -6
  483. package/.docs/raw/{auth → server/auth}/jwt.mdx +22 -10
  484. package/.docs/raw/{auth → server/auth}/supabase.mdx +45 -25
  485. package/.docs/raw/{auth → server/auth}/workos.mdx +39 -20
  486. package/.docs/raw/{server-db → server}/custom-adapters.mdx +40 -24
  487. package/.docs/raw/{server-db → server}/custom-api-routes.mdx +6 -6
  488. package/.docs/raw/{server-db → server}/mastra-client.mdx +35 -38
  489. package/.docs/raw/server/mastra-server.mdx +86 -0
  490. package/.docs/raw/{server-db → server}/middleware.mdx +11 -9
  491. package/.docs/raw/{server-db → server}/request-context.mdx +85 -43
  492. package/.docs/raw/server/server-adapters.mdx +410 -0
  493. package/.docs/raw/streaming/events.mdx +16 -7
  494. package/.docs/raw/streaming/overview.mdx +30 -17
  495. package/.docs/raw/streaming/tool-streaming.mdx +15 -17
  496. package/.docs/raw/streaming/workflow-streaming.mdx +8 -8
  497. package/.docs/raw/tools-mcp/advanced-usage.mdx +4 -2
  498. package/.docs/raw/tools-mcp/mcp-overview.mdx +46 -12
  499. package/.docs/raw/tools-mcp/overview.mdx +14 -13
  500. package/.docs/raw/voice/overview.mdx +17 -2
  501. package/.docs/raw/voice/speech-to-speech.mdx +5 -0
  502. package/.docs/raw/voice/speech-to-text.mdx +4 -0
  503. package/.docs/raw/voice/text-to-speech.mdx +3 -0
  504. package/.docs/raw/workflows/agents-and-tools.mdx +70 -21
  505. package/.docs/raw/workflows/control-flow.mdx +369 -34
  506. package/.docs/raw/workflows/error-handling.mdx +192 -18
  507. package/.docs/raw/workflows/human-in-the-loop.mdx +8 -7
  508. package/.docs/raw/workflows/input-data-mapping.mdx +9 -7
  509. package/.docs/raw/workflows/overview.mdx +80 -34
  510. package/.docs/raw/workflows/snapshots.mdx +19 -45
  511. package/.docs/raw/workflows/suspend-and-resume.mdx +14 -14
  512. package/.docs/raw/workflows/time-travel.mdx +25 -21
  513. package/.docs/raw/workflows/workflow-state.mdx +7 -8
  514. package/CHANGELOG.md +254 -0
  515. package/README.md +36 -0
  516. package/dist/index.d.ts.map +1 -1
  517. package/dist/logger.d.ts +3 -0
  518. package/dist/logger.d.ts.map +1 -1
  519. package/dist/stdio.js +746 -49
  520. package/dist/tools/course.d.ts.map +1 -1
  521. package/dist/tools/embedded-docs.d.ts +276 -0
  522. package/dist/tools/embedded-docs.d.ts.map +1 -0
  523. package/package.json +9 -8
  524. package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
  525. package/.docs/raw/deployment/building-mastra.mdx +0 -73
  526. package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
  527. package/.docs/raw/deployment/mastra-cloud/dashboard.mdx +0 -100
  528. package/.docs/raw/deployment/mastra-cloud/observability.mdx +0 -53
  529. package/.docs/raw/deployment/mastra-cloud/overview.mdx +0 -65
  530. package/.docs/raw/deployment/mastra-cloud/setting-up.mdx +0 -105
  531. package/.docs/raw/memory/conversation-history.mdx +0 -24
  532. package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
  533. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
  534. package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
  535. package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
  536. package/.docs/raw/memory/threads-and-resources.mdx +0 -95
  537. package/.docs/raw/reference/core/setTelemetry.mdx +0 -36
  538. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +0 -110
  539. package/.docs/raw/reference/memory/query.mdx +0 -189
  540. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
  541. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
  542. package/.docs/raw/server-db/mastra-server.mdx +0 -97
  543. package/.docs/raw/server-db/server-adapters.mdx +0 -286
  544. package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
@@ -1,10 +1,13 @@
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";
7
9
  import StepItem from "@site/src/components/StepItem";
10
+ import PropertiesTable from "@site/src/components/PropertiesTable";
8
11
 
9
12
  # Hono Adapter
10
13
 
@@ -12,29 +15,21 @@ The `@mastra/hono` package provides a server adapter for running Mastra with [Ho
12
15
 
13
16
  :::info
14
17
 
15
- 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).
16
19
 
17
20
  :::
18
21
 
19
22
  ## Installation
20
23
 
21
- <Steps>
22
-
23
- <StepItem>
24
-
25
24
  Install the Hono adapter and Hono framework:
26
25
 
27
- ```bash copy
28
- npm install @mastra/hono hono
26
+ ```bash
27
+ npm install @mastra/hono@beta hono
29
28
  ```
30
29
 
31
- </StepItem>
32
-
33
- <StepItem>
30
+ ## Usage example
34
31
 
35
- Create your server file:
36
-
37
- ```typescript title="server.ts" copy showLineNumbers
32
+ ```typescript title="server.ts"
38
33
  import { Hono } from 'hono';
39
34
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
40
35
  import { mastra } from './mastra';
@@ -47,41 +42,76 @@ await server.init();
47
42
  export default app;
48
43
  ```
49
44
 
50
- </StepItem>
51
-
52
- </Steps>
53
-
54
- ## Full example
55
-
56
- ```typescript title="server.ts" copy showLineNumbers
57
- import { Hono } from 'hono';
58
- import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
59
- import { mastra } from './mastra';
60
-
61
- const app = new Hono<{ Bindings: HonoBindings; Variables: HonoVariables }>();
62
-
63
- const server = new MastraServer({
64
- app,
65
- mastra,
66
- prefix: '/api/v2',
67
- openapiPath: '/openapi.json',
68
- bodyLimitOptions: {
69
- maxSize: 10 * 1024 * 1024, // 10MB
70
- onError: (err) => ({ error: 'Payload too large', maxSize: '10MB' }),
71
- },
72
- streamOptions: { redact: true },
73
- });
45
+ ## Constructor parameters
46
+
47
+ <PropertiesTable
48
+ content={[
49
+ {
50
+ name: "app",
51
+ type: "Hono",
52
+ description: "Hono app instance",
53
+ isOptional: false,
54
+ },
55
+ {
56
+ name: "mastra",
57
+ type: "Mastra",
58
+ description: "Mastra instance",
59
+ isOptional: false,
60
+ },
61
+ {
62
+ name: "prefix",
63
+ type: "string",
64
+ description: "Route path prefix (e.g., `/api/v2`)",
65
+ isOptional: true,
66
+ defaultValue: "''",
67
+ },
68
+ {
69
+ name: "openapiPath",
70
+ type: "string",
71
+ description: "Path to serve OpenAPI spec (e.g., `/openapi.json`)",
72
+ isOptional: true,
73
+ defaultValue: "''",
74
+ },
75
+ {
76
+ name: "bodyLimitOptions",
77
+ type: "{ maxSize: number, onError: (err) => unknown }",
78
+ description: "Request body size limits",
79
+ isOptional: true,
80
+ },
81
+ {
82
+ name: "streamOptions",
83
+ type: "{ redact?: boolean }",
84
+ description: "Stream redaction config. When true, redacts sensitive data from streams.",
85
+ isOptional: true,
86
+ defaultValue: "{ redact: true }",
87
+ },
88
+ {
89
+ name: "customRouteAuthConfig",
90
+ type: "Map<string, boolean>",
91
+ description: "Per-route auth overrides. Keys are `METHOD:PATH` (e.g., `GET:/api/health`). Value `false` makes route public, `true` requires auth.",
92
+ isOptional: true,
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
+ },
106
+ ]}
107
+ />
74
108
 
75
- await server.init();
76
-
77
- export default app;
78
- ```
79
109
 
80
110
  ## Adding custom routes
81
111
 
82
112
  Add routes directly to the Hono app:
83
113
 
84
- ```typescript title="server.ts" copy showLineNumbers
114
+ ```typescript title="server.ts"
85
115
  import { Hono } from 'hono';
86
116
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
87
117
 
@@ -110,7 +140,7 @@ Routes added before `init()` run without Mastra context. Add routes after `init(
110
140
 
111
141
  In Hono middleware and route handlers, access Mastra context via `c.get()`:
112
142
 
113
- ```typescript copy showLineNumbers
143
+ ```typescript
114
144
  app.get('/custom', async (c) => {
115
145
  const mastra = c.get('mastra');
116
146
  const requestContext = c.get('requestContext');
@@ -129,13 +159,15 @@ Available context keys:
129
159
  | `requestContext` | Request context map |
130
160
  | `abortSignal` | Request cancellation signal |
131
161
  | `tools` | Available tools |
162
+ | `taskStore` | Task store for A2A operations |
163
+ | `customRouteAuthConfig` | Per-route auth overrides |
132
164
  | `user` | Authenticated user (if auth configured) |
133
165
 
134
166
  ## Adding middleware
135
167
 
136
168
  Add Hono middleware before or after `init()`:
137
169
 
138
- ```typescript title="server.ts" copy showLineNumbers
170
+ ```typescript title="server.ts"
139
171
  import { Hono } from 'hono';
140
172
  import { HonoBindings, HonoVariables, MastraServer } from '@mastra/hono';
141
173
 
@@ -153,14 +185,13 @@ await server.init();
153
185
  // Middleware after init has access to Mastra context
154
186
  app.use('*', async (c, next) => {
155
187
  const mastra = c.get('mastra');
156
- // ...
157
188
  await next();
158
189
  });
159
190
  ```
160
191
 
161
192
  ## Manual initialization
162
193
 
163
- 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.
164
195
 
165
196
  ## Examples
166
197
 
@@ -168,7 +199,6 @@ For custom middleware ordering, call each method separately instead of `init()`.
168
199
 
169
200
  ## Related
170
201
 
171
- - [Server Adapters](/docs/v1/server-db/server-adapters) - Shared adapter concepts
172
- - [Express Adapter](/reference/v1/server/express-adapter) - Alternative adapter
202
+ - [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
173
203
  - [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
174
204
  - [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes
@@ -0,0 +1,129 @@
1
+ ---
2
+ title: "Reference: Koa Adapter | Server"
3
+ description: "API reference for the @mastra/koa server adapter."
4
+ packages:
5
+ - "@mastra/koa"
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
+ # Koa Adapter
13
+
14
+ The `@mastra/koa` package provides a server adapter for running Mastra with [Koa](https://koajs.com).
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 Koa adapter and Koa framework:
25
+
26
+ ```bash
27
+ npm install @mastra/koa@beta koa koa-bodyparser
28
+ ```
29
+
30
+ ## Usage example
31
+
32
+ ```typescript title="server.ts"
33
+ import Koa from 'koa';
34
+ import bodyParser from 'koa-bodyparser';
35
+ import { MastraServer } from '@mastra/koa';
36
+ import { mastra } from './mastra';
37
+
38
+ const app = new Koa();
39
+ app.use(bodyParser());
40
+
41
+ const server = new MastraServer({ app, mastra });
42
+
43
+ await server.init();
44
+
45
+ app.listen(3000, () => {
46
+ console.log('Server running on http://localhost:3000');
47
+ });
48
+ ```
49
+
50
+ ## Constructor parameters
51
+
52
+ <PropertiesTable
53
+ content={[
54
+ {
55
+ name: "app",
56
+ type: "Koa",
57
+ description: "Koa app instance",
58
+ isOptional: false,
59
+ },
60
+ {
61
+ name: "mastra",
62
+ type: "Mastra",
63
+ description: "Mastra instance",
64
+ isOptional: false,
65
+ },
66
+ {
67
+ name: "prefix",
68
+ type: "string",
69
+ description: "Route path prefix (e.g., `/api/v2`)",
70
+ isOptional: true,
71
+ defaultValue: "''",
72
+ },
73
+ {
74
+ name: "openapiPath",
75
+ type: "string",
76
+ description: "Path to serve OpenAPI spec (e.g., `/openapi.json`)",
77
+ isOptional: true,
78
+ defaultValue: "''",
79
+ },
80
+ {
81
+ name: "bodyLimitOptions",
82
+ type: "BodyLimitOptions",
83
+ typeDescription: "{ maxSize: number, onError: (error: unknown) => unknown }",
84
+ description: "Request body size limits",
85
+ isOptional: true,
86
+ },
87
+ {
88
+ name: "streamOptions",
89
+ type: "StreamOptions",
90
+ typeDescription: "{ redact?: boolean }",
91
+ description: "Stream redaction config. When true (default), redacts sensitive data (system prompts, tool definitions, API keys) from stream chunks before sending to clients.",
92
+ isOptional: true,
93
+ defaultValue: "{ redact: true }",
94
+ },
95
+ {
96
+ name: "customRouteAuthConfig",
97
+ type: "Map<string, boolean>",
98
+ description: "Per-route auth overrides. Keys are `METHOD:PATH` (e.g., `GET:/api/health`). Value `false` makes route public, `true` requires auth.",
99
+ isOptional: true,
100
+ },
101
+ {
102
+ name: "tools",
103
+ type: "ToolsInput",
104
+ typeDescription: "Record<string, ToolAction | VercelTool>",
105
+ description: "Available tools for the server",
106
+ isOptional: true,
107
+ },
108
+ {
109
+ name: "taskStore",
110
+ type: "InMemoryTaskStore",
111
+ description: "Task store for A2A (Agent-to-Agent) operations",
112
+ isOptional: true,
113
+ },
114
+ ]}
115
+ />
116
+
117
+ ## Manual initialization
118
+
119
+ For custom middleware ordering, call each method separately instead of `init()`. See [manual initialization](/docs/v1/server/server-adapters#manual-initialization) for details.
120
+
121
+ ## Examples
122
+
123
+ - [Koa Adapter](https://github.com/mastra-ai/mastra/tree/main/examples/server-koa-adapter) - Basic Koa server setup
124
+
125
+ ## Related
126
+
127
+ - [Server Adapters](/docs/v1/server/server-adapters) - Shared adapter concepts
128
+ - [MastraServer Reference](/reference/v1/server/mastra-server) - Full API reference
129
+ - [createRoute() Reference](/reference/v1/server/create-route) - Creating type-safe custom routes
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: MastraServer | Server"
3
3
  description: "API reference for the MastraServer abstract class used to create server adapters."
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/server"
4
7
  ---
5
8
 
6
9
  import PropertiesTable from "@site/src/components/PropertiesTable";
@@ -11,13 +14,13 @@ The `MastraServer` abstract class is the base for all server adapters. Extend th
11
14
 
12
15
  ## Import
13
16
 
14
- ```typescript copy
15
- import { MastraServer } from '@mastra/server';
17
+ ```typescript
18
+ import { MastraServer } from '@mastra/server/server-adapter';
16
19
  ```
17
20
 
18
21
  ## Type parameters
19
22
 
20
- ```typescript copy
23
+ ```typescript
21
24
  MastraServer<TApp, TRequest, TResponse>
22
25
  ```
23
26
 
@@ -29,7 +32,7 @@ MastraServer<TApp, TRequest, TResponse>
29
32
 
30
33
  ## Constructor
31
34
 
32
- ```typescript copy
35
+ ```typescript
33
36
  constructor(options: MastraServerOptions<TApp>)
34
37
  ```
35
38
 
@@ -61,6 +64,7 @@ constructor(options: MastraServerOptions<TApp>)
61
64
  type: "string",
62
65
  description: "Path to serve OpenAPI spec",
63
66
  isOptional: true,
67
+ defaultValue: "''",
64
68
  },
65
69
  {
66
70
  name: "bodyLimitOptions",
@@ -81,6 +85,18 @@ constructor(options: MastraServerOptions<TApp>)
81
85
  description: "Per-route auth overrides",
82
86
  isOptional: true,
83
87
  },
88
+ {
89
+ name: "tools",
90
+ type: "Record<string, Tool>",
91
+ description: "Available tools for the server",
92
+ isOptional: true,
93
+ },
94
+ {
95
+ name: "taskStore",
96
+ type: "InMemoryTaskStore",
97
+ description: "Task store for A2A (Agent-to-Agent) operations",
98
+ isOptional: true,
99
+ },
84
100
  ]}
85
101
  />
86
102
 
@@ -92,7 +108,7 @@ These methods must be implemented by adapters:
92
108
 
93
109
  Attach Mastra context to every request.
94
110
 
95
- ```typescript copy
111
+ ```typescript
96
112
  abstract registerContextMiddleware(): void
97
113
  ```
98
114
 
@@ -106,7 +122,7 @@ abstract registerContextMiddleware(): void
106
122
 
107
123
  Register authentication and authorization middleware.
108
124
 
109
- ```typescript copy
125
+ ```typescript
110
126
  abstract registerAuthMiddleware(): void
111
127
  ```
112
128
 
@@ -114,7 +130,7 @@ abstract registerAuthMiddleware(): void
114
130
 
115
131
  Register a single route with the framework.
116
132
 
117
- ```typescript copy
133
+ ```typescript
118
134
  abstract registerRoute(
119
135
  app: TApp,
120
136
  route: ServerRoute,
@@ -126,7 +142,7 @@ abstract registerRoute(
126
142
 
127
143
  Extract parameters from the request.
128
144
 
129
- ```typescript copy
145
+ ```typescript
130
146
  abstract getParams(
131
147
  route: ServerRoute,
132
148
  request: TRequest
@@ -141,7 +157,7 @@ abstract getParams(
141
157
 
142
158
  Send response based on route type.
143
159
 
144
- ```typescript copy
160
+ ```typescript
145
161
  abstract sendResponse(
146
162
  route: ServerRoute,
147
163
  response: TResponse,
@@ -153,7 +169,7 @@ abstract sendResponse(
153
169
 
154
170
  Handle streaming responses.
155
171
 
156
- ```typescript copy
172
+ ```typescript
157
173
  abstract stream(
158
174
  route: ServerRoute,
159
175
  response: TResponse,
@@ -167,7 +183,7 @@ abstract stream(
167
183
 
168
184
  Initialize the server by registering all middleware and routes.
169
185
 
170
- ```typescript copy
186
+ ```typescript
171
187
  async init(): Promise<void>
172
188
  ```
173
189
 
@@ -180,7 +196,7 @@ Calls in order:
180
196
 
181
197
  Register all Mastra routes.
182
198
 
183
- ```typescript copy
199
+ ```typescript
184
200
  async registerRoutes(): Promise<void>
185
201
  ```
186
202
 
@@ -188,7 +204,7 @@ async registerRoutes(): Promise<void>
188
204
 
189
205
  Get the framework app instance.
190
206
 
191
- ```typescript copy
207
+ ```typescript
192
208
  getApp<T = TApp>(): T
193
209
  ```
194
210
 
@@ -196,7 +212,7 @@ getApp<T = TApp>(): T
196
212
 
197
213
  Validate path parameters with the route's Zod schema.
198
214
 
199
- ```typescript copy
215
+ ```typescript
200
216
  async parsePathParams(
201
217
  route: ServerRoute,
202
218
  params: Record<string, string>
@@ -207,7 +223,7 @@ async parsePathParams(
207
223
 
208
224
  Validate query parameters with the route's Zod schema.
209
225
 
210
- ```typescript copy
226
+ ```typescript
211
227
  async parseQueryParams(
212
228
  route: ServerRoute,
213
229
  params: Record<string, string>
@@ -218,29 +234,18 @@ async parseQueryParams(
218
234
 
219
235
  Validate request body with the route's Zod schema.
220
236
 
221
- ```typescript copy
237
+ ```typescript
222
238
  async parseBody(
223
239
  route: ServerRoute,
224
240
  body: unknown
225
241
  ): Promise<unknown>
226
242
  ```
227
243
 
228
- ### mergeRequestContext()
229
-
230
- Merge request context from multiple sources (query params and body).
231
-
232
- ```typescript copy
233
- mergeRequestContext(options: {
234
- paramsRequestContext?: Record<string, any>;
235
- bodyRequestContext?: Record<string, any>;
236
- }): RequestContext
237
- ```
238
-
239
244
  ### registerOpenAPIRoute()
240
245
 
241
246
  Register an endpoint that serves the OpenAPI specification.
242
247
 
243
- ```typescript copy
248
+ ```typescript
244
249
  async registerOpenAPIRoute(
245
250
  app: TApp,
246
251
  config: OpenAPIConfig,
@@ -248,11 +253,24 @@ async registerOpenAPIRoute(
248
253
  ): Promise<void>
249
254
  ```
250
255
 
256
+ ## Protected methods
257
+
258
+ ### mergeRequestContext()
259
+
260
+ Merge request context from multiple sources (query params and body).
261
+
262
+ ```typescript
263
+ protected mergeRequestContext(options: {
264
+ paramsRequestContext?: Record<string, any>;
265
+ bodyRequestContext?: Record<string, any>;
266
+ }): RequestContext
267
+ ```
268
+
251
269
  ## Types
252
270
 
253
271
  ### BodyLimitOptions
254
272
 
255
- ```typescript copy
273
+ ```typescript
256
274
  interface BodyLimitOptions {
257
275
  maxSize: number;
258
276
  onError: (error: unknown) => unknown;
@@ -261,7 +279,7 @@ interface BodyLimitOptions {
261
279
 
262
280
  ### StreamOptions
263
281
 
264
- ```typescript copy
282
+ ```typescript
265
283
  interface StreamOptions {
266
284
  redact?: boolean;
267
285
  }
@@ -269,8 +287,8 @@ interface StreamOptions {
269
287
 
270
288
  ## Example
271
289
 
272
- ```typescript copy showLineNumbers
273
- import { MastraServer, ServerRoute } from '@mastra/server';
290
+ ```typescript
291
+ import { MastraServer, ServerRoute } from '@mastra/server/server-adapter';
274
292
  import type { Mastra } from '@mastra/core';
275
293
 
276
294
  export class MyServer extends MastraServer<MyApp, MyRequest, MyResponse> {
@@ -311,6 +329,6 @@ export class MyServer extends MastraServer<MyApp, MyRequest, MyResponse> {
311
329
 
312
330
  ## Related
313
331
 
314
- - [Server Adapters](/docs/v1/server-db/server-adapters) - Using adapters
315
- - [Custom Adapters](/docs/v1/server-db/custom-adapters) - Creating custom adapters
332
+ - [Server Adapters](/docs/v1/server/server-adapters) - Using adapters
333
+ - [Custom Adapters](/docs/v1/server/custom-adapters) - Creating custom adapters
316
334
  - [createRoute()](/reference/v1/server/create-route) - Creating custom routes
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Server Routes | Server"
3
3
  description: "API reference for HTTP routes registered by Mastra server adapters."
4
+ packages:
5
+ - "@mastra/server"
4
6
  ---
5
7
 
6
8
  # Server Routes
@@ -58,16 +60,43 @@ Server adapters register these routes when you call `server.init()`. All routes
58
60
  |--------|------|-------------|
59
61
  | `GET` | `/api/workflows` | List all workflows |
60
62
  | `GET` | `/api/workflows/:workflowId` | Get workflow by ID |
63
+ | `POST` | `/api/workflows/:workflowId/create-run` | Create a new workflow run |
64
+ | `POST` | `/api/workflows/:workflowId/start-async` | Start workflow and await result |
61
65
  | `POST` | `/api/workflows/:workflowId/stream` | Stream workflow execution |
62
66
  | `POST` | `/api/workflows/:workflowId/resume` | Resume suspended workflow |
63
67
  | `POST` | `/api/workflows/:workflowId/resume-async` | Resume asynchronously |
64
68
  | `GET` | `/api/workflows/:workflowId/runs` | List workflow runs |
65
69
  | `GET` | `/api/workflows/:workflowId/runs/:runId` | Get specific run |
66
70
 
71
+ ### Create run request body
72
+
73
+ ```typescript
74
+ {
75
+ resourceId?: string; // Associate run with a resource (e.g., user ID)
76
+ disableScorers?: boolean; // Disable scorers for this run
77
+ }
78
+ ```
79
+
80
+ ### Start-async request body
81
+
82
+ ```typescript
83
+ {
84
+ resourceId?: string; // Associate run with a resource (e.g., user ID)
85
+ inputData?: unknown;
86
+ initialState?: unknown;
87
+ requestContext?: Record<string, unknown>;
88
+ tracingOptions?: {
89
+ spanName?: string;
90
+ attributes?: Record<string, unknown>;
91
+ };
92
+ }
93
+ ```
94
+
67
95
  ### Stream workflow request body
68
96
 
69
97
  ```typescript
70
98
  {
99
+ resourceId?: string; // Associate run with a resource (e.g., user ID)
71
100
  inputData?: unknown;
72
101
  initialState?: unknown;
73
102
  requestContext?: Record<string, unknown>;
@@ -110,6 +139,7 @@ Server adapters register these routes when you call `server.init()`. All routes
110
139
  | `GET` | `/api/memory/threads/:threadId` | Get thread |
111
140
  | `POST` | `/api/memory/threads` | Create thread |
112
141
  | `DELETE` | `/api/memory/threads/:threadId` | Delete thread |
142
+ | `POST` | `/api/memory/threads/:threadId/clone` | Clone thread |
113
143
  | `GET` | `/api/memory/threads/:threadId/messages` | Get thread messages |
114
144
  | `POST` | `/api/memory/threads/:threadId/messages` | Add message |
115
145
 
@@ -123,6 +153,48 @@ Server adapters register these routes when you call `server.init()`. All routes
123
153
  }
124
154
  ```
125
155
 
156
+ ### Clone thread request body
157
+
158
+ ```typescript
159
+ {
160
+ newThreadId?: string; // Custom ID for cloned thread
161
+ resourceId?: string; // Override resource ID
162
+ title?: string; // Custom title for clone
163
+ metadata?: Record<string, unknown>; // Additional metadata
164
+ options?: {
165
+ messageLimit?: number; // Max messages to clone
166
+ messageFilter?: {
167
+ startDate?: Date; // Clone messages after this date
168
+ endDate?: Date; // Clone messages before this date
169
+ messageIds?: string[]; // Clone specific messages
170
+ };
171
+ };
172
+ }
173
+ ```
174
+
175
+ ### Clone thread response
176
+
177
+ ```typescript
178
+ {
179
+ thread: {
180
+ id: string;
181
+ resourceId: string;
182
+ title: string;
183
+ createdAt: Date;
184
+ updatedAt: Date;
185
+ metadata: {
186
+ clone: {
187
+ sourceThreadId: string;
188
+ clonedAt: Date;
189
+ lastMessageId?: string;
190
+ };
191
+ // ... other metadata
192
+ };
193
+ };
194
+ clonedMessages: MastraDBMessage[];
195
+ }
196
+ ```
197
+
126
198
  ## Vectors
127
199
 
128
200
  | Method | Path | Description |
@@ -201,15 +273,6 @@ Most list endpoints support:
201
273
  }
202
274
  ```
203
275
 
204
- Or offset-based:
205
-
206
- ```typescript
207
- {
208
- offset?: number; // Skip N items
209
- limit?: number; // Max items (default: 50)
210
- }
211
- ```
212
-
213
276
  ### Filtering
214
277
 
215
278
  Workflow runs support:
@@ -247,4 +310,4 @@ Common status codes:
247
310
  ## Related
248
311
 
249
312
  - [createRoute()](/reference/v1/server/create-route) - Creating custom routes
250
- - [Server Adapters](/docs/v1/server-db/server-adapters) - Using adapters
313
+ - [Server Adapters](/docs/v1/server/server-adapters) - Using adapters