@mastra/mcp-docs-server 0.13.37 → 0.13.38

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 (397) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
  3. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
  4. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
  5. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +23 -23
  6. package/.docs/organized/changelogs/%40mastra%2Fcore.md +69 -69
  7. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +17 -17
  8. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +17 -17
  9. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +17 -17
  10. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +17 -17
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +25 -25
  12. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
  13. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +27 -27
  14. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  15. package/.docs/organized/changelogs/%40mastra%2Fserver.md +23 -23
  16. package/.docs/organized/changelogs/create-mastra.md +5 -5
  17. package/.docs/organized/changelogs/mastra.md +17 -17
  18. package/.docs/raw/agents/adding-voice.mdx +20 -9
  19. package/.docs/raw/agents/agent-memory.mdx +55 -39
  20. package/.docs/raw/agents/guardrails.mdx +68 -61
  21. package/.docs/raw/agents/networks.mdx +50 -46
  22. package/.docs/raw/agents/overview.mdx +125 -88
  23. package/.docs/raw/agents/using-tools.mdx +14 -15
  24. package/.docs/raw/auth/auth0.mdx +28 -27
  25. package/.docs/raw/auth/clerk.mdx +22 -20
  26. package/.docs/raw/auth/firebase.mdx +42 -39
  27. package/.docs/raw/auth/index.mdx +1 -1
  28. package/.docs/raw/auth/jwt.mdx +18 -16
  29. package/.docs/raw/auth/supabase.mdx +20 -18
  30. package/.docs/raw/auth/workos.mdx +32 -26
  31. package/.docs/raw/community/contributing-templates.mdx +7 -7
  32. package/.docs/raw/community/discord.mdx +2 -2
  33. package/.docs/raw/community/licensing.mdx +1 -1
  34. package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
  35. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
  36. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
  37. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
  38. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
  39. package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
  40. package/.docs/raw/deployment/monorepo.mdx +32 -42
  41. package/.docs/raw/deployment/overview.mdx +15 -15
  42. package/.docs/raw/deployment/server-deployment.mdx +18 -23
  43. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
  44. package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
  45. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
  46. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
  47. package/.docs/raw/deployment/web-framework.mdx +14 -14
  48. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +138 -145
  49. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
  50. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
  51. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
  52. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +59 -48
  53. package/.docs/raw/frameworks/servers/express.mdx +45 -44
  54. package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
  55. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
  56. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +189 -164
  57. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
  58. package/.docs/raw/getting-started/installation.mdx +164 -133
  59. package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
  60. package/.docs/raw/getting-started/project-structure.mdx +34 -42
  61. package/.docs/raw/getting-started/studio.mdx +40 -58
  62. package/.docs/raw/getting-started/templates.mdx +22 -27
  63. package/.docs/raw/index.mdx +9 -9
  64. package/.docs/raw/mastra-cloud/dashboard.mdx +10 -10
  65. package/.docs/raw/mastra-cloud/observability.mdx +7 -8
  66. package/.docs/raw/mastra-cloud/overview.mdx +16 -22
  67. package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
  68. package/.docs/raw/memory/conversation-history.mdx +2 -2
  69. package/.docs/raw/memory/overview.mdx +21 -23
  70. package/.docs/raw/memory/semantic-recall.mdx +14 -13
  71. package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
  72. package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
  73. package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
  74. package/.docs/raw/memory/threads-and-resources.mdx +23 -20
  75. package/.docs/raw/memory/working-memory.mdx +27 -38
  76. package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
  77. package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
  78. package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
  79. package/.docs/raw/observability/ai-tracing/exporters/default.mdx +31 -32
  80. package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
  81. package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
  82. package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
  83. package/.docs/raw/observability/ai-tracing/overview.mdx +145 -122
  84. package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
  85. package/.docs/raw/observability/logging.mdx +14 -17
  86. package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
  87. package/.docs/raw/observability/otel-tracing.mdx +17 -18
  88. package/.docs/raw/observability/overview.mdx +14 -10
  89. package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
  90. package/.docs/raw/rag/overview.mdx +5 -5
  91. package/.docs/raw/rag/retrieval.mdx +125 -107
  92. package/.docs/raw/rag/vector-databases.mdx +232 -223
  93. package/.docs/raw/reference/agents/agent.mdx +54 -41
  94. package/.docs/raw/reference/agents/generate.mdx +367 -261
  95. package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
  96. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
  97. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
  98. package/.docs/raw/reference/agents/getDescription.mdx +3 -2
  99. package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
  100. package/.docs/raw/reference/agents/getLLM.mdx +11 -7
  101. package/.docs/raw/reference/agents/getMemory.mdx +7 -5
  102. package/.docs/raw/reference/agents/getModel.mdx +7 -5
  103. package/.docs/raw/reference/agents/getScorers.mdx +7 -5
  104. package/.docs/raw/reference/agents/getTools.mdx +7 -5
  105. package/.docs/raw/reference/agents/getVoice.mdx +7 -5
  106. package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
  107. package/.docs/raw/reference/agents/listAgents.mdx +6 -4
  108. package/.docs/raw/reference/agents/network.mdx +171 -116
  109. package/.docs/raw/reference/auth/auth0.mdx +18 -14
  110. package/.docs/raw/reference/auth/clerk.mdx +15 -12
  111. package/.docs/raw/reference/auth/firebase.mdx +23 -16
  112. package/.docs/raw/reference/auth/jwt.mdx +7 -6
  113. package/.docs/raw/reference/auth/supabase.mdx +13 -10
  114. package/.docs/raw/reference/auth/workos.mdx +17 -13
  115. package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
  116. package/.docs/raw/reference/cli/mastra.mdx +11 -11
  117. package/.docs/raw/reference/client-js/agents.mdx +40 -43
  118. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  119. package/.docs/raw/reference/client-js/logs.mdx +1 -1
  120. package/.docs/raw/reference/client-js/mastra-client.mdx +21 -13
  121. package/.docs/raw/reference/client-js/memory.mdx +6 -2
  122. package/.docs/raw/reference/client-js/observability.mdx +10 -9
  123. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  124. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  125. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  126. package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
  127. package/.docs/raw/reference/client-js/workflows.mdx +7 -7
  128. package/.docs/raw/reference/core/getAgent.mdx +6 -5
  129. package/.docs/raw/reference/core/getAgentById.mdx +5 -4
  130. package/.docs/raw/reference/core/getAgents.mdx +3 -3
  131. package/.docs/raw/reference/core/getDeployer.mdx +4 -3
  132. package/.docs/raw/reference/core/getLogger.mdx +4 -3
  133. package/.docs/raw/reference/core/getLogs.mdx +10 -6
  134. package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
  135. package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
  136. package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
  137. package/.docs/raw/reference/core/getMemory.mdx +4 -3
  138. package/.docs/raw/reference/core/getScorer.mdx +15 -12
  139. package/.docs/raw/reference/core/getScorerByName.mdx +12 -9
  140. package/.docs/raw/reference/core/getScorers.mdx +3 -2
  141. package/.docs/raw/reference/core/getServer.mdx +4 -3
  142. package/.docs/raw/reference/core/getStorage.mdx +4 -3
  143. package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
  144. package/.docs/raw/reference/core/getVector.mdx +6 -4
  145. package/.docs/raw/reference/core/getVectors.mdx +4 -3
  146. package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
  147. package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
  148. package/.docs/raw/reference/core/mastra-class.mdx +16 -16
  149. package/.docs/raw/reference/core/setLogger.mdx +6 -4
  150. package/.docs/raw/reference/core/setStorage.mdx +4 -4
  151. package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
  152. package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
  153. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  154. package/.docs/raw/reference/deployer/netlify.mdx +4 -4
  155. package/.docs/raw/reference/deployer/vercel.mdx +6 -6
  156. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
  157. package/.docs/raw/reference/evals/bias.mdx +4 -5
  158. package/.docs/raw/reference/evals/completeness.mdx +4 -5
  159. package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
  160. package/.docs/raw/reference/evals/context-position.mdx +4 -5
  161. package/.docs/raw/reference/evals/context-precision.mdx +4 -5
  162. package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
  163. package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
  164. package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
  165. package/.docs/raw/reference/evals/hallucination.mdx +4 -6
  166. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
  167. package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
  168. package/.docs/raw/reference/evals/summarization.mdx +4 -6
  169. package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
  170. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
  171. package/.docs/raw/reference/evals/toxicity.mdx +4 -5
  172. package/.docs/raw/reference/index.mdx +3 -3
  173. package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
  174. package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
  175. package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
  176. package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
  177. package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
  178. package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
  179. package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
  180. package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
  181. package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
  182. package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
  183. package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
  184. package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
  185. package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
  186. package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
  187. package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
  188. package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
  189. package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
  190. package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
  191. package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
  192. package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
  193. package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
  194. package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
  195. package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
  196. package/.docs/raw/reference/memory/createThread.mdx +10 -10
  197. package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
  198. package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
  199. package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
  200. package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
  201. package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +53 -46
  202. package/.docs/raw/reference/memory/query.mdx +39 -25
  203. package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -5
  204. package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
  205. package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
  206. package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
  207. package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
  208. package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
  209. package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
  210. package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
  211. package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
  212. package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
  213. package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +115 -106
  214. package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
  215. package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
  216. package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
  217. package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
  218. package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
  219. package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
  220. package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
  221. package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
  222. package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +3 -3
  223. package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
  224. package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
  225. package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
  226. package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
  227. package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
  228. package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
  229. package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
  230. package/.docs/raw/reference/processors/batch-parts-processor.mdx +13 -10
  231. package/.docs/raw/reference/processors/language-detector.mdx +27 -17
  232. package/.docs/raw/reference/processors/moderation-processor.mdx +26 -17
  233. package/.docs/raw/reference/processors/pii-detector.mdx +28 -18
  234. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +25 -17
  235. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +26 -17
  236. package/.docs/raw/reference/processors/token-limiter-processor.mdx +22 -15
  237. package/.docs/raw/reference/processors/unicode-normalizer.mdx +13 -12
  238. package/.docs/raw/reference/rag/chunk.mdx +41 -23
  239. package/.docs/raw/reference/rag/database-config.mdx +56 -38
  240. package/.docs/raw/reference/rag/document.mdx +1 -1
  241. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  242. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  243. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  244. package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
  245. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  246. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
  247. package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
  248. package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
  249. package/.docs/raw/reference/scorers/bias.mdx +22 -19
  250. package/.docs/raw/reference/scorers/completeness.mdx +21 -16
  251. package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
  252. package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
  253. package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
  254. package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
  255. package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
  256. package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
  257. package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
  258. package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
  259. package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
  260. package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
  261. package/.docs/raw/reference/scorers/run-experiment.mdx +40 -31
  262. package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
  263. package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
  264. package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
  265. package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
  266. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  267. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  268. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  269. package/.docs/raw/reference/storage/lance.mdx +1 -1
  270. package/.docs/raw/reference/storage/libsql.mdx +2 -2
  271. package/.docs/raw/reference/storage/mongodb.mdx +4 -5
  272. package/.docs/raw/reference/storage/mssql.mdx +5 -4
  273. package/.docs/raw/reference/storage/postgresql.mdx +35 -33
  274. package/.docs/raw/reference/storage/upstash.mdx +6 -5
  275. package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
  276. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
  277. package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
  278. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
  279. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
  280. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
  281. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +24 -20
  282. package/.docs/raw/reference/streaming/workflows/stream.mdx +35 -26
  283. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +36 -27
  284. package/.docs/raw/reference/templates/overview.mdx +16 -39
  285. package/.docs/raw/reference/tools/client.mdx +1 -1
  286. package/.docs/raw/reference/tools/create-tool.mdx +45 -35
  287. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
  288. package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
  289. package/.docs/raw/reference/tools/mcp-client.mdx +70 -64
  290. package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
  291. package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
  292. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  293. package/.docs/raw/reference/vectors/chroma.mdx +25 -19
  294. package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
  295. package/.docs/raw/reference/vectors/lance.mdx +5 -6
  296. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  297. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  298. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  299. package/.docs/raw/reference/vectors/pg.mdx +8 -4
  300. package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
  301. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  302. package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
  303. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  304. package/.docs/raw/reference/vectors/upstash.mdx +33 -25
  305. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  306. package/.docs/raw/reference/voice/azure.mdx +1 -1
  307. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  308. package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
  309. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  310. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  311. package/.docs/raw/reference/voice/google-gemini-live.mdx +6 -4
  312. package/.docs/raw/reference/voice/google.mdx +1 -1
  313. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  314. package/.docs/raw/reference/voice/murf.mdx +1 -1
  315. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  316. package/.docs/raw/reference/voice/openai.mdx +1 -1
  317. package/.docs/raw/reference/voice/playai.mdx +1 -1
  318. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  319. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  320. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  321. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  322. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  323. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  324. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  325. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  326. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
  327. package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
  328. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  329. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  330. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  331. package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
  332. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  333. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
  334. package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
  335. package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
  336. package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
  337. package/.docs/raw/reference/workflows/run.mdx +7 -10
  338. package/.docs/raw/reference/workflows/step.mdx +15 -12
  339. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
  340. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  341. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
  342. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
  343. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
  344. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  345. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +3 -2
  346. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  347. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
  348. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
  349. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
  350. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  351. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
  352. package/.docs/raw/reference/workflows/workflow.mdx +13 -10
  353. package/.docs/raw/scorers/custom-scorers.mdx +58 -48
  354. package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
  355. package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
  356. package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
  357. package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
  358. package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
  359. package/.docs/raw/scorers/overview.mdx +20 -19
  360. package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
  361. package/.docs/raw/server-db/mastra-client.mdx +56 -54
  362. package/.docs/raw/server-db/middleware.mdx +11 -7
  363. package/.docs/raw/server-db/production-server.mdx +5 -7
  364. package/.docs/raw/server-db/runtime-context.mdx +41 -38
  365. package/.docs/raw/server-db/storage.mdx +82 -87
  366. package/.docs/raw/streaming/events.mdx +24 -16
  367. package/.docs/raw/streaming/overview.mdx +17 -18
  368. package/.docs/raw/streaming/tool-streaming.mdx +9 -10
  369. package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
  370. package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
  371. package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
  372. package/.docs/raw/tools-mcp/overview.mdx +9 -14
  373. package/.docs/raw/voice/overview.mdx +273 -250
  374. package/.docs/raw/voice/speech-to-speech.mdx +14 -12
  375. package/.docs/raw/voice/speech-to-text.mdx +2 -2
  376. package/.docs/raw/voice/text-to-speech.mdx +2 -2
  377. package/.docs/raw/workflows/agents-and-tools.mdx +29 -28
  378. package/.docs/raw/workflows/control-flow.mdx +24 -24
  379. package/.docs/raw/workflows/error-handling.mdx +15 -17
  380. package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
  381. package/.docs/raw/workflows/inngest-workflow.mdx +33 -29
  382. package/.docs/raw/workflows/input-data-mapping.mdx +9 -9
  383. package/.docs/raw/workflows/overview.mdx +60 -60
  384. package/.docs/raw/workflows/snapshots.mdx +54 -36
  385. package/.docs/raw/workflows/suspend-and-resume.mdx +52 -57
  386. package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
  387. package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
  388. package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
  389. package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
  390. package/.docs/raw/workflows-legacy/overview.mdx +28 -26
  391. package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
  392. package/.docs/raw/workflows-legacy/steps.mdx +5 -3
  393. package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
  394. package/.docs/raw/workflows-legacy/variables.mdx +10 -8
  395. package/CHANGELOG.md +14 -0
  396. package/package.json +5 -5
  397. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: suspend() | Control Flow | Mastra Docs"
2
+ title: "Reference: suspend() | Legacy Workflows | Mastra Docs"
3
3
  description: "Documentation for the suspend function in Mastra workflows, which pauses execution until resumed."
4
4
  ---
5
5
 
@@ -65,6 +65,6 @@ const reviewStep = new LegacyStep({
65
65
 
66
66
  ### Related
67
67
 
68
- - [Suspend & Resume Workflows](../../docs/workflows-legacy/suspend-and-resume.mdx)
69
- - [.resume()](./resume.mdx)
70
- - [.watch()](./watch.mdx)
68
+ - [Suspend & Resume Workflows](/docs/workflows-legacy/suspend-and-resume)
69
+ - [.resume()](./resume)
70
+ - [.watch()](./watch)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.then() | Building Workflows (Legacy) | Mastra Docs"
2
+ title: "Reference: Workflow.then() | Legacy Workflows | Mastra Docs"
3
3
  description: Documentation for the `.then()` method in workflows, which creates sequential dependencies between steps.
4
4
  ---
5
5
 
@@ -66,7 +66,7 @@ try {
66
66
 
67
67
  ## Related
68
68
 
69
- - [step Reference](./step-class.mdx)
70
- - [after Reference](./after.mdx)
71
- - [Sequential Steps Example](../../examples/workflows_legacy/sequential-steps.mdx)
72
- - [Control Flow Guide](../../docs/workflows-legacy/control-flow.mdx)
69
+ - [step Reference](./step-class)
70
+ - [after Reference](./after)
71
+ - [Sequential Steps Example](/examples/workflows_legacy/sequential-steps)
72
+ - [Control Flow Guide](/docs/workflows-legacy/control-flow)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.until() | Looping in Workflows (Legacy) | Mastra Docs"
2
+ title: "Reference: Workflow.until() | Legacy Workflows | Mastra Docs"
3
3
  description: "Documentation for the `.until()` method in Mastra workflows, which repeats a step until a specified condition becomes true."
4
4
  ---
5
5
 
@@ -163,6 +163,6 @@ const result = await run.start({
163
163
 
164
164
  ## Related
165
165
 
166
- - [.while()](./while.mdx) - Loop while a condition is true
167
- - [Control Flow Guide](../../docs/workflows-legacy/control-flow.mdx)
168
- - [Workflow Class Reference](./workflow.mdx)
166
+ - [.while()](./while) - Loop while a condition is true
167
+ - [Control Flow Guide](/docs/workflows-legacy/control-flow)
168
+ - [Workflow Class Reference](./workflow)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: run.watch() | Workflows (Legacy) | Mastra Docs"
2
+ title: "Reference: run.watch() | Legacy Workflows | Mastra Docs"
3
3
  description: Documentation for the `.watch()` method in workflows, which monitors the status of a workflow run.
4
4
  ---
5
5
 
@@ -120,5 +120,5 @@ run.watch(({ results, activePaths }) => {
120
120
 
121
121
  ### Related
122
122
 
123
- - [Workflow Creation](./createRun.mdx)
124
- - [Step Configuration](./step-class.mdx)
123
+ - [Workflow Creation](./createRun)
124
+ - [Step Configuration](./step-class)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow.while() | Looping in Workflows (Legacy) | Mastra Docs"
2
+ title: "Reference: Workflow.while() | Legacy Workflows | Mastra Docs"
3
3
  description: "Documentation for the `.while()` method in Mastra workflows, which repeats a step as long as a specified condition remains true."
4
4
  ---
5
5
 
@@ -163,6 +163,6 @@ const result = await run.start({
163
163
 
164
164
  ## Related
165
165
 
166
- - [.until()](./until.mdx) - Loop until a condition becomes true
167
- - [Control Flow Guide](../../docs/workflows-legacy/control-flow.mdx)
168
- - [Workflow Class Reference](./workflow.mdx)
166
+ - [.until()](./until) - Loop until a condition becomes true
167
+ - [Control Flow Guide](/docs/workflows-legacy/control-flow)
168
+ - [Workflow Class Reference](./workflow)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Workflow Class | Building Workflows (Legacy) | Mastra Docs"
2
+ title: "Reference: Workflow Class | Legacy Workflows | Mastra Docs"
3
3
  description: Documentation for the Workflow class in Mastra, which enables you to create state machines for complex sequences of operations with conditional branching and data validation.
4
4
  ---
5
5
 
@@ -47,7 +47,7 @@ const workflow = new LegacyWorkflow({ name: "my-workflow" });
47
47
 
48
48
  #### `step()`
49
49
 
50
- Adds a [Step](./step-class.mdx) to the workflow, including transitions to other steps. Returns the workflow instance for chaining. [Learn more about steps](./step-class.mdx).
50
+ Adds a [Step](./step-class) to the workflow, including transitions to other steps. Returns the workflow instance for chaining. [Learn more about steps](./step-class).
51
51
 
52
52
  #### `commit()`
53
53
 
@@ -55,7 +55,7 @@ Validates and finalizes the workflow configuration. Must be called after adding
55
55
 
56
56
  #### `execute()`
57
57
 
58
- Executes the workflow with optional trigger data. Typed based on the [trigger schema](./workflow.mdx#trigger-schemas).
58
+ Executes the workflow with optional trigger data. Typed based on the [trigger schema](./workflow#trigger-schemas).
59
59
 
60
60
  ## Trigger Schemas
61
61
 
@@ -228,7 +228,7 @@ The context object:
228
228
 
229
229
  ## Related Documentation
230
230
 
231
- - [Step](./step-class.mdx)
232
- - [.then()](./then.mdx)
233
- - [.step()](./step-function.mdx)
234
- - [.after()](./after.mdx)
231
+ - [Step](./step-class)
232
+ - [.then()](./then)
233
+ - [.step()](./step-function)
234
+ - [.after()](./after)
@@ -85,7 +85,7 @@ await memory?.createThread({ resourceId: "user-123" });
85
85
 
86
86
  ## Extended usage example
87
87
 
88
- ```typescript filename="src/test-memory.ts" showLineNumbers copy
88
+ ```typescript title="src/test-memory.ts" showLineNumbers copy
89
89
  import { mastra } from "./mastra";
90
90
 
91
91
  const agent = mastra.getAgent("agent");
@@ -96,15 +96,15 @@ const thread = await memory?.createThread({
96
96
  title: "Memory Test Thread",
97
97
  metadata: {
98
98
  source: "test-script",
99
- purpose: "memory-testing"
100
- }
99
+ purpose: "memory-testing",
100
+ },
101
101
  });
102
102
 
103
103
  const response = await agent.generate("message for agent", {
104
104
  memory: {
105
105
  thread: thread!.id,
106
- resource: thread!.resourceId
107
- }
106
+ resource: thread!.resourceId,
107
+ },
108
108
  });
109
109
 
110
110
  console.log(response.text);
@@ -112,8 +112,8 @@ console.log(response.text);
112
112
 
113
113
  ### Related
114
114
 
115
- - [Memory Class Reference](/reference/memory/Memory.mdx)
116
- - [Getting Started with Memory](/docs/memory/overview.mdx) (Covers threads concept)
117
- - [getThreadById](/reference/memory/getThreadById.mdx)
118
- - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId.mdx)
119
- - [query](/reference/memory/query.mdx)
115
+ - [Memory Class Reference](/reference/memory/memory-class)
116
+ - [Getting Started with Memory](/docs/memory/overview) (Covers threads concept)
117
+ - [getThreadById](/reference/memory/getThreadById)
118
+ - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId)
119
+ - [query](/reference/memory/query)
@@ -40,7 +40,7 @@ await memory?.deleteMessages(["671ae63f-3a91-4082-a907-fe7de78e10ec"]);
40
40
 
41
41
  ## Extended usage example
42
42
 
43
- ```typescript filename="src/test-memory.ts" showLineNumbers copy
43
+ ```typescript title="src/test-memory.ts" showLineNumbers copy
44
44
  import { mastra } from "./mastra";
45
45
  import { UIMessageWithMetadata } from "@mastra/core/agent";
46
46
 
@@ -49,12 +49,14 @@ const memory = await agent.getMemory();
49
49
 
50
50
  const { uiMessages } = await memory!.query({ threadId: "thread-123" });
51
51
 
52
- const messageIds = uiMessages.map((message: UIMessageWithMetadata) => message.id);
52
+ const messageIds = uiMessages.map(
53
+ (message: UIMessageWithMetadata) => message.id,
54
+ );
53
55
  await memory?.deleteMessages([...messageIds]);
54
56
  ```
55
57
 
56
58
  ## Related
57
59
 
58
- - [Memory Class Reference](/reference/memory/Memory.mdx)
59
- - [query](/reference/memory/query.mdx)
60
- - [Getting Started with Memory](/docs/memory/overview.mdx)
60
+ - [Memory Class Reference](/reference/memory/memory-class)
61
+ - [query](/reference/memory/query)
62
+ - [Getting Started with Memory](/docs/memory/overview)
@@ -33,14 +33,15 @@ await memory?.getThreadById({ threadId: "thread-123" });
33
33
  {
34
34
  name: "thread",
35
35
  type: "Promise<StorageThreadType | null>",
36
- description: "A promise that resolves to the thread associated with the given ID, or null if not found.",
36
+ description:
37
+ "A promise that resolves to the thread associated with the given ID, or null if not found.",
37
38
  },
38
39
  ]}
39
40
  />
40
41
 
41
42
  ### Related
42
43
 
43
- - [Memory Class Reference](/reference/memory/Memory.mdx)
44
- - [Getting Started with Memory](/docs/memory/overview.mdx) (Covers threads concept)
45
- - [createThread](/reference/memory/createThread.mdx)
46
- - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId.mdx)
44
+ - [Memory Class Reference](/reference/memory/memory-class)
45
+ - [Getting Started with Memory](/docs/memory/overview) (Covers threads concept)
46
+ - [createThread](/reference/memory/createThread)
47
+ - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId)
@@ -26,19 +26,20 @@ await memory?.getThreadsByResourceId({ resourceId: "user-123" });
26
26
  {
27
27
  name: "orderBy",
28
28
  type: "ThreadOrderBy",
29
- description: "Field to sort threads by. Accepts 'createdAt' or 'updatedAt'. Default: 'createdAt'",
29
+ description:
30
+ "Field to sort threads by. Accepts 'createdAt' or 'updatedAt'. Default: 'createdAt'",
30
31
  isOptional: true,
31
32
  },
32
33
  {
33
34
  name: "sortDirection",
34
35
  type: "ThreadSortDirection",
35
- description: "Sort order direction. Accepts 'ASC' or 'DESC'. Default: 'DESC'",
36
+ description:
37
+ "Sort order direction. Accepts 'ASC' or 'DESC'. Default: 'DESC'",
36
38
  isOptional: true,
37
39
  },
38
40
  ]}
39
41
  />
40
42
 
41
-
42
43
  ## Returns
43
44
 
44
45
  <PropertiesTable
@@ -54,7 +55,7 @@ await memory?.getThreadsByResourceId({ resourceId: "user-123" });
54
55
 
55
56
  ## Extended usage example
56
57
 
57
- ```typescript filename="src/test-memory.ts" showLineNumbers copy
58
+ ```typescript title="src/test-memory.ts" showLineNumbers copy
58
59
  import { mastra } from "./mastra";
59
60
 
60
61
  const agent = mastra.getAgent("agent");
@@ -63,7 +64,7 @@ const memory = await agent.getMemory();
63
64
  const thread = await memory?.getThreadsByResourceId({
64
65
  resourceId: "user-123",
65
66
  orderBy: "updatedAt",
66
- sortDirection: "ASC"
67
+ sortDirection: "ASC",
67
68
  });
68
69
 
69
70
  console.log(thread);
@@ -71,8 +72,8 @@ console.log(thread);
71
72
 
72
73
  ### Related
73
74
 
74
- - [Memory Class Reference](/reference/memory/Memory.mdx)
75
- - [getThreadsByResourceIdPaginated](/reference/memory/getThreadsByResourceIdPaginated.mdx) - Paginated version
76
- - [Getting Started with Memory](/docs/memory/overview.mdx) (Covers threads/resources concept)
77
- - [createThread](/reference/memory/createThread.mdx)
78
- - [getThreadById](/reference/memory/getThreadById.mdx)
75
+ - [Memory Class Reference](/reference/memory/memory-class)
76
+ - [getThreadsByResourceIdPaginated](/reference/memory/getThreadsByResourceIdPaginated) - Paginated version
77
+ - [Getting Started with Memory](/docs/memory/overview) (Covers threads/resources concept)
78
+ - [createThread](/reference/memory/createThread)
79
+ - [getThreadById](/reference/memory/getThreadById)
@@ -13,7 +13,7 @@ The `.getThreadsByResourceIdPaginated()` method retrieves threads associated wit
13
13
  await memory.getThreadsByResourceIdPaginated({
14
14
  resourceId: "user-123",
15
15
  page: 0,
16
- perPage: 10
16
+ perPage: 10,
17
17
  });
18
18
  ```
19
19
 
@@ -61,14 +61,15 @@ await memory.getThreadsByResourceIdPaginated({
61
61
  {
62
62
  name: "result",
63
63
  type: "Promise<PaginationInfo & { threads: StorageThreadType[] }>",
64
- description: "A promise that resolves to paginated thread results with metadata",
64
+ description:
65
+ "A promise that resolves to paginated thread results with metadata",
65
66
  },
66
67
  ]}
67
68
  />
68
69
 
69
70
  ## Extended usage example
70
71
 
71
- ```typescript filename="src/test-memory.ts" showLineNumbers copy
72
+ ```typescript title="src/test-memory.ts" showLineNumbers copy
72
73
  import { mastra } from "./mastra";
73
74
 
74
75
  const agent = mastra.getAgent("agent");
@@ -83,7 +84,7 @@ while (hasMorePages) {
83
84
  page: currentPage,
84
85
  perPage: 25,
85
86
  orderBy: "createdAt",
86
- sortDirection: "ASC"
87
+ sortDirection: "ASC",
87
88
  });
88
89
 
89
90
  if (!threads) {
@@ -102,8 +103,8 @@ while (hasMorePages) {
102
103
 
103
104
  ## Related
104
105
 
105
- - [Memory Class Reference](/reference/memory/Memory.mdx)
106
- - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId.mdx) - Non-paginated version
107
- - [Getting Started with Memory](/docs/memory/overview.mdx) (Covers threads/resources concept)
108
- - [createThread](/reference/memory/createThread.mdx)
109
- - [getThreadById](/reference/memory/getThreadById.mdx)
106
+ - [Memory Class Reference](/reference/memory/memory-class)
107
+ - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId) - Non-paginated version
108
+ - [Getting Started with Memory](/docs/memory/overview) (Covers threads/resources concept)
109
+ - [createThread](/reference/memory/createThread)
110
+ - [getThreadById](/reference/memory/getThreadById)
@@ -9,7 +9,7 @@ The `Memory` class provides a robust system for managing conversation history an
9
9
 
10
10
  ## Usage example
11
11
 
12
- ```typescript filename="src/mastra/agents/test-agent.ts" showLineNumbers copy
12
+ ```typescript title="src/mastra/agents/test-agent.ts" showLineNumbers copy
13
13
  import { Memory } from "@mastra/memory";
14
14
  import { Agent } from "@mastra/core/agent";
15
15
  import { openai } from "@ai-sdk/openai";
@@ -21,14 +21,14 @@ export const agent = new Agent({
21
21
  memory: new Memory({
22
22
  options: {
23
23
  workingMemory: {
24
- enabled: true
25
- }
26
- }
27
- })
24
+ enabled: true,
25
+ },
26
+ },
27
+ }),
28
28
  });
29
29
  ```
30
30
 
31
- > To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](../core/mastra-class.mdx) for more information.
31
+ > To enable `workingMemory` on an agent, you’ll need a storage provider configured on your main Mastra instance. See [Mastra class](../core/mastra-class) for more information.
32
32
 
33
33
  ## Constructor parameters
34
34
 
@@ -37,19 +37,22 @@ export const agent = new Agent({
37
37
  {
38
38
  name: "storage",
39
39
  type: "MastraStorage",
40
- description: "Storage implementation for persisting memory data. Defaults to `new DefaultStorage({ config: { url: \"file:memory.db\" } })` if not provided.",
40
+ description:
41
+ 'Storage implementation for persisting memory data. Defaults to `new DefaultStorage({ config: { url: "file:memory.db" } })` if not provided.',
41
42
  isOptional: true,
42
43
  },
43
44
  {
44
45
  name: "vector",
45
46
  type: "MastraVector | false",
46
- description: "Vector store for semantic search capabilities. Set to `false` to disable vector operations.",
47
+ description:
48
+ "Vector store for semantic search capabilities. Set to `false` to disable vector operations.",
47
49
  isOptional: true,
48
50
  },
49
51
  {
50
52
  name: "embedder",
51
53
  type: "EmbeddingModel<string> | EmbeddingModelV2<string>",
52
- description: "Embedder instance for vector embeddings. Required when semantic recall is enabled.",
54
+ description:
55
+ "Embedder instance for vector embeddings. Required when semantic recall is enabled.",
53
56
  isOptional: true,
54
57
  },
55
58
  {
@@ -61,7 +64,8 @@ export const agent = new Agent({
61
64
  {
62
65
  name: "processors",
63
66
  type: "MemoryProcessor[]",
64
- description: "Array of memory processors that can filter or transform messages before they're sent to the LLM.",
67
+ description:
68
+ "Array of memory processors that can filter or transform messages before they're sent to the LLM.",
65
69
  isOptional: true,
66
70
  },
67
71
  ]}
@@ -74,7 +78,8 @@ export const agent = new Agent({
74
78
  {
75
79
  name: "lastMessages",
76
80
  type: "number | false",
77
- description: "Number of most recent messages to retrieve. Set to false to disable.",
81
+ description:
82
+ "Number of most recent messages to retrieve. Set to false to disable.",
78
83
  isOptional: true,
79
84
  defaultValue: "10",
80
85
  },
@@ -88,14 +93,17 @@ export const agent = new Agent({
88
93
  {
89
94
  name: "workingMemory",
90
95
  type: "WorkingMemory",
91
- description: "Configuration for working memory feature. Can be `{ enabled: boolean; template?: string; schema?: ZodObject<any> | JSONSchema7; scope?: 'thread' | 'resource' }` or `{ enabled: boolean }` to disable.",
96
+ description:
97
+ "Configuration for working memory feature. Can be `{ enabled: boolean; template?: string; schema?: ZodObject<any> | JSONSchema7; scope?: 'thread' | 'resource' }` or `{ enabled: boolean }` to disable.",
92
98
  isOptional: true,
93
- defaultValue: "{ enabled: false, template: '# User Information\\n- **First Name**:\\n- **Last Name**:\\n...' }",
99
+ defaultValue:
100
+ "{ enabled: false, template: '# User Information\\n- **First Name**:\\n- **Last Name**:\\n...' }",
94
101
  },
95
102
  {
96
103
  name: "threads",
97
104
  type: "{ generateTitle?: boolean | { model: DynamicArgument<MastraLanguageModel>; instructions?: DynamicArgument<string> } }",
98
- description: "Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions.",
105
+ description:
106
+ "Settings related to memory thread creation. `generateTitle` controls automatic thread title generation from the user's first message. Can be a boolean or an object with custom model and instructions.",
99
107
  isOptional: true,
100
108
  defaultValue: "{ generateTitle: false }",
101
109
  },
@@ -114,10 +122,9 @@ export const agent = new Agent({
114
122
  ]}
115
123
  />
116
124
 
117
-
118
125
  ## Extended usage example
119
126
 
120
- ```typescript filename="src/mastra/agents/test-agent.ts" showLineNumbers copy
127
+ ```typescript title="src/mastra/agents/test-agent.ts" showLineNumbers copy
121
128
  import { Memory } from "@mastra/memory";
122
129
  import { Agent } from "@mastra/core/agent";
123
130
  import { openai } from "@ai-sdk/openai";
@@ -129,32 +136,32 @@ export const agent = new Agent({
129
136
  model: openai("gpt-4o"),
130
137
  memory: new Memory({
131
138
  storage: new LibSQLStore({
132
- url: "file:./working-memory.db"
139
+ url: "file:./working-memory.db",
133
140
  }),
134
141
  vector: new LibSQLVector({
135
- connectionUrl: "file:./vector-memory.db"
142
+ connectionUrl: "file:./vector-memory.db",
136
143
  }),
137
144
  options: {
138
145
  lastMessages: 10,
139
146
  semanticRecall: {
140
147
  topK: 3,
141
148
  messageRange: 2,
142
- scope: 'resource'
149
+ scope: "resource",
143
150
  },
144
151
  workingMemory: {
145
- enabled: true
152
+ enabled: true,
146
153
  },
147
154
  threads: {
148
- generateTitle: true
149
- }
150
- }
151
- })
155
+ generateTitle: true,
156
+ },
157
+ },
158
+ }),
152
159
  });
153
160
  ```
154
161
 
155
162
  ## PostgreSQL with index configuration
156
163
 
157
- ```typescript filename="src/mastra/agents/pg-agent.ts" showLineNumbers copy
164
+ ```typescript title="src/mastra/agents/pg-agent.ts" showLineNumbers copy
158
165
  import { Memory } from "@mastra/memory";
159
166
  import { Agent } from "@mastra/core/agent";
160
167
  import { openai } from "@ai-sdk/openai";
@@ -166,10 +173,10 @@ export const agent = new Agent({
166
173
  model: openai("gpt-4o"),
167
174
  memory: new Memory({
168
175
  storage: new PgStore({
169
- connectionString: process.env.DATABASE_URL
176
+ connectionString: process.env.DATABASE_URL,
170
177
  }),
171
178
  vector: new PgVector({
172
- connectionString: process.env.DATABASE_URL
179
+ connectionString: process.env.DATABASE_URL,
173
180
  }),
174
181
  embedder: openai.embedding("text-embedding-3-small"),
175
182
  options: {
@@ -177,30 +184,30 @@ export const agent = new Agent({
177
184
  semanticRecall: {
178
185
  topK: 5,
179
186
  messageRange: 3,
180
- scope: 'resource',
187
+ scope: "resource",
181
188
  indexConfig: {
182
- type: 'hnsw', // Use HNSW for better performance
183
- metric: 'dotproduct', // Optimal for OpenAI embeddings
184
- m: 16, // Number of bi-directional links
185
- efConstruction: 64 // Construction-time candidate list size
186
- }
189
+ type: "hnsw", // Use HNSW for better performance
190
+ metric: "dotproduct", // Optimal for OpenAI embeddings
191
+ m: 16, // Number of bi-directional links
192
+ efConstruction: 64, // Construction-time candidate list size
193
+ },
187
194
  },
188
195
  workingMemory: {
189
- enabled: true
190
- }
191
- }
192
- })
196
+ enabled: true,
197
+ },
198
+ },
199
+ }),
193
200
  });
194
201
  ```
195
202
 
196
203
  ### Related
197
204
 
198
- - [Getting Started with Memory](/docs/memory/overview.mdx)
199
- - [Semantic Recall](/docs/memory/semantic-recall.mdx)
200
- - [Working Memory](/docs/memory/working-memory.mdx)
201
- - [Memory Processors](/docs/memory/memory-processors.mdx)
202
- - [createThread](/reference/memory/createThread.mdx)
203
- - [query](/reference/memory/query.mdx)
204
- - [getThreadById](/reference/memory/getThreadById.mdx)
205
- - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId.mdx)
206
- - [deleteMessages](/reference/memory/deleteMessages.mdx)
205
+ - [Getting Started with Memory](/docs/memory/overview)
206
+ - [Semantic Recall](/docs/memory/semantic-recall)
207
+ - [Working Memory](/docs/memory/working-memory)
208
+ - [Memory Processors](/docs/memory/memory-processors)
209
+ - [createThread](/reference/memory/createThread)
210
+ - [query](/reference/memory/query)
211
+ - [getThreadById](/reference/memory/getThreadById)
212
+ - [getThreadsByResourceId](/reference/memory/getThreadsByResourceId)
213
+ - [deleteMessages](/reference/memory/deleteMessages)