@mastra/mcp-docs-server 0.13.37 → 0.13.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (397) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
  3. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
  4. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
  5. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +23 -23
  6. package/.docs/organized/changelogs/%40mastra%2Fcore.md +69 -69
  7. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +17 -17
  8. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +17 -17
  9. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +17 -17
  10. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +17 -17
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +25 -25
  12. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
  13. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +27 -27
  14. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  15. package/.docs/organized/changelogs/%40mastra%2Fserver.md +23 -23
  16. package/.docs/organized/changelogs/create-mastra.md +5 -5
  17. package/.docs/organized/changelogs/mastra.md +17 -17
  18. package/.docs/raw/agents/adding-voice.mdx +20 -9
  19. package/.docs/raw/agents/agent-memory.mdx +55 -39
  20. package/.docs/raw/agents/guardrails.mdx +68 -61
  21. package/.docs/raw/agents/networks.mdx +50 -46
  22. package/.docs/raw/agents/overview.mdx +125 -88
  23. package/.docs/raw/agents/using-tools.mdx +14 -15
  24. package/.docs/raw/auth/auth0.mdx +28 -27
  25. package/.docs/raw/auth/clerk.mdx +22 -20
  26. package/.docs/raw/auth/firebase.mdx +42 -39
  27. package/.docs/raw/auth/index.mdx +1 -1
  28. package/.docs/raw/auth/jwt.mdx +18 -16
  29. package/.docs/raw/auth/supabase.mdx +20 -18
  30. package/.docs/raw/auth/workos.mdx +32 -26
  31. package/.docs/raw/community/contributing-templates.mdx +7 -7
  32. package/.docs/raw/community/discord.mdx +2 -2
  33. package/.docs/raw/community/licensing.mdx +1 -1
  34. package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
  35. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
  36. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
  37. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
  38. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
  39. package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
  40. package/.docs/raw/deployment/monorepo.mdx +32 -42
  41. package/.docs/raw/deployment/overview.mdx +15 -15
  42. package/.docs/raw/deployment/server-deployment.mdx +18 -23
  43. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
  44. package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
  45. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
  46. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
  47. package/.docs/raw/deployment/web-framework.mdx +14 -14
  48. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +138 -145
  49. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
  50. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
  51. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
  52. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +59 -48
  53. package/.docs/raw/frameworks/servers/express.mdx +45 -44
  54. package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
  55. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
  56. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +189 -164
  57. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
  58. package/.docs/raw/getting-started/installation.mdx +164 -133
  59. package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
  60. package/.docs/raw/getting-started/project-structure.mdx +34 -42
  61. package/.docs/raw/getting-started/studio.mdx +40 -58
  62. package/.docs/raw/getting-started/templates.mdx +22 -27
  63. package/.docs/raw/index.mdx +9 -9
  64. package/.docs/raw/mastra-cloud/dashboard.mdx +10 -10
  65. package/.docs/raw/mastra-cloud/observability.mdx +7 -8
  66. package/.docs/raw/mastra-cloud/overview.mdx +16 -22
  67. package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
  68. package/.docs/raw/memory/conversation-history.mdx +2 -2
  69. package/.docs/raw/memory/overview.mdx +21 -23
  70. package/.docs/raw/memory/semantic-recall.mdx +14 -13
  71. package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
  72. package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
  73. package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
  74. package/.docs/raw/memory/threads-and-resources.mdx +23 -20
  75. package/.docs/raw/memory/working-memory.mdx +27 -38
  76. package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
  77. package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
  78. package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
  79. package/.docs/raw/observability/ai-tracing/exporters/default.mdx +31 -32
  80. package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
  81. package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
  82. package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
  83. package/.docs/raw/observability/ai-tracing/overview.mdx +145 -122
  84. package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
  85. package/.docs/raw/observability/logging.mdx +14 -17
  86. package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
  87. package/.docs/raw/observability/otel-tracing.mdx +17 -18
  88. package/.docs/raw/observability/overview.mdx +14 -10
  89. package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
  90. package/.docs/raw/rag/overview.mdx +5 -5
  91. package/.docs/raw/rag/retrieval.mdx +125 -107
  92. package/.docs/raw/rag/vector-databases.mdx +232 -223
  93. package/.docs/raw/reference/agents/agent.mdx +54 -41
  94. package/.docs/raw/reference/agents/generate.mdx +367 -261
  95. package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
  96. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
  97. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
  98. package/.docs/raw/reference/agents/getDescription.mdx +3 -2
  99. package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
  100. package/.docs/raw/reference/agents/getLLM.mdx +11 -7
  101. package/.docs/raw/reference/agents/getMemory.mdx +7 -5
  102. package/.docs/raw/reference/agents/getModel.mdx +7 -5
  103. package/.docs/raw/reference/agents/getScorers.mdx +7 -5
  104. package/.docs/raw/reference/agents/getTools.mdx +7 -5
  105. package/.docs/raw/reference/agents/getVoice.mdx +7 -5
  106. package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
  107. package/.docs/raw/reference/agents/listAgents.mdx +6 -4
  108. package/.docs/raw/reference/agents/network.mdx +171 -116
  109. package/.docs/raw/reference/auth/auth0.mdx +18 -14
  110. package/.docs/raw/reference/auth/clerk.mdx +15 -12
  111. package/.docs/raw/reference/auth/firebase.mdx +23 -16
  112. package/.docs/raw/reference/auth/jwt.mdx +7 -6
  113. package/.docs/raw/reference/auth/supabase.mdx +13 -10
  114. package/.docs/raw/reference/auth/workos.mdx +17 -13
  115. package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
  116. package/.docs/raw/reference/cli/mastra.mdx +11 -11
  117. package/.docs/raw/reference/client-js/agents.mdx +40 -43
  118. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  119. package/.docs/raw/reference/client-js/logs.mdx +1 -1
  120. package/.docs/raw/reference/client-js/mastra-client.mdx +21 -13
  121. package/.docs/raw/reference/client-js/memory.mdx +6 -2
  122. package/.docs/raw/reference/client-js/observability.mdx +10 -9
  123. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  124. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  125. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  126. package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
  127. package/.docs/raw/reference/client-js/workflows.mdx +7 -7
  128. package/.docs/raw/reference/core/getAgent.mdx +6 -5
  129. package/.docs/raw/reference/core/getAgentById.mdx +5 -4
  130. package/.docs/raw/reference/core/getAgents.mdx +3 -3
  131. package/.docs/raw/reference/core/getDeployer.mdx +4 -3
  132. package/.docs/raw/reference/core/getLogger.mdx +4 -3
  133. package/.docs/raw/reference/core/getLogs.mdx +10 -6
  134. package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
  135. package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
  136. package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
  137. package/.docs/raw/reference/core/getMemory.mdx +4 -3
  138. package/.docs/raw/reference/core/getScorer.mdx +15 -12
  139. package/.docs/raw/reference/core/getScorerByName.mdx +12 -9
  140. package/.docs/raw/reference/core/getScorers.mdx +3 -2
  141. package/.docs/raw/reference/core/getServer.mdx +4 -3
  142. package/.docs/raw/reference/core/getStorage.mdx +4 -3
  143. package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
  144. package/.docs/raw/reference/core/getVector.mdx +6 -4
  145. package/.docs/raw/reference/core/getVectors.mdx +4 -3
  146. package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
  147. package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
  148. package/.docs/raw/reference/core/mastra-class.mdx +16 -16
  149. package/.docs/raw/reference/core/setLogger.mdx +6 -4
  150. package/.docs/raw/reference/core/setStorage.mdx +4 -4
  151. package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
  152. package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
  153. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  154. package/.docs/raw/reference/deployer/netlify.mdx +4 -4
  155. package/.docs/raw/reference/deployer/vercel.mdx +6 -6
  156. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
  157. package/.docs/raw/reference/evals/bias.mdx +4 -5
  158. package/.docs/raw/reference/evals/completeness.mdx +4 -5
  159. package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
  160. package/.docs/raw/reference/evals/context-position.mdx +4 -5
  161. package/.docs/raw/reference/evals/context-precision.mdx +4 -5
  162. package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
  163. package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
  164. package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
  165. package/.docs/raw/reference/evals/hallucination.mdx +4 -6
  166. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
  167. package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
  168. package/.docs/raw/reference/evals/summarization.mdx +4 -6
  169. package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
  170. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
  171. package/.docs/raw/reference/evals/toxicity.mdx +4 -5
  172. package/.docs/raw/reference/index.mdx +3 -3
  173. package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
  174. package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
  175. package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
  176. package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
  177. package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
  178. package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
  179. package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
  180. package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
  181. package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
  182. package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
  183. package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
  184. package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
  185. package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
  186. package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
  187. package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
  188. package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
  189. package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
  190. package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
  191. package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
  192. package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
  193. package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
  194. package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
  195. package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
  196. package/.docs/raw/reference/memory/createThread.mdx +10 -10
  197. package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
  198. package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
  199. package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
  200. package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
  201. package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +53 -46
  202. package/.docs/raw/reference/memory/query.mdx +39 -25
  203. package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -5
  204. package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
  205. package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
  206. package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
  207. package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
  208. package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
  209. package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
  210. package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
  211. package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
  212. package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
  213. package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +115 -106
  214. package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
  215. package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
  216. package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
  217. package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
  218. package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
  219. package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
  220. package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
  221. package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
  222. package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +3 -3
  223. package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
  224. package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
  225. package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
  226. package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
  227. package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
  228. package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
  229. package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
  230. package/.docs/raw/reference/processors/batch-parts-processor.mdx +13 -10
  231. package/.docs/raw/reference/processors/language-detector.mdx +27 -17
  232. package/.docs/raw/reference/processors/moderation-processor.mdx +26 -17
  233. package/.docs/raw/reference/processors/pii-detector.mdx +28 -18
  234. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +25 -17
  235. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +26 -17
  236. package/.docs/raw/reference/processors/token-limiter-processor.mdx +22 -15
  237. package/.docs/raw/reference/processors/unicode-normalizer.mdx +13 -12
  238. package/.docs/raw/reference/rag/chunk.mdx +41 -23
  239. package/.docs/raw/reference/rag/database-config.mdx +56 -38
  240. package/.docs/raw/reference/rag/document.mdx +1 -1
  241. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  242. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  243. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  244. package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
  245. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  246. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
  247. package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
  248. package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
  249. package/.docs/raw/reference/scorers/bias.mdx +22 -19
  250. package/.docs/raw/reference/scorers/completeness.mdx +21 -16
  251. package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
  252. package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
  253. package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
  254. package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
  255. package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
  256. package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
  257. package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
  258. package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
  259. package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
  260. package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
  261. package/.docs/raw/reference/scorers/run-experiment.mdx +40 -31
  262. package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
  263. package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
  264. package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
  265. package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
  266. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  267. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  268. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  269. package/.docs/raw/reference/storage/lance.mdx +1 -1
  270. package/.docs/raw/reference/storage/libsql.mdx +2 -2
  271. package/.docs/raw/reference/storage/mongodb.mdx +4 -5
  272. package/.docs/raw/reference/storage/mssql.mdx +5 -4
  273. package/.docs/raw/reference/storage/postgresql.mdx +35 -33
  274. package/.docs/raw/reference/storage/upstash.mdx +6 -5
  275. package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
  276. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
  277. package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
  278. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
  279. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
  280. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
  281. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +24 -20
  282. package/.docs/raw/reference/streaming/workflows/stream.mdx +35 -26
  283. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +36 -27
  284. package/.docs/raw/reference/templates/overview.mdx +16 -39
  285. package/.docs/raw/reference/tools/client.mdx +1 -1
  286. package/.docs/raw/reference/tools/create-tool.mdx +45 -35
  287. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
  288. package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
  289. package/.docs/raw/reference/tools/mcp-client.mdx +70 -64
  290. package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
  291. package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
  292. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  293. package/.docs/raw/reference/vectors/chroma.mdx +25 -19
  294. package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
  295. package/.docs/raw/reference/vectors/lance.mdx +5 -6
  296. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  297. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  298. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  299. package/.docs/raw/reference/vectors/pg.mdx +8 -4
  300. package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
  301. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  302. package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
  303. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  304. package/.docs/raw/reference/vectors/upstash.mdx +33 -25
  305. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  306. package/.docs/raw/reference/voice/azure.mdx +1 -1
  307. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  308. package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
  309. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  310. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  311. package/.docs/raw/reference/voice/google-gemini-live.mdx +6 -4
  312. package/.docs/raw/reference/voice/google.mdx +1 -1
  313. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  314. package/.docs/raw/reference/voice/murf.mdx +1 -1
  315. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  316. package/.docs/raw/reference/voice/openai.mdx +1 -1
  317. package/.docs/raw/reference/voice/playai.mdx +1 -1
  318. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  319. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  320. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  321. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  322. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  323. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  324. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  325. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  326. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
  327. package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
  328. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  329. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  330. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  331. package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
  332. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  333. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
  334. package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
  335. package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
  336. package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
  337. package/.docs/raw/reference/workflows/run.mdx +7 -10
  338. package/.docs/raw/reference/workflows/step.mdx +15 -12
  339. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
  340. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  341. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
  342. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
  343. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
  344. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  345. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +3 -2
  346. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  347. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
  348. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
  349. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
  350. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  351. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
  352. package/.docs/raw/reference/workflows/workflow.mdx +13 -10
  353. package/.docs/raw/scorers/custom-scorers.mdx +58 -48
  354. package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
  355. package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
  356. package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
  357. package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
  358. package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
  359. package/.docs/raw/scorers/overview.mdx +20 -19
  360. package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
  361. package/.docs/raw/server-db/mastra-client.mdx +56 -54
  362. package/.docs/raw/server-db/middleware.mdx +11 -7
  363. package/.docs/raw/server-db/production-server.mdx +5 -7
  364. package/.docs/raw/server-db/runtime-context.mdx +41 -38
  365. package/.docs/raw/server-db/storage.mdx +82 -87
  366. package/.docs/raw/streaming/events.mdx +24 -16
  367. package/.docs/raw/streaming/overview.mdx +17 -18
  368. package/.docs/raw/streaming/tool-streaming.mdx +9 -10
  369. package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
  370. package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
  371. package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
  372. package/.docs/raw/tools-mcp/overview.mdx +9 -14
  373. package/.docs/raw/voice/overview.mdx +273 -250
  374. package/.docs/raw/voice/speech-to-speech.mdx +14 -12
  375. package/.docs/raw/voice/speech-to-text.mdx +2 -2
  376. package/.docs/raw/voice/text-to-speech.mdx +2 -2
  377. package/.docs/raw/workflows/agents-and-tools.mdx +29 -28
  378. package/.docs/raw/workflows/control-flow.mdx +24 -24
  379. package/.docs/raw/workflows/error-handling.mdx +15 -17
  380. package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
  381. package/.docs/raw/workflows/inngest-workflow.mdx +33 -29
  382. package/.docs/raw/workflows/input-data-mapping.mdx +9 -9
  383. package/.docs/raw/workflows/overview.mdx +60 -60
  384. package/.docs/raw/workflows/snapshots.mdx +54 -36
  385. package/.docs/raw/workflows/suspend-and-resume.mdx +52 -57
  386. package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
  387. package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
  388. package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
  389. package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
  390. package/.docs/raw/workflows-legacy/overview.mdx +28 -26
  391. package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
  392. package/.docs/raw/workflows-legacy/steps.mdx +5 -3
  393. package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
  394. package/.docs/raw/workflows-legacy/variables.mdx +10 -8
  395. package/CHANGELOG.md +14 -0
  396. package/package.json +5 -5
  397. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Upstash Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Upstash Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the UpstashVector class in Mastra, which provides vector search using Upstash Vector.
4
4
  ---
5
5
 
@@ -70,7 +70,8 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
70
70
  name: "sparseVectors",
71
71
  type: "{ indices: number[], values: number[] }[]",
72
72
  isOptional: true,
73
- description: "Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.",
73
+ description:
74
+ "Array of sparse vectors for hybrid search. Each sparse vector must have matching indices and values arrays.",
74
75
  },
75
76
  {
76
77
  name: "metadata",
@@ -105,7 +106,8 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
105
106
  name: "sparseVector",
106
107
  type: "{ indices: number[], values: number[] }",
107
108
  isOptional: true,
108
- description: "Optional sparse vector for hybrid search. Must have matching indices and values arrays.",
109
+ description:
110
+ "Optional sparse vector for hybrid search. Must have matching indices and values arrays.",
109
111
  },
110
112
  {
111
113
  name: "topK",
@@ -131,13 +133,15 @@ Note: This method is a no-op for Upstash as indexes are created automatically.
131
133
  name: "fusionAlgorithm",
132
134
  type: "FusionAlgorithm",
133
135
  isOptional: true,
134
- description: "Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)",
136
+ description:
137
+ "Algorithm used to combine dense and sparse search results in hybrid search (e.g., RRF - Reciprocal Rank Fusion)",
135
138
  },
136
139
  {
137
140
  name: "queryMode",
138
141
  type: "QueryMode",
139
142
  isOptional: true,
140
- description: "Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search",
143
+ description:
144
+ "Search mode: 'DENSE' for dense-only, 'SPARSE' for sparse-only, or 'HYBRID' for combined search",
141
145
  },
142
146
  ]}
143
147
  />
@@ -197,7 +201,8 @@ interface IndexStats {
197
201
  {
198
202
  name: "update",
199
203
  type: "object",
200
- description: "Update object containing vector, sparse vector, and/or metadata",
204
+ description:
205
+ "Update object containing vector, sparse vector, and/or metadata",
201
206
  },
202
207
  ]}
203
208
  />
@@ -234,65 +239,68 @@ Upstash Vector supports hybrid search that combines semantic search (dense vecto
234
239
  ### Basic Hybrid Usage
235
240
 
236
241
  ```typescript copy
237
- import { UpstashVector } from '@mastra/upstash';
242
+ import { UpstashVector } from "@mastra/upstash";
238
243
 
239
244
  const vectorStore = new UpstashVector({
240
245
  url: process.env.UPSTASH_VECTOR_URL,
241
- token: process.env.UPSTASH_VECTOR_TOKEN
246
+ token: process.env.UPSTASH_VECTOR_TOKEN,
242
247
  });
243
248
 
244
249
  // Upsert vectors with both dense and sparse components
245
- const denseVectors = [[0.1, 0.2, 0.3], [0.4, 0.5, 0.6]];
250
+ const denseVectors = [
251
+ [0.1, 0.2, 0.3],
252
+ [0.4, 0.5, 0.6],
253
+ ];
246
254
  const sparseVectors = [
247
255
  { indices: [1, 5, 10], values: [0.8, 0.6, 0.4] },
248
- { indices: [2, 6, 11], values: [0.7, 0.5, 0.3] }
256
+ { indices: [2, 6, 11], values: [0.7, 0.5, 0.3] },
249
257
  ];
250
258
 
251
259
  await vectorStore.upsert({
252
- indexName: 'hybrid-index',
260
+ indexName: "hybrid-index",
253
261
  vectors: denseVectors,
254
262
  sparseVectors: sparseVectors,
255
- metadata: [{ title: 'Document 1' }, { title: 'Document 2' }]
263
+ metadata: [{ title: "Document 1" }, { title: "Document 2" }],
256
264
  });
257
265
 
258
266
  // Query with hybrid search
259
267
  const results = await vectorStore.query({
260
- indexName: 'hybrid-index',
268
+ indexName: "hybrid-index",
261
269
  queryVector: [0.1, 0.2, 0.3],
262
270
  sparseVector: { indices: [1, 5], values: [0.9, 0.7] },
263
- topK: 10
271
+ topK: 10,
264
272
  });
265
273
  ```
266
274
 
267
275
  ### Advanced Hybrid Search Options
268
276
 
269
277
  ```typescript copy
270
- import { FusionAlgorithm, QueryMode } from '@upstash/vector';
278
+ import { FusionAlgorithm, QueryMode } from "@upstash/vector";
271
279
 
272
280
  // Query with specific fusion algorithm
273
281
  const fusionResults = await vectorStore.query({
274
- indexName: 'hybrid-index',
282
+ indexName: "hybrid-index",
275
283
  queryVector: [0.1, 0.2, 0.3],
276
284
  sparseVector: { indices: [1, 5], values: [0.9, 0.7] },
277
285
  fusionAlgorithm: FusionAlgorithm.RRF,
278
- topK: 10
286
+ topK: 10,
279
287
  });
280
288
 
281
289
  // Dense-only search
282
290
  const denseResults = await vectorStore.query({
283
- indexName: 'hybrid-index',
291
+ indexName: "hybrid-index",
284
292
  queryVector: [0.1, 0.2, 0.3],
285
293
  queryMode: QueryMode.DENSE,
286
- topK: 10
294
+ topK: 10,
287
295
  });
288
296
 
289
297
  // Sparse-only search
290
298
  const sparseResults = await vectorStore.query({
291
- indexName: 'hybrid-index',
299
+ indexName: "hybrid-index",
292
300
  queryVector: [0.1, 0.2, 0.3], // Still required for index structure
293
301
  sparseVector: { indices: [1, 5], values: [0.9, 0.7] },
294
302
  queryMode: QueryMode.SPARSE,
295
- topK: 10
303
+ topK: 10,
296
304
  });
297
305
  ```
298
306
 
@@ -301,13 +309,13 @@ const sparseResults = await vectorStore.query({
301
309
  ```typescript copy
302
310
  // Update both dense and sparse components
303
311
  await vectorStore.updateVector({
304
- indexName: 'hybrid-index',
305
- id: 'vector-id',
312
+ indexName: "hybrid-index",
313
+ id: "vector-id",
306
314
  update: {
307
315
  vector: [0.2, 0.3, 0.4],
308
316
  sparseVector: { indices: [2, 7, 12], values: [0.9, 0.8, 0.6] },
309
- metadata: { title: 'Updated Document' }
310
- }
317
+ metadata: { title: "Updated Document" },
318
+ },
311
319
  });
312
320
  ```
313
321
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Cloudflare Vector Store | Vector Databases | Mastra Docs"
2
+ title: "Reference: Cloudflare Vector Store | Vectors | Mastra Docs"
3
3
  description: Documentation for the CloudflareVector class in Mastra, which provides vector search using Cloudflare Vectorize.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Azure Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Azure | Voice | Mastra Docs"
3
3
  description: "Documentation for the AzureVoice class, providing text-to-speech and speech-to-text capabilities using Azure Cognitive Services."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Cloudflare Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Cloudflare | Voice | Mastra Docs"
3
3
  description: "Documentation for the CloudflareVoice class, providing text-to-speech capabilities using Cloudflare Workers AI."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: CompositeVoice | Voice Providers | Mastra Docs"
2
+ title: "Reference: CompositeVoice | Voice | Mastra Docs"
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
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Deepgram Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Deepgram | Voice | Mastra Docs"
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
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: ElevenLabs Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: ElevenLabs | Voice | Mastra Docs"
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
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Google Gemini Live Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Google Gemini Live Voice | Voice | Mastra Docs"
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
4
  ---
5
5
 
@@ -161,7 +161,8 @@ voice.close();
161
161
  {
162
162
  name: "sessionConfig",
163
163
  type: "GeminiSessionConfig",
164
- description: "Session configuration including interrupt and context settings.",
164
+ description:
165
+ "Session configuration including interrupt and context settings.",
165
166
  isOptional: true,
166
167
  },
167
168
  {
@@ -506,7 +507,8 @@ The GeminiLiveVoice class emits the following events:
506
507
  description:
507
508
  "Interrupt events. Callback receives { type: 'user' | 'model', timestamp: number }.",
508
509
  },
509
- ]}
510
+
511
+ ]}
510
512
  />
511
513
 
512
514
  ## Available Models
@@ -598,7 +600,7 @@ const voice = new GeminiLiveVoice({
598
600
  Enable the model to call functions during conversations:
599
601
 
600
602
  ```typescript
601
- import { z } from 'zod';
603
+ import { z } from "zod";
602
604
 
603
605
  voice.addTools({
604
606
  weather: {
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Google Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Google | Voice | Mastra Docs"
3
3
  description: "Documentation for the Google Voice implementation, providing text-to-speech and speech-to-text capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraVoice | Voice Providers | Mastra Docs"
2
+ title: "Reference: MastraVoice | Voice | Mastra Docs"
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
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Murf Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Murf | Voice | Mastra Docs"
3
3
  description: "Documentation for the Murf voice implementation, providing text-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: OpenAI Realtime Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: OpenAI Realtime Voice | Voice | Mastra Docs"
3
3
  description: "Documentation for the OpenAIRealtimeVoice class, providing real-time text-to-speech and speech-to-text capabilities via WebSockets."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: OpenAI Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: OpenAI | Voice | Mastra Docs"
3
3
  description: "Documentation for the OpenAIVoice class, providing text-to-speech and speech-to-text capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: PlayAI Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: PlayAI | Voice | Mastra Docs"
3
3
  description: "Documentation for the PlayAI voice implementation, providing text-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Sarvam Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Sarvam | Voice | Mastra Docs"
3
3
  description: "Documentation for the Sarvam class, providing text-to-speech and speech-to-text capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Speechify Voice | Voice Providers | Mastra Docs"
2
+ title: "Reference: Speechify | Voice | Mastra Docs"
3
3
  description: "Documentation for the Speechify voice implementation, providing text-to-speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.addInstructions() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.addInstructions() | Voice | Mastra Docs"
3
3
  description: "Documentation for the addInstructions() method available in voice providers, which adds instructions to guide the voice model's behavior."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.addTools() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.addTools() | Voice | Mastra Docs"
3
3
  description: "Documentation for the addTools() method available in voice providers, which equips voice models with function calling capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.answer() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.answer() | Voice | Mastra Docs"
3
3
  description: "Documentation for the answer() method available in real-time voice providers, which triggers the voice provider to generate a response."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.close() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.close() | Voice | Mastra Docs"
3
3
  description: "Documentation for the close() method available in voice providers, which disconnects from real-time voice services."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.connect() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.connect() | Voice | Mastra Docs"
3
3
  description: "Documentation for the connect() method available in real-time voice providers, which establishes a connection for speech-to-speech communication."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Voice Events | Voice Providers | Mastra Docs"
2
+ title: "Reference: Voice Events | Voice | Mastra Docs"
3
3
  description: "Documentation for events emitted by voice providers, particularly for real-time voice interactions."
4
4
  ---
5
5
 
@@ -3,7 +3,8 @@ title: "Reference: voice.getSpeakers() | Voice Providers | Mastra Docs"
3
3
  description: "Documentation for the getSpeakers() method available in voice providers, which retrieves available voice options."
4
4
  ---
5
5
 
6
- import { Tabs } from "nextra/components";
6
+ import Tabs from "@theme/Tabs";
7
+ import TabItem from "@theme/TabItem";
7
8
 
8
9
  # voice.getSpeakers()
9
10
 
@@ -58,16 +59,8 @@ This method does not accept any parameters.
58
59
 
59
60
  Different voice providers return different metadata for their voices:
60
61
 
61
- {/*
62
- LLM CONTEXT: This Tabs component shows the different metadata structures returned by various voice providers' getSpeakers() method.
63
- Each tab displays the specific properties and data types returned by that voice provider when listing available speakers/voices.
64
- The tabs help users understand what information is available for each provider and how to access voice-specific metadata.
65
- Each tab includes property tables showing voiceId and provider-specific metadata like name, language, gender, accent, etc.
66
- The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Murf, PlayAI, Sarvam, Speechify, and Azure.
67
- */}
68
-
69
- <Tabs items={["OpenAI", "OpenAI Realtime", "Deepgram", "ElevenLabs", "Google", "Murf", "PlayAI", "Sarvam", "Speechify", "Azure"]}>
70
- <Tabs.Tab label="OpenAI">
62
+ <Tabs>
63
+ <TabItem value="OpenAI">
71
64
  <PropertiesTable
72
65
  content={[
73
66
  {
@@ -77,9 +70,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
77
70
  }
78
71
  ]}
79
72
  />
80
- </Tabs.Tab>
73
+ </TabItem>
81
74
 
82
- <Tabs.Tab label="OpenAI Realtime">
75
+ <TabItem value="OpenAI Realtime">
83
76
  <PropertiesTable
84
77
  content={[
85
78
  {
@@ -90,9 +83,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
90
83
  },
91
84
  ]}
92
85
  />
93
- </Tabs.Tab>
86
+ </TabItem>
94
87
 
95
- <Tabs.Tab label="Deepgram">
88
+ <TabItem value="Deepgram">
96
89
  <PropertiesTable
97
90
  content={[
98
91
  {
@@ -107,9 +100,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
107
100
  },
108
101
  ]}
109
102
  />
110
- </Tabs.Tab>
103
+ </TabItem>
111
104
 
112
- <Tabs.Tab label="ElevenLabs">
105
+ <TabItem value="ElevenLabs">
113
106
  <PropertiesTable
114
107
  content={[
115
108
  {
@@ -129,9 +122,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
129
122
  },
130
123
  ]}
131
124
  />
132
- </Tabs.Tab>
125
+ </TabItem>
133
126
 
134
- <Tabs.Tab label="Google">
127
+ <TabItem value="Google">
135
128
  <PropertiesTable
136
129
  content={[
137
130
  {
@@ -147,9 +140,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
147
140
  },
148
141
  ]}
149
142
  />
150
- </Tabs.Tab>
143
+ </TabItem>
151
144
 
152
- <Tabs.Tab label="Azure">
145
+ <TabItem value="Azure">
153
146
  <PropertiesTable
154
147
  content={[
155
148
  {
@@ -169,9 +162,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
169
162
  },
170
163
  ]}
171
164
  />
172
- </Tabs.Tab>
165
+ </TabItem>
173
166
 
174
- <Tabs.Tab label="Murf">
167
+ <TabItem value="Murf">
175
168
  <PropertiesTable
176
169
  content={[
177
170
  {
@@ -197,9 +190,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
197
190
  },
198
191
  ]}
199
192
  />
200
- </Tabs.Tab>
193
+ </TabItem>
201
194
 
202
- <Tabs.Tab label="PlayAI">
195
+ <TabItem value="PlayAI">
203
196
  <PropertiesTable
204
197
  content={[
205
198
  {
@@ -237,9 +230,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
237
230
  },
238
231
  ]}
239
232
  />
240
- </Tabs.Tab>
233
+ </TabItem>
241
234
 
242
- <Tabs.Tab label="Speechify">
235
+ <TabItem value="Speechify">
243
236
  <PropertiesTable
244
237
  content={[
245
238
  {
@@ -259,9 +252,9 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
259
252
  },
260
253
  ]}
261
254
  />
262
- </Tabs.Tab>
255
+ </TabItem>
263
256
 
264
- <Tabs.Tab label="Sarvam">
257
+ <TabItem value="Sarvam">
265
258
  <PropertiesTable
266
259
  content={[
267
260
  {
@@ -286,7 +279,7 @@ The providers include OpenAI, OpenAI Realtime, Deepgram, ElevenLabs, Google, Mur
286
279
  }
287
280
  ]}
288
281
  />
289
- </Tabs.Tab>
282
+ </TabItem>
290
283
  </Tabs>
291
284
 
292
285
  ## Notes
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.listen() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.listen() | Voice | Mastra Docs"
3
3
  description: "Documentation for the listen() method available in all Mastra voice providers, which converts speech to text."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.off() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.off() | Voice | Mastra Docs"
3
3
  description: "Documentation for the off() method available in voice providers, which removes event listeners for voice events."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.on() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.on() | Voice | Mastra Docs"
3
3
  description: "Documentation for the on() method available in voice providers, which registers event listeners for voice events."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.send() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.send() | Voice | Mastra Docs"
3
3
  description: "Documentation for the send() method available in real-time voice providers, which streams audio data for continuous processing."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.speak() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.speak() | Voice | Mastra Docs"
3
3
  description: "Documentation for the speak() method available in all Mastra voice providers, which converts text to speech."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: voice.updateConfig() | Voice Providers | Mastra Docs"
2
+ title: "Reference: voice.updateConfig() | Voice | Mastra Docs"
3
3
  description: "Documentation for the updateConfig() method available in voice providers, which updates the configuration of a voice provider at runtime."
4
4
  ---
5
5
 
@@ -35,7 +35,8 @@ await run.cancel();
35
35
  {
36
36
  name: "result",
37
37
  type: "Promise<void>",
38
- description: "A promise that resolves when the workflow run has been cancelled",
38
+ description:
39
+ "A promise that resolves when the workflow run has been cancelled",
39
40
  },
40
41
  ]}
41
42
  />
@@ -54,5 +55,5 @@ try {
54
55
 
55
56
  ## Related
56
57
 
57
- - [Workflows overview](../../../docs/workflows/overview.mdx#run-workflow)
58
- - [Workflow.createRunAsync()](../create-run.mdx)
58
+ - [Workflows overview](/docs/workflows/overview#running-workflows)
59
+ - [Workflow.createRunAsync()](../workflow-methods/create-run)