@mastra/mcp-docs-server 1.0.0-beta.8 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (544) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +1 -13
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +1 -5
  3. package/.docs/organized/changelogs/%40internal%2Fplayground.md +40 -0
  4. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
  5. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +1 -53
  6. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +287 -287
  7. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +315 -315
  8. package/.docs/organized/changelogs/%40mastra%2Fastra.md +53 -53
  9. package/.docs/organized/changelogs/%40mastra%2Fauth.md +38 -0
  10. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +66 -66
  11. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +522 -212
  12. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +658 -196
  13. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +439 -234
  14. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +450 -211
  15. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +208 -0
  16. package/.docs/organized/changelogs/%40mastra%2Fconvex.md +448 -22
  17. package/.docs/organized/changelogs/%40mastra%2Fcore.md +3341 -271
  18. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +60 -60
  19. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +289 -289
  20. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +90 -90
  21. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +74 -74
  22. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +70 -70
  23. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +247 -220
  24. package/.docs/organized/changelogs/%40mastra%2Fduckdb.md +70 -0
  25. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +403 -225
  26. package/.docs/organized/changelogs/%40mastra%2Felasticsearch.md +72 -0
  27. package/.docs/organized/changelogs/%40mastra%2Fevals.md +145 -145
  28. package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +54 -0
  29. package/.docs/organized/changelogs/%40mastra%2Flance.md +456 -226
  30. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +604 -208
  31. package/.docs/organized/changelogs/%40mastra%2Floggers.md +71 -71
  32. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +247 -247
  33. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +28 -28
  34. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +285 -285
  35. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +354 -156
  36. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +545 -212
  37. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +481 -202
  38. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +194 -194
  39. package/.docs/organized/changelogs/%40mastra%2Fpg.md +759 -213
  40. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +198 -198
  41. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +636 -229
  42. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +163 -163
  43. package/.docs/organized/changelogs/%40mastra%2Frag.md +310 -310
  44. package/.docs/organized/changelogs/%40mastra%2Freact.md +328 -230
  45. package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +64 -0
  46. package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +160 -0
  47. package/.docs/organized/changelogs/%40mastra%2Fserver.md +829 -218
  48. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +57 -57
  49. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +479 -232
  50. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +53 -53
  51. package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +45 -45
  52. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +45 -45
  53. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +47 -47
  54. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +110 -110
  55. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +15 -0
  56. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +98 -0
  57. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +54 -54
  58. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +46 -46
  59. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +93 -93
  60. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +47 -47
  61. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +45 -45
  62. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +45 -45
  63. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +45 -45
  64. package/.docs/organized/changelogs/create-mastra.md +227 -227
  65. package/.docs/organized/changelogs/mastra.md +277 -277
  66. package/.docs/organized/code-examples/a2a.md +2 -2
  67. package/.docs/organized/code-examples/agent-v6.md +221 -0
  68. package/.docs/organized/code-examples/agui.md +4 -4
  69. package/.docs/organized/code-examples/ai-elements.md +3 -3
  70. package/.docs/organized/code-examples/ai-sdk-useChat.md +2 -2
  71. package/.docs/organized/code-examples/ai-sdk-v5.md +3 -3
  72. package/.docs/organized/code-examples/assistant-ui.md +5 -5
  73. package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
  74. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +2 -2
  75. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +3 -3
  76. package/.docs/organized/code-examples/client-side-tools.md +4 -4
  77. package/.docs/organized/code-examples/crypto-chatbot.md +5 -5
  78. package/.docs/organized/code-examples/experimental-auth-weather-agent.md +1 -1
  79. package/.docs/organized/code-examples/fireworks-r1.md +2 -2
  80. package/.docs/organized/code-examples/heads-up-game.md +7 -7
  81. package/.docs/organized/code-examples/inngest.md +1075 -0
  82. package/.docs/organized/code-examples/mcp-configuration.md +1 -1
  83. package/.docs/organized/code-examples/mcp-server-adapters.md +3 -4
  84. package/.docs/organized/code-examples/memory-per-resource-example.md +3 -3
  85. package/.docs/organized/code-examples/memory-todo-agent.md +1 -1
  86. package/.docs/organized/code-examples/memory-with-context.md +1 -1
  87. package/.docs/organized/code-examples/memory-with-processors.md +1 -1
  88. package/.docs/organized/code-examples/openapi-spec-writer.md +3 -3
  89. package/.docs/organized/code-examples/processors-with-ai-sdk.md +14 -0
  90. package/.docs/organized/code-examples/quick-start.md +1 -5
  91. package/.docs/organized/code-examples/server-app-access.md +3 -3
  92. package/.docs/organized/code-examples/server-express-adapter.md +1 -1
  93. package/.docs/organized/code-examples/server-fastify-adapter.md +83 -0
  94. package/.docs/organized/code-examples/server-hono-adapter.md +3 -3
  95. package/.docs/organized/code-examples/server-koa-adapter.md +94 -0
  96. package/.docs/organized/code-examples/stock-price-tool.md +21 -2
  97. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  98. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  99. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  100. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  101. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
  102. package/.docs/raw/agents/adding-voice.mdx +24 -6
  103. package/.docs/raw/agents/agent-approval.mdx +209 -12
  104. package/.docs/raw/agents/agent-memory.mdx +36 -32
  105. package/.docs/raw/agents/guardrails.mdx +105 -56
  106. package/.docs/raw/agents/network-approval.mdx +281 -0
  107. package/.docs/raw/agents/networks.mdx +69 -13
  108. package/.docs/raw/agents/overview.mdx +43 -25
  109. package/.docs/raw/agents/processors.mdx +234 -17
  110. package/.docs/raw/agents/structured-output.mdx +78 -8
  111. package/.docs/raw/agents/using-tools.mdx +67 -6
  112. package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +1 -2
  113. package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +1 -1
  114. package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +1 -2
  115. package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +1 -1
  116. package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +1 -1
  117. package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +1 -1
  118. package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +1 -1
  119. package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +1 -1
  120. package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +3 -3
  121. package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
  122. package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +35 -0
  123. package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
  124. package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +1 -1
  125. package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +4 -5
  126. package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
  127. package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +3 -4
  128. package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +3 -4
  129. package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +3 -4
  130. package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +3 -4
  131. package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
  132. package/.docs/raw/deployment/cloud-providers.mdx +22 -0
  133. package/.docs/raw/deployment/mastra-server.mdx +140 -0
  134. package/.docs/raw/deployment/monorepo.mdx +106 -42
  135. package/.docs/raw/deployment/overview.mdx +35 -48
  136. package/.docs/raw/deployment/web-framework.mdx +17 -19
  137. package/.docs/raw/deployment/workflow-runners.mdx +16 -0
  138. package/.docs/raw/evals/built-in-scorers.mdx +2 -0
  139. package/.docs/raw/evals/custom-scorers.mdx +60 -12
  140. package/.docs/raw/evals/overview.mdx +6 -6
  141. package/.docs/raw/evals/running-in-ci.mdx +4 -2
  142. package/.docs/raw/getting-started/manual-install.mdx +20 -20
  143. package/.docs/raw/getting-started/mcp-docs-server.mdx +59 -2
  144. package/.docs/raw/getting-started/project-structure.mdx +2 -2
  145. package/.docs/raw/getting-started/start.mdx +17 -1
  146. package/.docs/raw/getting-started/studio.mdx +10 -37
  147. package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +151 -0
  148. package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1034 -80
  149. package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
  150. package/.docs/raw/guides/build-your-ui/copilotkit.mdx +32 -11
  151. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/amazon-ec2.mdx +9 -9
  152. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/aws-lambda.mdx +13 -16
  153. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/azure-app-services.mdx +5 -7
  154. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/cloudflare-deployer.mdx +8 -5
  155. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/digital-ocean.mdx +18 -23
  156. package/.docs/raw/guides/deployment/index.mdx +32 -0
  157. package/.docs/raw/guides/deployment/inngest.mdx +673 -0
  158. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/netlify-deployer.mdx +7 -3
  159. package/.docs/raw/{deployment/cloud-providers → guides/deployment}/vercel-deployer.mdx +8 -5
  160. package/.docs/raw/guides/getting-started/astro.mdx +292 -451
  161. package/.docs/raw/guides/getting-started/express.mdx +72 -153
  162. package/.docs/raw/guides/getting-started/hono.mdx +227 -0
  163. package/.docs/raw/guides/getting-started/next-js.mdx +173 -61
  164. package/.docs/raw/guides/getting-started/nuxt.mdx +505 -0
  165. package/.docs/raw/guides/getting-started/quickstart.mdx +5 -5
  166. package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
  167. package/.docs/raw/guides/getting-started/vite-react.mdx +317 -147
  168. package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
  169. package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
  170. package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
  171. package/.docs/raw/guides/guide/research-assistant.mdx +20 -20
  172. package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
  173. package/.docs/raw/guides/guide/web-search.mdx +38 -38
  174. package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
  175. package/.docs/raw/guides/index.mdx +0 -1
  176. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
  177. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +105 -4
  178. package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +15 -1
  179. package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +170 -0
  180. package/.docs/raw/guides/migrations/upgrade-to-v1/deployment.mdx +42 -0
  181. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +0 -35
  182. package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +40 -3
  183. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +17 -2
  184. package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
  185. package/.docs/raw/guides/migrations/upgrade-to-v1/rag.mdx +47 -0
  186. package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +271 -25
  187. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +3 -3
  188. package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +72 -17
  189. package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +46 -1
  190. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +50 -7
  191. package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
  192. package/.docs/raw/index.mdx +2 -2
  193. package/.docs/raw/mastra-cloud/deployment.mdx +86 -0
  194. package/.docs/raw/mastra-cloud/observability.mdx +43 -0
  195. package/.docs/raw/mastra-cloud/overview.mdx +31 -0
  196. package/.docs/raw/mastra-cloud/setup.mdx +64 -0
  197. package/.docs/raw/mastra-cloud/studio.mdx +35 -0
  198. package/.docs/raw/mcp/overview.mdx +60 -25
  199. package/.docs/raw/mcp/publishing-mcp-server.mdx +7 -4
  200. package/.docs/raw/memory/memory-processors.mdx +17 -12
  201. package/.docs/raw/memory/message-history.mdx +72 -0
  202. package/.docs/raw/memory/overview.mdx +38 -76
  203. package/.docs/raw/memory/semantic-recall.mdx +65 -52
  204. package/.docs/raw/memory/storage.mdx +248 -0
  205. package/.docs/raw/memory/working-memory.mdx +24 -13
  206. package/.docs/raw/observability/logging.mdx +16 -15
  207. package/.docs/raw/observability/overview.mdx +27 -7
  208. package/.docs/raw/observability/tracing/bridges/otel.mdx +7 -4
  209. package/.docs/raw/observability/tracing/exporters/arize.mdx +61 -24
  210. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +32 -22
  211. package/.docs/raw/observability/tracing/exporters/cloud.mdx +24 -5
  212. package/.docs/raw/observability/tracing/exporters/datadog.mdx +175 -0
  213. package/.docs/raw/observability/tracing/exporters/default.mdx +28 -7
  214. package/.docs/raw/observability/tracing/exporters/laminar.mdx +89 -0
  215. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +31 -22
  216. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +33 -3
  217. package/.docs/raw/observability/tracing/exporters/otel.mdx +194 -22
  218. package/.docs/raw/observability/tracing/exporters/posthog.mdx +32 -22
  219. package/.docs/raw/observability/tracing/exporters/sentry.mdx +198 -0
  220. package/.docs/raw/observability/tracing/overview.mdx +388 -108
  221. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +27 -7
  222. package/.docs/raw/rag/chunking-and-embedding.mdx +22 -33
  223. package/.docs/raw/rag/graph-rag.mdx +223 -0
  224. package/.docs/raw/rag/overview.mdx +6 -3
  225. package/.docs/raw/rag/retrieval.mdx +53 -57
  226. package/.docs/raw/rag/vector-databases.mdx +55 -31
  227. package/.docs/raw/reference/agents/agent.mdx +17 -14
  228. package/.docs/raw/reference/agents/generate.mdx +172 -44
  229. package/.docs/raw/reference/agents/generateLegacy.mdx +5 -3
  230. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +5 -3
  231. package/.docs/raw/reference/agents/getDefaultOptions.mdx +5 -3
  232. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +5 -3
  233. package/.docs/raw/reference/agents/getDescription.mdx +3 -1
  234. package/.docs/raw/reference/agents/getInstructions.mdx +5 -3
  235. package/.docs/raw/reference/agents/getLLM.mdx +5 -3
  236. package/.docs/raw/reference/agents/getMemory.mdx +5 -3
  237. package/.docs/raw/reference/agents/getModel.mdx +5 -3
  238. package/.docs/raw/reference/agents/getTools.mdx +4 -2
  239. package/.docs/raw/reference/agents/getVoice.mdx +4 -2
  240. package/.docs/raw/reference/agents/listAgents.mdx +4 -2
  241. package/.docs/raw/reference/agents/listScorers.mdx +5 -3
  242. package/.docs/raw/reference/agents/listTools.mdx +4 -2
  243. package/.docs/raw/reference/agents/listWorkflows.mdx +4 -2
  244. package/.docs/raw/reference/agents/network.mdx +113 -1
  245. package/.docs/raw/reference/ai-sdk/chat-route.mdx +6 -3
  246. package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +4 -2
  247. package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +4 -2
  248. package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +5 -3
  249. package/.docs/raw/reference/ai-sdk/network-route.mdx +6 -3
  250. package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +10 -6
  251. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +130 -0
  252. package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +110 -0
  253. package/.docs/raw/reference/ai-sdk/with-mastra.mdx +122 -0
  254. package/.docs/raw/reference/ai-sdk/workflow-route.mdx +7 -4
  255. package/.docs/raw/reference/auth/auth0.mdx +5 -3
  256. package/.docs/raw/reference/auth/clerk.mdx +5 -3
  257. package/.docs/raw/reference/auth/firebase.mdx +6 -5
  258. package/.docs/raw/reference/auth/jwt.mdx +5 -3
  259. package/.docs/raw/reference/auth/supabase.mdx +5 -3
  260. package/.docs/raw/reference/auth/workos.mdx +5 -3
  261. package/.docs/raw/reference/cli/create-mastra.mdx +12 -10
  262. package/.docs/raw/reference/cli/mastra.mdx +63 -15
  263. package/.docs/raw/reference/client-js/agents.mdx +311 -85
  264. package/.docs/raw/reference/client-js/error-handling.mdx +3 -3
  265. package/.docs/raw/reference/client-js/logs.mdx +2 -0
  266. package/.docs/raw/reference/client-js/mastra-client.mdx +6 -4
  267. package/.docs/raw/reference/client-js/memory.mdx +47 -2
  268. package/.docs/raw/reference/client-js/observability.mdx +2 -0
  269. package/.docs/raw/reference/client-js/telemetry.mdx +2 -0
  270. package/.docs/raw/reference/client-js/tools.mdx +2 -0
  271. package/.docs/raw/reference/client-js/vectors.mdx +2 -0
  272. package/.docs/raw/reference/client-js/workflows.mdx +47 -3
  273. package/.docs/raw/reference/configuration.mdx +761 -0
  274. package/.docs/raw/reference/core/addGateway.mdx +2 -0
  275. package/.docs/raw/reference/core/getAgent.mdx +3 -1
  276. package/.docs/raw/reference/core/getAgentById.mdx +3 -1
  277. package/.docs/raw/reference/core/getDeployer.mdx +3 -1
  278. package/.docs/raw/reference/core/getGateway.mdx +2 -0
  279. package/.docs/raw/reference/core/getGatewayById.mdx +2 -0
  280. package/.docs/raw/reference/core/getLogger.mdx +3 -1
  281. package/.docs/raw/reference/core/getMCPServer.mdx +3 -1
  282. package/.docs/raw/reference/core/getMCPServerById.mdx +3 -1
  283. package/.docs/raw/reference/core/getMemory.mdx +77 -0
  284. package/.docs/raw/reference/core/getScorer.mdx +2 -0
  285. package/.docs/raw/reference/core/getScorerById.mdx +2 -0
  286. package/.docs/raw/reference/core/getServer.mdx +6 -4
  287. package/.docs/raw/reference/core/getStorage.mdx +5 -3
  288. package/.docs/raw/reference/core/getStoredAgentById.mdx +185 -0
  289. package/.docs/raw/reference/core/getTelemetry.mdx +3 -1
  290. package/.docs/raw/reference/core/getVector.mdx +3 -1
  291. package/.docs/raw/reference/core/getWorkflow.mdx +3 -1
  292. package/.docs/raw/reference/core/listAgents.mdx +3 -1
  293. package/.docs/raw/reference/core/listGateways.mdx +2 -0
  294. package/.docs/raw/reference/core/listLogs.mdx +3 -1
  295. package/.docs/raw/reference/core/listLogsByRunId.mdx +3 -1
  296. package/.docs/raw/reference/core/listMCPServers.mdx +3 -1
  297. package/.docs/raw/reference/core/listMemory.mdx +74 -0
  298. package/.docs/raw/reference/core/listScorers.mdx +2 -0
  299. package/.docs/raw/reference/core/listStoredAgents.mdx +153 -0
  300. package/.docs/raw/reference/core/listVectors.mdx +3 -1
  301. package/.docs/raw/reference/core/listWorkflows.mdx +3 -1
  302. package/.docs/raw/reference/core/mastra-class.mdx +35 -20
  303. package/.docs/raw/reference/core/mastra-model-gateway.mdx +2 -0
  304. package/.docs/raw/reference/core/setLogger.mdx +3 -1
  305. package/.docs/raw/reference/core/setStorage.mdx +6 -4
  306. package/.docs/raw/reference/deployer/cloudflare.mdx +22 -53
  307. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  308. package/.docs/raw/reference/deployer/netlify.mdx +4 -1
  309. package/.docs/raw/reference/deployer/vercel.mdx +5 -4
  310. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -1
  311. package/.docs/raw/reference/evals/answer-similarity.mdx +4 -1
  312. package/.docs/raw/reference/evals/bias.mdx +4 -1
  313. package/.docs/raw/reference/evals/completeness.mdx +4 -1
  314. package/.docs/raw/reference/evals/content-similarity.mdx +4 -1
  315. package/.docs/raw/reference/evals/context-precision.mdx +4 -1
  316. package/.docs/raw/reference/evals/context-relevance.mdx +2 -0
  317. package/.docs/raw/reference/evals/create-scorer.mdx +11 -3
  318. package/.docs/raw/reference/evals/faithfulness.mdx +4 -1
  319. package/.docs/raw/reference/evals/hallucination.mdx +4 -1
  320. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -1
  321. package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
  322. package/.docs/raw/reference/evals/noise-sensitivity.mdx +2 -0
  323. package/.docs/raw/reference/evals/prompt-alignment.mdx +9 -7
  324. package/.docs/raw/reference/evals/run-evals.mdx +3 -1
  325. package/.docs/raw/reference/evals/scorer-utils.mdx +3 -0
  326. package/.docs/raw/reference/evals/textual-difference.mdx +4 -1
  327. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -1
  328. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +25 -23
  329. package/.docs/raw/reference/evals/toxicity.mdx +4 -1
  330. package/.docs/raw/reference/index.mdx +2 -1
  331. package/.docs/raw/reference/logging/pino-logger.mdx +10 -8
  332. package/.docs/raw/reference/memory/clone-utilities.mdx +345 -0
  333. package/.docs/raw/reference/memory/cloneThread.mdx +237 -0
  334. package/.docs/raw/reference/memory/createThread.mdx +6 -4
  335. package/.docs/raw/reference/memory/deleteMessages.mdx +4 -2
  336. package/.docs/raw/reference/memory/getThreadById.mdx +3 -1
  337. package/.docs/raw/reference/memory/listThreads.mdx +187 -0
  338. package/.docs/raw/reference/memory/memory-class.mdx +27 -20
  339. package/.docs/raw/reference/memory/recall.mdx +6 -4
  340. package/.docs/raw/reference/observability/tracing/bridges/otel.mdx +6 -2
  341. package/.docs/raw/reference/observability/tracing/configuration.mdx +51 -0
  342. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +25 -6
  343. package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +23 -2
  344. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +10 -0
  345. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +3 -0
  346. package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx +172 -0
  347. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +10 -0
  348. package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx +139 -0
  349. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +26 -4
  350. package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +10 -0
  351. package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +51 -34
  352. package/.docs/raw/reference/observability/tracing/exporters/posthog.mdx +25 -4
  353. package/.docs/raw/reference/observability/tracing/exporters/sentry.mdx +224 -0
  354. package/.docs/raw/reference/observability/tracing/instances.mdx +2 -0
  355. package/.docs/raw/reference/observability/tracing/interfaces.mdx +20 -0
  356. package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +2 -0
  357. package/.docs/raw/reference/observability/tracing/spans.mdx +2 -0
  358. package/.docs/raw/reference/processors/batch-parts-processor.mdx +4 -2
  359. package/.docs/raw/reference/processors/language-detector.mdx +6 -3
  360. package/.docs/raw/reference/processors/message-history-processor.mdx +5 -2
  361. package/.docs/raw/reference/processors/moderation-processor.mdx +6 -4
  362. package/.docs/raw/reference/processors/pii-detector.mdx +6 -4
  363. package/.docs/raw/reference/processors/processor-interface.mdx +326 -23
  364. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +5 -3
  365. package/.docs/raw/reference/processors/semantic-recall-processor.mdx +7 -2
  366. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +5 -3
  367. package/.docs/raw/reference/processors/token-limiter-processor.mdx +62 -19
  368. package/.docs/raw/reference/processors/tool-call-filter.mdx +5 -3
  369. package/.docs/raw/reference/processors/unicode-normalizer.mdx +6 -3
  370. package/.docs/raw/reference/processors/working-memory-processor.mdx +6 -3
  371. package/.docs/raw/reference/rag/chunk.mdx +7 -6
  372. package/.docs/raw/reference/rag/database-config.mdx +8 -6
  373. package/.docs/raw/reference/rag/document.mdx +2 -0
  374. package/.docs/raw/reference/rag/embeddings.mdx +2 -0
  375. package/.docs/raw/reference/rag/extract-params.mdx +57 -3
  376. package/.docs/raw/reference/rag/graph-rag.mdx +2 -0
  377. package/.docs/raw/reference/rag/metadata-filters.mdx +27 -7
  378. package/.docs/raw/reference/rag/rerank.mdx +2 -0
  379. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -0
  380. package/.docs/raw/reference/server/create-route.mdx +34 -18
  381. package/.docs/raw/reference/server/express-adapter.mdx +78 -50
  382. package/.docs/raw/reference/server/fastify-adapter.mdx +130 -0
  383. package/.docs/raw/reference/server/hono-adapter.mdx +78 -48
  384. package/.docs/raw/reference/server/koa-adapter.mdx +129 -0
  385. package/.docs/raw/reference/server/mastra-server.mdx +52 -34
  386. package/.docs/raw/reference/server/routes.mdx +73 -10
  387. package/.docs/raw/reference/storage/cloudflare-d1.mdx +10 -5
  388. package/.docs/raw/reference/storage/cloudflare.mdx +12 -2
  389. package/.docs/raw/reference/storage/composite.mdx +245 -0
  390. package/.docs/raw/reference/storage/convex.mdx +8 -6
  391. package/.docs/raw/reference/storage/dynamodb.mdx +134 -8
  392. package/.docs/raw/reference/storage/lance.mdx +9 -5
  393. package/.docs/raw/reference/storage/libsql.mdx +76 -54
  394. package/.docs/raw/reference/storage/mongodb.mdx +115 -16
  395. package/.docs/raw/reference/storage/mssql.mdx +11 -6
  396. package/.docs/raw/{server-db/storage.mdx → reference/storage/overview.mdx} +15 -111
  397. package/.docs/raw/reference/storage/postgresql.mdx +228 -83
  398. package/.docs/raw/reference/storage/upstash.mdx +78 -2
  399. package/.docs/raw/reference/streaming/ChunkType.mdx +31 -3
  400. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +67 -6
  401. package/.docs/raw/reference/streaming/agents/stream.mdx +48 -51
  402. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +5 -3
  403. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -1
  404. package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +3 -1
  405. package/.docs/raw/reference/streaming/workflows/stream.mdx +37 -22
  406. package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +6 -4
  407. package/.docs/raw/reference/templates/overview.mdx +3 -2
  408. package/.docs/raw/reference/tools/client.mdx +3 -0
  409. package/.docs/raw/reference/tools/create-tool.mdx +127 -5
  410. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -0
  411. package/.docs/raw/reference/tools/graph-rag-tool.mdx +40 -3
  412. package/.docs/raw/reference/tools/mcp-client.mdx +110 -1
  413. package/.docs/raw/reference/tools/mcp-server.mdx +278 -24
  414. package/.docs/raw/reference/tools/vector-query-tool.mdx +68 -4
  415. package/.docs/raw/reference/vectors/astra.mdx +5 -3
  416. package/.docs/raw/reference/vectors/chroma.mdx +5 -3
  417. package/.docs/raw/reference/vectors/convex.mdx +14 -12
  418. package/.docs/raw/reference/vectors/couchbase.mdx +7 -5
  419. package/.docs/raw/reference/vectors/duckdb.mdx +12 -10
  420. package/.docs/raw/reference/vectors/elasticsearch.mdx +12 -4
  421. package/.docs/raw/reference/vectors/lance.mdx +6 -4
  422. package/.docs/raw/reference/vectors/libsql.mdx +66 -13
  423. package/.docs/raw/reference/vectors/mongodb.mdx +90 -10
  424. package/.docs/raw/reference/vectors/opensearch.mdx +30 -3
  425. package/.docs/raw/reference/vectors/pg.mdx +58 -6
  426. package/.docs/raw/reference/vectors/pinecone.mdx +23 -8
  427. package/.docs/raw/reference/vectors/qdrant.mdx +148 -4
  428. package/.docs/raw/reference/vectors/s3vectors.mdx +8 -6
  429. package/.docs/raw/reference/vectors/turbopuffer.mdx +6 -4
  430. package/.docs/raw/reference/vectors/upstash.mdx +60 -6
  431. package/.docs/raw/reference/vectors/vectorize.mdx +5 -3
  432. package/.docs/raw/reference/voice/azure.mdx +2 -0
  433. package/.docs/raw/reference/voice/cloudflare.mdx +2 -0
  434. package/.docs/raw/reference/voice/composite-voice.mdx +4 -0
  435. package/.docs/raw/reference/voice/deepgram.mdx +2 -0
  436. package/.docs/raw/reference/voice/elevenlabs.mdx +2 -0
  437. package/.docs/raw/reference/voice/google-gemini-live.mdx +3 -0
  438. package/.docs/raw/reference/voice/google.mdx +2 -0
  439. package/.docs/raw/reference/voice/mastra-voice.mdx +2 -0
  440. package/.docs/raw/reference/voice/murf.mdx +2 -0
  441. package/.docs/raw/reference/voice/openai-realtime.mdx +3 -0
  442. package/.docs/raw/reference/voice/openai.mdx +2 -0
  443. package/.docs/raw/reference/voice/playai.mdx +2 -0
  444. package/.docs/raw/reference/voice/sarvam.mdx +2 -0
  445. package/.docs/raw/reference/voice/speechify.mdx +2 -0
  446. package/.docs/raw/reference/voice/voice.addInstructions.mdx +3 -0
  447. package/.docs/raw/reference/voice/voice.addTools.mdx +3 -0
  448. package/.docs/raw/reference/voice/voice.answer.mdx +4 -0
  449. package/.docs/raw/reference/voice/voice.close.mdx +3 -0
  450. package/.docs/raw/reference/voice/voice.connect.mdx +5 -1
  451. package/.docs/raw/reference/voice/voice.events.mdx +2 -0
  452. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +3 -0
  453. package/.docs/raw/reference/voice/voice.listen.mdx +6 -0
  454. package/.docs/raw/reference/voice/voice.off.mdx +2 -0
  455. package/.docs/raw/reference/voice/voice.on.mdx +5 -1
  456. package/.docs/raw/reference/voice/voice.send.mdx +4 -0
  457. package/.docs/raw/reference/voice/voice.speak.mdx +6 -0
  458. package/.docs/raw/reference/voice/voice.updateConfig.mdx +2 -0
  459. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +55 -5
  460. package/.docs/raw/reference/workflows/run-methods/restart.mdx +3 -3
  461. package/.docs/raw/reference/workflows/run-methods/resume.mdx +6 -4
  462. package/.docs/raw/reference/workflows/run-methods/start.mdx +7 -5
  463. package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +145 -0
  464. package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +10 -8
  465. package/.docs/raw/reference/workflows/run.mdx +11 -3
  466. package/.docs/raw/reference/workflows/step.mdx +56 -3
  467. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +3 -1
  468. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +3 -1
  469. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +39 -2
  470. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +3 -1
  471. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +3 -1
  472. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +71 -4
  473. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +9 -7
  474. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +3 -1
  475. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +4 -6
  476. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +4 -6
  477. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +3 -1
  478. package/.docs/raw/reference/workflows/workflow.mdx +193 -2
  479. package/.docs/raw/{auth → server/auth}/auth0.mdx +40 -21
  480. package/.docs/raw/{auth → server/auth}/clerk.mdx +37 -16
  481. package/.docs/raw/{auth → server/auth}/firebase.mdx +47 -25
  482. package/.docs/raw/{auth → server/auth}/index.mdx +8 -6
  483. package/.docs/raw/{auth → server/auth}/jwt.mdx +22 -10
  484. package/.docs/raw/{auth → server/auth}/supabase.mdx +45 -25
  485. package/.docs/raw/{auth → server/auth}/workos.mdx +39 -20
  486. package/.docs/raw/{server-db → server}/custom-adapters.mdx +40 -24
  487. package/.docs/raw/{server-db → server}/custom-api-routes.mdx +6 -6
  488. package/.docs/raw/{server-db → server}/mastra-client.mdx +35 -38
  489. package/.docs/raw/server/mastra-server.mdx +86 -0
  490. package/.docs/raw/{server-db → server}/middleware.mdx +11 -9
  491. package/.docs/raw/{server-db → server}/request-context.mdx +85 -43
  492. package/.docs/raw/server/server-adapters.mdx +410 -0
  493. package/.docs/raw/streaming/events.mdx +16 -7
  494. package/.docs/raw/streaming/overview.mdx +30 -17
  495. package/.docs/raw/streaming/tool-streaming.mdx +15 -17
  496. package/.docs/raw/streaming/workflow-streaming.mdx +8 -8
  497. package/.docs/raw/tools-mcp/advanced-usage.mdx +4 -2
  498. package/.docs/raw/tools-mcp/mcp-overview.mdx +46 -12
  499. package/.docs/raw/tools-mcp/overview.mdx +14 -13
  500. package/.docs/raw/voice/overview.mdx +17 -2
  501. package/.docs/raw/voice/speech-to-speech.mdx +5 -0
  502. package/.docs/raw/voice/speech-to-text.mdx +4 -0
  503. package/.docs/raw/voice/text-to-speech.mdx +3 -0
  504. package/.docs/raw/workflows/agents-and-tools.mdx +70 -21
  505. package/.docs/raw/workflows/control-flow.mdx +369 -34
  506. package/.docs/raw/workflows/error-handling.mdx +192 -18
  507. package/.docs/raw/workflows/human-in-the-loop.mdx +8 -7
  508. package/.docs/raw/workflows/input-data-mapping.mdx +9 -7
  509. package/.docs/raw/workflows/overview.mdx +80 -34
  510. package/.docs/raw/workflows/snapshots.mdx +19 -45
  511. package/.docs/raw/workflows/suspend-and-resume.mdx +14 -14
  512. package/.docs/raw/workflows/time-travel.mdx +25 -21
  513. package/.docs/raw/workflows/workflow-state.mdx +7 -8
  514. package/CHANGELOG.md +254 -0
  515. package/README.md +36 -0
  516. package/dist/index.d.ts.map +1 -1
  517. package/dist/logger.d.ts +3 -0
  518. package/dist/logger.d.ts.map +1 -1
  519. package/dist/stdio.js +746 -49
  520. package/dist/tools/course.d.ts.map +1 -1
  521. package/dist/tools/embedded-docs.d.ts +276 -0
  522. package/dist/tools/embedded-docs.d.ts.map +1 -0
  523. package/package.json +9 -8
  524. package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
  525. package/.docs/raw/deployment/building-mastra.mdx +0 -73
  526. package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
  527. package/.docs/raw/deployment/mastra-cloud/dashboard.mdx +0 -100
  528. package/.docs/raw/deployment/mastra-cloud/observability.mdx +0 -53
  529. package/.docs/raw/deployment/mastra-cloud/overview.mdx +0 -65
  530. package/.docs/raw/deployment/mastra-cloud/setting-up.mdx +0 -105
  531. package/.docs/raw/memory/conversation-history.mdx +0 -24
  532. package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
  533. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
  534. package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
  535. package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
  536. package/.docs/raw/memory/threads-and-resources.mdx +0 -95
  537. package/.docs/raw/reference/core/setTelemetry.mdx +0 -36
  538. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +0 -110
  539. package/.docs/raw/reference/memory/query.mdx +0 -189
  540. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
  541. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
  542. package/.docs/raw/server-db/mastra-server.mdx +0 -97
  543. package/.docs/raw/server-db/server-adapters.mdx +0 -286
  544. package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Pinecone Vector Store | Vectors"
3
3
  description: Documentation for the PineconeVector class in Mastra, which provides an interface to Pinecone's vector database.
4
+ packages:
5
+ - "@mastra/pinecone"
4
6
  ---
5
7
 
6
8
  # Pinecone Vector Store
@@ -10,6 +12,8 @@ It provides real-time vector search, with features like hybrid search, metadata
10
12
 
11
13
  ## Constructor Options
12
14
 
15
+ The constructor accepts all [Pinecone configuration options](https://docs.pinecone.io/reference/typescript-sdk) plus Mastra-specific fields.
16
+
13
17
  <PropertiesTable
14
18
  content={[
15
19
  {
@@ -23,24 +27,36 @@ It provides real-time vector search, with features like hybrid search, metadata
23
27
  description: "Pinecone API key",
24
28
  },
25
29
  {
26
- name: "environment",
30
+ name: "controllerHostUrl",
31
+ type: "string",
32
+ isOptional: true,
33
+ description: "Custom Pinecone controller host URL",
34
+ },
35
+ {
36
+ name: "additionalHeaders",
37
+ type: "Record<string, string>",
38
+ isOptional: true,
39
+ description: "Additional HTTP headers to include in requests",
40
+ },
41
+ {
42
+ name: "sourceTag",
27
43
  type: "string",
28
44
  isOptional: true,
29
- description: "Pinecone environment controller host URL",
45
+ description: "Source tag for request tracking",
30
46
  },
31
47
  {
32
48
  name: "cloud",
33
49
  type: "'aws' | 'gcp' | 'azure'",
34
50
  isOptional: true,
35
51
  defaultValue: "aws",
36
- description: "Cloud provider for Pinecone serverless",
52
+ description: "Cloud provider for new index creation",
37
53
  },
38
54
  {
39
55
  name: "region",
40
56
  type: "string",
41
57
  isOptional: true,
42
58
  defaultValue: "us-east-1",
43
- description: "Region for Pinecone serverless",
59
+ description: "Region for new index creation",
44
60
  },
45
61
  ]}
46
62
  />
@@ -184,7 +200,7 @@ Returns an array of index names as strings.
184
200
 
185
201
  Returns:
186
202
 
187
- ```typescript copy
203
+ ```typescript
188
204
  interface IndexStats {
189
205
  dimension: number;
190
206
  count: number;
@@ -306,7 +322,7 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
306
322
 
307
323
  Query results are returned in this format:
308
324
 
309
- ```typescript copy
325
+ ```typescript
310
326
  interface QueryResult {
311
327
  id: string;
312
328
  score: number;
@@ -319,7 +335,7 @@ interface QueryResult {
319
335
 
320
336
  The store throws typed errors that can be caught:
321
337
 
322
- ```typescript copy
338
+ ```typescript
323
339
  try {
324
340
  await store.query({
325
341
  indexName: "index_name",
@@ -338,7 +354,6 @@ try {
338
354
  Required environment variables:
339
355
 
340
356
  - `PINECONE_API_KEY`: Your Pinecone API key
341
- - `PINECONE_ENVIRONMENT`: Pinecone environment (e.g., 'us-west1-gcp')
342
357
 
343
358
  ## Hybrid Search
344
359
 
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Qdrant Vector Store | Vectors"
3
3
  description: Documentation for integrating Qdrant with Mastra, a vector similarity search engine for managing vectors and payloads.
4
+ packages:
5
+ - "@mastra/qdrant"
4
6
  ---
5
7
 
6
8
  # Qdrant Vector Store
@@ -46,7 +48,7 @@ It provides a production-ready service with a convenient API to store, search, a
46
48
  {
47
49
  name: "dimension",
48
50
  type: "number",
49
- description: "Vector dimension (must match your embedding model)",
51
+ description: "Vector dimension (must match your embedding model). Required for single-vector collections.",
50
52
  },
51
53
  {
52
54
  name: "metric",
@@ -55,13 +57,38 @@ It provides a production-ready service with a convenient API to store, search, a
55
57
  defaultValue: "cosine",
56
58
  description: "Distance metric for similarity search",
57
59
  },
60
+ {
61
+ name: "namedVectors",
62
+ type: "Record<string, { size: number; distance: 'cosine' | 'euclidean' | 'dotproduct' }>",
63
+ isOptional: true,
64
+ description: "Configuration for named vector spaces. When provided, creates a collection with multiple named vector fields.",
65
+ },
58
66
  ]}
59
67
  />
60
68
 
69
+ #### Creating a Named Vectors Collection
70
+
71
+ ```typescript
72
+ // Create a collection with multiple named vector spaces
73
+ await store.createIndex({
74
+ indexName: "multi_modal",
75
+ dimension: 768, // fallback
76
+ namedVectors: {
77
+ text: { size: 768, distance: "cosine" },
78
+ image: { size: 512, distance: "euclidean" },
79
+ },
80
+ });
81
+ ```
82
+
61
83
  ### upsert()
62
84
 
63
85
  <PropertiesTable
64
86
  content={[
87
+ {
88
+ name: "indexName",
89
+ type: "string",
90
+ description: "Name of the index to upsert into",
91
+ },
65
92
  {
66
93
  name: "vectors",
67
94
  type: "number[][]",
@@ -79,9 +106,35 @@ It provides a production-ready service with a convenient API to store, search, a
79
106
  isOptional: true,
80
107
  description: "Optional vector IDs (auto-generated if not provided)",
81
108
  },
109
+ {
110
+ name: "vectorName",
111
+ type: "string",
112
+ isOptional: true,
113
+ description: "Name of the vector space to upsert into when using named vectors.",
114
+ },
82
115
  ]}
83
116
  />
84
117
 
118
+ #### Upserting into Named Vector Spaces
119
+
120
+ ```typescript
121
+ // Upsert into the "text" vector space
122
+ await store.upsert({
123
+ indexName: "multi_modal",
124
+ vectors: textEmbeddings,
125
+ metadata: textMetadata,
126
+ vectorName: "text",
127
+ });
128
+
129
+ // Upsert into the "image" vector space
130
+ await store.upsert({
131
+ indexName: "multi_modal",
132
+ vectors: imageEmbeddings,
133
+ metadata: imageMetadata,
134
+ vectorName: "image",
135
+ });
136
+ ```
137
+
85
138
  ### query()
86
139
 
87
140
  <PropertiesTable
@@ -116,9 +169,28 @@ It provides a production-ready service with a convenient API to store, search, a
116
169
  defaultValue: "false",
117
170
  description: "Whether to include vectors in the results",
118
171
  },
172
+ {
173
+ name: "using",
174
+ type: "string",
175
+ isOptional: true,
176
+ description: "Name of the vector field to query when using named vectors. Use this when your collection has multiple named vector fields.",
177
+ },
119
178
  ]}
120
179
  />
121
180
 
181
+ #### Named Vectors
182
+
183
+ Qdrant supports [named vectors](https://qdrant.tech/documentation/concepts/vectors/#named-vectors), allowing multiple vector fields per collection. Use the `using` parameter to specify which named vector to query against:
184
+
185
+ ```typescript
186
+ const results = await store.query({
187
+ indexName: "my_index",
188
+ queryVector: embedding,
189
+ topK: 10,
190
+ using: "title_embedding", // Query against a specific named vector
191
+ });
192
+ ```
193
+
122
194
  ### listIndexes()
123
195
 
124
196
  Returns an array of index names as strings.
@@ -137,7 +209,7 @@ Returns an array of index names as strings.
137
209
 
138
210
  Returns:
139
211
 
140
- ```typescript copy
212
+ ```typescript
141
213
  interface IndexStats {
142
214
  dimension: number;
143
215
  count: number;
@@ -235,11 +307,83 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
235
307
  ]}
236
308
  />
237
309
 
310
+ ### createPayloadIndex()
311
+
312
+ Creates a payload (metadata) index on a collection field to enable efficient filtering. This is **required** for Qdrant Cloud and any Qdrant instance with `strict_mode_config = true`.
313
+
314
+ <PropertiesTable
315
+ content={[
316
+ {
317
+ name: "indexName",
318
+ type: "string",
319
+ description: "Name of the collection to create the payload index on",
320
+ },
321
+ {
322
+ name: "fieldName",
323
+ type: "string",
324
+ description: "Name of the payload field to index",
325
+ },
326
+ {
327
+ name: "fieldSchema",
328
+ type: "'keyword' | 'integer' | 'float' | 'geo' | 'text' | 'bool' | 'datetime' | 'uuid'",
329
+ description: "The schema type for the payload field",
330
+ },
331
+ {
332
+ name: "wait",
333
+ type: "boolean",
334
+ isOptional: true,
335
+ defaultValue: "true",
336
+ description: "Whether to wait for the operation to complete",
337
+ },
338
+ ]}
339
+ />
340
+
341
+ ```typescript
342
+ // Create a keyword index for filtering by source
343
+ await store.createPayloadIndex({
344
+ indexName: "my_index",
345
+ fieldName: "source",
346
+ fieldSchema: "keyword",
347
+ });
348
+
349
+ const results = await store.query({
350
+ indexName: "my_index",
351
+ queryVector: queryVector,
352
+ filter: { source: "document-a" },
353
+ });
354
+ ```
355
+
356
+ ### deletePayloadIndex()
357
+
358
+ Removes a payload index from a collection field.
359
+
360
+ <PropertiesTable
361
+ content={[
362
+ {
363
+ name: "indexName",
364
+ type: "string",
365
+ description: "Name of the collection to delete the payload index from",
366
+ },
367
+ {
368
+ name: "fieldName",
369
+ type: "string",
370
+ description: "Name of the payload field index to delete",
371
+ },
372
+ {
373
+ name: "wait",
374
+ type: "boolean",
375
+ isOptional: true,
376
+ defaultValue: "true",
377
+ description: "Whether to wait for the operation to complete",
378
+ },
379
+ ]}
380
+ />
381
+
238
382
  ## Response Types
239
383
 
240
384
  Query results are returned in this format:
241
385
 
242
- ```typescript copy
386
+ ```typescript
243
387
  interface QueryResult {
244
388
  id: string;
245
389
  score: number;
@@ -252,7 +396,7 @@ interface QueryResult {
252
396
 
253
397
  The store throws typed errors that can be caught:
254
398
 
255
- ```typescript copy
399
+ ```typescript
256
400
  try {
257
401
  await store.query({
258
402
  indexName: "index_name",
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Amazon S3 Vectors Store | Vectors"
3
3
  description: Documentation for the S3Vectors class in Mastra, which provides vector search using Amazon S3 Vectors (Preview).
4
+ packages:
5
+ - "@mastra/s3vectors"
4
6
  ---
5
7
 
6
8
  # Amazon S3 Vectors Store
@@ -14,13 +16,13 @@ The `S3Vectors` class provides vector search using [Amazon S3 Vectors (Preview)]
14
16
 
15
17
  ## Installation
16
18
 
17
- ```bash copy
19
+ ```bash
18
20
  npm install @mastra/s3vectors@beta
19
21
  ```
20
22
 
21
23
  ## Usage Example
22
24
 
23
- ```typescript copy showLineNumbers
25
+ ```typescript
24
26
  import { S3Vectors } from "@mastra/s3vectors";
25
27
 
26
28
  const store = new S3Vectors({
@@ -214,7 +216,7 @@ Returns information about the index.
214
216
 
215
217
  Returns:
216
218
 
217
- ```typescript copy
219
+ ```typescript
218
220
  interface IndexStats {
219
221
  dimension: number;
220
222
  count: number; // computed via ListVectors pagination (O(n))
@@ -305,7 +307,7 @@ Closes the underlying AWS SDK HTTP handler to free sockets.
305
307
 
306
308
  Query results are returned in this format:
307
309
 
308
- ```typescript copy
310
+ ```typescript
309
311
  interface QueryResult {
310
312
  id: string;
311
313
  score: number; // 1/(1 + distance)
@@ -337,7 +339,7 @@ S3 Vectors supports a strict subset of operators and value types. The Mastra fil
337
339
 
338
340
  **Examples:**
339
341
 
340
- ```typescript copy
342
+ ```typescript
341
343
  // Implicit AND
342
344
  { genre: { $in: ["documentary", "comedy"] }, year: { $gte: 2020 } }
343
345
 
@@ -359,7 +361,7 @@ S3 Vectors supports a strict subset of operators and value types. The Mastra fil
359
361
 
360
362
  The store throws typed errors that can be caught:
361
363
 
362
- ```typescript copy
364
+ ```typescript
363
365
  try {
364
366
  await store.query({
365
367
  indexName: "index-name",
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Turbopuffer Vector Store | Vectors"
3
3
  description: Documentation for integrating Turbopuffer with Mastra, a high-performance vector database for efficient similarity search.
4
+ packages:
5
+ - "@mastra/turbopuffer"
4
6
  ---
5
7
 
6
8
  # Turbopuffer Vector Store
@@ -170,7 +172,7 @@ Returns an array of index names as strings.
170
172
 
171
173
  Returns:
172
174
 
173
- ```typescript copy
175
+ ```typescript
174
176
  interface IndexStats {
175
177
  dimension: number;
176
178
  count: number;
@@ -268,7 +270,7 @@ Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` m
268
270
 
269
271
  Query results are returned in this format:
270
272
 
271
- ```typescript copy
273
+ ```typescript
272
274
  interface QueryResult {
273
275
  id: string;
274
276
  score: number;
@@ -281,7 +283,7 @@ interface QueryResult {
281
283
 
282
284
  The `schemaConfigForIndex` option allows you to define explicit schemas for different indexes:
283
285
 
284
- ```typescript copy
286
+ ```typescript
285
287
  schemaConfigForIndex: (indexName: string) => {
286
288
  // Mastra's default embedding model and index for memory messages:
287
289
  if (indexName === "memory_messages_384") {
@@ -304,7 +306,7 @@ schemaConfigForIndex: (indexName: string) => {
304
306
 
305
307
  The store throws typed errors that can be caught:
306
308
 
307
- ```typescript copy
309
+ ```typescript
308
310
  try {
309
311
  await store.query({
310
312
  indexName: "index_name",
@@ -1,6 +1,11 @@
1
1
  ---
2
2
  title: "Reference: Upstash Vector Store | Vectors"
3
3
  description: Documentation for the UpstashVector class in Mastra, which provides vector search using Upstash Vector.
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/fastembed"
7
+ - "@mastra/memory"
8
+ - "@mastra/upstash"
4
9
  ---
5
10
 
6
11
  # Upstash Vector Store
@@ -164,7 +169,7 @@ Returns an array of index names (namespaces) as strings.
164
169
 
165
170
  Returns:
166
171
 
167
- ```typescript copy
172
+ ```typescript
168
173
  interface IndexStats {
169
174
  dimension: number;
170
175
  count: number;
@@ -238,7 +243,7 @@ Upstash Vector supports hybrid search that combines semantic search (dense vecto
238
243
 
239
244
  ### Basic Hybrid Usage
240
245
 
241
- ```typescript copy
246
+ ```typescript
242
247
  import { UpstashVector } from "@mastra/upstash";
243
248
 
244
249
  const vectorStore = new UpstashVector({
@@ -275,7 +280,7 @@ const results = await vectorStore.query({
275
280
 
276
281
  ### Advanced Hybrid Search Options
277
282
 
278
- ```typescript copy
283
+ ```typescript
279
284
  import { FusionAlgorithm, QueryMode } from "@upstash/vector";
280
285
 
281
286
  // Query with specific fusion algorithm
@@ -307,7 +312,7 @@ const sparseResults = await vectorStore.query({
307
312
 
308
313
  ### Updating Hybrid Vectors
309
314
 
310
- ```typescript copy
315
+ ```typescript
311
316
  // Update both dense and sparse components
312
317
  await vectorStore.updateVector({
313
318
  indexName: "hybrid-index",
@@ -324,7 +329,7 @@ await vectorStore.updateVector({
324
329
 
325
330
  Query results are returned in this format:
326
331
 
327
- ```typescript copy
332
+ ```typescript
328
333
  interface QueryResult {
329
334
  id: string;
330
335
  score: number;
@@ -337,7 +342,7 @@ interface QueryResult {
337
342
 
338
343
  The store throws typed errors that can be caught:
339
344
 
340
- ```typescript copy
345
+ ```typescript
341
346
  try {
342
347
  await store.query({
343
348
  indexName: "index_name",
@@ -358,6 +363,55 @@ Required environment variables:
358
363
  - `UPSTASH_VECTOR_URL`: Your Upstash Vector database URL
359
364
  - `UPSTASH_VECTOR_TOKEN`: Your Upstash Vector API token
360
365
 
366
+ ## Usage Example
367
+
368
+ ### Local embeddings with fastembed
369
+
370
+ Embeddings are numeric vectors used by memory's `semanticRecall` to retrieve related messages by meaning (not keywords). This setup uses `@mastra/fastembed` to generate vector embeddings.
371
+
372
+ Install `fastembed` to get started:
373
+
374
+ ```bash
375
+ npm install @mastra/fastembed@beta
376
+ ```
377
+
378
+ Add the following to your agent:
379
+
380
+ ```typescript title="src/mastra/agents/example-upstash-agent.ts"
381
+ import { Memory } from "@mastra/memory";
382
+ import { Agent } from "@mastra/core/agent";
383
+ import { UpstashStore, UpstashVector } from "@mastra/upstash";
384
+ import { fastembed } from "@mastra/fastembed";
385
+
386
+ export const upstashAgent = new Agent({
387
+ id: "upstash-agent",
388
+ name: "Upstash Agent",
389
+ instructions:
390
+ "You are an AI agent with the ability to automatically recall memories from previous interactions.",
391
+ model: "openai/gpt-5.1",
392
+ memory: new Memory({
393
+ storage: new UpstashStore({
394
+ id: 'upstash-agent-storage',
395
+ url: process.env.UPSTASH_REDIS_REST_URL!,
396
+ token: process.env.UPSTASH_REDIS_REST_TOKEN!,
397
+ }),
398
+ vector: new UpstashVector({
399
+ id: 'upstash-agent-vector',
400
+ url: process.env.UPSTASH_VECTOR_REST_URL!,
401
+ token: process.env.UPSTASH_VECTOR_REST_TOKEN!,
402
+ }),
403
+ embedder: fastembed,
404
+ options: {
405
+ lastMessages: 10,
406
+ semanticRecall: {
407
+ topK: 3,
408
+ messageRange: 2,
409
+ },
410
+ },
411
+ }),
412
+ });
413
+ ```
414
+
361
415
  ## Related
362
416
 
363
417
  - [Metadata Filters](../rag/metadata-filters)
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Cloudflare Vector Store | Vectors"
3
3
  description: Documentation for the CloudflareVector class in Mastra, which provides vector search using Cloudflare Vectorize.
4
+ packages:
5
+ - "@mastra/vectorize"
4
6
  ---
5
7
 
6
8
  # Cloudflare Vector Store
@@ -135,7 +137,7 @@ Returns an array of index names as strings.
135
137
 
136
138
  Returns:
137
139
 
138
- ```typescript copy
140
+ ```typescript
139
141
  interface IndexStats {
140
142
  dimension: number;
141
143
  count: number;
@@ -259,7 +261,7 @@ Deletes a vector and its associated metadata for a specific ID within an index.
259
261
 
260
262
  Query results are returned in this format:
261
263
 
262
- ```typescript copy
264
+ ```typescript
263
265
  interface QueryResult {
264
266
  id: string;
265
267
  score: number;
@@ -272,7 +274,7 @@ interface QueryResult {
272
274
 
273
275
  The store throws typed errors that can be caught:
274
276
 
275
- ```typescript copy
277
+ ```typescript
276
278
  try {
277
279
  await store.query({
278
280
  indexName: "index_name",
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Azure | Voice"
3
3
  description: "Documentation for the AzureVoice class, providing text-to-speech and speech-to-text capabilities using Azure Cognitive Services."
4
+ packages:
5
+ - "@mastra/voice-azure"
4
6
  ---
5
7
 
6
8
  # Azure
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Cloudflare | Voice"
3
3
  description: "Documentation for the CloudflareVoice class, providing text-to-speech capabilities using Cloudflare Workers AI."
4
+ packages:
5
+ - "@mastra/voice-cloudflare"
4
6
  ---
5
7
 
6
8
  # Cloudflare
@@ -1,6 +1,10 @@
1
1
  ---
2
2
  title: "Reference: CompositeVoice | Voice"
3
3
  description: "Documentation for the CompositeVoice class, which enables combining multiple voice providers for flexible text-to-speech and speech-to-text operations."
4
+ packages:
5
+ - "@mastra/core"
6
+ - "@mastra/voice-openai"
7
+ - "@mastra/voice-playai"
4
8
  ---
5
9
 
6
10
  # CompositeVoice
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Deepgram | Voice"
3
3
  description: "Documentation for the Deepgram voice implementation, providing text-to-speech and speech-to-text capabilities with multiple voice models and languages."
4
+ packages:
5
+ - "@mastra/voice-deepgram"
4
6
  ---
5
7
 
6
8
  # Deepgram
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: ElevenLabs | Voice"
3
3
  description: "Documentation for the ElevenLabs voice implementation, offering high-quality text-to-speech capabilities with multiple voice models and natural-sounding synthesis."
4
+ packages:
5
+ - "@mastra/voice-elevenlabs"
4
6
  ---
5
7
 
6
8
  # ElevenLabs
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: Google Gemini Live Voice | Voice"
3
3
  description: "Documentation for the GeminiLiveVoice class, providing real-time multimodal voice interactions using Google's Gemini Live API with support for both Gemini API and Vertex AI."
4
+ packages:
5
+ - "@mastra/node-audio"
6
+ - "@mastra/voice-google-gemini-live"
4
7
  ---
5
8
 
6
9
  # Google Gemini Live Voice
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Google | Voice"
3
3
  description: "Documentation for the Google Voice implementation, providing text-to-speech and speech-to-text capabilities with support for both API key and Vertex AI authentication."
4
+ packages:
5
+ - "@mastra/voice-google"
4
6
  ---
5
7
 
6
8
  # Google
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: MastraVoice | Voice"
3
3
  description: "Documentation for the MastraVoice abstract base class, which defines the core interface for all voice services in Mastra, including speech-to-speech capabilities."
4
+ packages:
5
+ - "@mastra/core"
4
6
  ---
5
7
 
6
8
  # MastraVoice
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: Murf | Voice"
3
3
  description: "Documentation for the Murf voice implementation, providing text-to-speech capabilities."
4
+ packages:
5
+ - "@mastra/voice-murf"
4
6
  ---
5
7
 
6
8
  # Murf
@@ -1,6 +1,9 @@
1
1
  ---
2
2
  title: "Reference: OpenAI Realtime Voice | Voice"
3
3
  description: "Documentation for the OpenAIRealtimeVoice class, providing real-time text-to-speech and speech-to-text capabilities via WebSockets."
4
+ packages:
5
+ - "@mastra/node-audio"
6
+ - "@mastra/voice-openai-realtime"
4
7
  ---
5
8
 
6
9
  # OpenAI Realtime Voice
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: OpenAI | Voice"
3
3
  description: "Documentation for the OpenAIVoice class, providing text-to-speech and speech-to-text capabilities."
4
+ packages:
5
+ - "@mastra/voice-openai"
4
6
  ---
5
7
 
6
8
  # OpenAI
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  title: "Reference: PlayAI | Voice"
3
3
  description: "Documentation for the PlayAI voice implementation, providing text-to-speech capabilities."
4
+ packages:
5
+ - "@mastra/voice-playai"
4
6
  ---
5
7
 
6
8
  # PlayAI