@mastra/mcp-docs-server 1.1.8 → 1.1.9-alpha.1

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 (462) hide show
  1. package/.docs/docs/agents/adding-voice.md +4 -4
  2. package/.docs/docs/agents/agent-approval.md +3 -3
  3. package/.docs/docs/agents/agent-memory.md +3 -3
  4. package/.docs/docs/agents/guardrails.md +3 -3
  5. package/.docs/docs/agents/network-approval.md +5 -2
  6. package/.docs/docs/agents/networks.md +2 -2
  7. package/.docs/docs/agents/overview.md +2 -2
  8. package/.docs/docs/agents/processors.md +42 -24
  9. package/.docs/docs/agents/structured-output.md +2 -2
  10. package/.docs/docs/agents/supervisor-agents.md +3 -3
  11. package/.docs/docs/agents/using-tools.md +3 -3
  12. package/.docs/docs/build-with-ai/mcp-docs-server.md +5 -5
  13. package/.docs/docs/build-with-ai/skills.md +2 -2
  14. package/.docs/docs/community/contributing-templates.md +1 -1
  15. package/.docs/docs/community/discord.md +3 -3
  16. package/.docs/docs/community/licensing.md +2 -2
  17. package/.docs/docs/deployment/cloud-providers.md +2 -2
  18. package/.docs/docs/deployment/mastra-server.md +2 -2
  19. package/.docs/docs/deployment/monorepo.md +1 -1
  20. package/.docs/docs/deployment/overview.md +3 -3
  21. package/.docs/docs/deployment/studio.md +3 -3
  22. package/.docs/docs/deployment/web-framework.md +2 -2
  23. package/.docs/docs/deployment/workflow-runners.md +1 -1
  24. package/.docs/docs/evals/built-in-scorers.md +1 -1
  25. package/.docs/docs/evals/custom-scorers.md +6 -6
  26. package/.docs/docs/evals/overview.md +2 -2
  27. package/.docs/docs/evals/running-in-ci.md +6 -6
  28. package/.docs/docs/getting-started/build-with-ai.md +3 -3
  29. package/.docs/docs/getting-started/manual-install.md +1 -1
  30. package/.docs/docs/getting-started/project-structure.md +2 -2
  31. package/.docs/docs/index.md +63 -17
  32. package/.docs/docs/mastra-cloud/deployment.md +1 -1
  33. package/.docs/docs/mastra-cloud/studio.md +1 -1
  34. package/.docs/docs/mcp/overview.md +1 -1
  35. package/.docs/docs/mcp/publishing-mcp-server.md +4 -4
  36. package/.docs/docs/memory/memory-processors.md +9 -9
  37. package/.docs/docs/memory/message-history.md +4 -4
  38. package/.docs/docs/memory/observational-memory.md +11 -7
  39. package/.docs/docs/memory/semantic-recall.md +9 -9
  40. package/.docs/docs/memory/storage.md +1 -1
  41. package/.docs/docs/memory/working-memory.md +20 -20
  42. package/.docs/docs/observability/datasets/overview.md +1 -1
  43. package/.docs/docs/observability/datasets/running-experiments.md +1 -1
  44. package/.docs/docs/observability/logging.md +1 -1
  45. package/.docs/docs/observability/overview.md +5 -5
  46. package/.docs/docs/observability/tracing/bridges/otel.md +9 -9
  47. package/.docs/docs/observability/tracing/exporters/arize.md +3 -3
  48. package/.docs/docs/observability/tracing/exporters/braintrust.md +1 -1
  49. package/.docs/docs/observability/tracing/exporters/cloud.md +2 -2
  50. package/.docs/docs/observability/tracing/exporters/datadog.md +3 -3
  51. package/.docs/docs/observability/tracing/exporters/default.md +8 -8
  52. package/.docs/docs/observability/tracing/exporters/laminar.md +1 -1
  53. package/.docs/docs/observability/tracing/exporters/langfuse.md +3 -3
  54. package/.docs/docs/observability/tracing/exporters/langsmith.md +4 -4
  55. package/.docs/docs/observability/tracing/exporters/otel.md +8 -8
  56. package/.docs/docs/observability/tracing/exporters/posthog.md +2 -2
  57. package/.docs/docs/observability/tracing/exporters/sentry.md +4 -4
  58. package/.docs/docs/observability/tracing/overview.md +24 -24
  59. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +13 -13
  60. package/.docs/docs/rag/chunking-and-embedding.md +5 -5
  61. package/.docs/docs/rag/overview.md +2 -2
  62. package/.docs/docs/rag/retrieval.md +4 -4
  63. package/.docs/docs/rag/vector-databases.md +13 -13
  64. package/.docs/docs/server/auth/auth0.md +2 -2
  65. package/.docs/docs/server/auth/clerk.md +1 -1
  66. package/.docs/docs/server/auth/composite-auth.md +9 -9
  67. package/.docs/docs/server/auth/custom-auth-provider.md +12 -12
  68. package/.docs/docs/server/auth/firebase.md +3 -3
  69. package/.docs/docs/server/auth/jwt.md +1 -1
  70. package/.docs/docs/server/auth/simple-auth.md +9 -9
  71. package/.docs/docs/server/auth/supabase.md +1 -1
  72. package/.docs/docs/server/auth/workos.md +1 -1
  73. package/.docs/docs/server/auth.md +2 -2
  74. package/.docs/docs/server/custom-adapters.md +7 -7
  75. package/.docs/docs/server/custom-api-routes.md +2 -2
  76. package/.docs/docs/server/mastra-client.md +2 -2
  77. package/.docs/docs/server/mastra-server.md +2 -2
  78. package/.docs/docs/server/request-context.md +2 -2
  79. package/.docs/docs/server/server-adapters.md +3 -3
  80. package/.docs/docs/streaming/events.md +2 -2
  81. package/.docs/docs/streaming/overview.md +2 -2
  82. package/.docs/docs/streaming/tool-streaming.md +46 -32
  83. package/.docs/docs/streaming/workflow-streaming.md +1 -1
  84. package/.docs/docs/voice/overview.md +3 -3
  85. package/.docs/docs/voice/speech-to-speech.md +1 -1
  86. package/.docs/docs/voice/speech-to-text.md +2 -2
  87. package/.docs/docs/voice/text-to-speech.md +2 -2
  88. package/.docs/docs/workflows/agents-and-tools.md +1 -1
  89. package/.docs/docs/workflows/control-flow.md +45 -3
  90. package/.docs/docs/workflows/error-handling.md +4 -4
  91. package/.docs/docs/workflows/overview.md +3 -3
  92. package/.docs/docs/workflows/snapshots.md +1 -1
  93. package/.docs/docs/workflows/suspend-and-resume.md +1 -1
  94. package/.docs/docs/workflows/time-travel.md +3 -3
  95. package/.docs/docs/workflows/workflow-state.md +1 -1
  96. package/.docs/docs/workspace/filesystem.md +3 -3
  97. package/.docs/docs/workspace/overview.md +53 -8
  98. package/.docs/docs/workspace/sandbox.md +72 -13
  99. package/.docs/docs/workspace/search.md +1 -1
  100. package/.docs/docs/workspace/skills.md +4 -4
  101. package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -2
  102. package/.docs/guides/build-your-ui/assistant-ui.md +1 -1
  103. package/.docs/guides/build-your-ui/copilotkit.md +2 -2
  104. package/.docs/guides/deployment/digital-ocean.md +1 -1
  105. package/.docs/guides/deployment/inngest.md +4 -4
  106. package/.docs/guides/getting-started/astro.md +1 -1
  107. package/.docs/guides/getting-started/electron.md +1 -1
  108. package/.docs/guides/getting-started/next-js.md +1 -1
  109. package/.docs/guides/getting-started/vite-react.md +1 -1
  110. package/.docs/guides/guide/ai-recruiter.md +4 -4
  111. package/.docs/guides/guide/chef-michel.md +4 -4
  112. package/.docs/guides/guide/code-review-bot.md +3 -3
  113. package/.docs/guides/guide/dev-assistant.md +5 -5
  114. package/.docs/guides/guide/docs-manager.md +3 -3
  115. package/.docs/guides/guide/github-actions-pr-description.md +4 -4
  116. package/.docs/guides/guide/notes-mcp-server.md +4 -4
  117. package/.docs/guides/guide/research-assistant.md +4 -4
  118. package/.docs/guides/guide/research-coordinator.md +1 -1
  119. package/.docs/guides/guide/stock-agent.md +6 -6
  120. package/.docs/guides/guide/web-search.md +2 -2
  121. package/.docs/guides/guide/whatsapp-chat-bot.md +1 -1
  122. package/.docs/guides/migrations/agentnetwork.md +1 -1
  123. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +3 -3
  124. package/.docs/guides/migrations/network-to-supervisor.md +1 -1
  125. package/.docs/guides/migrations/upgrade-to-v1/agent.md +1 -1
  126. package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -2
  127. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -2
  128. package/.docs/guides/migrations/upgrade-to-v1/evals.md +1 -1
  129. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +1 -1
  130. package/.docs/guides/migrations/upgrade-to-v1/memory.md +2 -2
  131. package/.docs/guides/migrations/upgrade-to-v1/overview.md +3 -3
  132. package/.docs/guides/migrations/upgrade-to-v1/storage.md +4 -4
  133. package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -2
  134. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -2
  135. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +3 -3
  136. package/.docs/guides/migrations/upgrade-to-v1/voice.md +1 -1
  137. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +6 -6
  138. package/.docs/guides/migrations/vnext-to-standard-apis.md +3 -3
  139. package/.docs/models/embeddings.md +4 -4
  140. package/.docs/models/gateways/custom-gateways.md +4 -4
  141. package/.docs/models/gateways/netlify.md +2 -3
  142. package/.docs/models/gateways/openrouter.md +9 -2
  143. package/.docs/models/gateways/vercel.md +11 -2
  144. package/.docs/models/gateways.md +2 -2
  145. package/.docs/models/index.md +1 -1
  146. package/.docs/models/providers/302ai.md +3 -3
  147. package/.docs/models/providers/abacus.md +24 -14
  148. package/.docs/models/providers/aihubmix.md +10 -5
  149. package/.docs/models/providers/alibaba-cn.md +83 -74
  150. package/.docs/models/providers/alibaba-coding-plan-cn.md +78 -0
  151. package/.docs/models/providers/alibaba-coding-plan.md +78 -0
  152. package/.docs/models/providers/alibaba.md +3 -3
  153. package/.docs/models/providers/anthropic.md +4 -4
  154. package/.docs/models/providers/bailing.md +3 -3
  155. package/.docs/models/providers/baseten.md +3 -3
  156. package/.docs/models/providers/berget.md +3 -3
  157. package/.docs/models/providers/cerebras.md +4 -4
  158. package/.docs/models/providers/chutes.md +7 -6
  159. package/.docs/models/providers/clarifai.md +81 -0
  160. package/.docs/models/providers/cloudferro-sherlock.md +8 -7
  161. package/.docs/models/providers/cloudflare-workers-ai.md +6 -5
  162. package/.docs/models/providers/cortecs.md +10 -8
  163. package/.docs/models/providers/deepinfra.md +11 -6
  164. package/.docs/models/providers/deepseek.md +4 -4
  165. package/.docs/models/providers/drun.md +73 -0
  166. package/.docs/models/providers/evroc.md +3 -3
  167. package/.docs/models/providers/fastrouter.md +3 -3
  168. package/.docs/models/providers/fireworks-ai.md +3 -3
  169. package/.docs/models/providers/firmware.md +31 -23
  170. package/.docs/models/providers/friendli.md +3 -3
  171. package/.docs/models/providers/github-models.md +3 -3
  172. package/.docs/models/providers/google.md +7 -5
  173. package/.docs/models/providers/groq.md +4 -4
  174. package/.docs/models/providers/helicone.md +3 -3
  175. package/.docs/models/providers/huggingface.md +3 -3
  176. package/.docs/models/providers/iflowcn.md +3 -3
  177. package/.docs/models/providers/inception.md +7 -5
  178. package/.docs/models/providers/inference.md +3 -3
  179. package/.docs/models/providers/io-net.md +3 -3
  180. package/.docs/models/providers/jiekou.md +3 -3
  181. package/.docs/models/providers/kilo.md +6 -4
  182. package/.docs/models/providers/kimi-for-coding.md +4 -4
  183. package/.docs/models/providers/kuae-cloud-coding-plan.md +3 -3
  184. package/.docs/models/providers/llama.md +3 -3
  185. package/.docs/models/providers/lmstudio.md +3 -3
  186. package/.docs/models/providers/lucidquery.md +3 -3
  187. package/.docs/models/providers/meganova.md +3 -3
  188. package/.docs/models/providers/minimax-cn-coding-plan.md +4 -4
  189. package/.docs/models/providers/minimax-cn.md +4 -4
  190. package/.docs/models/providers/minimax-coding-plan.md +4 -4
  191. package/.docs/models/providers/minimax.md +4 -4
  192. package/.docs/models/providers/mistral.md +4 -4
  193. package/.docs/models/providers/moark.md +3 -3
  194. package/.docs/models/providers/modelscope.md +3 -3
  195. package/.docs/models/providers/moonshotai-cn.md +3 -3
  196. package/.docs/models/providers/moonshotai.md +3 -3
  197. package/.docs/models/providers/morph.md +3 -3
  198. package/.docs/models/providers/nano-gpt.md +523 -42
  199. package/.docs/models/providers/nebius.md +37 -37
  200. package/.docs/models/providers/nova.md +3 -3
  201. package/.docs/models/providers/novita-ai.md +3 -3
  202. package/.docs/models/providers/nvidia.md +7 -5
  203. package/.docs/models/providers/ollama-cloud.md +4 -5
  204. package/.docs/models/providers/openai.md +7 -5
  205. package/.docs/models/providers/opencode-go.md +3 -3
  206. package/.docs/models/providers/opencode.md +39 -36
  207. package/.docs/models/providers/ovhcloud.md +3 -3
  208. package/.docs/models/providers/perplexity-agent.md +4 -4
  209. package/.docs/models/providers/perplexity.md +4 -4
  210. package/.docs/models/providers/poe.md +11 -5
  211. package/.docs/models/providers/privatemode-ai.md +3 -3
  212. package/.docs/models/providers/qihang-ai.md +3 -3
  213. package/.docs/models/providers/qiniu-ai.md +23 -8
  214. package/.docs/models/providers/requesty.md +20 -4
  215. package/.docs/models/providers/scaleway.md +3 -3
  216. package/.docs/models/providers/siliconflow-cn.md +10 -4
  217. package/.docs/models/providers/siliconflow.md +3 -3
  218. package/.docs/models/providers/stackit.md +3 -3
  219. package/.docs/models/providers/stepfun.md +3 -3
  220. package/.docs/models/providers/submodel.md +3 -3
  221. package/.docs/models/providers/synthetic.md +3 -3
  222. package/.docs/models/providers/togetherai.md +5 -7
  223. package/.docs/models/providers/upstage.md +3 -3
  224. package/.docs/models/providers/vivgrid.md +4 -4
  225. package/.docs/models/providers/vultr.md +3 -3
  226. package/.docs/models/providers/wandb.md +3 -3
  227. package/.docs/models/providers/xai.md +34 -31
  228. package/.docs/models/providers/xiaomi.md +4 -4
  229. package/.docs/models/providers/zai-coding-plan.md +3 -3
  230. package/.docs/models/providers/zai.md +3 -3
  231. package/.docs/models/providers/zenmux.md +7 -5
  232. package/.docs/models/providers/zhipuai-coding-plan.md +3 -3
  233. package/.docs/models/providers/zhipuai.md +3 -3
  234. package/.docs/models/providers.md +4 -0
  235. package/.docs/reference/agents/agent.md +3 -3
  236. package/.docs/reference/agents/generateLegacy.md +1 -1
  237. package/.docs/reference/agents/getDefaultGenerateOptions.md +1 -1
  238. package/.docs/reference/agents/getDefaultOptions.md +1 -1
  239. package/.docs/reference/agents/getDefaultStreamOptions.md +1 -1
  240. package/.docs/reference/agents/getDescription.md +1 -1
  241. package/.docs/reference/agents/network.md +5 -3
  242. package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
  243. package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
  244. package/.docs/reference/ai-sdk/network-route.md +2 -0
  245. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +1 -1
  246. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +1 -1
  247. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +1 -1
  248. package/.docs/reference/auth/auth0.md +7 -7
  249. package/.docs/reference/auth/better-auth.md +2 -2
  250. package/.docs/reference/auth/clerk.md +1 -1
  251. package/.docs/reference/auth/firebase.md +5 -5
  252. package/.docs/reference/auth/jwt.md +1 -1
  253. package/.docs/reference/auth/supabase.md +1 -1
  254. package/.docs/reference/auth/workos.md +6 -6
  255. package/.docs/reference/cli/mastra.md +5 -5
  256. package/.docs/reference/client-js/agents.md +22 -22
  257. package/.docs/reference/client-js/error-handling.md +2 -2
  258. package/.docs/reference/client-js/logs.md +2 -2
  259. package/.docs/reference/client-js/mastra-client.md +2 -2
  260. package/.docs/reference/client-js/memory.md +6 -6
  261. package/.docs/reference/client-js/observability.md +4 -4
  262. package/.docs/reference/client-js/telemetry.md +1 -1
  263. package/.docs/reference/client-js/tools.md +3 -3
  264. package/.docs/reference/client-js/vectors.md +2 -2
  265. package/.docs/reference/client-js/workflows.md +12 -12
  266. package/.docs/reference/configuration.md +62 -6
  267. package/.docs/reference/core/getDeployer.md +1 -1
  268. package/.docs/reference/core/getGatewayById.md +1 -1
  269. package/.docs/reference/core/getLogger.md +1 -1
  270. package/.docs/reference/core/getMCPServer.md +2 -2
  271. package/.docs/reference/core/getMCPServerById.md +2 -2
  272. package/.docs/reference/core/getMemory.md +1 -1
  273. package/.docs/reference/core/getScorer.md +4 -4
  274. package/.docs/reference/core/getScorerById.md +2 -2
  275. package/.docs/reference/core/getServer.md +1 -1
  276. package/.docs/reference/core/getStorage.md +1 -1
  277. package/.docs/reference/core/getStoredAgentById.md +3 -3
  278. package/.docs/reference/core/getTelemetry.md +1 -1
  279. package/.docs/reference/core/getWorkflow.md +1 -1
  280. package/.docs/reference/core/listAgents.md +1 -1
  281. package/.docs/reference/core/listMCPServers.md +3 -3
  282. package/.docs/reference/core/listMemory.md +1 -1
  283. package/.docs/reference/core/listScorers.md +1 -1
  284. package/.docs/reference/core/listStoredAgents.md +3 -3
  285. package/.docs/reference/core/listVectors.md +1 -1
  286. package/.docs/reference/core/mastra-class.md +2 -2
  287. package/.docs/reference/core/mastra-model-gateway.md +11 -11
  288. package/.docs/reference/core/setLogger.md +1 -1
  289. package/.docs/reference/core/setStorage.md +1 -1
  290. package/.docs/reference/datasets/dataset.md +2 -2
  291. package/.docs/reference/datasets/datasets-manager.md +1 -1
  292. package/.docs/reference/datasets/get.md +2 -2
  293. package/.docs/reference/datasets/getDetails.md +1 -1
  294. package/.docs/reference/datasets/listItems.md +1 -1
  295. package/.docs/reference/deployer/vercel.md +1 -1
  296. package/.docs/reference/deployer.md +4 -4
  297. package/.docs/reference/evals/answer-relevancy.md +4 -4
  298. package/.docs/reference/evals/answer-similarity.md +3 -3
  299. package/.docs/reference/evals/bias.md +4 -4
  300. package/.docs/reference/evals/completeness.md +6 -6
  301. package/.docs/reference/evals/content-similarity.md +3 -3
  302. package/.docs/reference/evals/context-precision.md +9 -9
  303. package/.docs/reference/evals/context-relevance.md +7 -7
  304. package/.docs/reference/evals/create-scorer.md +7 -7
  305. package/.docs/reference/evals/faithfulness.md +3 -3
  306. package/.docs/reference/evals/hallucination.md +8 -14
  307. package/.docs/reference/evals/keyword-coverage.md +4 -4
  308. package/.docs/reference/evals/mastra-scorer.md +7 -7
  309. package/.docs/reference/evals/noise-sensitivity.md +11 -11
  310. package/.docs/reference/evals/prompt-alignment.md +5 -5
  311. package/.docs/reference/evals/run-evals.md +5 -5
  312. package/.docs/reference/evals/scorer-utils.md +17 -17
  313. package/.docs/reference/evals/textual-difference.md +4 -4
  314. package/.docs/reference/evals/tone-consistency.md +5 -5
  315. package/.docs/reference/evals/tool-call-accuracy.md +10 -10
  316. package/.docs/reference/evals/toxicity.md +3 -3
  317. package/.docs/reference/harness/harness-class.md +5 -3
  318. package/.docs/reference/index.md +2 -0
  319. package/.docs/reference/memory/clone-utilities.md +7 -7
  320. package/.docs/reference/memory/cloneThread.md +5 -5
  321. package/.docs/reference/memory/createThread.md +1 -1
  322. package/.docs/reference/memory/deleteMessages.md +1 -1
  323. package/.docs/reference/memory/getThreadById.md +1 -1
  324. package/.docs/reference/memory/listThreads.md +3 -3
  325. package/.docs/reference/memory/memory-class.md +1 -1
  326. package/.docs/reference/memory/observational-memory.md +8 -6
  327. package/.docs/reference/memory/recall.md +1 -1
  328. package/.docs/reference/observability/tracing/bridges/otel.md +6 -6
  329. package/.docs/reference/observability/tracing/configuration.md +17 -17
  330. package/.docs/reference/observability/tracing/exporters/arize.md +4 -4
  331. package/.docs/reference/observability/tracing/exporters/braintrust.md +3 -3
  332. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +6 -6
  333. package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -4
  334. package/.docs/reference/observability/tracing/exporters/datadog.md +4 -4
  335. package/.docs/reference/observability/tracing/exporters/default-exporter.md +6 -6
  336. package/.docs/reference/observability/tracing/exporters/laminar.md +2 -2
  337. package/.docs/reference/observability/tracing/exporters/langfuse.md +4 -4
  338. package/.docs/reference/observability/tracing/exporters/langsmith.md +6 -6
  339. package/.docs/reference/observability/tracing/exporters/otel.md +12 -12
  340. package/.docs/reference/observability/tracing/exporters/posthog.md +3 -3
  341. package/.docs/reference/observability/tracing/exporters/sentry.md +5 -5
  342. package/.docs/reference/observability/tracing/instances.md +9 -9
  343. package/.docs/reference/observability/tracing/interfaces.md +39 -39
  344. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +6 -6
  345. package/.docs/reference/observability/tracing/spans.md +15 -13
  346. package/.docs/reference/processors/message-history-processor.md +1 -1
  347. package/.docs/reference/processors/processor-interface.md +21 -17
  348. package/.docs/reference/processors/token-limiter-processor.md +2 -2
  349. package/.docs/reference/rag/chunk.md +2 -2
  350. package/.docs/reference/rag/database-config.md +8 -8
  351. package/.docs/reference/rag/document.md +11 -11
  352. package/.docs/reference/rag/embeddings.md +5 -5
  353. package/.docs/reference/rag/extract-params.md +8 -8
  354. package/.docs/reference/rag/graph-rag.md +4 -4
  355. package/.docs/reference/rag/metadata-filters.md +15 -15
  356. package/.docs/reference/rag/rerank.md +2 -2
  357. package/.docs/reference/rag/rerankWithScorer.md +2 -2
  358. package/.docs/reference/server/create-route.md +2 -0
  359. package/.docs/reference/server/express-adapter.md +1 -1
  360. package/.docs/reference/server/fastify-adapter.md +1 -1
  361. package/.docs/reference/server/hono-adapter.md +1 -1
  362. package/.docs/reference/server/koa-adapter.md +2 -2
  363. package/.docs/reference/server/mastra-server.md +16 -16
  364. package/.docs/reference/server/register-api-route.md +7 -7
  365. package/.docs/reference/server/routes.md +1 -1
  366. package/.docs/reference/storage/cloudflare-d1.md +5 -5
  367. package/.docs/reference/storage/cloudflare.md +3 -3
  368. package/.docs/reference/storage/composite.md +1 -1
  369. package/.docs/reference/storage/convex.md +6 -6
  370. package/.docs/reference/storage/dynamodb.md +7 -7
  371. package/.docs/reference/storage/lance.md +5 -5
  372. package/.docs/reference/storage/libsql.md +1 -1
  373. package/.docs/reference/storage/mongodb.md +6 -6
  374. package/.docs/reference/storage/mssql.md +4 -4
  375. package/.docs/reference/storage/overview.md +2 -2
  376. package/.docs/reference/storage/postgresql.md +7 -7
  377. package/.docs/reference/storage/upstash.md +4 -4
  378. package/.docs/reference/streaming/ChunkType.md +13 -13
  379. package/.docs/reference/streaming/agents/MastraModelOutput.md +6 -6
  380. package/.docs/reference/streaming/agents/stream.md +2 -2
  381. package/.docs/reference/streaming/agents/streamLegacy.md +1 -1
  382. package/.docs/reference/streaming/workflows/observeStream.md +2 -2
  383. package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
  384. package/.docs/reference/streaming/workflows/stream.md +1 -1
  385. package/.docs/reference/templates/overview.md +4 -4
  386. package/.docs/reference/tools/create-tool.md +10 -10
  387. package/.docs/reference/tools/document-chunker-tool.md +4 -4
  388. package/.docs/reference/tools/graph-rag-tool.md +7 -7
  389. package/.docs/reference/tools/mcp-client.md +13 -13
  390. package/.docs/reference/tools/mcp-server.md +27 -27
  391. package/.docs/reference/tools/vector-query-tool.md +12 -12
  392. package/.docs/reference/vectors/astra.md +13 -13
  393. package/.docs/reference/vectors/chroma.md +18 -18
  394. package/.docs/reference/vectors/convex.md +15 -15
  395. package/.docs/reference/vectors/couchbase.md +21 -21
  396. package/.docs/reference/vectors/duckdb.md +17 -17
  397. package/.docs/reference/vectors/elasticsearch.md +14 -14
  398. package/.docs/reference/vectors/lance.md +22 -22
  399. package/.docs/reference/vectors/libsql.md +15 -15
  400. package/.docs/reference/vectors/mongodb.md +18 -18
  401. package/.docs/reference/vectors/opensearch.md +11 -11
  402. package/.docs/reference/vectors/pg.md +23 -21
  403. package/.docs/reference/vectors/pinecone.md +15 -15
  404. package/.docs/reference/vectors/qdrant.md +15 -15
  405. package/.docs/reference/vectors/s3vectors.md +22 -22
  406. package/.docs/reference/vectors/turbopuffer.md +14 -14
  407. package/.docs/reference/vectors/upstash.md +15 -15
  408. package/.docs/reference/vectors/vectorize.md +16 -16
  409. package/.docs/reference/voice/azure.md +12 -10
  410. package/.docs/reference/voice/cloudflare.md +9 -7
  411. package/.docs/reference/voice/composite-voice.md +5 -5
  412. package/.docs/reference/voice/deepgram.md +5 -5
  413. package/.docs/reference/voice/elevenlabs.md +7 -7
  414. package/.docs/reference/voice/google-gemini-live.md +22 -22
  415. package/.docs/reference/voice/google.md +12 -12
  416. package/.docs/reference/voice/mastra-voice.md +18 -18
  417. package/.docs/reference/voice/murf.md +8 -8
  418. package/.docs/reference/voice/openai-realtime.md +19 -17
  419. package/.docs/reference/voice/openai.md +12 -8
  420. package/.docs/reference/voice/playai.md +9 -7
  421. package/.docs/reference/voice/sarvam.md +8 -6
  422. package/.docs/reference/voice/speechify.md +11 -9
  423. package/.docs/reference/voice/voice.addInstructions.md +4 -4
  424. package/.docs/reference/voice/voice.addTools.md +3 -3
  425. package/.docs/reference/voice/voice.answer.md +2 -2
  426. package/.docs/reference/voice/voice.close.md +4 -4
  427. package/.docs/reference/voice/voice.connect.md +9 -7
  428. package/.docs/reference/voice/voice.events.md +4 -4
  429. package/.docs/reference/voice/voice.getSpeakers.md +4 -4
  430. package/.docs/reference/voice/voice.listen.md +17 -11
  431. package/.docs/reference/voice/voice.off.md +4 -4
  432. package/.docs/reference/voice/voice.on.md +5 -5
  433. package/.docs/reference/voice/voice.send.md +2 -2
  434. package/.docs/reference/voice/voice.speak.md +19 -9
  435. package/.docs/reference/voice/voice.updateConfig.md +4 -4
  436. package/.docs/reference/workflows/run-methods/startAsync.md +1 -1
  437. package/.docs/reference/workflows/run-methods/timeTravel.md +1 -1
  438. package/.docs/reference/workflows/run.md +3 -3
  439. package/.docs/reference/workflows/step.md +2 -2
  440. package/.docs/reference/workflows/workflow-methods/create-run.md +1 -1
  441. package/.docs/reference/workflows/workflow.md +1 -1
  442. package/.docs/reference/workspace/blaxel-sandbox.md +164 -0
  443. package/.docs/reference/workspace/daytona-sandbox.md +50 -141
  444. package/.docs/reference/workspace/e2b-sandbox.md +41 -77
  445. package/.docs/reference/workspace/filesystem.md +25 -11
  446. package/.docs/reference/workspace/gcs-filesystem.md +21 -1
  447. package/.docs/reference/workspace/local-filesystem.md +24 -10
  448. package/.docs/reference/workspace/local-sandbox.md +27 -102
  449. package/.docs/reference/workspace/process-manager.md +296 -0
  450. package/.docs/reference/workspace/s3-filesystem.md +21 -1
  451. package/.docs/reference/workspace/sandbox.md +9 -1
  452. package/.docs/reference/workspace/workspace-class.md +95 -27
  453. package/CHANGELOG.md +15 -0
  454. package/dist/tools/course.d.ts +7 -27
  455. package/dist/tools/course.d.ts.map +1 -1
  456. package/dist/tools/docs.d.ts +6 -18
  457. package/dist/tools/docs.d.ts.map +1 -1
  458. package/dist/tools/embedded-docs.d.ts +12 -112
  459. package/dist/tools/embedded-docs.d.ts.map +1 -1
  460. package/dist/tools/migration.d.ts +6 -26
  461. package/dist/tools/migration.d.ts.map +1 -1
  462. package/package.json +6 -6
@@ -22,7 +22,7 @@ constructor({
22
22
 
23
23
  **timeout** (`number`): Global timeout value in milliseconds for all servers unless overridden in individual server configs. (Default: `60000`)
24
24
 
25
- ### MastraMCPServerDefinition
25
+ ### `MastraMCPServerDefinition`
26
26
 
27
27
  Each server in the `servers` map is configured using the `MastraMCPServerDefinition` type. The transport type is detected based on the provided parameters:
28
28
 
@@ -55,7 +55,7 @@ Each server in the `servers` map is configured using the `MastraMCPServerDefinit
55
55
 
56
56
  ## Methods
57
57
 
58
- ### listTools()
58
+ ### `listTools()`
59
59
 
60
60
  Retrieves all tools from all configured servers, with tool names namespaced by their server name (in the format `serverName_toolName`) to prevent conflicts. Intended to be passed onto an Agent definition.
61
61
 
@@ -63,7 +63,7 @@ Retrieves all tools from all configured servers, with tool names namespaced by t
63
63
  new Agent({ id: 'agent', tools: await mcp.listTools() })
64
64
  ```
65
65
 
66
- ### listToolsets()
66
+ ### `listToolsets()`
67
67
 
68
68
  Returns an object mapping namespaced tool names (in the format `serverName.toolName`) to their tool implementations. Intended to be passed dynamically into the generate or stream method.
69
69
 
@@ -73,7 +73,7 @@ const res = await agent.stream(prompt, {
73
73
  })
74
74
  ```
75
75
 
76
- ### disconnect()
76
+ ### `disconnect()`
77
77
 
78
78
  Disconnects from all MCP servers and cleans up resources.
79
79
 
@@ -239,7 +239,7 @@ mcpClient.elicitation.onRequest('serverName', async request => {
239
239
 
240
240
  Sets up a handler function that will be called when any connected MCP server sends an elicitation request. The handler receives the request and must return a response.
241
241
 
242
- ##### ElicitationHandler Function
242
+ ##### `ElicitationHandler` Function
243
243
 
244
244
  The handler function receives a request object with:
245
245
 
@@ -534,7 +534,7 @@ mcpClient.elicitation.onRequest('interactiveServer', async request => {
534
534
  })
535
535
  ```
536
536
 
537
- ### Response Types
537
+ ### Response types
538
538
 
539
539
  Your elicitation handler must return one of three response types:
540
540
 
@@ -592,7 +592,7 @@ await mcpClient.elicitation.onRequest('interactiveServer', async request => {
592
592
  })
593
593
  ```
594
594
 
595
- ### Best Practices
595
+ ### Best practices
596
596
 
597
597
  - **Always handle elicitation**: Set up your handler before calling tools that might use elicitation
598
598
  - **Validate input**: Check that required fields are provided
@@ -600,7 +600,7 @@ await mcpClient.elicitation.onRequest('interactiveServer', async request => {
600
600
  - **Clear UI**: Make it obvious what information is being requested and why
601
601
  - **Security**: Never auto-accept requests for sensitive information
602
602
 
603
- ## OAuth Authentication
603
+ ## OAuth authentication
604
604
 
605
605
  For connecting to MCP servers that require OAuth authentication per the [MCP Auth Specification](https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization), use the `MCPOAuthClientProvider`:
606
606
 
@@ -819,7 +819,7 @@ const response = await agent.stream('How is AAPL doing and what is the weather?'
819
819
  })
820
820
  ```
821
821
 
822
- ## Instance Management
822
+ ## Instance management
823
823
 
824
824
  The `MCPClient` class includes built-in memory leak prevention for managing multiple instances:
825
825
 
@@ -863,7 +863,7 @@ const mcp4 = new MCPClient({
863
863
  })
864
864
  ```
865
865
 
866
- ## Server Lifecycle
866
+ ## Server lifecycle
867
867
 
868
868
  MCPClient handles server connections gracefully:
869
869
 
@@ -871,7 +871,7 @@ MCPClient handles server connections gracefully:
871
871
  2. Graceful server shutdown to prevent error messages during development
872
872
  3. Proper cleanup of resources when disconnecting
873
873
 
874
- ## Using Custom Fetch for Dynamic Authentication
874
+ ## Using custom fetch for dynamic authentication
875
875
 
876
876
  For HTTP servers, you can provide a custom `fetch` function to handle dynamic authentication, request interception, or other custom behavior. This is particularly useful when you need to refresh tokens on each request or forward user credentials from the incoming request to the MCP server.
877
877
 
@@ -910,7 +910,7 @@ await agent.generate('Hello!', {
910
910
  })
911
911
  ```
912
912
 
913
- ## Using SSE Request Headers
913
+ ## Using SSE request headers
914
914
 
915
915
  When using the legacy SSE MCP transport, you must configure both `requestInit` and `eventSourceInit` due to a bug in the MCP SDK. Alternatively, you can use a custom `fetch` function which will be automatically used for both POST requests and SSE connections:
916
916
 
@@ -959,7 +959,7 @@ const sseClientWithFetch = new MCPClient({
959
959
  })
960
960
  ```
961
961
 
962
- ## Related Information
962
+ ## Related information
963
963
 
964
964
  - For creating MCP servers, see the [MCPServer documentation](https://mastra.ai/reference/tools/mcp-server).
965
965
  - For more about the Model Context Protocol, see the [@modelcontextprotocol/sdk documentation](https://github.com/modelcontextprotocol/typescript-sdk).
@@ -83,7 +83,7 @@ The constructor accepts an `MCPServerConfig` object with the following propertie
83
83
 
84
84
  **prompts** (`MCPServerPrompts`): An object defining how the server should handle MCP prompts. See Prompt Handling section for details.
85
85
 
86
- ## Exposing Agents as Tools
86
+ ## Exposing agents as tools
87
87
 
88
88
  A powerful feature of `MCPServer` is its ability to automatically expose your Mastra Agents as callable tools. When you provide agents in the `agents` property of the configuration:
89
89
 
@@ -96,9 +96,9 @@ A powerful feature of `MCPServer` is its ability to automatically expose your Ma
96
96
  - **Execution**: When this tool is called, it invokes the `generate()` method of the corresponding agent, passing the provided `query`.
97
97
  - **Output**: The direct result from the agent's `generate()` method is returned as the output of the tool.
98
98
 
99
- - **Name Collisions**: If an explicit tool defined in the `tools` configuration has the same name as an agent-derived tool (e.g., you have a tool named `ask_myAgentKey` and also an agent with the key `myAgentKey`), the _explicitly defined tool will take precedence_. The agent will not be converted into a tool in this conflicting case, and a warning will be logged.
99
+ - **Name Collisions**: If an explicit tool defined in the `tools` configuration has the same name as an agent-derived tool (e.g., you have a tool named `ask_myAgentKey` and also an agent with the key `myAgentKey`), the _explicitly defined tool will take precedence_. The agent won't be converted into a tool in this conflicting case, and a warning will be logged.
100
100
 
101
- This makes it straightforward to allow MCP clients to interact with your agents using natural language queries, just like any other tool.
101
+ This makes it straightforward to allow MCP clients to interact with your agents using natural language queries, like any other tool.
102
102
 
103
103
  ### Agent-to-Tool Conversion
104
104
 
@@ -164,7 +164,7 @@ const fetchUserData = createTool({
164
164
 
165
165
  These are the functions you can call on an `MCPServer` instance to control its behavior and get information.
166
166
 
167
- ### startStdio()
167
+ ### `startStdio()`
168
168
 
169
169
  Use this method to start the server so it communicates using standard input and output (stdio). This is typical when running the server as a command-line program.
170
170
 
@@ -186,7 +186,7 @@ const server = new MCPServer({
186
186
  await server.startStdio()
187
187
  ```
188
188
 
189
- ### startSSE()
189
+ ### `startSSE()`
190
190
 
191
191
  This method helps you integrate the MCP server with an existing web server to use Server-Sent Events (SSE) for communication. You'll call this from your web server's code when it receives a request for the SSE or message paths.
192
192
 
@@ -238,7 +238,7 @@ Here are the details for the values needed by the `startSSE` method:
238
238
 
239
239
  **res** (`any`): The response object from your web server, used to send data back.
240
240
 
241
- ### startHonoSSE()
241
+ ### `startHonoSSE()`
242
242
 
243
243
  This method helps you integrate the MCP server with an existing web server to use Server-Sent Events (SSE) for communication. You'll call this from your web server's code when it receives a request for the SSE or message paths.
244
244
 
@@ -290,7 +290,7 @@ Here are the details for the values needed by the `startHonoSSE` method:
290
290
 
291
291
  **res** (`any`): The response object from your web server, used to send data back.
292
292
 
293
- ### startHTTP()
293
+ ### `startHTTP()`
294
294
 
295
295
  This method helps you integrate the MCP server with an existing web server to use streamable HTTP for communication. You'll call this from your web server's code when it receives HTTP requests.
296
296
 
@@ -391,7 +391,7 @@ serve(async req => {
391
391
  >
392
392
  > The serverless mode disables session management and creates fresh server instances per request, which is necessary for stateless environments where memory doesn't persist between invocations.
393
393
  >
394
- > **Note:** The following MCP features require session state or persistent connections and will **not work** in serverless mode:
394
+ > **Note:** The following MCP features require session state or persistent connections and **won't work** in serverless mode:
395
395
  >
396
396
  > - **Elicitation** - Interactive user input requests during tool execution require session management to route responses back to the correct client
397
397
  > - **Resource subscriptions** - `resources/subscribe` and `resources/unsubscribe` need persistent connections to maintain subscription state
@@ -424,7 +424,7 @@ The `StreamableHTTPServerTransportOptions` object allows you to customize the be
424
424
 
425
425
  **eventStore** (`EventStore`): An event store for message resumability. Providing this enables clients to reconnect and resume message streams.
426
426
 
427
- ### close()
427
+ ### `close()`
428
428
 
429
429
  This method closes the server and releases all resources.
430
430
 
@@ -432,7 +432,7 @@ This method closes the server and releases all resources.
432
432
  async close(): Promise<void>
433
433
  ```
434
434
 
435
- ### getServerInfo()
435
+ ### `getServerInfo()`
436
436
 
437
437
  This method gives you a look at the server's basic information.
438
438
 
@@ -440,7 +440,7 @@ This method gives you a look at the server's basic information.
440
440
  getServerInfo(): ServerInfo
441
441
  ```
442
442
 
443
- ### getServerDetail()
443
+ ### `getServerDetail()`
444
444
 
445
445
  This method gives you a detailed look at the server's information.
446
446
 
@@ -448,7 +448,7 @@ This method gives you a detailed look at the server's information.
448
448
  getServerDetail(): ServerDetail
449
449
  ```
450
450
 
451
- ### getToolListInfo()
451
+ ### `getToolListInfo()`
452
452
 
453
453
  This method gives you a look at the tools that were set up when you created the server. It's a read-only list, useful for debugging purposes.
454
454
 
@@ -456,7 +456,7 @@ This method gives you a look at the tools that were set up when you created the
456
456
  getToolListInfo(): ToolListInfo
457
457
  ```
458
458
 
459
- ### getToolInfo()
459
+ ### `getToolInfo()`
460
460
 
461
461
  This method gives you detailed information about a specific tool.
462
462
 
@@ -464,7 +464,7 @@ This method gives you detailed information about a specific tool.
464
464
  getToolInfo(toolName: string): ToolInfo
465
465
  ```
466
466
 
467
- ### executeTool()
467
+ ### `executeTool()`
468
468
 
469
469
  This method executes a specific tool and returns the result.
470
470
 
@@ -472,7 +472,7 @@ This method executes a specific tool and returns the result.
472
472
  executeTool(toolName: string, input: any): Promise<any>
473
473
  ```
474
474
 
475
- ### getStdioTransport()
475
+ ### `getStdioTransport()`
476
476
 
477
477
  If you started the server with `startStdio()`, you can use this to get the object that manages the stdio communication. This is mostly for checking things internally or for testing.
478
478
 
@@ -480,7 +480,7 @@ If you started the server with `startStdio()`, you can use this to get the objec
480
480
  getStdioTransport(): StdioServerTransport | undefined
481
481
  ```
482
482
 
483
- ### getSseTransport()
483
+ ### `getSseTransport()`
484
484
 
485
485
  If you started the server with `startSSE()`, you can use this to get the object that manages the SSE communication. Like `getStdioTransport`, this is mainly for internal checks or testing.
486
486
 
@@ -488,7 +488,7 @@ If you started the server with `startSSE()`, you can use this to get the object
488
488
  getSseTransport(): SSEServerTransport | undefined
489
489
  ```
490
490
 
491
- ### getSseHonoTransport()
491
+ ### `getSseHonoTransport()`
492
492
 
493
493
  If you started the server with `startHonoSSE()`, you can use this to get the object that manages the SSE communication. Like `getSseTransport`, this is mainly for internal checks or testing.
494
494
 
@@ -496,7 +496,7 @@ If you started the server with `startHonoSSE()`, you can use this to get the obj
496
496
  getSseHonoTransport(): SSETransport | undefined
497
497
  ```
498
498
 
499
- ### getStreamableHTTPTransport()
499
+ ### `getStreamableHTTPTransport()`
500
500
 
501
501
  If you started the server with `startHTTP()`, you can use this to get the object that manages the HTTP communication. Like `getSseTransport`, this is mainly for internal checks or testing.
502
502
 
@@ -504,7 +504,7 @@ If you started the server with `startHTTP()`, you can use this to get the object
504
504
  getStreamableHTTPTransport(): StreamableHTTPServerTransport | undefined
505
505
  ```
506
506
 
507
- ### tools()
507
+ ### `tools()`
508
508
 
509
509
  Executes a specific tool provided by this MCP server.
510
510
 
@@ -522,7 +522,7 @@ async executeTool(
522
522
 
523
523
  **executionContext** (`object`): Optional context for the tool execution, like messages or a toolCallId.
524
524
 
525
- ## Resource Handling
525
+ ## Resource handling
526
526
 
527
527
  ### What are MCP Resources?
528
528
 
@@ -649,7 +649,7 @@ Example:
649
649
  await serverWithResources.resources.notifyListChanged()
650
650
  ```
651
651
 
652
- ## Prompt Handling
652
+ ## Prompt handling
653
653
 
654
654
  ### What are MCP Prompts?
655
655
 
@@ -758,7 +758,7 @@ Call this method when the overall list of available prompts has changed (e.g., a
758
758
  await serverWithPrompts.prompts.notifyListChanged()
759
759
  ```
760
760
 
761
- ### Best Practices for Prompt Handling
761
+ ### Best practices for Prompt Handling
762
762
 
763
763
  - Use clear, descriptive prompt names and descriptions.
764
764
  - Validate all required arguments in `getPromptMessages`.
@@ -778,7 +778,7 @@ The example at the beginning of this page also demonstrates how to instantiate `
778
778
 
779
779
  ## Elicitation
780
780
 
781
- ### What is Elicitation?
781
+ ### What's Elicitation?
782
782
 
783
783
  Elicitation is a feature in the Model Context Protocol (MCP) that allows servers to request structured information from users. This enables interactive workflows where servers can collect additional data dynamically.
784
784
 
@@ -982,7 +982,7 @@ type ElicitResult = {
982
982
  }
983
983
  ```
984
984
 
985
- ## OAuth Protection
985
+ ## OAuth protection
986
986
 
987
987
  To protect your MCP server with OAuth authentication per the [MCP Auth Specification](https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization), use the `createOAuthMiddleware` function:
988
988
 
@@ -1085,11 +1085,11 @@ const customMiddleware = createOAuthMiddleware({
1085
1085
 
1086
1086
  **mcpPath** (`string`): Path where the MCP endpoint is served. Only requests to this path require authentication. (Default: `'/mcp'`)
1087
1087
 
1088
- ## Authentication Context
1088
+ ## Authentication context
1089
1089
 
1090
1090
  Tools can access request metadata via `context.mcp.extra` when using HTTP-based transports. This allows you to pass authentication info, user context, or any custom data from your HTTP middleware to your MCP tools.
1091
1091
 
1092
- ### How It Works
1092
+ ### How it works
1093
1093
 
1094
1094
  Whatever you set on `req.auth` in your HTTP middleware becomes available as `context.mcp.extra.authInfo` in your tools:
1095
1095
 
@@ -1265,7 +1265,7 @@ app.all('/mcp', async (req, res) => {
1265
1265
  app.listen(3000)
1266
1266
  ```
1267
1267
 
1268
- ## Related Information
1268
+ ## Related information
1269
1269
 
1270
1270
  - For connecting to MCP servers in Mastra, see the [MCPClient documentation](https://mastra.ai/reference/tools/mcp-client).
1271
1271
  - For more about the Model Context Protocol, see the [@modelcontextprotocol/sdk documentation](https://github.com/modelcontextprotocol/typescript-sdk).
@@ -2,7 +2,7 @@
2
2
 
3
3
  The `createVectorQueryTool()` function creates a tool for semantic search over vector stores. It supports filtering, reranking, database-specific configurations, and integrates with various vector store backends.
4
4
 
5
- ## Basic Usage
5
+ ## Basic usage
6
6
 
7
7
  ```typescript
8
8
  import { createVectorQueryTool } from '@mastra/rag'
@@ -79,7 +79,7 @@ The tool returns an object with:
79
79
 
80
80
  **sources** (`QueryResult[]`): Array of full retrieval result objects. Each object contains all information needed to reference the original document, chunk, and similarity score.
81
81
 
82
- ### QueryResult object structure
82
+ ### `QueryResult` object structure
83
83
 
84
84
  ```typescript
85
85
  {
@@ -91,7 +91,7 @@ The tool returns an object with:
91
91
  }
92
92
  ```
93
93
 
94
- ## Default Tool Description
94
+ ## Default tool description
95
95
 
96
96
  The default description focuses on:
97
97
 
@@ -99,11 +99,11 @@ The default description focuses on:
99
99
  - Answering user questions
100
100
  - Retrieving factual content
101
101
 
102
- ## Result Handling
102
+ ## Result handling
103
103
 
104
104
  The tool determines the number of results to return based on the user's query, with a default of 10 results. This can be adjusted based on the query requirements.
105
105
 
106
- ## Example with Filters
106
+ ## Example with filters
107
107
 
108
108
  ```typescript
109
109
  const queryTool = createVectorQueryTool({
@@ -134,7 +134,7 @@ For detailed filter syntax and store-specific capabilities, see the [Metadata Fi
134
134
 
135
135
  For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](https://github.com/mastra-ai/mastra/tree/main/examples/basics/rag/filter-rag) example.
136
136
 
137
- ## Example with Reranking
137
+ ## Example with reranking
138
138
 
139
139
  ```typescript
140
140
  const queryTool = createVectorQueryTool({
@@ -164,7 +164,7 @@ Reranking improves result quality by combining:
164
164
 
165
165
  The reranker processes the initial vector search results and returns a reordered list optimized for relevance.
166
166
 
167
- ## Example with Custom Description
167
+ ## Example with custom description
168
168
 
169
169
  ```typescript
170
170
  const queryTool = createVectorQueryTool({
@@ -178,7 +178,7 @@ const queryTool = createVectorQueryTool({
178
178
 
179
179
  This example shows how to customize the tool description for a specific use case while maintaining its core purpose of information retrieval.
180
180
 
181
- ## Database-Specific Configuration Examples
181
+ ## Database-specific configuration examples
182
182
 
183
183
  The `databaseConfig` parameter allows you to leverage unique features and optimizations specific to each vector database. These configurations are automatically applied during query execution.
184
184
 
@@ -335,7 +335,7 @@ This approach allows you to:
335
335
  - Adjust performance parameters based on load
336
336
  - Apply different filtering strategies per request
337
337
 
338
- ## Example: Using Request Context
338
+ ## Example: Using request context
339
339
 
340
340
  ```typescript
341
341
  const queryTool = createVectorQueryTool({
@@ -374,7 +374,7 @@ For more information on request context, please see:
374
374
  - [Agent Request Context](https://mastra.ai/docs/server/request-context)
375
375
  - [Request Context](https://mastra.ai/docs/server/request-context)
376
376
 
377
- ## Usage Without a Mastra Server
377
+ ## Usage without a Mastra server
378
378
 
379
379
  The tool can be used by itself to retrieve documents matching a query:
380
380
 
@@ -401,7 +401,7 @@ const queryResult = await vectorQueryTool.execute({ queryText: 'foo', topK: 1 },
401
401
  console.log(queryResult.sources)
402
402
  ```
403
403
 
404
- ## Dynamic Vector Store for Multi-Tenant Applications
404
+ ## Dynamic vector store for multi-tenant applications
405
405
 
406
406
  For multi-tenant applications where each tenant has isolated data (e.g., separate PostgreSQL schemas), you can pass a resolver function instead of a static vector store instance. The function receives the request context and can return the appropriate vector store for the current tenant:
407
407
 
@@ -457,7 +457,7 @@ This pattern is similar to how `Agent.memory` supports dynamic configuration and
457
457
  - **Database isolation**: Route to different database instances per tenant
458
458
  - **Dynamic configuration**: Adjust vector store settings based on request context
459
459
 
460
- ## Tool Details
460
+ ## Tool details
461
461
 
462
462
  The tool is created with:
463
463
 
@@ -1,8 +1,8 @@
1
- # Astra Vector Store
1
+ # Astra vector store
2
2
 
3
3
  The AstraVector class provides vector search using [DataStax Astra DB](https://www.datastax.com/products/datastax-astra), a cloud-native, serverless database built on Apache Cassandra. It provides vector search capabilities with enterprise-grade scalability and high availability.
4
4
 
5
- ## Constructor Options
5
+ ## Constructor options
6
6
 
7
7
  **token** (`string`): Astra DB API token
8
8
 
@@ -12,7 +12,7 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
12
12
 
13
13
  ## Methods
14
14
 
15
- ### createIndex()
15
+ ### `createIndex()`
16
16
 
17
17
  **indexName** (`string`): Name of the index to create
18
18
 
@@ -20,7 +20,7 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
20
20
 
21
21
  **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (maps to dot\_product for dotproduct) (Default: `cosine`)
22
22
 
23
- ### upsert()
23
+ ### `upsert()`
24
24
 
25
25
  **indexName** (`string`): Name of the index to upsert into
26
26
 
@@ -30,7 +30,7 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
30
30
 
31
31
  **ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
32
32
 
33
- ### query()
33
+ ### `query()`
34
34
 
35
35
  **indexName** (`string`): Name of the index to query
36
36
 
@@ -42,11 +42,11 @@ The AstraVector class provides vector search using [DataStax Astra DB](https://w
42
42
 
43
43
  **includeVector** (`boolean`): Whether to include vectors in the results (Default: `false`)
44
44
 
45
- ### listIndexes()
45
+ ### `listIndexes()`
46
46
 
47
47
  Returns an array of index names as strings.
48
48
 
49
- ### describeIndex()
49
+ ### `describeIndex()`
50
50
 
51
51
  **indexName** (`string`): Name of the index to describe
52
52
 
@@ -60,11 +60,11 @@ interface IndexStats {
60
60
  }
61
61
  ```
62
62
 
63
- ### deleteIndex()
63
+ ### `deleteIndex()`
64
64
 
65
65
  **indexName** (`string`): Name of the index to delete
66
66
 
67
- ### updateVector()
67
+ ### `updateVector()`
68
68
 
69
69
  **indexName** (`string`): Name of the index containing the vector
70
70
 
@@ -72,13 +72,13 @@ interface IndexStats {
72
72
 
73
73
  **update** (`object`): Update object containing vector and/or metadata changes
74
74
 
75
- ### deleteVector()
75
+ ### `deleteVector()`
76
76
 
77
77
  **indexName** (`string`): Name of the index containing the vector
78
78
 
79
79
  **id** (`string`): ID of the vector to delete
80
80
 
81
- ## Response Types
81
+ ## Response types
82
82
 
83
83
  Query results are returned in this format:
84
84
 
@@ -91,7 +91,7 @@ interface QueryResult {
91
91
  }
92
92
  ```
93
93
 
94
- ## Error Handling
94
+ ## Error handling
95
95
 
96
96
  The store throws typed errors that can be caught:
97
97
 
@@ -109,7 +109,7 @@ try {
109
109
  }
110
110
  ```
111
111
 
112
- ## Environment Variables
112
+ ## Environment variables
113
113
 
114
114
  Required environment variables:
115
115
 
@@ -1,4 +1,4 @@
1
- # Chroma Vector Store
1
+ # Chroma vector store
2
2
 
3
3
  The ChromaVector class provides vector search using [Chroma](https://docs.trychroma.com/docs/overview/getting-started), an open-source embedding database. It offers efficient vector search with metadata filtering and hybrid search capabilities.
4
4
 
@@ -10,7 +10,7 @@ The ChromaVector class provides vector search using [Chroma](https://docs.trychr
10
10
  >
11
11
  > [Get started with Chroma Cloud](https://trychroma.com/signup)
12
12
 
13
- ## Constructor Options
13
+ ## Constructor options
14
14
 
15
15
  **host** (`string`): The host address of the Chroma server. Defaults to 'localhost'
16
16
 
@@ -28,9 +28,9 @@ The ChromaVector class provides vector search using [Chroma](https://docs.trychr
28
28
 
29
29
  **fetchOptions** (`RequestInit`): Additional fetch options for HTTP requests
30
30
 
31
- ## Running a Chroma Server
31
+ ## Running a Chroma server
32
32
 
33
- If you are a Chroma Cloud user, simply provide the `ChromaVector` constructor your API key, tenant, and database name.
33
+ If you are a Chroma Cloud user, provide the `ChromaVector` constructor your API key, tenant, and database name.
34
34
 
35
35
  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`.
36
36
 
@@ -42,7 +42,7 @@ Otherwise, you have several options for setting up your single-node Chroma serve
42
42
 
43
43
  ## Methods
44
44
 
45
- ### createIndex()
45
+ ### `createIndex()`
46
46
 
47
47
  **indexName** (`string`): Name of the index to create
48
48
 
@@ -50,17 +50,17 @@ Otherwise, you have several options for setting up your single-node Chroma serve
50
50
 
51
51
  **metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
52
52
 
53
- ### forkIndex()
53
+ ### `forkIndex()`
54
54
 
55
55
  Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS **distributed** Chroma.
56
56
 
57
- `forkIndex` lets you fork an existing Chroma index instantly. Operations on the forked index do not affect the original one. Learn more on the [Chroma docs](https://docs.trychroma.com/cloud/collection-forking).
57
+ `forkIndex` lets you fork an existing Chroma index instantly. Operations on the forked index don't affect the original one. Learn more on the [Chroma docs](https://docs.trychroma.com/cloud/collection-forking).
58
58
 
59
59
  **indexName** (`string`): Name of the index to fork
60
60
 
61
61
  **newIndexName** (`string`): The name of the forked index
62
62
 
63
- ### upsert()
63
+ ### `upsert()`
64
64
 
65
65
  **indexName** (`string`): Name of the index to upsert into
66
66
 
@@ -72,7 +72,7 @@ Note: Forking is only supported on Chroma Cloud, or if you deploy your own OSS *
72
72
 
73
73
  **documents** (`string[]`): Chroma-specific: Original text documents associated with the vectors
74
74
 
75
- ### query()
75
+ ### `query()`
76
76
 
77
77
  Query an index using a `queryVector`. Returns an array of semantically similar records in order of distance from the `queryVector`. Each record has the shape:
78
78
 
@@ -100,7 +100,7 @@ You can also provide the shape of your metadata to a `query` call for type infer
100
100
 
101
101
  **documentFilter** (`Record<string, any>`): Chroma-specific: Filter to apply on the document content
102
102
 
103
- ### get()
103
+ ### `get()`
104
104
 
105
105
  Get records from your Chroma index by IDs, metadata, and document filters. It returns an array of records of the shape:
106
106
 
@@ -129,11 +129,11 @@ You can also provide the shape of your metadata to a `get` call for type inferen
129
129
 
130
130
  **offset** (`number`): Offset for returning records. Use with \`limit\` to paginate results.
131
131
 
132
- ### listIndexes()
132
+ ### `listIndexes()`
133
133
 
134
134
  Returns an array of index names as strings.
135
135
 
136
- ### describeIndex()
136
+ ### `describeIndex()`
137
137
 
138
138
  **indexName** (`string`): Name of the index to describe
139
139
 
@@ -147,11 +147,11 @@ interface IndexStats {
147
147
  }
148
148
  ```
149
149
 
150
- ### deleteIndex()
150
+ ### `deleteIndex()`
151
151
 
152
152
  **indexName** (`string`): Name of the index to delete
153
153
 
154
- ### updateVector()
154
+ ### `updateVector()`
155
155
 
156
156
  Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
157
157
 
@@ -187,13 +187,13 @@ await vectorStore.updateVector({
187
187
  })
188
188
  ```
189
189
 
190
- ### deleteVector()
190
+ ### `deleteVector()`
191
191
 
192
192
  **indexName** (`string`): Name of the index containing the vector to delete
193
193
 
194
194
  **id** (`string`): ID of the vector to delete
195
195
 
196
- ### deleteVectors()
196
+ ### `deleteVectors()`
197
197
 
198
198
  Delete multiple vectors by IDs or by metadata filter. This method enables bulk deletion and source-based vector management. Either `ids` or `filter` must be provided, but not both.
199
199
 
@@ -227,7 +227,7 @@ await vectorStore.deleteVectors({
227
227
  })
228
228
  ```
229
229
 
230
- ## Response Types
230
+ ## Response types
231
231
 
232
232
  Query results are returned in this format:
233
233
 
@@ -241,7 +241,7 @@ interface QueryResult {
241
241
  }
242
242
  ```
243
243
 
244
- ## Error Handling
244
+ ## Error handling
245
245
 
246
246
  The store throws typed errors that can be caught:
247
247