@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,10 +1,10 @@
1
1
  ---
2
- title: "Reference: createVectorQueryTool() | RAG | Mastra Tools Docs"
2
+ title: "Reference: createVectorQueryTool() | Tools & MCP | Mastra Docs"
3
3
  description: Documentation for the Vector Query Tool in Mastra, which facilitates semantic search over vector stores with filtering and reranking capabilities.
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
- import { Tabs } from "nextra/components";
6
+ import Tabs from "@theme/Tabs";
7
+ import TabItem from "@theme/TabItem";
8
8
 
9
9
  # createVectorQueryTool()
10
10
 
@@ -25,13 +25,15 @@ const queryTool = createVectorQueryTool({
25
25
 
26
26
  ## Parameters
27
27
 
28
- <Callout>
29
- **Parameter Requirements:** Most fields can be set at creation as defaults.
30
- Some fields can be overridden at runtime via the runtime context or input. If
31
- a required field is missing from both creation and runtime, an error will be
32
- thrown. Note that `model`, `id`, and `description` can only be set at creation
33
- time.
34
- </Callout>
28
+ :::note
29
+
30
+ **Parameter Requirements:** Most fields can be set at creation as defaults.
31
+ Some fields can be overridden at runtime via the runtime context or input. If
32
+ a required field is missing from both creation and runtime, an error will be
33
+ thrown. Note that `model`, `id`, and `description` can only be set at creation
34
+ time.
35
+
36
+ :::
35
37
 
36
38
  <PropertiesTable
37
39
  content={[
@@ -152,7 +154,8 @@ The `DatabaseConfig` type allows you to specify database-specific configurations
152
154
  {
153
155
  name: "pgvector",
154
156
  type: "PgVectorConfig",
155
- description: "Configuration specific to PostgreSQL with pgvector extension",
157
+ description:
158
+ "Configuration specific to PostgreSQL with pgvector extension",
156
159
  isOptional: true,
157
160
  properties: [
158
161
  {
@@ -166,13 +169,15 @@ The `DatabaseConfig` type allows you to specify database-specific configurations
166
169
  },
167
170
  {
168
171
  name: "ef",
169
- description: "HNSW search parameter - controls accuracy vs speed tradeoff",
172
+ description:
173
+ "HNSW search parameter - controls accuracy vs speed tradeoff",
170
174
  isOptional: true,
171
175
  type: "number",
172
176
  },
173
177
  {
174
178
  name: "probes",
175
- description: "IVFFlat probe parameter - number of cells to visit during search",
179
+ description:
180
+ "IVFFlat probe parameter - number of cells to visit during search",
176
181
  isOptional: true,
177
182
  type: "number",
178
183
  },
@@ -321,7 +326,7 @@ This agent-driven approach:
321
326
 
322
327
  For detailed filter syntax and store-specific capabilities, see the [Metadata Filters](../rag/metadata-filters) documentation.
323
328
 
324
- For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](../../../examples/rag/usage/filter-rag.mdx) example.
329
+ For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](/examples/rag/usage/filter-rag) example.
325
330
 
326
331
  ## Example with Reranking
327
332
 
@@ -371,8 +376,8 @@ This example shows how to customize the tool description for a specific use case
371
376
 
372
377
  The `databaseConfig` parameter allows you to leverage unique features and optimizations specific to each vector database. These configurations are automatically applied during query execution.
373
378
 
374
- <Tabs items={['Pinecone', 'pgVector', 'Chroma', 'Multiple Configs']}>
375
- <Tabs.Tab>
379
+ <Tabs>
380
+ <TabItem value="pinecone" label="Pinecone">
376
381
  ### Pinecone Configuration
377
382
 
378
383
  ```typescript
@@ -396,9 +401,10 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
396
401
  - **Namespace**: Isolate different data sets within the same index
397
402
  - **Sparse Vector**: Combine dense and sparse embeddings for improved search quality
398
403
  - **Use Cases**: Multi-tenant applications, hybrid semantic search
399
- </Tabs.Tab>
400
404
 
401
- <Tabs.Tab>
405
+ </TabItem>
406
+
407
+ <TabItem value="pgvector" label="pgVector">
402
408
  ### pgVector Configuration
403
409
 
404
410
  ```typescript
@@ -421,9 +427,10 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
421
427
  - **ef (HNSW)**: Control accuracy vs speed for HNSW indexes
422
428
  - **probes (IVFFlat)**: Control recall vs speed for IVFFlat indexes
423
429
  - **Use Cases**: Performance tuning, quality filtering
424
- </Tabs.Tab>
425
430
 
426
- <Tabs.Tab>
431
+ </TabItem>
432
+
433
+ <TabItem value="chroma" label="Chroma">
427
434
  ### Chroma Configuration
428
435
 
429
436
  ```typescript
@@ -449,9 +456,10 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
449
456
  - **where**: Filter by metadata fields
450
457
  - **whereDocument**: Filter by document content
451
458
  - **Use Cases**: Advanced filtering, content-based search
452
- </Tabs.Tab>
453
459
 
454
- <Tabs.Tab>
460
+ </TabItem>
461
+
462
+ <TabItem value="multiple-configs" label="Multiple Configs">
455
463
  ### Multiple Database Configurations
456
464
 
457
465
  ```typescript
@@ -479,7 +487,8 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
479
487
  - Support multiple vector stores with one tool
480
488
  - Database-specific optimizations are automatically applied
481
489
  - Flexible deployment scenarios
482
- </Tabs.Tab>
490
+
491
+ </TabItem>
483
492
  </Tabs>
484
493
 
485
494
  ### Runtime Configuration Override
@@ -487,7 +496,7 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
487
496
  You can override database configurations at runtime to adapt to different scenarios:
488
497
 
489
498
  ```typescript
490
- import { RuntimeContext } from '@mastra/core/runtime-context';
499
+ import { RuntimeContext } from "@mastra/core/runtime-context";
491
500
 
492
501
  const queryTool = createVectorQueryTool({
493
502
  vectorStoreName: "pinecone",
@@ -495,26 +504,26 @@ const queryTool = createVectorQueryTool({
495
504
  model: openai.embedding("text-embedding-3-small"),
496
505
  databaseConfig: {
497
506
  pinecone: {
498
- namespace: "development"
499
- }
500
- }
507
+ namespace: "development",
508
+ },
509
+ },
501
510
  });
502
511
 
503
512
  // Override at runtime
504
513
  const runtimeContext = new RuntimeContext();
505
- runtimeContext.set('databaseConfig', {
514
+ runtimeContext.set("databaseConfig", {
506
515
  pinecone: {
507
- namespace: 'production' // Switch to production namespace
508
- }
516
+ namespace: "production", // Switch to production namespace
517
+ },
509
518
  });
510
519
 
511
- const response = await agent.generate(
512
- "Find information about deployment",
513
- { runtimeContext }
514
- );
520
+ const response = await agent.generate("Find information about deployment", {
521
+ runtimeContext,
522
+ });
515
523
  ```
516
524
 
517
525
  This approach allows you to:
526
+
518
527
  - Switch between environments (dev/staging/prod)
519
528
  - Adjust performance parameters based on load
520
529
  - Apply different filtering strategies per request
@@ -544,7 +553,7 @@ runtimeContext.set("indexName", "my-index");
544
553
  runtimeContext.set("topK", 5);
545
554
  runtimeContext.set("filter", { category: "docs" });
546
555
  runtimeContext.set("databaseConfig", {
547
- pinecone: { namespace: "runtime-namespace" }
556
+ pinecone: { namespace: "runtime-namespace" },
548
557
  });
549
558
  runtimeContext.set("model", openai.embedding("text-embedding-3-small"));
550
559
 
@@ -558,13 +567,14 @@ const response = await agent.generate(
558
567
 
559
568
  For more information on runtime context, please see:
560
569
 
561
- - [Agent Runtime Context](../../docs/server-db/runtime-context.mdx)
562
- - [Tool Runtime Context](../../docs/tools-mcp/overview.mdx#using-runtimecontext)
570
+ - [Agent Runtime Context](/docs/server-db/runtime-context)
571
+ - [Tool Runtime Context](/docs/tools-mcp/overview#using-runtimecontext)
563
572
 
564
573
  ## Usage Without a Mastra Server
565
574
 
566
575
  The tool can be used by itself to retrieve documents matching a query:
567
- ```typescript copy showLineNumbers filename="src/index.ts"
576
+
577
+ ```typescript copy showLineNumbers title="src/index.ts"
568
578
  import { openai } from "@ai-sdk/openai";
569
579
  import { RuntimeContext } from "@mastra/core/runtime-context";
570
580
  import { createVectorQueryTool } from "@mastra/rag";
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Astra Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Astra Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the AstraVector class in Mastra, which provides vector search using DataStax Astra DB.
4
4
  ---
5
5
 
@@ -1,23 +1,22 @@
1
1
  ---
2
- title: "Reference: Chroma Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Chroma Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the ChromaVector class in Mastra, which provides vector search using ChromaDB.
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # Chroma Vector Store
9
7
 
10
8
  The ChromaVector class provides vector search using [Chroma](https://docs.trychroma.com/docs/overview/getting-started), an open-source embedding database.
11
9
  It offers efficient vector search with metadata filtering and hybrid search capabilities.
12
10
 
13
- <Callout type="info">
14
- <b>Chroma Cloud</b>
15
- <p>
11
+ :::info
12
+
13
+ <b>Chroma Cloud</b>
14
+
16
15
  Chroma Cloud powers serverless vector and full-text search. It's extremely fast, cost-effective, scalable and painless. Create a DB and try it out in under 30 seconds with $5 of free credits.
17
16
 
18
17
  [Get started with Chroma Cloud](https://trychroma.com/signup)
19
- </p>
20
- </Callout>
18
+
19
+ :::
21
20
 
22
21
  ## Constructor Options
23
22
 
@@ -27,7 +26,8 @@ It offers efficient vector search with metadata filtering and hybrid search capa
27
26
  name: "host",
28
27
  type: "string",
29
28
  isOptional: true,
30
- description: "The host address of the Chroma server. Defaults to 'localhost'",
29
+ description:
30
+ "The host address of the Chroma server. Defaults to 'localhost'",
31
31
  },
32
32
  {
33
33
  name: "port",
@@ -39,7 +39,8 @@ It offers efficient vector search with metadata filtering and hybrid search capa
39
39
  name: "ssl",
40
40
  type: "boolean",
41
41
  isOptional: true,
42
- description: "Whether to use SSL/HTTPS for connections. Defaults to false",
42
+ description:
43
+ "Whether to use SSL/HTTPS for connections. Defaults to false",
43
44
  },
44
45
  {
45
46
  name: "apiKey",
@@ -51,13 +52,15 @@ It offers efficient vector search with metadata filtering and hybrid search capa
51
52
  name: "tenant",
52
53
  type: "string",
53
54
  isOptional: true,
54
- description: "The tenant name in the Chroma server to connect to. Defaults to 'default_tenant' for single-node Chroma. Auto-resolved for Chroma Cloud users based on the provided API key",
55
+ description:
56
+ "The tenant name in the Chroma server to connect to. Defaults to 'default_tenant' for single-node Chroma. Auto-resolved for Chroma Cloud users based on the provided API key",
55
57
  },
56
58
  {
57
59
  name: "database",
58
60
  type: "string",
59
61
  isOptional: true,
60
- description: "The database name to connect to. Defaults to 'default_database' for single-node Chroma. Auto-resolved for Chroma Cloud users based on the provided API key",
62
+ description:
63
+ "The database name to connect to. Defaults to 'default_database' for single-node Chroma. Auto-resolved for Chroma Cloud users based on the provided API key",
61
64
  },
62
65
  {
63
66
  name: "headers",
@@ -70,7 +73,7 @@ It offers efficient vector search with metadata filtering and hybrid search capa
70
73
  type: "RequestInit",
71
74
  isOptional: true,
72
75
  description: "Additional fetch options for HTTP requests",
73
- }
76
+ },
74
77
  ]}
75
78
  />
76
79
 
@@ -81,9 +84,10 @@ If you are a Chroma Cloud user, simply provide the `ChromaVector` constructor yo
81
84
  When you install the `@mastra/chroma` package, you get access to the [Chroma CLI](https://docs.trychroma.com/docs/cli/db), which can set these as environment variables for you: `chroma db connect [DB-NAME] --env-file`.
82
85
 
83
86
  Otherwise, you have several options for setting up your single-node Chroma server:
84
- * Run one locally using the Chroma CLI: `chroma run`. You can find more configuration options on the [Chroma docs](https://docs.trychroma.com/docs/cli/run).
85
- * Run on [Docker](https://docs.trychroma.com/guides/deploy/docker) using the official Chroma image.
86
- * Deploy your own Chroma server on your provider of choice. Chroma offers example templates for [AWS](https://docs.trychroma.com/guides/deploy/aws), [Azure](https://docs.trychroma.com/guides/deploy/azure), and [GCP](https://docs.trychroma.com/guides/deploy/gcp).
87
+
88
+ - Run one locally using the Chroma CLI: `chroma run`. You can find more configuration options on the [Chroma docs](https://docs.trychroma.com/docs/cli/run).
89
+ - Run on [Docker](https://docs.trychroma.com/guides/deploy/docker) using the official Chroma image.
90
+ - Deploy your own Chroma server on your provider of choice. Chroma offers example templates for [AWS](https://docs.trychroma.com/guides/deploy/aws), [Azure](https://docs.trychroma.com/guides/deploy/azure), and [GCP](https://docs.trychroma.com/guides/deploy/gcp).
87
91
 
88
92
  ## Methods
89
93
 
@@ -128,7 +132,7 @@ Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS *
128
132
  name: "newIndexName",
129
133
  type: "string",
130
134
  description: "The name of the forked index",
131
- }
135
+ },
132
136
  ]}
133
137
  />
134
138
 
@@ -251,7 +255,8 @@ You can also provide the shape of your metadata to a `get` call for type inferen
251
255
  name: "ids",
252
256
  type: "string[]",
253
257
  isOptional: true,
254
- description: "A list of record IDs to return. If not provided, all records are returned.",
258
+ description:
259
+ "A list of record IDs to return. If not provided, all records are returned.",
255
260
  },
256
261
  {
257
262
  name: "filter",
@@ -284,7 +289,8 @@ You can also provide the shape of your metadata to a `get` call for type inferen
284
289
  type: "number",
285
290
  isOptional: true,
286
291
  defaultValue: 0,
287
- description: "Offset for returning records. Use with `limit` to paginate results.",
292
+ description:
293
+ "Offset for returning records. Use with `limit` to paginate results.",
288
294
  },
289
295
  ]}
290
296
  />
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Couchbase Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Couchbase Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the CouchbaseVector class in Mastra, which provides vector search using Couchbase Vector Search.
4
4
  ---
5
5
 
@@ -21,7 +21,7 @@ npm install @mastra/couchbase
21
21
  ## Usage Example
22
22
 
23
23
  ```typescript copy showLineNumbers
24
- import { CouchbaseVector } from '@mastra/couchbase';
24
+ import { CouchbaseVector } from "@mastra/couchbase";
25
25
 
26
26
  const store = new CouchbaseVector({
27
27
  connectionString: process.env.COUCHBASE_CONNECTION_STRING,
@@ -317,7 +317,7 @@ try {
317
317
  // Handle specific error cases
318
318
  if (error.message.includes("Invalid index name")) {
319
319
  console.error(
320
- "Index name must start with a letter or underscore and contain only valid characters."
320
+ "Index name must start with a letter or underscore and contain only valid characters.",
321
321
  );
322
322
  } else if (error.message.includes("Index not found")) {
323
323
  console.error("The specified index does not exist");
@@ -342,4 +342,4 @@ try {
342
342
 
343
343
  ## Related
344
344
 
345
- - [Metadata Filters](../rag/metadata-filters)
345
+ - [Metadata Filters](../rag/metadata-filters)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Lance Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Lance Vector Store | Vectors | Mastra Docs"
3
3
  description: "Documentation for the LanceVectorStore class in Mastra, which provides vector search using LanceDB, an embedded vector database based on the Lance columnar format."
4
4
  ---
5
5
 
@@ -21,8 +21,7 @@ The LanceVectorStore uses a factory pattern for creation. You should use the sta
21
21
  {
22
22
  name: "options",
23
23
  type: "ConnectionOptions",
24
- description:
25
- "Additional connection options for LanceDB",
24
+ description: "Additional connection options for LanceDB",
26
25
  isOptional: true,
27
26
  },
28
27
  ]}
@@ -42,8 +41,8 @@ const vectorStore = await LanceVectorStore.create("/path/to/db");
42
41
  const cloudStore = await LanceVectorStore.create("db://host:port");
43
42
 
44
43
  // Connect to a cloud database with options
45
- const s3Store = await LanceVectorStore.create("s3://bucket/db", {
46
- storageOptions: { timeout: '60s' }
44
+ const s3Store = await LanceVectorStore.create("s3://bucket/db", {
45
+ storageOptions: { timeout: "60s" },
47
46
  });
48
47
  ```
49
48
 
@@ -448,4 +447,4 @@ try {
448
447
 
449
448
  ## Related
450
449
 
451
- - [Metadata Filters](../rag/metadata-filters)
450
+ - [Metadata Filters](../rag/metadata-filters)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Default Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: LibSQLVector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the LibSQLVector class in Mastra, which provides vector search using LibSQL with vector extensions.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MongoDB Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: MongoDB Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the MongoDBVector class in Mastra, which provides vector search using MongoDB Atlas and Atlas Vector Search.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: OpenSearch Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: OpenSearch Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the OpenSearchVector class in Mastra, which provides vector search using OpenSearch.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: PG Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: PG Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the PgVector class in Mastra, which provides vector search using PostgreSQL with pgvector extension.
4
4
  ---
5
5
 
@@ -584,16 +584,18 @@ try {
584
584
  ### Performance Optimization
585
585
 
586
586
  #### IVFFlat Tuning
587
+
587
588
  - **lists parameter**: Set to `sqrt(n) * 2` where n is the number of vectors
588
589
  - More lists = better accuracy but slower build time
589
590
  - Fewer lists = faster build but potentially lower accuracy
590
591
 
591
592
  #### HNSW Tuning
592
- - **m parameter**:
593
+
594
+ - **m parameter**:
593
595
  - 8-16: Moderate accuracy, lower memory
594
596
  - 16-32: High accuracy, moderate memory
595
597
  - 32-64: Very high accuracy, high memory
596
- - **efConstruction**:
598
+ - **efConstruction**:
597
599
  - 32-64: Fast build, good quality
598
600
  - 64-128: Slower build, better quality
599
601
  - 128-256: Slowest build, best quality
@@ -601,6 +603,7 @@ try {
601
603
  ### Index Recreation Behavior
602
604
 
603
605
  The system automatically detects configuration changes and only rebuilds indexes when necessary:
606
+
604
607
  - Same configuration: Index is kept (no recreation)
605
608
  - Changed configuration: Index is dropped and rebuilt
606
609
  - This prevents the performance issues from unnecessary index recreations
@@ -617,10 +620,11 @@ The system automatically detects configuration changes and only rebuilds indexes
617
620
  The `PgVector` class exposes its underlying PostgreSQL connection pool as a public field:
618
621
 
619
622
  ```typescript
620
- pgVector.pool // instance of pg.Pool
623
+ pgVector.pool; // instance of pg.Pool
621
624
  ```
622
625
 
623
626
  This enables advanced usage such as running direct SQL queries, managing transactions, or monitoring pool state. When using the pool directly:
627
+
624
628
  - You are responsible for releasing clients (`client.release()`) after use.
625
629
  - The pool remains accessible after calling `disconnect()`, but new queries will fail.
626
630
  - Direct access bypasses any validation or transaction logic provided by PgVector methods.
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Pinecone Vector Store | Vector DBs | Mastra Docs"
2
+ title: "Reference: Pinecone Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the PineconeVector class in Mastra, which provides an interface to Pinecone's vector database.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Qdrant Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Qdrant Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for integrating Qdrant with Mastra, a vector similarity search engine for managing vectors and payloads.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Amazon S3 Vectors Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Amazon S3 Vectors Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the S3Vectors class in Mastra, which provides vector search using Amazon S3 Vectors (Preview).
4
4
  ---
5
5
 
@@ -47,7 +47,12 @@ const ids = await store.upsert({
47
47
  [0.3, 0.4 /* … */],
48
48
  ],
49
49
  metadata: [
50
- { text: "doc1", genre: "documentary", year: 2023, createdAt: new Date("2024-01-01") },
50
+ {
51
+ text: "doc1",
52
+ genre: "documentary",
53
+ year: 2023,
54
+ createdAt: new Date("2024-01-01"),
55
+ },
51
56
  { text: "doc2", genre: "comedy", year: 2021 },
52
57
  ],
53
58
  });
@@ -84,7 +89,8 @@ await store.disconnect();
84
89
  name: "nonFilterableMetadataKeys",
85
90
  type: "string[]",
86
91
  isOptional: true,
87
- description: "Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like `content`.",
92
+ description:
93
+ "Metadata keys that should NOT be filterable (applied to the index at creation time). Use this for large text fields like `content`.",
88
94
  },
89
95
  ]}
90
96
  />
@@ -100,7 +106,8 @@ Creates a new vector index in the configured vector bucket. If the index already
100
106
  {
101
107
  name: "indexName",
102
108
  type: "string",
103
- description: "Logical index name. Normalized internally: underscores are replaced with hyphens and the name is lowercased.",
109
+ description:
110
+ "Logical index name. Normalized internally: underscores are replaced with hyphens and the name is lowercased.",
104
111
  },
105
112
  {
106
113
  name: "dimension",
@@ -112,7 +119,8 @@ Creates a new vector index in the configured vector bucket. If the index already
112
119
  type: "'cosine' | 'euclidean'",
113
120
  isOptional: true,
114
121
  defaultValue: "cosine",
115
- description: "Distance metric for similarity search. `dotproduct` is not supported by S3 Vectors.",
122
+ description:
123
+ "Distance metric for similarity search. `dotproduct` is not supported by S3 Vectors.",
116
124
  },
117
125
  ]}
118
126
  />
@@ -175,7 +183,8 @@ Searches for nearest neighbors with optional metadata filtering.
175
183
  name: "filter",
176
184
  type: "S3VectorsFilter",
177
185
  isOptional: true,
178
- description: "JSON-based metadata filter supporting `$and`, `$or`, `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`.",
186
+ description:
187
+ "JSON-based metadata filter supporting `$and`, `$or`, `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`.",
179
188
  },
180
189
  {
181
190
  name: "includeVector",
@@ -187,7 +196,6 @@ Searches for nearest neighbors with optional metadata filtering.
187
196
  ]}
188
197
  />
189
198
 
190
-
191
199
  > **Scoring:** Results include `score = 1/(1 + distance)` so that higher is better while preserving the underlying distance ranking.
192
200
 
193
201
  ### describeIndex()
@@ -310,20 +318,20 @@ interface QueryResult {
310
318
 
311
319
  S3 Vectors supports a strict subset of operators and value types. The Mastra filter translator:
312
320
 
313
- * **Canonicalizes implicit AND**: `{a:1,b:2}` → `{ $and: [{a:1},{b:2}] }`.
314
- * **Normalizes Date values** to epoch ms for numeric comparisons and array elements.
315
- * **Disallows Date** in equality positions (`field: value` or `$eq/$ne`); equality values must be **string | number | boolean**.
316
- * **Rejects** null/undefined for equality; **array equality** is not supported (use `$in`/`$nin`).
317
- * Only **`$and` / `$or`** are allowed as top-level logical operators.
318
- * Logical operators must contain **field conditions** (not direct operators).
321
+ - **Canonicalizes implicit AND**: `{a:1,b:2}` → `{ $and: [{a:1},{b:2}] }`.
322
+ - **Normalizes Date values** to epoch ms for numeric comparisons and array elements.
323
+ - **Disallows Date** in equality positions (`field: value` or `$eq/$ne`); equality values must be **string | number | boolean**.
324
+ - **Rejects** null/undefined for equality; **array equality** is not supported (use `$in`/`$nin`).
325
+ - Only **`$and` / `$or`** are allowed as top-level logical operators.
326
+ - Logical operators must contain **field conditions** (not direct operators).
319
327
 
320
328
  **Supported operators:**
321
329
 
322
- * **Logical:** `$and`, `$or` (non-empty arrays)
323
- * **Basic:** `$eq`, `$ne` (string | number | boolean)
324
- * **Numeric:** `$gt`, `$gte`, `$lt`, `$lte` (number or `Date` → epoch ms)
325
- * **Array:** `$in`, `$nin` (non-empty arrays of string | number | boolean; `Date` → epoch ms)
326
- * **Element:** `$exists` (boolean)
330
+ - **Logical:** `$and`, `$or` (non-empty arrays)
331
+ - **Basic:** `$eq`, `$ne` (string | number | boolean)
332
+ - **Numeric:** `$gt`, `$gte`, `$lt`, `$lte` (number or `Date` → epoch ms)
333
+ - **Array:** `$in`, `$nin` (non-empty arrays of string | number | boolean; `Date` → epoch ms)
334
+ - **Element:** `$exists` (boolean)
327
335
 
328
336
  **Unsupported / disallowed (rejected):** `$not`, `$nor`, `$regex`, `$all`, `$elemMatch`, `$size`, `$text`, etc.
329
337
 
@@ -369,18 +377,18 @@ try {
369
377
 
370
378
  Typical environment variables when wiring your app:
371
379
 
372
- * `S3_VECTORS_BUCKET_NAME`: Your S3 **vector bucket** name (used to populate `vectorBucketName`).
373
- * `AWS_REGION`: AWS region for the S3 Vectors bucket.
374
- * **AWS credentials**: via the standard AWS SDK provider chain (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, etc.).
380
+ - `S3_VECTORS_BUCKET_NAME`: Your S3 **vector bucket** name (used to populate `vectorBucketName`).
381
+ - `AWS_REGION`: AWS region for the S3 Vectors bucket.
382
+ - **AWS credentials**: via the standard AWS SDK provider chain (`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_PROFILE`, etc.).
375
383
 
376
384
  ## Best Practices
377
385
 
378
- * Choose the metric (`cosine` or `euclidean`) to match your embedding model; `dotproduct` is not supported.
379
- * Keep **filterable** metadata small and structured (string/number/boolean). Store large text (e.g., `content`) as **non-filterable**.
380
- * Use **dotted paths** for nested metadata and explicit `$and`/`$or` for complex logic.
381
- * Avoid calling `describeIndex()` on hot paths—`count` is computed with paginated `ListVectors` (**O(n)**).
382
- * Use `includeVector: true` only when you need raw vectors.
386
+ - Choose the metric (`cosine` or `euclidean`) to match your embedding model; `dotproduct` is not supported.
387
+ - Keep **filterable** metadata small and structured (string/number/boolean). Store large text (e.g., `content`) as **non-filterable**.
388
+ - Use **dotted paths** for nested metadata and explicit `$and`/`$or` for complex logic.
389
+ - Avoid calling `describeIndex()` on hot paths—`count` is computed with paginated `ListVectors` (**O(n)**).
390
+ - Use `includeVector: true` only when you need raw vectors.
383
391
 
384
392
  ## Related
385
393
 
386
- * [Metadata Filters](../rag/metadata-filters)
394
+ - [Metadata Filters](../rag/metadata-filters)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Turbopuffer Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Turbopuffer Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for integrating Turbopuffer with Mastra, a high-performance vector database for efficient similarity search.
4
4
  ---
5
5