@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: Toxicity | Scorers | Mastra Docs"
2
+ title: "Reference: Toxicity Scorer | Scorers | Mastra Docs"
3
3
  description: Documentation for the Toxicity Scorer in Mastra, which evaluates LLM outputs for racist, biased, or toxic elements.
4
4
  ---
5
5
 
@@ -43,12 +43,14 @@ This function returns an instance of the MastraScorer class. The `.run()` method
43
43
  {
44
44
  name: "analyzeStepResult",
45
45
  type: "object",
46
- description: "Object with verdicts: { verdicts: Array<{ verdict: 'yes' | 'no', reason: string }> }",
46
+ description:
47
+ "Object with verdicts: { verdicts: Array<{ verdict: 'yes' | 'no', reason: string }> }",
47
48
  },
48
49
  {
49
50
  name: "analyzePrompt",
50
51
  type: "string",
51
- description: "The prompt sent to the LLM for the analyze step (optional).",
52
+ description:
53
+ "The prompt sent to the LLM for the analyze step (optional).",
52
54
  },
53
55
  {
54
56
  name: "score",
@@ -63,7 +65,8 @@ This function returns an instance of the MastraScorer class. The `.run()` method
63
65
  {
64
66
  name: "generateReasonPrompt",
65
67
  type: "string",
66
- description: "The prompt sent to the LLM for the generateReason step (optional).",
68
+ description:
69
+ "The prompt sent to the LLM for the generateReason step (optional).",
67
70
  },
68
71
  ]}
69
72
  />
@@ -83,7 +86,6 @@ This function returns an instance of the MastraScorer class. The `.run()` method
83
86
  }
84
87
  ```
85
88
 
86
-
87
89
  ## Scoring Details
88
90
 
89
91
  The scorer evaluates toxicity through multiple aspects:
@@ -123,21 +125,22 @@ A toxicity score between 0 and 1:
123
125
 
124
126
  In this example, the response contains explicit personal attacks and harmful language, resulting in a high toxicity score.
125
127
 
126
- ```typescript filename="src/example-high-toxicity.ts" showLineNumbers copy
128
+ ```typescript title="src/example-high-toxicity.ts" showLineNumbers copy
127
129
  import { createToxicityScorer } from "@mastra/evals/scorers/llm";
128
130
 
129
- const scorer = createToxicityScorer({ model: 'openai/gpt-4o-mini' });
131
+ const scorer = createToxicityScorer({ model: "openai/gpt-4o-mini" });
130
132
 
131
- const query = 'What do you think about the new team member?';
132
- const response = 'That incompetent fool is a complete waste of space. They clearly bought their degree and have no business being here. Everyone hates working with them.';
133
+ const query = "What do you think about the new team member?";
134
+ const response =
135
+ "That incompetent fool is a complete waste of space. They clearly bought their degree and have no business being here. Everyone hates working with them.";
133
136
 
134
137
  const result = await scorer.run({
135
- input: [{ role: 'user', content: query }],
136
- output: { role: 'assistant', text: response },
138
+ input: [{ role: "user", content: query }],
139
+ output: { role: "assistant", text: response },
137
140
  });
138
141
 
139
- console.log('Score:', result.score);
140
- console.log('Reason:', result.reason);
142
+ console.log("Score:", result.score);
143
+ console.log("Reason:", result.reason);
141
144
  ```
142
145
 
143
146
  #### High toxicity output
@@ -155,24 +158,24 @@ The scorer returns a high score indicating severe toxic content. The `reason` fi
155
158
 
156
159
  In this example, the response combines toxic and professional elements. The scorer identifies the problematic language while acknowledging the constructive feedback, resulting in a moderate toxicity score.
157
160
 
158
- ```typescript filename="src/example-mixed-toxicity.ts" showLineNumbers copy
161
+ ```typescript title="src/example-mixed-toxicity.ts" showLineNumbers copy
159
162
  import { createToxicityScorer } from "@mastra/evals/scorers/llm";
160
163
 
161
- const scorer = createToxicityScorer({ model: 'openai/gpt-4o-mini' });
164
+ const scorer = createToxicityScorer({ model: "openai/gpt-4o-mini" });
162
165
 
163
- const query = 'How was the meeting discussion?';
166
+ const query = "How was the meeting discussion?";
164
167
  const response = [
165
- 'Half the meeting was just listening to the marketing team ramble on with their usual clueless suggestions.',
166
- "At least the engineering team's presentation was focused and had some solid technical solutions we can actually use."
168
+ "Half the meeting was just listening to the marketing team ramble on with their usual clueless suggestions.",
169
+ "At least the engineering team's presentation was focused and had some solid technical solutions we can actually use.",
167
170
  ];
168
171
 
169
172
  const result = await scorer.run({
170
- input: [{ role: 'user', content: query }],
171
- output: { role: 'assistant', text: response },
173
+ input: [{ role: "user", content: query }],
174
+ output: { role: "assistant", text: response },
172
175
  });
173
176
 
174
- console.log('Score:', result.score);
175
- console.log('Reason:', result.reason);
177
+ console.log("Score:", result.score);
178
+ console.log("Reason:", result.reason);
176
179
  ```
177
180
 
178
181
  #### Mixed toxicity output
@@ -190,21 +193,22 @@ The scorer returns a moderate score reflecting a combination of dismissive langu
190
193
 
191
194
  In this example, the response is professional and constructive, with no toxic or harmful language detected.
192
195
 
193
- ```typescript filename="src/example-no-toxicity.ts" showLineNumbers copy
196
+ ```typescript title="src/example-no-toxicity.ts" showLineNumbers copy
194
197
  import { createToxicityScorer } from "@mastra/evals/scorers/llm";
195
198
 
196
- const scorer = createToxicityScorer({ model: 'openai/gpt-4o-mini' });
199
+ const scorer = createToxicityScorer({ model: "openai/gpt-4o-mini" });
197
200
 
198
- const query = 'Can you provide feedback on the project proposal?';
199
- const response = 'The proposal has strong points in its technical approach but could benefit from more detailed market analysis. I suggest we collaborate with the research team to strengthen these sections.';
201
+ const query = "Can you provide feedback on the project proposal?";
202
+ const response =
203
+ "The proposal has strong points in its technical approach but could benefit from more detailed market analysis. I suggest we collaborate with the research team to strengthen these sections.";
200
204
 
201
205
  const result = await scorer.run({
202
- input: [{ role: 'user', content: query }],
203
- output: { role: 'assistant', text: response },
206
+ input: [{ role: "user", content: query }],
207
+ output: { role: "assistant", text: response },
204
208
  });
205
209
 
206
- console.log('Score:', result.score);
207
- console.log('Reason:', result.reason);
210
+ console.log("Score:", result.score);
211
+ console.log("Reason:", result.reason);
208
212
  ```
209
213
 
210
214
  #### No toxicity output
@@ -221,4 +225,4 @@ The scorer returns a low score indicating the response is free from toxic conten
221
225
  ## Related
222
226
 
223
227
  - [Tone Consistency Scorer](./tone-consistency)
224
- - [Bias Scorer](./bias)
228
+ - [Bias Scorer](./bias)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Cloudflare D1 Storage | Storage System | Mastra Core"
2
+ title: "Reference: Cloudflare D1 Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the Cloudflare D1 SQL storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Cloudflare Storage | Storage System | Mastra Core"
2
+ title: "Reference: Cloudflare Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the Cloudflare KV storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "DynamoDB Storage | Storage System | Mastra Core"
2
+ title: "Reference: DynamoDB Storage | Storage | Mastra Docs"
3
3
  description: "Documentation for the DynamoDB storage implementation in Mastra, using a single-table design with ElectroDB."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "LanceDB Storage"
2
+ title: "Reference: LanceDB Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the LanceDB storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "LibSQL Storage | Storage System | Mastra Core"
2
+ title: "Reference: LibSQL Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the LibSQL storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -66,7 +66,7 @@ For production use cases, use a persistent database URL: `libsql://your-database
66
66
  The storage implementation handles schema creation and updates automatically. It creates the following tables:
67
67
 
68
68
  - `mastra_workflow_snapshot`: Stores workflow state and execution data
69
- - `mastra_evals`: Stores evaluation results and metadata
69
+ - `mastra_evals`: Stores evaluation results and metadata
70
70
  - `mastra_threads`: Stores conversation threads
71
71
  - `mastra_messages`: Stores individual messages
72
72
  - `mastra_traces`: Stores telemetry and tracing data
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "MongoDB Storage | Storage System | Mastra Core"
2
+ title: "Reference: MongoDB Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the MongoDB storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -40,8 +40,7 @@ const storage = new MongoDBStore({
40
40
  {
41
41
  name: "dbName",
42
42
  type: "string",
43
- description:
44
- "The name of the database you want the storage to use.",
43
+ description: "The name of the database you want the storage to use.",
45
44
  isOptional: false,
46
45
  },
47
46
  {
@@ -50,7 +49,7 @@ const storage = new MongoDBStore({
50
49
  description:
51
50
  "MongoDB client options for advanced configuration (SSL, connection pooling, etc.). See advanced configuration [here](https://www.mongodb.com/docs/drivers/node/current/connect/connection-options/).",
52
51
  isOptional: true,
53
- }
52
+ },
54
53
  ]}
55
54
  />
56
55
 
@@ -87,7 +86,7 @@ const store2 = new MongoDBStore({
87
86
  The storage implementation handles collection creation and management automatically. It creates the following collections:
88
87
 
89
88
  - `mastra_workflow_snapshot`: Stores workflow state and execution data
90
- - `mastra_evals`: Stores evaluation results and metadata
89
+ - `mastra_evals`: Stores evaluation results and metadata
91
90
  - `mastra_threads`: Stores conversation threads
92
91
  - `mastra_messages`: Stores individual messages
93
92
  - `mastra_traces`: Stores telemetry and tracing data
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "MSSQL Storage | Storage System | Mastra Core"
2
+ title: "Reference: MSSQL Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the MSSQL storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -89,7 +89,7 @@ const store5 = new MSSQLStore({
89
89
  The storage implementation handles schema creation and updates automatically. It creates the following tables:
90
90
 
91
91
  - `mastra_workflow_snapshot`: Stores workflow state and execution data
92
- - `mastra_evals`: Stores evaluation results and metadata
92
+ - `mastra_evals`: Stores evaluation results and metadata
93
93
  - `mastra_threads`: Stores conversation threads
94
94
  - `mastra_messages`: Stores individual messages
95
95
  - `mastra_traces`: Stores telemetry and tracing data
@@ -101,12 +101,13 @@ The storage implementation handles schema creation and updates automatically. It
101
101
  `MSSQLStore` exposes the mssql connection pool as public fields:
102
102
 
103
103
  ```typescript
104
- store.pool // mssql connection pool instance
104
+ store.pool; // mssql connection pool instance
105
105
  ```
106
106
 
107
107
  This enables direct queries and custom transaction management. When using these fields:
108
+
108
109
  - You are responsible for proper connection and transaction handling.
109
110
  - Closing the store (`store.close()`) will destroy the associated connection pool.
110
111
  - Direct access bypasses any additional logic or validation provided by MSSQLStore methods.
111
112
 
112
- This approach is intended for advanced scenarios where low-level access is required.
113
+ This approach is intended for advanced scenarios where low-level access is required.
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "PostgreSQL Storage | Storage System | Mastra Core"
2
+ title: "Reference: PostgreSQL Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the PostgreSQL storage implementation in Mastra.
4
4
  ---
5
5
 
@@ -89,7 +89,7 @@ const store5 = new PostgresStore({
89
89
  The storage implementation handles schema creation and updates automatically. It creates the following tables:
90
90
 
91
91
  - `mastra_workflow_snapshot`: Stores workflow state and execution data
92
- - `mastra_evals`: Stores evaluation results and metadata
92
+ - `mastra_evals`: Stores evaluation results and metadata
93
93
  - `mastra_threads`: Stores conversation threads
94
94
  - `mastra_messages`: Stores individual messages
95
95
  - `mastra_traces`: Stores telemetry and tracing data
@@ -101,11 +101,12 @@ The storage implementation handles schema creation and updates automatically. It
101
101
  `PostgresStore` exposes both the underlying database object and the pg-promise instance as public fields:
102
102
 
103
103
  ```typescript
104
- store.db // pg-promise database instance
105
- store.pgp // pg-promise main instance
104
+ store.db; // pg-promise database instance
105
+ store.pgp; // pg-promise main instance
106
106
  ```
107
107
 
108
108
  This enables direct queries and custom transaction management. When using these fields:
109
+
109
110
  - You are responsible for proper connection and transaction handling.
110
111
  - Closing the store (`store.close()`) will destroy the associated connection pool.
111
112
  - Direct access bypasses any additional logic or validation provided by PostgresStore methods.
@@ -121,7 +122,7 @@ PostgreSQL storage provides comprehensive index management capabilities to optim
121
122
  PostgreSQL storage automatically creates composite indexes during initialization for common query patterns:
122
123
 
123
124
  - `mastra_threads_resourceid_createdat_idx`: (resourceId, createdAt DESC)
124
- - `mastra_messages_thread_id_createdat_idx`: (thread_id, createdAt DESC)
125
+ - `mastra_messages_thread_id_createdat_idx`: (thread_id, createdAt DESC)
125
126
  - `mastra_traces_name_starttime_idx`: (name, startTime DESC)
126
127
  - `mastra_evals_agent_name_created_at_idx`: (agent_name, created_at DESC)
127
128
 
@@ -134,28 +135,29 @@ Create additional indexes to optimize specific query patterns:
134
135
  ```typescript copy
135
136
  // Basic index for common queries
136
137
  await storage.createIndex({
137
- name: 'idx_threads_resource',
138
- table: 'mastra_threads',
139
- columns: ['resourceId']
138
+ name: "idx_threads_resource",
139
+ table: "mastra_threads",
140
+ columns: ["resourceId"],
140
141
  });
141
142
 
142
143
  // Composite index with sort order for filtering + sorting
143
144
  await storage.createIndex({
144
- name: 'idx_messages_composite',
145
- table: 'mastra_messages',
146
- columns: ['thread_id', 'createdAt DESC']
145
+ name: "idx_messages_composite",
146
+ table: "mastra_messages",
147
+ columns: ["thread_id", "createdAt DESC"],
147
148
  });
148
149
 
149
150
  // GIN index for JSONB columns (fast JSON queries)
150
151
  await storage.createIndex({
151
- name: 'idx_traces_attributes',
152
- table: 'mastra_traces',
153
- columns: ['attributes'],
154
- method: 'gin'
152
+ name: "idx_traces_attributes",
153
+ table: "mastra_traces",
154
+ columns: ["attributes"],
155
+ method: "gin",
155
156
  });
156
157
  ```
157
158
 
158
159
  For more advanced use cases, you can also use:
160
+
159
161
  - `unique: true` for unique constraints
160
162
  - `where: 'condition'` for partial indexes
161
163
  - `method: 'brin'` for time-series data
@@ -181,7 +183,8 @@ For more advanced use cases, you can also use:
181
183
  {
182
184
  name: "columns",
183
185
  type: "string[]",
184
- description: "Array of column names with optional sort order (e.g., ['id', 'createdAt DESC'])",
186
+ description:
187
+ "Array of column names with optional sort order (e.g., ['id', 'createdAt DESC'])",
185
188
  isOptional: false,
186
189
  },
187
190
  {
@@ -225,7 +228,7 @@ For more advanced use cases, you can also use:
225
228
  type: "string",
226
229
  description: "Tablespace name for index placement",
227
230
  isOptional: true,
228
- }
231
+ },
229
232
  ]}
230
233
  />
231
234
 
@@ -250,10 +253,10 @@ console.log(allIndexes);
250
253
  // ]
251
254
 
252
255
  // List indexes for specific table
253
- const threadIndexes = await storage.listIndexes('mastra_threads');
256
+ const threadIndexes = await storage.listIndexes("mastra_threads");
254
257
 
255
258
  // Get detailed statistics for an index
256
- const stats = await storage.describeIndex('idx_threads_resource');
259
+ const stats = await storage.describeIndex("idx_threads_resource");
257
260
  console.log(stats);
258
261
  // {
259
262
  // name: 'idx_threads_resource',
@@ -269,7 +272,7 @@ console.log(stats);
269
272
  // }
270
273
 
271
274
  // Drop an index
272
- await storage.dropIndex('idx_threads_status');
275
+ await storage.dropIndex("idx_threads_status");
273
276
  ```
274
277
 
275
278
  ### Schema-Specific Indexes
@@ -279,14 +282,14 @@ When using custom schemas, indexes are created with schema prefixes:
279
282
  ```typescript copy
280
283
  const storage = new PostgresStore({
281
284
  connectionString: process.env.DATABASE_URL,
282
- schemaName: 'custom_schema'
285
+ schemaName: "custom_schema",
283
286
  });
284
287
 
285
288
  // Creates index as: custom_schema_idx_threads_status
286
289
  await storage.createIndex({
287
- name: 'idx_threads_status',
288
- table: 'mastra_threads',
289
- columns: ['status']
290
+ name: "idx_threads_status",
291
+ table: "mastra_threads",
292
+ columns: ["status"],
290
293
  });
291
294
  ```
292
295
 
@@ -294,12 +297,11 @@ await storage.createIndex({
294
297
 
295
298
  PostgreSQL offers different index types optimized for specific scenarios:
296
299
 
297
- | Index Type | Best For | Storage | Speed |
298
- |------------|----------|---------|-------|
299
- | **btree** (default) | Range queries, sorting, general purpose | Moderate | Fast |
300
- | **hash** | Equality comparisons only | Small | Very fast for `=` |
301
- | **gin** | JSONB, arrays, full-text search | Large | Fast for contains |
302
- | **gist** | Geometric data, full-text search | Moderate | Fast for nearest-neighbor |
303
- | **spgist** | Non-balanced data, text patterns | Small | Fast for specific patterns |
304
- | **brin** | Large tables with natural ordering | Very small | Fast for ranges |
305
-
300
+ | Index Type | Best For | Storage | Speed |
301
+ | ------------------- | --------------------------------------- | ---------- | -------------------------- |
302
+ | **btree** (default) | Range queries, sorting, general purpose | Moderate | Fast |
303
+ | **hash** | Equality comparisons only | Small | Very fast for `=` |
304
+ | **gin** | JSONB, arrays, full-text search | Large | Fast for contains |
305
+ | **gist** | Geometric data, full-text search | Moderate | Fast for nearest-neighbor |
306
+ | **spgist** | Non-balanced data, text patterns | Small | Fast for specific patterns |
307
+ | **brin** | Large tables with natural ordering | Very small | Fast for ranges |
@@ -1,16 +1,17 @@
1
1
  ---
2
- title: "Upstash Storage | Storage System | Mastra Core"
2
+ title: "Reference: Upstash Storage | Storage | Mastra Docs"
3
3
  description: Documentation for the Upstash storage implementation in Mastra.
4
4
  ---
5
- import { Callout } from 'nextra/components'
6
5
 
7
6
  # Upstash Storage
8
7
 
9
8
  The Upstash storage implementation provides a serverless-friendly storage solution using Upstash's Redis-compatible key-value store.
10
9
 
11
- <Callout type="warning">
12
- **Important:** When using Mastra with Upstash, the pay-as-you-go model can result in unexpectedly high costs due to the high volume of Redis commands generated during agent conversations. We strongly recommend using a **fixed pricing plan** for predictable costs. See [Upstash pricing](https://upstash.com/pricing/redis) for details and [GitHub issue #5850](https://github.com/mastra-ai/mastra/issues/5850) for context.
13
- </Callout>
10
+ :::warning
11
+
12
+ **Important:** When using Mastra with Upstash, the pay-as-you-go model can result in unexpectedly high costs due to the high volume of Redis commands generated during agent conversations. We strongly recommend using a **fixed pricing plan** for predictable costs. See [Upstash pricing](https://upstash.com/pricing/redis) for details and [GitHub issue #5850](https://github.com/mastra-ai/mastra/issues/5850) for context.
13
+
14
+ :::
14
15
 
15
16
  ## Installation
16
17