@mastra/mcp-docs-server 0.0.0-error-handler-fix-20251020202607 → 0.0.0-execa-dynamic-import-20260304221256

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 (1226) hide show
  1. package/.docs/course/01-first-agent/04-project-structure.md +19 -0
  2. package/.docs/course/01-first-agent/05-running-playground.md +19 -0
  3. package/.docs/course/01-first-agent/07-creating-your-agent.md +50 -0
  4. package/.docs/course/01-first-agent/08-exporting-your-agent.md +34 -0
  5. package/.docs/course/01-first-agent/09-testing-your-agent.md +12 -0
  6. package/.docs/course/01-first-agent/11-creating-transactions-tool.md +41 -0
  7. package/.docs/course/01-first-agent/12-connecting-tool-to-agent.md +29 -0
  8. package/.docs/course/01-first-agent/13-testing-your-tool.md +15 -0
  9. package/.docs/course/01-first-agent/15-installing-memory.md +13 -0
  10. package/.docs/course/01-first-agent/16-adding-memory-to-agent.md +33 -0
  11. package/.docs/course/01-first-agent/17-testing-memory.md +15 -0
  12. package/.docs/course/02-agent-tools-mcp/03-setting-up-mcp-configuration.md +21 -0
  13. package/.docs/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +11 -0
  14. package/.docs/course/02-agent-tools-mcp/05-updating-your-agent.md +20 -0
  15. package/.docs/course/02-agent-tools-mcp/07-what-is-zapier-mcp.md +23 -0
  16. package/.docs/course/02-agent-tools-mcp/08-getting-zapier-mcp-url.md +21 -0
  17. package/.docs/course/02-agent-tools-mcp/09-updating-mcp-config-zapier.md +29 -0
  18. package/.docs/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +29 -0
  19. package/.docs/course/02-agent-tools-mcp/12-troubleshooting-zapier.md +19 -0
  20. package/.docs/course/02-agent-tools-mcp/13-what-is-github-mcp.md +14 -0
  21. package/.docs/course/02-agent-tools-mcp/14-getting-github-mcp-url.md +40 -0
  22. package/.docs/course/02-agent-tools-mcp/15-updating-mcp-config-github.md +36 -0
  23. package/.docs/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +33 -0
  24. package/.docs/course/02-agent-tools-mcp/18-troubleshooting-github.md +17 -0
  25. package/.docs/course/02-agent-tools-mcp/20-updating-mcp-config-hackernews.md +36 -0
  26. package/.docs/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +38 -0
  27. package/.docs/course/02-agent-tools-mcp/26-updating-mcp-config-filesystem.md +43 -0
  28. package/.docs/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +45 -0
  29. package/.docs/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +78 -0
  30. package/.docs/course/02-agent-tools-mcp/32-conclusion.md +17 -0
  31. package/.docs/course/03-agent-memory/03-installing-memory.md +13 -0
  32. package/.docs/course/03-agent-memory/04-creating-basic-memory-agent.md +36 -0
  33. package/.docs/course/03-agent-memory/05-updating-mastra-export.md +18 -0
  34. package/.docs/course/03-agent-memory/07-understanding-memory-threads.md +49 -0
  35. package/.docs/course/03-agent-memory/08-configuring-conversation-history.md +36 -0
  36. package/.docs/course/03-agent-memory/09-using-memory-in-application.md +19 -0
  37. package/.docs/course/03-agent-memory/10-storage-configuration.md +29 -0
  38. package/.docs/course/03-agent-memory/12-handling-memory-frontend.md +62 -0
  39. package/.docs/course/03-agent-memory/13-vector-store-configuration.md +29 -0
  40. package/.docs/course/03-agent-memory/16-configuring-semantic-recall.md +42 -0
  41. package/.docs/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +29 -0
  42. package/.docs/course/03-agent-memory/21-configuring-working-memory.md +64 -0
  43. package/.docs/course/03-agent-memory/22-custom-working-memory-templates.md +89 -0
  44. package/.docs/course/03-agent-memory/25-combining-memory-features.md +80 -0
  45. package/.docs/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -0
  46. package/.docs/course/03-agent-memory/27-creating-learning-assistant.md +103 -0
  47. package/.docs/course/04-workflows/01-introduction-to-workflows.md +44 -0
  48. package/.docs/course/04-workflows/02-understanding-steps.md +53 -0
  49. package/.docs/course/04-workflows/03-creating-your-first-step.md +57 -0
  50. package/.docs/course/04-workflows/04-creating-a-second-step.md +58 -0
  51. package/.docs/course/04-workflows/05-chaining-steps-together.md +57 -0
  52. package/.docs/course/04-workflows/06-registering-with-mastra.md +24 -0
  53. package/.docs/course/04-workflows/07-using-playground.md +58 -0
  54. package/.docs/course/04-workflows/08-running-workflows-programmatically.md +73 -0
  55. package/.docs/course/04-workflows/09-adding-a-third-step.md +68 -0
  56. package/.docs/course/04-workflows/10-updating-the-workflow.md +55 -0
  57. package/.docs/course/04-workflows/11-creating-an-ai-agent.md +66 -0
  58. package/.docs/course/04-workflows/12-using-agent-in-workflow.md +89 -0
  59. package/.docs/course/04-workflows/13-creating-ai-enhanced-workflow.md +72 -0
  60. package/.docs/course/04-workflows/14-understanding-parallel-execution.md +38 -0
  61. package/.docs/course/04-workflows/15-creating-parallel-steps.md +111 -0
  62. package/.docs/course/04-workflows/16-building-parallel-workflow.md +100 -0
  63. package/.docs/course/04-workflows/17-testing-parallel-performance.md +36 -0
  64. package/.docs/course/04-workflows/18-understanding-conditional-branching.md +61 -0
  65. package/.docs/course/04-workflows/19-creating-conditional-steps.md +124 -0
  66. package/.docs/course/04-workflows/20-building-conditional-workflow.md +55 -0
  67. package/.docs/course/04-workflows/21-testing-conditional-logic.md +58 -0
  68. package/.docs/docs/agents/adding-voice.md +349 -0
  69. package/.docs/docs/agents/agent-approval.md +588 -0
  70. package/.docs/docs/agents/agent-memory.md +209 -0
  71. package/.docs/docs/agents/guardrails.md +374 -0
  72. package/.docs/docs/agents/network-approval.md +275 -0
  73. package/.docs/docs/agents/networks.md +299 -0
  74. package/.docs/docs/agents/overview.md +304 -0
  75. package/.docs/docs/agents/processors.md +622 -0
  76. package/.docs/docs/agents/structured-output.md +273 -0
  77. package/.docs/docs/agents/supervisor-agents.md +304 -0
  78. package/.docs/docs/agents/using-tools.md +248 -0
  79. package/.docs/docs/build-with-ai/mcp-docs-server.md +238 -0
  80. package/.docs/docs/build-with-ai/skills.md +35 -0
  81. package/.docs/docs/community/contributing-templates.md +3 -0
  82. package/.docs/docs/community/discord.md +9 -0
  83. package/.docs/docs/community/licensing.md +66 -0
  84. package/.docs/docs/deployment/cloud-providers.md +15 -0
  85. package/.docs/docs/deployment/mastra-server.md +122 -0
  86. package/.docs/docs/deployment/monorepo.md +142 -0
  87. package/.docs/docs/deployment/overview.md +62 -0
  88. package/.docs/docs/deployment/studio.md +247 -0
  89. package/.docs/docs/deployment/web-framework.md +52 -0
  90. package/.docs/docs/deployment/workflow-runners.md +9 -0
  91. package/.docs/docs/evals/built-in-scorers.md +47 -0
  92. package/.docs/docs/evals/custom-scorers.md +519 -0
  93. package/.docs/docs/evals/overview.md +141 -0
  94. package/.docs/docs/evals/running-in-ci.md +124 -0
  95. package/.docs/docs/getting-started/build-with-ai.md +68 -0
  96. package/.docs/docs/getting-started/manual-install.md +226 -0
  97. package/.docs/docs/getting-started/project-structure.md +60 -0
  98. package/.docs/docs/getting-started/start.md +28 -0
  99. package/.docs/docs/getting-started/studio.md +101 -0
  100. package/.docs/docs/index.md +43 -0
  101. package/.docs/docs/mastra-cloud/deployment.md +77 -0
  102. package/.docs/docs/mastra-cloud/observability.md +38 -0
  103. package/.docs/docs/mastra-cloud/overview.md +23 -0
  104. package/.docs/docs/mastra-cloud/setup.md +42 -0
  105. package/.docs/docs/mastra-cloud/studio.md +24 -0
  106. package/.docs/docs/mcp/overview.md +373 -0
  107. package/.docs/docs/mcp/publishing-mcp-server.md +95 -0
  108. package/.docs/docs/memory/memory-processors.md +314 -0
  109. package/.docs/docs/memory/message-history.md +260 -0
  110. package/.docs/docs/memory/observational-memory.md +255 -0
  111. package/.docs/docs/memory/overview.md +45 -0
  112. package/.docs/docs/memory/semantic-recall.md +288 -0
  113. package/.docs/docs/memory/storage.md +261 -0
  114. package/.docs/docs/memory/working-memory.md +400 -0
  115. package/.docs/docs/observability/datasets/overview.md +198 -0
  116. package/.docs/docs/observability/datasets/running-experiments.md +274 -0
  117. package/.docs/docs/observability/logging.md +99 -0
  118. package/.docs/docs/observability/overview.md +70 -0
  119. package/.docs/docs/observability/tracing/bridges/otel.md +209 -0
  120. package/.docs/docs/observability/tracing/exporters/arize.md +272 -0
  121. package/.docs/docs/observability/tracing/exporters/braintrust.md +111 -0
  122. package/.docs/docs/observability/tracing/exporters/cloud.md +127 -0
  123. package/.docs/docs/observability/tracing/exporters/datadog.md +187 -0
  124. package/.docs/docs/observability/tracing/exporters/default.md +209 -0
  125. package/.docs/docs/observability/tracing/exporters/laminar.md +100 -0
  126. package/.docs/docs/observability/tracing/exporters/langfuse.md +213 -0
  127. package/.docs/docs/observability/tracing/exporters/langsmith.md +198 -0
  128. package/.docs/docs/observability/tracing/exporters/otel.md +476 -0
  129. package/.docs/docs/observability/tracing/exporters/posthog.md +148 -0
  130. package/.docs/docs/observability/tracing/exporters/sentry.md +208 -0
  131. package/.docs/docs/observability/tracing/overview.md +1112 -0
  132. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +300 -0
  133. package/.docs/docs/rag/chunking-and-embedding.md +183 -0
  134. package/.docs/docs/rag/graph-rag.md +215 -0
  135. package/.docs/docs/rag/overview.md +72 -0
  136. package/.docs/docs/rag/retrieval.md +515 -0
  137. package/.docs/docs/rag/vector-databases.md +645 -0
  138. package/.docs/docs/server/auth/auth0.md +220 -0
  139. package/.docs/docs/server/auth/better-auth.md +220 -0
  140. package/.docs/docs/server/auth/clerk.md +132 -0
  141. package/.docs/docs/server/auth/composite-auth.md +234 -0
  142. package/.docs/docs/server/auth/custom-auth-provider.md +513 -0
  143. package/.docs/docs/server/auth/firebase.md +272 -0
  144. package/.docs/docs/server/auth/jwt.md +110 -0
  145. package/.docs/docs/server/auth/simple-auth.md +180 -0
  146. package/.docs/docs/server/auth/supabase.md +117 -0
  147. package/.docs/docs/server/auth/workos.md +186 -0
  148. package/.docs/docs/server/auth.md +38 -0
  149. package/.docs/docs/server/custom-adapters.md +378 -0
  150. package/.docs/docs/server/custom-api-routes.md +267 -0
  151. package/.docs/docs/server/mastra-client.md +243 -0
  152. package/.docs/docs/server/mastra-server.md +71 -0
  153. package/.docs/docs/server/middleware.md +225 -0
  154. package/.docs/docs/server/request-context.md +471 -0
  155. package/.docs/docs/server/server-adapters.md +547 -0
  156. package/.docs/docs/streaming/events.md +237 -0
  157. package/.docs/docs/streaming/overview.md +175 -0
  158. package/.docs/docs/streaming/tool-streaming.md +175 -0
  159. package/.docs/docs/streaming/workflow-streaming.md +109 -0
  160. package/.docs/docs/voice/overview.md +959 -0
  161. package/.docs/docs/voice/speech-to-speech.md +102 -0
  162. package/.docs/docs/voice/speech-to-text.md +79 -0
  163. package/.docs/docs/voice/text-to-speech.md +83 -0
  164. package/.docs/docs/workflows/agents-and-tools.md +166 -0
  165. package/.docs/docs/workflows/control-flow.md +822 -0
  166. package/.docs/docs/workflows/error-handling.md +360 -0
  167. package/.docs/docs/workflows/human-in-the-loop.md +215 -0
  168. package/.docs/docs/workflows/overview.md +370 -0
  169. package/.docs/docs/workflows/snapshots.md +238 -0
  170. package/.docs/docs/workflows/suspend-and-resume.md +205 -0
  171. package/.docs/docs/workflows/time-travel.md +309 -0
  172. package/.docs/docs/workflows/workflow-state.md +181 -0
  173. package/.docs/docs/workspace/filesystem.md +164 -0
  174. package/.docs/docs/workspace/overview.md +239 -0
  175. package/.docs/docs/workspace/sandbox.md +65 -0
  176. package/.docs/docs/workspace/search.md +243 -0
  177. package/.docs/docs/workspace/skills.md +169 -0
  178. package/.docs/guides/agent-frameworks/ai-sdk.md +140 -0
  179. package/.docs/guides/build-your-ui/ai-sdk-ui.md +1499 -0
  180. package/.docs/guides/build-your-ui/assistant-ui.md +156 -0
  181. package/.docs/guides/build-your-ui/copilotkit.md +289 -0
  182. package/.docs/guides/deployment/amazon-ec2.md +130 -0
  183. package/.docs/guides/deployment/aws-lambda.md +248 -0
  184. package/.docs/guides/deployment/azure-app-services.md +114 -0
  185. package/.docs/guides/deployment/cloudflare.md +99 -0
  186. package/.docs/guides/deployment/digital-ocean.md +168 -0
  187. package/.docs/guides/deployment/inngest.md +682 -0
  188. package/.docs/guides/deployment/netlify.md +77 -0
  189. package/.docs/guides/deployment/vercel.md +120 -0
  190. package/.docs/guides/getting-started/astro.md +398 -0
  191. package/.docs/guides/getting-started/electron.md +504 -0
  192. package/.docs/guides/getting-started/express.md +251 -0
  193. package/.docs/guides/getting-started/hono.md +190 -0
  194. package/.docs/guides/getting-started/next-js.md +347 -0
  195. package/.docs/guides/getting-started/nuxt.md +497 -0
  196. package/.docs/guides/getting-started/quickstart.md +67 -0
  197. package/.docs/guides/getting-started/sveltekit.md +296 -0
  198. package/.docs/guides/getting-started/vite-react.md +425 -0
  199. package/.docs/guides/guide/ai-recruiter.md +226 -0
  200. package/.docs/guides/guide/chef-michel.md +211 -0
  201. package/.docs/guides/guide/code-review-bot.md +226 -0
  202. package/.docs/guides/guide/dev-assistant.md +307 -0
  203. package/.docs/guides/guide/docs-manager.md +238 -0
  204. package/.docs/guides/guide/github-actions-pr-description.md +236 -0
  205. package/.docs/guides/guide/notes-mcp-server.md +416 -0
  206. package/.docs/guides/guide/research-assistant.md +348 -0
  207. package/.docs/guides/guide/research-coordinator.md +416 -0
  208. package/.docs/guides/guide/stock-agent.md +132 -0
  209. package/.docs/guides/guide/web-search.md +320 -0
  210. package/.docs/guides/guide/whatsapp-chat-bot.md +405 -0
  211. package/.docs/guides/index.md +22 -0
  212. package/.docs/guides/migrations/agentnetwork.md +97 -0
  213. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +112 -0
  214. package/.docs/guides/migrations/network-to-supervisor.md +261 -0
  215. package/.docs/guides/migrations/upgrade-to-v1/agent.md +404 -0
  216. package/.docs/guides/migrations/upgrade-to-v1/cli.md +57 -0
  217. package/.docs/guides/migrations/upgrade-to-v1/client.md +337 -0
  218. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +37 -0
  219. package/.docs/guides/migrations/upgrade-to-v1/evals.md +239 -0
  220. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +143 -0
  221. package/.docs/guides/migrations/upgrade-to-v1/mcp.md +97 -0
  222. package/.docs/guides/migrations/upgrade-to-v1/memory.md +285 -0
  223. package/.docs/guides/migrations/upgrade-to-v1/overview.md +119 -0
  224. package/.docs/guides/migrations/upgrade-to-v1/processors.md +68 -0
  225. package/.docs/guides/migrations/upgrade-to-v1/rag.md +42 -0
  226. package/.docs/guides/migrations/upgrade-to-v1/storage.md +553 -0
  227. package/.docs/guides/migrations/upgrade-to-v1/tools.md +180 -0
  228. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +412 -0
  229. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +87 -0
  230. package/.docs/guides/migrations/upgrade-to-v1/voice.md +30 -0
  231. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +341 -0
  232. package/.docs/guides/migrations/vnext-to-standard-apis.md +362 -0
  233. package/.docs/models/embeddings.md +161 -0
  234. package/.docs/models/gateways/azure-openai.md +128 -0
  235. package/.docs/models/gateways/custom-gateways.md +545 -0
  236. package/.docs/models/gateways/netlify.md +93 -0
  237. package/.docs/models/gateways/openrouter.md +222 -0
  238. package/.docs/models/gateways/vercel.md +235 -0
  239. package/.docs/models/gateways.md +14 -0
  240. package/.docs/models/index.md +286 -0
  241. package/.docs/models/providers/302ai.md +134 -0
  242. package/.docs/models/providers/abacus.md +125 -0
  243. package/.docs/models/providers/agentrouter.md +90 -0
  244. package/.docs/models/providers/aihubmix.md +113 -0
  245. package/.docs/models/providers/alibaba-cn.md +135 -0
  246. package/.docs/models/providers/alibaba.md +111 -0
  247. package/.docs/models/providers/amazon-bedrock.md +33 -0
  248. package/.docs/models/providers/anthropic.md +154 -0
  249. package/.docs/models/providers/azure.md +33 -0
  250. package/.docs/models/providers/bailing.md +72 -0
  251. package/.docs/models/providers/baseten.md +79 -0
  252. package/.docs/models/providers/berget.md +78 -0
  253. package/.docs/models/providers/cerebras.md +101 -0
  254. package/.docs/models/providers/chutes.md +137 -0
  255. package/.docs/models/providers/cloudferro-sherlock.md +74 -0
  256. package/.docs/models/providers/cloudflare-ai-gateway.md +33 -0
  257. package/.docs/models/providers/cloudflare-workers-ai.md +109 -0
  258. package/.docs/models/providers/cohere.md +33 -0
  259. package/.docs/models/providers/cortecs.md +91 -0
  260. package/.docs/models/providers/deepinfra.md +112 -0
  261. package/.docs/models/providers/deepseek.md +88 -0
  262. package/.docs/models/providers/evroc.md +83 -0
  263. package/.docs/models/providers/fastrouter.md +84 -0
  264. package/.docs/models/providers/fireworks-ai.md +83 -0
  265. package/.docs/models/providers/firmware.md +86 -0
  266. package/.docs/models/providers/friendli.md +77 -0
  267. package/.docs/models/providers/github-models.md +125 -0
  268. package/.docs/models/providers/google-vertex.md +33 -0
  269. package/.docs/models/providers/google.md +161 -0
  270. package/.docs/models/providers/groq.md +107 -0
  271. package/.docs/models/providers/helicone.md +161 -0
  272. package/.docs/models/providers/huggingface.md +90 -0
  273. package/.docs/models/providers/iflowcn.md +84 -0
  274. package/.docs/models/providers/inception.md +72 -0
  275. package/.docs/models/providers/inference.md +79 -0
  276. package/.docs/models/providers/io-intelligence.md +87 -0
  277. package/.docs/models/providers/io-net.md +87 -0
  278. package/.docs/models/providers/jiekou.md +131 -0
  279. package/.docs/models/providers/kilo.md +333 -0
  280. package/.docs/models/providers/kimi-for-coding.md +100 -0
  281. package/.docs/models/providers/kuae-cloud-coding-plan.md +71 -0
  282. package/.docs/models/providers/llama.md +77 -0
  283. package/.docs/models/providers/lmstudio.md +73 -0
  284. package/.docs/models/providers/lucidquery.md +72 -0
  285. package/.docs/models/providers/meganova.md +89 -0
  286. package/.docs/models/providers/minimax-cn-coding-plan.md +102 -0
  287. package/.docs/models/providers/minimax-cn.md +102 -0
  288. package/.docs/models/providers/minimax-coding-plan.md +102 -0
  289. package/.docs/models/providers/minimax.md +104 -0
  290. package/.docs/models/providers/mistral.md +124 -0
  291. package/.docs/models/providers/moark.md +72 -0
  292. package/.docs/models/providers/modelscope.md +77 -0
  293. package/.docs/models/providers/moonshotai-cn.md +76 -0
  294. package/.docs/models/providers/moonshotai.md +76 -0
  295. package/.docs/models/providers/morph.md +73 -0
  296. package/.docs/models/providers/nano-gpt.md +103 -0
  297. package/.docs/models/providers/nebius.md +116 -0
  298. package/.docs/models/providers/nova.md +72 -0
  299. package/.docs/models/providers/novita-ai.md +154 -0
  300. package/.docs/models/providers/nvidia.md +141 -0
  301. package/.docs/models/providers/ollama-cloud.md +103 -0
  302. package/.docs/models/providers/ollama.md +33 -0
  303. package/.docs/models/providers/openai.md +193 -0
  304. package/.docs/models/providers/opencode-go.md +73 -0
  305. package/.docs/models/providers/opencode.md +100 -0
  306. package/.docs/models/providers/ovhcloud.md +83 -0
  307. package/.docs/models/providers/perplexity-agent.md +113 -0
  308. package/.docs/models/providers/perplexity.md +101 -0
  309. package/.docs/models/providers/poe.md +184 -0
  310. package/.docs/models/providers/privatemode-ai.md +75 -0
  311. package/.docs/models/providers/qihang-ai.md +79 -0
  312. package/.docs/models/providers/qiniu-ai.md +146 -0
  313. package/.docs/models/providers/requesty.md +90 -0
  314. package/.docs/models/providers/scaleway.md +84 -0
  315. package/.docs/models/providers/siliconflow-cn.md +142 -0
  316. package/.docs/models/providers/siliconflow.md +140 -0
  317. package/.docs/models/providers/stackit.md +78 -0
  318. package/.docs/models/providers/stepfun.md +73 -0
  319. package/.docs/models/providers/submodel.md +79 -0
  320. package/.docs/models/providers/synthetic.md +96 -0
  321. package/.docs/models/providers/togetherai.md +116 -0
  322. package/.docs/models/providers/upstage.md +73 -0
  323. package/.docs/models/providers/venice.md +95 -0
  324. package/.docs/models/providers/vivgrid.md +106 -0
  325. package/.docs/models/providers/vultr.md +75 -0
  326. package/.docs/models/providers/wandb.md +80 -0
  327. package/.docs/models/providers/xai.md +141 -0
  328. package/.docs/models/providers/xiaomi.md +71 -0
  329. package/.docs/models/providers/zai-coding-plan.md +80 -0
  330. package/.docs/models/providers/zai.md +79 -0
  331. package/.docs/models/providers/zenmux.md +165 -0
  332. package/.docs/models/providers/zhipuai-coding-plan.md +79 -0
  333. package/.docs/models/providers/zhipuai.md +79 -0
  334. package/.docs/models/providers.md +88 -0
  335. package/.docs/reference/agents/agent.md +141 -0
  336. package/.docs/reference/agents/generate.md +186 -0
  337. package/.docs/reference/agents/generateLegacy.md +173 -0
  338. package/.docs/reference/agents/getDefaultGenerateOptions.md +36 -0
  339. package/.docs/reference/agents/getDefaultOptions.md +34 -0
  340. package/.docs/reference/agents/getDefaultStreamOptions.md +36 -0
  341. package/.docs/reference/agents/getDescription.md +21 -0
  342. package/.docs/reference/agents/getInstructions.md +34 -0
  343. package/.docs/reference/agents/getLLM.md +37 -0
  344. package/.docs/reference/agents/getMemory.md +34 -0
  345. package/.docs/reference/agents/getModel.md +34 -0
  346. package/.docs/reference/agents/getTools.md +29 -0
  347. package/.docs/reference/agents/getVoice.md +34 -0
  348. package/.docs/reference/agents/listAgents.md +35 -0
  349. package/.docs/reference/agents/listScorers.md +34 -0
  350. package/.docs/reference/agents/listTools.md +34 -0
  351. package/.docs/reference/agents/listWorkflows.md +34 -0
  352. package/.docs/reference/agents/network.md +170 -0
  353. package/.docs/reference/ai-sdk/chat-route.md +82 -0
  354. package/.docs/reference/ai-sdk/handle-chat-stream.md +53 -0
  355. package/.docs/reference/ai-sdk/handle-network-stream.md +37 -0
  356. package/.docs/reference/ai-sdk/handle-workflow-stream.md +55 -0
  357. package/.docs/reference/ai-sdk/network-route.md +74 -0
  358. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +231 -0
  359. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +79 -0
  360. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +76 -0
  361. package/.docs/reference/ai-sdk/with-mastra.md +63 -0
  362. package/.docs/reference/ai-sdk/workflow-route.md +79 -0
  363. package/.docs/reference/auth/auth0.md +73 -0
  364. package/.docs/reference/auth/better-auth.md +71 -0
  365. package/.docs/reference/auth/clerk.md +36 -0
  366. package/.docs/reference/auth/firebase.md +80 -0
  367. package/.docs/reference/auth/jwt.md +26 -0
  368. package/.docs/reference/auth/supabase.md +33 -0
  369. package/.docs/reference/auth/workos.md +84 -0
  370. package/.docs/reference/cli/create-mastra.md +137 -0
  371. package/.docs/reference/cli/mastra.md +336 -0
  372. package/.docs/reference/client-js/agents.md +437 -0
  373. package/.docs/reference/client-js/error-handling.md +16 -0
  374. package/.docs/reference/client-js/logs.md +24 -0
  375. package/.docs/reference/client-js/mastra-client.md +63 -0
  376. package/.docs/reference/client-js/memory.md +221 -0
  377. package/.docs/reference/client-js/observability.md +72 -0
  378. package/.docs/reference/client-js/telemetry.md +20 -0
  379. package/.docs/reference/client-js/tools.md +44 -0
  380. package/.docs/reference/client-js/vectors.md +79 -0
  381. package/.docs/reference/client-js/workflows.md +199 -0
  382. package/.docs/reference/configuration.md +752 -0
  383. package/.docs/reference/core/addGateway.md +42 -0
  384. package/.docs/reference/core/getAgent.md +21 -0
  385. package/.docs/reference/core/getAgentById.md +21 -0
  386. package/.docs/reference/core/getDeployer.md +22 -0
  387. package/.docs/reference/core/getGateway.md +38 -0
  388. package/.docs/reference/core/getGatewayById.md +41 -0
  389. package/.docs/reference/core/getLogger.md +22 -0
  390. package/.docs/reference/core/getMCPServer.md +47 -0
  391. package/.docs/reference/core/getMCPServerById.md +55 -0
  392. package/.docs/reference/core/getMemory.md +50 -0
  393. package/.docs/reference/core/getScorer.md +54 -0
  394. package/.docs/reference/core/getScorerById.md +54 -0
  395. package/.docs/reference/core/getServer.md +22 -0
  396. package/.docs/reference/core/getStorage.md +22 -0
  397. package/.docs/reference/core/getStoredAgentById.md +89 -0
  398. package/.docs/reference/core/getTelemetry.md +22 -0
  399. package/.docs/reference/core/getVector.md +22 -0
  400. package/.docs/reference/core/getWorkflow.md +42 -0
  401. package/.docs/reference/core/listAgents.md +21 -0
  402. package/.docs/reference/core/listGateways.md +40 -0
  403. package/.docs/reference/core/listLogs.md +38 -0
  404. package/.docs/reference/core/listLogsByRunId.md +36 -0
  405. package/.docs/reference/core/listMCPServers.md +55 -0
  406. package/.docs/reference/core/listMemory.md +56 -0
  407. package/.docs/reference/core/listScorers.md +29 -0
  408. package/.docs/reference/core/listStoredAgents.md +93 -0
  409. package/.docs/reference/core/listVectors.md +22 -0
  410. package/.docs/reference/core/listWorkflows.md +21 -0
  411. package/.docs/reference/core/mastra-class.md +66 -0
  412. package/.docs/reference/core/mastra-model-gateway.md +153 -0
  413. package/.docs/reference/core/setLogger.md +26 -0
  414. package/.docs/reference/core/setStorage.md +27 -0
  415. package/.docs/reference/datasets/addItem.md +37 -0
  416. package/.docs/reference/datasets/addItems.md +35 -0
  417. package/.docs/reference/datasets/compareExperiments.md +52 -0
  418. package/.docs/reference/datasets/create.md +51 -0
  419. package/.docs/reference/datasets/dataset.md +82 -0
  420. package/.docs/reference/datasets/datasets-manager.md +94 -0
  421. package/.docs/reference/datasets/delete.md +25 -0
  422. package/.docs/reference/datasets/deleteExperiment.md +27 -0
  423. package/.docs/reference/datasets/deleteItem.md +27 -0
  424. package/.docs/reference/datasets/deleteItems.md +29 -0
  425. package/.docs/reference/datasets/get.md +31 -0
  426. package/.docs/reference/datasets/getDetails.md +47 -0
  427. package/.docs/reference/datasets/getExperiment.md +30 -0
  428. package/.docs/reference/datasets/getItem.md +33 -0
  429. package/.docs/reference/datasets/getItemHistory.md +31 -0
  430. package/.docs/reference/datasets/list.md +31 -0
  431. package/.docs/reference/datasets/listExperimentResults.md +39 -0
  432. package/.docs/reference/datasets/listExperiments.md +33 -0
  433. package/.docs/reference/datasets/listItems.md +46 -0
  434. package/.docs/reference/datasets/listVersions.md +33 -0
  435. package/.docs/reference/datasets/startExperiment.md +62 -0
  436. package/.docs/reference/datasets/startExperimentAsync.md +43 -0
  437. package/.docs/reference/datasets/update.md +48 -0
  438. package/.docs/reference/datasets/updateItem.md +38 -0
  439. package/.docs/reference/deployer/cloudflare.md +79 -0
  440. package/.docs/reference/deployer/netlify.md +80 -0
  441. package/.docs/reference/deployer/vercel.md +116 -0
  442. package/.docs/reference/deployer.md +100 -0
  443. package/.docs/reference/evals/answer-relevancy.md +105 -0
  444. package/.docs/reference/evals/answer-similarity.md +99 -0
  445. package/.docs/reference/evals/bias.md +120 -0
  446. package/.docs/reference/evals/completeness.md +136 -0
  447. package/.docs/reference/evals/content-similarity.md +101 -0
  448. package/.docs/reference/evals/context-precision.md +196 -0
  449. package/.docs/reference/evals/context-relevance.md +531 -0
  450. package/.docs/reference/evals/create-scorer.md +270 -0
  451. package/.docs/reference/evals/faithfulness.md +114 -0
  452. package/.docs/reference/evals/hallucination.md +213 -0
  453. package/.docs/reference/evals/keyword-coverage.md +128 -0
  454. package/.docs/reference/evals/mastra-scorer.md +123 -0
  455. package/.docs/reference/evals/noise-sensitivity.md +675 -0
  456. package/.docs/reference/evals/prompt-alignment.md +614 -0
  457. package/.docs/reference/evals/run-evals.md +179 -0
  458. package/.docs/reference/evals/scorer-utils.md +326 -0
  459. package/.docs/reference/evals/textual-difference.md +113 -0
  460. package/.docs/reference/evals/tone-consistency.md +119 -0
  461. package/.docs/reference/evals/tool-call-accuracy.md +533 -0
  462. package/.docs/reference/evals/toxicity.md +123 -0
  463. package/.docs/reference/harness/harness-class.md +760 -0
  464. package/.docs/reference/index.md +277 -0
  465. package/.docs/reference/logging/pino-logger.md +117 -0
  466. package/.docs/reference/memory/clone-utilities.md +199 -0
  467. package/.docs/reference/memory/cloneThread.md +142 -0
  468. package/.docs/reference/memory/createThread.md +68 -0
  469. package/.docs/reference/memory/deleteMessages.md +38 -0
  470. package/.docs/reference/memory/getThreadById.md +24 -0
  471. package/.docs/reference/memory/listThreads.md +145 -0
  472. package/.docs/reference/memory/memory-class.md +147 -0
  473. package/.docs/reference/memory/observational-memory.md +577 -0
  474. package/.docs/reference/memory/recall.md +91 -0
  475. package/.docs/reference/observability/tracing/bridges/otel.md +131 -0
  476. package/.docs/reference/observability/tracing/configuration.md +178 -0
  477. package/.docs/reference/observability/tracing/exporters/arize.md +141 -0
  478. package/.docs/reference/observability/tracing/exporters/braintrust.md +93 -0
  479. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +163 -0
  480. package/.docs/reference/observability/tracing/exporters/console-exporter.md +138 -0
  481. package/.docs/reference/observability/tracing/exporters/datadog.md +116 -0
  482. package/.docs/reference/observability/tracing/exporters/default-exporter.md +174 -0
  483. package/.docs/reference/observability/tracing/exporters/laminar.md +78 -0
  484. package/.docs/reference/observability/tracing/exporters/langfuse.md +134 -0
  485. package/.docs/reference/observability/tracing/exporters/langsmith.md +108 -0
  486. package/.docs/reference/observability/tracing/exporters/otel.md +199 -0
  487. package/.docs/reference/observability/tracing/exporters/posthog.md +92 -0
  488. package/.docs/reference/observability/tracing/exporters/sentry.md +184 -0
  489. package/.docs/reference/observability/tracing/instances.md +107 -0
  490. package/.docs/reference/observability/tracing/interfaces.md +743 -0
  491. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +144 -0
  492. package/.docs/reference/observability/tracing/spans.md +224 -0
  493. package/.docs/reference/processors/batch-parts-processor.md +61 -0
  494. package/.docs/reference/processors/language-detector.md +82 -0
  495. package/.docs/reference/processors/message-history-processor.md +85 -0
  496. package/.docs/reference/processors/moderation-processor.md +104 -0
  497. package/.docs/reference/processors/pii-detector.md +108 -0
  498. package/.docs/reference/processors/processor-interface.md +521 -0
  499. package/.docs/reference/processors/prompt-injection-detector.md +72 -0
  500. package/.docs/reference/processors/semantic-recall-processor.md +117 -0
  501. package/.docs/reference/processors/system-prompt-scrubber.md +80 -0
  502. package/.docs/reference/processors/token-limiter-processor.md +115 -0
  503. package/.docs/reference/processors/tool-call-filter.md +85 -0
  504. package/.docs/reference/processors/tool-search-processor.md +111 -0
  505. package/.docs/reference/processors/unicode-normalizer.md +62 -0
  506. package/.docs/reference/processors/working-memory-processor.md +152 -0
  507. package/.docs/reference/rag/chunk.md +221 -0
  508. package/.docs/reference/rag/database-config.md +261 -0
  509. package/.docs/reference/rag/document.md +114 -0
  510. package/.docs/reference/rag/embeddings.md +92 -0
  511. package/.docs/reference/rag/extract-params.md +168 -0
  512. package/.docs/reference/rag/graph-rag.md +111 -0
  513. package/.docs/reference/rag/metadata-filters.md +216 -0
  514. package/.docs/reference/rag/rerank.md +75 -0
  515. package/.docs/reference/rag/rerankWithScorer.md +80 -0
  516. package/.docs/reference/server/create-route.md +262 -0
  517. package/.docs/reference/server/express-adapter.md +176 -0
  518. package/.docs/reference/server/fastify-adapter.md +90 -0
  519. package/.docs/reference/server/hono-adapter.md +162 -0
  520. package/.docs/reference/server/koa-adapter.md +127 -0
  521. package/.docs/reference/server/mastra-server.md +298 -0
  522. package/.docs/reference/server/register-api-route.md +249 -0
  523. package/.docs/reference/server/routes.md +306 -0
  524. package/.docs/reference/storage/cloudflare-d1.md +218 -0
  525. package/.docs/reference/storage/cloudflare.md +88 -0
  526. package/.docs/reference/storage/composite.md +235 -0
  527. package/.docs/reference/storage/convex.md +161 -0
  528. package/.docs/reference/storage/dynamodb.md +282 -0
  529. package/.docs/reference/storage/lance.md +131 -0
  530. package/.docs/reference/storage/libsql.md +135 -0
  531. package/.docs/reference/storage/mongodb.md +262 -0
  532. package/.docs/reference/storage/mssql.md +157 -0
  533. package/.docs/reference/storage/overview.md +121 -0
  534. package/.docs/reference/storage/postgresql.md +526 -0
  535. package/.docs/reference/storage/upstash.md +160 -0
  536. package/.docs/reference/streaming/ChunkType.md +292 -0
  537. package/.docs/reference/streaming/agents/MastraModelOutput.md +182 -0
  538. package/.docs/reference/streaming/agents/stream.md +255 -0
  539. package/.docs/reference/streaming/agents/streamLegacy.md +142 -0
  540. package/.docs/reference/streaming/workflows/observeStream.md +42 -0
  541. package/.docs/reference/streaming/workflows/resumeStream.md +61 -0
  542. package/.docs/reference/streaming/workflows/stream.md +88 -0
  543. package/.docs/reference/streaming/workflows/timeTravelStream.md +142 -0
  544. package/.docs/reference/templates/overview.md +194 -0
  545. package/.docs/reference/tools/create-tool.md +285 -0
  546. package/.docs/reference/tools/document-chunker-tool.md +89 -0
  547. package/.docs/reference/tools/graph-rag-tool.md +182 -0
  548. package/.docs/reference/tools/mcp-client.md +965 -0
  549. package/.docs/reference/tools/mcp-server.md +1271 -0
  550. package/.docs/reference/tools/vector-query-tool.md +459 -0
  551. package/.docs/reference/vectors/astra.md +121 -0
  552. package/.docs/reference/vectors/chroma.md +264 -0
  553. package/.docs/reference/vectors/convex.md +300 -0
  554. package/.docs/reference/vectors/couchbase.md +226 -0
  555. package/.docs/reference/vectors/duckdb.md +318 -0
  556. package/.docs/reference/vectors/elasticsearch.md +189 -0
  557. package/.docs/reference/vectors/lance.md +220 -0
  558. package/.docs/reference/vectors/libsql.md +305 -0
  559. package/.docs/reference/vectors/mongodb.md +295 -0
  560. package/.docs/reference/vectors/opensearch.md +99 -0
  561. package/.docs/reference/vectors/pg.md +408 -0
  562. package/.docs/reference/vectors/pinecone.md +168 -0
  563. package/.docs/reference/vectors/qdrant.md +222 -0
  564. package/.docs/reference/vectors/s3vectors.md +277 -0
  565. package/.docs/reference/vectors/turbopuffer.md +157 -0
  566. package/.docs/reference/vectors/upstash.md +294 -0
  567. package/.docs/reference/vectors/vectorize.md +147 -0
  568. package/.docs/reference/voice/azure.md +148 -0
  569. package/.docs/reference/voice/cloudflare.md +83 -0
  570. package/.docs/reference/voice/composite-voice.md +121 -0
  571. package/.docs/reference/voice/deepgram.md +79 -0
  572. package/.docs/reference/voice/elevenlabs.md +98 -0
  573. package/.docs/reference/voice/google-gemini-live.md +378 -0
  574. package/.docs/reference/voice/google.md +228 -0
  575. package/.docs/reference/voice/mastra-voice.md +311 -0
  576. package/.docs/reference/voice/murf.md +122 -0
  577. package/.docs/reference/voice/openai-realtime.md +203 -0
  578. package/.docs/reference/voice/openai.md +88 -0
  579. package/.docs/reference/voice/playai.md +80 -0
  580. package/.docs/reference/voice/sarvam.md +126 -0
  581. package/.docs/reference/voice/speechify.md +75 -0
  582. package/.docs/reference/voice/voice.addInstructions.md +55 -0
  583. package/.docs/reference/voice/voice.addTools.md +67 -0
  584. package/.docs/reference/voice/voice.answer.md +54 -0
  585. package/.docs/reference/voice/voice.close.md +51 -0
  586. package/.docs/reference/voice/voice.connect.md +94 -0
  587. package/.docs/reference/voice/voice.events.md +37 -0
  588. package/.docs/reference/voice/voice.getSpeakers.md +129 -0
  589. package/.docs/reference/voice/voice.listen.md +164 -0
  590. package/.docs/reference/voice/voice.off.md +54 -0
  591. package/.docs/reference/voice/voice.on.md +111 -0
  592. package/.docs/reference/voice/voice.send.md +65 -0
  593. package/.docs/reference/voice/voice.speak.md +157 -0
  594. package/.docs/reference/voice/voice.updateConfig.md +60 -0
  595. package/.docs/reference/workflows/run-methods/cancel.md +86 -0
  596. package/.docs/reference/workflows/run-methods/restart.md +33 -0
  597. package/.docs/reference/workflows/run-methods/resume.md +59 -0
  598. package/.docs/reference/workflows/run-methods/start.md +58 -0
  599. package/.docs/reference/workflows/run-methods/startAsync.md +67 -0
  600. package/.docs/reference/workflows/run-methods/timeTravel.md +142 -0
  601. package/.docs/reference/workflows/run.md +59 -0
  602. package/.docs/reference/workflows/step.md +119 -0
  603. package/.docs/reference/workflows/workflow-methods/branch.md +25 -0
  604. package/.docs/reference/workflows/workflow-methods/commit.md +17 -0
  605. package/.docs/reference/workflows/workflow-methods/create-run.md +63 -0
  606. package/.docs/reference/workflows/workflow-methods/dountil.md +25 -0
  607. package/.docs/reference/workflows/workflow-methods/dowhile.md +25 -0
  608. package/.docs/reference/workflows/workflow-methods/foreach.md +118 -0
  609. package/.docs/reference/workflows/workflow-methods/map.md +93 -0
  610. package/.docs/reference/workflows/workflow-methods/parallel.md +21 -0
  611. package/.docs/reference/workflows/workflow-methods/sleep.md +35 -0
  612. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +35 -0
  613. package/.docs/reference/workflows/workflow-methods/then.md +21 -0
  614. package/.docs/reference/workflows/workflow.md +157 -0
  615. package/.docs/reference/workspace/daytona-sandbox.md +580 -0
  616. package/.docs/reference/workspace/e2b-sandbox.md +289 -0
  617. package/.docs/reference/workspace/filesystem.md +255 -0
  618. package/.docs/reference/workspace/gcs-filesystem.md +174 -0
  619. package/.docs/reference/workspace/local-filesystem.md +343 -0
  620. package/.docs/reference/workspace/local-sandbox.md +301 -0
  621. package/.docs/reference/workspace/s3-filesystem.md +177 -0
  622. package/.docs/reference/workspace/sandbox.md +87 -0
  623. package/.docs/reference/workspace/workspace-class.md +244 -0
  624. package/CHANGELOG.md +659 -4
  625. package/LICENSE.md +15 -0
  626. package/README.md +63 -125
  627. package/dist/index.d.ts.map +1 -1
  628. package/dist/logger.d.ts +3 -0
  629. package/dist/logger.d.ts.map +1 -1
  630. package/dist/prompts/migration.d.ts +6 -0
  631. package/dist/prompts/migration.d.ts.map +1 -0
  632. package/dist/stdio.js +1253 -293
  633. package/dist/stdio.js.map +1 -0
  634. package/dist/tools/course.d.ts.map +1 -1
  635. package/dist/tools/docs.d.ts.map +1 -1
  636. package/dist/tools/embedded-docs.d.ts +276 -0
  637. package/dist/tools/embedded-docs.d.ts.map +1 -0
  638. package/dist/tools/migration.d.ts +40 -0
  639. package/dist/tools/migration.d.ts.map +1 -0
  640. package/dist/utils.d.ts +0 -54
  641. package/dist/utils.d.ts.map +1 -1
  642. package/package.json +22 -21
  643. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -9
  644. package/.docs/organized/changelogs/%40internal%2Fplayground.md +0 -3
  645. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +0 -302
  646. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -49
  647. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +0 -302
  648. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +0 -302
  649. package/.docs/organized/changelogs/%40mastra%2Fastra.md +0 -302
  650. package/.docs/organized/changelogs/%40mastra%2Fauth.md +0 -31
  651. package/.docs/organized/changelogs/%40mastra%2Fchroma.md +0 -302
  652. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +0 -302
  653. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +0 -302
  654. package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
  655. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +0 -302
  656. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +0 -302
  657. package/.docs/organized/changelogs/%40mastra%2Fcore.md +0 -302
  658. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +0 -302
  659. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +0 -302
  660. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +0 -302
  661. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +0 -302
  662. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +0 -302
  663. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +0 -302
  664. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +0 -302
  665. package/.docs/organized/changelogs/%40mastra%2Fevals.md +0 -302
  666. package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +0 -87
  667. package/.docs/organized/changelogs/%40mastra%2Flance.md +0 -302
  668. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +0 -302
  669. package/.docs/organized/changelogs/%40mastra%2Floggers.md +0 -302
  670. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +0 -302
  671. package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +0 -302
  672. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +0 -302
  673. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +0 -302
  674. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +0 -302
  675. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +0 -302
  676. package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +0 -302
  677. package/.docs/organized/changelogs/%40mastra%2Fpg.md +0 -302
  678. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +0 -302
  679. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +0 -302
  680. package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +0 -302
  681. package/.docs/organized/changelogs/%40mastra%2Frag.md +0 -302
  682. package/.docs/organized/changelogs/%40mastra%2Freact.md +0 -247
  683. package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +0 -149
  684. package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +0 -195
  685. package/.docs/organized/changelogs/%40mastra%2Fserver.md +0 -302
  686. package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +0 -302
  687. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +0 -302
  688. package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +0 -302
  689. package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +0 -302
  690. package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +0 -302
  691. package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +0 -302
  692. package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +0 -302
  693. package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +0 -302
  694. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +0 -265
  695. package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +0 -302
  696. package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +0 -302
  697. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +0 -302
  698. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +0 -302
  699. package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +0 -302
  700. package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +0 -302
  701. package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +0 -302
  702. package/.docs/organized/changelogs/create-mastra.md +0 -302
  703. package/.docs/organized/changelogs/mastra.md +0 -302
  704. package/.docs/organized/code-examples/a2a.md +0 -208
  705. package/.docs/organized/code-examples/agent.md +0 -1333
  706. package/.docs/organized/code-examples/agui.md +0 -173
  707. package/.docs/organized/code-examples/ai-elements.md +0 -47
  708. package/.docs/organized/code-examples/ai-sdk-useChat.md +0 -369
  709. package/.docs/organized/code-examples/ai-sdk-v5.md +0 -203
  710. package/.docs/organized/code-examples/assistant-ui.md +0 -28
  711. package/.docs/organized/code-examples/bird-checker-with-express.md +0 -223
  712. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +0 -347
  713. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +0 -241
  714. package/.docs/organized/code-examples/client-side-tools.md +0 -59
  715. package/.docs/organized/code-examples/crypto-chatbot.md +0 -87
  716. package/.docs/organized/code-examples/experimental-auth-weather-agent.md +0 -564
  717. package/.docs/organized/code-examples/fireworks-r1.md +0 -148
  718. package/.docs/organized/code-examples/heads-up-game.md +0 -252
  719. package/.docs/organized/code-examples/mcp-configuration.md +0 -556
  720. package/.docs/organized/code-examples/mcp-registry-registry.md +0 -50
  721. package/.docs/organized/code-examples/memory-per-resource-example.md +0 -222
  722. package/.docs/organized/code-examples/memory-todo-agent.md +0 -152
  723. package/.docs/organized/code-examples/memory-with-context.md +0 -155
  724. package/.docs/organized/code-examples/memory-with-libsql.md +0 -190
  725. package/.docs/organized/code-examples/memory-with-pg.md +0 -211
  726. package/.docs/organized/code-examples/memory-with-processors.md +0 -594
  727. package/.docs/organized/code-examples/memory-with-upstash.md +0 -254
  728. package/.docs/organized/code-examples/openapi-spec-writer.md +0 -567
  729. package/.docs/organized/code-examples/quick-start.md +0 -156
  730. package/.docs/organized/code-examples/stock-price-tool.md +0 -111
  731. package/.docs/organized/code-examples/weather-agent.md +0 -576
  732. package/.docs/organized/code-examples/workflow-ai-recruiter.md +0 -147
  733. package/.docs/organized/code-examples/workflow-with-inline-steps.md +0 -99
  734. package/.docs/organized/code-examples/workflow-with-memory.md +0 -381
  735. package/.docs/organized/code-examples/workflow-with-separate-steps.md +0 -160
  736. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +0 -182
  737. package/.docs/raw/agents/adding-voice.mdx +0 -290
  738. package/.docs/raw/agents/agent-memory.mdx +0 -158
  739. package/.docs/raw/agents/guardrails.mdx +0 -342
  740. package/.docs/raw/agents/networks.mdx +0 -235
  741. package/.docs/raw/agents/overview.mdx +0 -425
  742. package/.docs/raw/agents/using-tools.mdx +0 -95
  743. package/.docs/raw/auth/auth0.mdx +0 -235
  744. package/.docs/raw/auth/clerk.mdx +0 -142
  745. package/.docs/raw/auth/firebase.mdx +0 -285
  746. package/.docs/raw/auth/index.mdx +0 -19
  747. package/.docs/raw/auth/jwt.mdx +0 -101
  748. package/.docs/raw/auth/supabase.mdx +0 -128
  749. package/.docs/raw/auth/workos.mdx +0 -198
  750. package/.docs/raw/community/contributing-templates.mdx +0 -193
  751. package/.docs/raw/community/discord.mdx +0 -12
  752. package/.docs/raw/community/licensing.mdx +0 -71
  753. package/.docs/raw/course/01-first-agent/04-project-structure.md +0 -17
  754. package/.docs/raw/course/01-first-agent/05-running-playground.md +0 -19
  755. package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +0 -51
  756. package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +0 -33
  757. package/.docs/raw/course/01-first-agent/09-testing-your-agent.md +0 -12
  758. package/.docs/raw/course/01-first-agent/11-creating-transactions-tool.md +0 -41
  759. package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +0 -29
  760. package/.docs/raw/course/01-first-agent/13-testing-your-tool.md +0 -15
  761. package/.docs/raw/course/01-first-agent/15-installing-memory.md +0 -13
  762. package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +0 -33
  763. package/.docs/raw/course/01-first-agent/17-testing-memory.md +0 -15
  764. package/.docs/raw/course/02-agent-tools-mcp/03-setting-up-mcp-configuration.md +0 -21
  765. package/.docs/raw/course/02-agent-tools-mcp/04-initializing-mcp-tools.md +0 -11
  766. package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +0 -20
  767. package/.docs/raw/course/02-agent-tools-mcp/07-what-is-zapier-mcp.md +0 -14
  768. package/.docs/raw/course/02-agent-tools-mcp/08-getting-zapier-mcp-url.md +0 -16
  769. package/.docs/raw/course/02-agent-tools-mcp/09-updating-mcp-config-zapier.md +0 -17
  770. package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +0 -29
  771. package/.docs/raw/course/02-agent-tools-mcp/12-troubleshooting-zapier.md +0 -17
  772. package/.docs/raw/course/02-agent-tools-mcp/13-what-is-github-mcp.md +0 -14
  773. package/.docs/raw/course/02-agent-tools-mcp/14-getting-github-mcp-url.md +0 -35
  774. package/.docs/raw/course/02-agent-tools-mcp/15-updating-mcp-config-github.md +0 -20
  775. package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +0 -33
  776. package/.docs/raw/course/02-agent-tools-mcp/18-troubleshooting-github.md +0 -17
  777. package/.docs/raw/course/02-agent-tools-mcp/20-updating-mcp-config-hackernews.md +0 -26
  778. package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +0 -38
  779. package/.docs/raw/course/02-agent-tools-mcp/26-updating-mcp-config-filesystem.md +0 -33
  780. package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +0 -45
  781. package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +0 -76
  782. package/.docs/raw/course/02-agent-tools-mcp/32-conclusion.md +0 -17
  783. package/.docs/raw/course/03-agent-memory/03-installing-memory.md +0 -13
  784. package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +0 -36
  785. package/.docs/raw/course/03-agent-memory/05-updating-mastra-export.md +0 -18
  786. package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +0 -14
  787. package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +0 -37
  788. package/.docs/raw/course/03-agent-memory/09-using-memory-in-application.md +0 -19
  789. package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +0 -30
  790. package/.docs/raw/course/03-agent-memory/12-handling-memory-frontend.md +0 -62
  791. package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +0 -27
  792. package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +0 -41
  793. package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +0 -28
  794. package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +0 -63
  795. package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +0 -89
  796. package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +0 -80
  797. package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
  798. package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +0 -103
  799. package/.docs/raw/course/04-workflows/01-introduction-to-workflows.md +0 -44
  800. package/.docs/raw/course/04-workflows/02-understanding-steps.md +0 -53
  801. package/.docs/raw/course/04-workflows/03-creating-your-first-step.md +0 -57
  802. package/.docs/raw/course/04-workflows/04-creating-a-second-step.md +0 -58
  803. package/.docs/raw/course/04-workflows/05-chaining-steps-together.md +0 -57
  804. package/.docs/raw/course/04-workflows/06-registering-with-mastra.md +0 -24
  805. package/.docs/raw/course/04-workflows/07-using-playground.md +0 -58
  806. package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +0 -77
  807. package/.docs/raw/course/04-workflows/09-adding-a-third-step.md +0 -70
  808. package/.docs/raw/course/04-workflows/10-updating-the-workflow.md +0 -55
  809. package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +0 -67
  810. package/.docs/raw/course/04-workflows/12-using-agent-in-workflow.md +0 -91
  811. package/.docs/raw/course/04-workflows/13-creating-ai-enhanced-workflow.md +0 -75
  812. package/.docs/raw/course/04-workflows/14-understanding-parallel-execution.md +0 -38
  813. package/.docs/raw/course/04-workflows/15-creating-parallel-steps.md +0 -115
  814. package/.docs/raw/course/04-workflows/16-building-parallel-workflow.md +0 -100
  815. package/.docs/raw/course/04-workflows/17-testing-parallel-performance.md +0 -40
  816. package/.docs/raw/course/04-workflows/18-understanding-conditional-branching.md +0 -61
  817. package/.docs/raw/course/04-workflows/19-creating-conditional-steps.md +0 -128
  818. package/.docs/raw/course/04-workflows/20-building-conditional-workflow.md +0 -60
  819. package/.docs/raw/course/04-workflows/21-testing-conditional-logic.md +0 -58
  820. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +0 -115
  821. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +0 -273
  822. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +0 -137
  823. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +0 -206
  824. package/.docs/raw/deployment/cloud-providers/index.mdx +0 -52
  825. package/.docs/raw/deployment/monorepo.mdx +0 -107
  826. package/.docs/raw/deployment/overview.mdx +0 -82
  827. package/.docs/raw/deployment/server-deployment.mdx +0 -86
  828. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +0 -87
  829. package/.docs/raw/deployment/serverless-platforms/index.mdx +0 -52
  830. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +0 -94
  831. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +0 -109
  832. package/.docs/raw/deployment/web-framework.mdx +0 -63
  833. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +0 -675
  834. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +0 -125
  835. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +0 -108
  836. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +0 -341
  837. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +0 -165
  838. package/.docs/raw/frameworks/servers/express.mdx +0 -208
  839. package/.docs/raw/frameworks/web-frameworks/astro.mdx +0 -519
  840. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +0 -336
  841. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +0 -461
  842. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +0 -242
  843. package/.docs/raw/getting-started/installation.mdx +0 -316
  844. package/.docs/raw/getting-started/mcp-docs-server.mdx +0 -183
  845. package/.docs/raw/getting-started/project-structure.mdx +0 -72
  846. package/.docs/raw/getting-started/templates.mdx +0 -70
  847. package/.docs/raw/index.mdx +0 -58
  848. package/.docs/raw/mastra-cloud/dashboard.mdx +0 -100
  849. package/.docs/raw/mastra-cloud/observability.mdx +0 -52
  850. package/.docs/raw/mastra-cloud/overview.mdx +0 -71
  851. package/.docs/raw/mastra-cloud/setting-up.mdx +0 -92
  852. package/.docs/raw/memory/conversation-history.mdx +0 -23
  853. package/.docs/raw/memory/memory-processors.mdx +0 -136
  854. package/.docs/raw/memory/overview.mdx +0 -119
  855. package/.docs/raw/memory/semantic-recall.mdx +0 -226
  856. package/.docs/raw/memory/threads-and-resources.mdx +0 -94
  857. package/.docs/raw/memory/working-memory.mdx +0 -378
  858. package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +0 -81
  859. package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +0 -120
  860. package/.docs/raw/observability/ai-tracing/exporters/default.mdx +0 -168
  861. package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +0 -121
  862. package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +0 -88
  863. package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +0 -253
  864. package/.docs/raw/observability/ai-tracing/overview.mdx +0 -565
  865. package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +0 -274
  866. package/.docs/raw/observability/logging.mdx +0 -113
  867. package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
  868. package/.docs/raw/observability/otel-tracing.mdx +0 -190
  869. package/.docs/raw/observability/overview.mdx +0 -66
  870. package/.docs/raw/rag/chunking-and-embedding.mdx +0 -208
  871. package/.docs/raw/rag/overview.mdx +0 -87
  872. package/.docs/raw/rag/retrieval.mdx +0 -543
  873. package/.docs/raw/rag/vector-databases.mdx +0 -529
  874. package/.docs/raw/reference/agents/agent.mdx +0 -230
  875. package/.docs/raw/reference/agents/generate.mdx +0 -577
  876. package/.docs/raw/reference/agents/generateLegacy.mdx +0 -528
  877. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +0 -67
  878. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +0 -67
  879. package/.docs/raw/reference/agents/getDescription.mdx +0 -34
  880. package/.docs/raw/reference/agents/getInstructions.mdx +0 -67
  881. package/.docs/raw/reference/agents/getLLM.mdx +0 -74
  882. package/.docs/raw/reference/agents/getMemory.mdx +0 -67
  883. package/.docs/raw/reference/agents/getModel.mdx +0 -67
  884. package/.docs/raw/reference/agents/getScorers.mdx +0 -67
  885. package/.docs/raw/reference/agents/getTools.mdx +0 -67
  886. package/.docs/raw/reference/agents/getVoice.mdx +0 -67
  887. package/.docs/raw/reference/agents/getWorkflows.mdx +0 -67
  888. package/.docs/raw/reference/agents/listAgents.mdx +0 -68
  889. package/.docs/raw/reference/agents/network.mdx +0 -290
  890. package/.docs/raw/reference/auth/auth0.mdx +0 -117
  891. package/.docs/raw/reference/auth/clerk.mdx +0 -71
  892. package/.docs/raw/reference/auth/firebase.mdx +0 -128
  893. package/.docs/raw/reference/auth/jwt.mdx +0 -41
  894. package/.docs/raw/reference/auth/supabase.mdx +0 -62
  895. package/.docs/raw/reference/auth/workos.mdx +0 -128
  896. package/.docs/raw/reference/cli/create-mastra.mdx +0 -177
  897. package/.docs/raw/reference/cli/mastra.mdx +0 -258
  898. package/.docs/raw/reference/client-js/agents.mdx +0 -220
  899. package/.docs/raw/reference/client-js/error-handling.mdx +0 -23
  900. package/.docs/raw/reference/client-js/logs.mdx +0 -29
  901. package/.docs/raw/reference/client-js/mastra-client.mdx +0 -157
  902. package/.docs/raw/reference/client-js/memory.mdx +0 -130
  903. package/.docs/raw/reference/client-js/observability.mdx +0 -76
  904. package/.docs/raw/reference/client-js/telemetry.mdx +0 -25
  905. package/.docs/raw/reference/client-js/tools.mdx +0 -49
  906. package/.docs/raw/reference/client-js/vectors.mdx +0 -84
  907. package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
  908. package/.docs/raw/reference/client-js/workflows.mdx +0 -175
  909. package/.docs/raw/reference/core/getAgent.mdx +0 -43
  910. package/.docs/raw/reference/core/getAgentById.mdx +0 -43
  911. package/.docs/raw/reference/core/getAgents.mdx +0 -35
  912. package/.docs/raw/reference/core/getDeployer.mdx +0 -35
  913. package/.docs/raw/reference/core/getLogger.mdx +0 -35
  914. package/.docs/raw/reference/core/getLogs.mdx +0 -92
  915. package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -84
  916. package/.docs/raw/reference/core/getMCPServer.mdx +0 -49
  917. package/.docs/raw/reference/core/getMCPServers.mdx +0 -35
  918. package/.docs/raw/reference/core/getMemory.mdx +0 -35
  919. package/.docs/raw/reference/core/getScorer.mdx +0 -75
  920. package/.docs/raw/reference/core/getScorerByName.mdx +0 -75
  921. package/.docs/raw/reference/core/getScorers.mdx +0 -42
  922. package/.docs/raw/reference/core/getServer.mdx +0 -35
  923. package/.docs/raw/reference/core/getStorage.mdx +0 -35
  924. package/.docs/raw/reference/core/getTelemetry.mdx +0 -35
  925. package/.docs/raw/reference/core/getVector.mdx +0 -43
  926. package/.docs/raw/reference/core/getVectors.mdx +0 -35
  927. package/.docs/raw/reference/core/getWorkflow.mdx +0 -48
  928. package/.docs/raw/reference/core/getWorkflows.mdx +0 -43
  929. package/.docs/raw/reference/core/mastra-class.mdx +0 -143
  930. package/.docs/raw/reference/core/setLogger.mdx +0 -47
  931. package/.docs/raw/reference/core/setStorage.mdx +0 -39
  932. package/.docs/raw/reference/core/setTelemetry.mdx +0 -35
  933. package/.docs/raw/reference/deployer/cloudflare.mdx +0 -91
  934. package/.docs/raw/reference/deployer/deployer.mdx +0 -165
  935. package/.docs/raw/reference/deployer/netlify.mdx +0 -20
  936. package/.docs/raw/reference/deployer/vercel.mdx +0 -46
  937. package/.docs/raw/reference/evals/answer-relevancy.mdx +0 -190
  938. package/.docs/raw/reference/evals/bias.mdx +0 -195
  939. package/.docs/raw/reference/evals/completeness.mdx +0 -184
  940. package/.docs/raw/reference/evals/content-similarity.mdx +0 -185
  941. package/.docs/raw/reference/evals/context-position.mdx +0 -198
  942. package/.docs/raw/reference/evals/context-precision.mdx +0 -196
  943. package/.docs/raw/reference/evals/context-relevancy.mdx +0 -197
  944. package/.docs/raw/reference/evals/contextual-recall.mdx +0 -197
  945. package/.docs/raw/reference/evals/faithfulness.mdx +0 -200
  946. package/.docs/raw/reference/evals/hallucination.mdx +0 -227
  947. package/.docs/raw/reference/evals/keyword-coverage.mdx +0 -186
  948. package/.docs/raw/reference/evals/prompt-alignment.mdx +0 -248
  949. package/.docs/raw/reference/evals/summarization.mdx +0 -214
  950. package/.docs/raw/reference/evals/textual-difference.mdx +0 -172
  951. package/.docs/raw/reference/evals/tone-consistency.mdx +0 -190
  952. package/.docs/raw/reference/evals/toxicity.mdx +0 -173
  953. package/.docs/raw/reference/index.mdx +0 -12
  954. package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
  955. package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
  956. package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
  957. package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
  958. package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
  959. package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
  960. package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
  961. package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
  962. package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
  963. package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
  964. package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
  965. package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
  966. package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
  967. package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
  968. package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
  969. package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
  970. package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
  971. package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
  972. package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
  973. package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
  974. package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
  975. package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
  976. package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
  977. package/.docs/raw/reference/memory/Memory.mdx +0 -206
  978. package/.docs/raw/reference/memory/createThread.mdx +0 -119
  979. package/.docs/raw/reference/memory/deleteMessages.mdx +0 -60
  980. package/.docs/raw/reference/memory/getThreadById.mdx +0 -46
  981. package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -78
  982. package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -109
  983. package/.docs/raw/reference/memory/query.mdx +0 -174
  984. package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -182
  985. package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -234
  986. package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +0 -112
  987. package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +0 -176
  988. package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +0 -148
  989. package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +0 -196
  990. package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +0 -116
  991. package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +0 -112
  992. package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +0 -361
  993. package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +0 -651
  994. package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +0 -178
  995. package/.docs/raw/reference/observability/ai-tracing/span.mdx +0 -371
  996. package/.docs/raw/reference/observability/logging/pino-logger.mdx +0 -148
  997. package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
  998. package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
  999. package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -120
  1000. package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
  1001. package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
  1002. package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -22
  1003. package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
  1004. package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
  1005. package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
  1006. package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
  1007. package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
  1008. package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
  1009. package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
  1010. package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
  1011. package/.docs/raw/reference/processors/batch-parts-processor.mdx +0 -111
  1012. package/.docs/raw/reference/processors/language-detector.mdx +0 -154
  1013. package/.docs/raw/reference/processors/moderation-processor.mdx +0 -145
  1014. package/.docs/raw/reference/processors/pii-detector.mdx +0 -153
  1015. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +0 -130
  1016. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +0 -145
  1017. package/.docs/raw/reference/processors/token-limiter-processor.mdx +0 -136
  1018. package/.docs/raw/reference/processors/unicode-normalizer.mdx +0 -114
  1019. package/.docs/raw/reference/rag/chunk.mdx +0 -445
  1020. package/.docs/raw/reference/rag/database-config.mdx +0 -334
  1021. package/.docs/raw/reference/rag/document.mdx +0 -131
  1022. package/.docs/raw/reference/rag/embeddings.mdx +0 -168
  1023. package/.docs/raw/reference/rag/extract-params.mdx +0 -254
  1024. package/.docs/raw/reference/rag/graph-rag.mdx +0 -186
  1025. package/.docs/raw/reference/rag/metadata-filters.mdx +0 -347
  1026. package/.docs/raw/reference/rag/rerank.mdx +0 -213
  1027. package/.docs/raw/reference/rag/rerankWithScorer.mdx +0 -213
  1028. package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -209
  1029. package/.docs/raw/reference/scorers/answer-similarity.mdx +0 -423
  1030. package/.docs/raw/reference/scorers/bias.mdx +0 -225
  1031. package/.docs/raw/reference/scorers/completeness.mdx +0 -209
  1032. package/.docs/raw/reference/scorers/content-similarity.mdx +0 -195
  1033. package/.docs/raw/reference/scorers/context-precision.mdx +0 -343
  1034. package/.docs/raw/reference/scorers/context-relevance.mdx +0 -599
  1035. package/.docs/raw/reference/scorers/create-scorer.mdx +0 -495
  1036. package/.docs/raw/reference/scorers/faithfulness.mdx +0 -233
  1037. package/.docs/raw/reference/scorers/hallucination.mdx +0 -247
  1038. package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -224
  1039. package/.docs/raw/reference/scorers/mastra-scorer.mdx +0 -182
  1040. package/.docs/raw/reference/scorers/noise-sensitivity.mdx +0 -766
  1041. package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -614
  1042. package/.docs/raw/reference/scorers/run-experiment.mdx +0 -216
  1043. package/.docs/raw/reference/scorers/textual-difference.mdx +0 -204
  1044. package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -208
  1045. package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +0 -567
  1046. package/.docs/raw/reference/scorers/toxicity.mdx +0 -224
  1047. package/.docs/raw/reference/storage/cloudflare-d1.mdx +0 -104
  1048. package/.docs/raw/reference/storage/cloudflare.mdx +0 -95
  1049. package/.docs/raw/reference/storage/dynamodb.mdx +0 -196
  1050. package/.docs/raw/reference/storage/lance.mdx +0 -101
  1051. package/.docs/raw/reference/storage/libsql.mdx +0 -74
  1052. package/.docs/raw/reference/storage/mssql.mdx +0 -112
  1053. package/.docs/raw/reference/storage/postgresql.mdx +0 -305
  1054. package/.docs/raw/reference/storage/upstash.mdx +0 -91
  1055. package/.docs/raw/reference/streaming/ChunkType.mdx +0 -854
  1056. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +0 -321
  1057. package/.docs/raw/reference/streaming/agents/stream.mdx +0 -698
  1058. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +0 -515
  1059. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +0 -49
  1060. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +0 -47
  1061. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +0 -118
  1062. package/.docs/raw/reference/streaming/workflows/stream.mdx +0 -125
  1063. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +0 -144
  1064. package/.docs/raw/reference/templates/overview.mdx +0 -228
  1065. package/.docs/raw/reference/tools/client.mdx +0 -336
  1066. package/.docs/raw/reference/tools/create-tool.mdx +0 -130
  1067. package/.docs/raw/reference/tools/document-chunker-tool.mdx +0 -141
  1068. package/.docs/raw/reference/tools/graph-rag-tool.mdx +0 -262
  1069. package/.docs/raw/reference/tools/mcp-client.mdx +0 -830
  1070. package/.docs/raw/reference/tools/mcp-server.mdx +0 -1079
  1071. package/.docs/raw/reference/tools/vector-query-tool.mdx +0 -604
  1072. package/.docs/raw/reference/vectors/astra.mdx +0 -258
  1073. package/.docs/raw/reference/vectors/chroma.mdx +0 -422
  1074. package/.docs/raw/reference/vectors/couchbase.mdx +0 -345
  1075. package/.docs/raw/reference/vectors/lance.mdx +0 -451
  1076. package/.docs/raw/reference/vectors/libsql.mdx +0 -355
  1077. package/.docs/raw/reference/vectors/mongodb.mdx +0 -309
  1078. package/.docs/raw/reference/vectors/opensearch.mdx +0 -200
  1079. package/.docs/raw/reference/vectors/pg.mdx +0 -632
  1080. package/.docs/raw/reference/vectors/pinecone.mdx +0 -286
  1081. package/.docs/raw/reference/vectors/qdrant.mdx +0 -236
  1082. package/.docs/raw/reference/vectors/s3vectors.mdx +0 -386
  1083. package/.docs/raw/reference/vectors/turbopuffer.mdx +0 -249
  1084. package/.docs/raw/reference/vectors/upstash.mdx +0 -354
  1085. package/.docs/raw/reference/vectors/vectorize.mdx +0 -298
  1086. package/.docs/raw/reference/voice/azure.mdx +0 -218
  1087. package/.docs/raw/reference/voice/cloudflare.mdx +0 -154
  1088. package/.docs/raw/reference/voice/composite-voice.mdx +0 -144
  1089. package/.docs/raw/reference/voice/deepgram.mdx +0 -166
  1090. package/.docs/raw/reference/voice/elevenlabs.mdx +0 -218
  1091. package/.docs/raw/reference/voice/google-gemini-live.mdx +0 -629
  1092. package/.docs/raw/reference/voice/google.mdx +0 -203
  1093. package/.docs/raw/reference/voice/mastra-voice.mdx +0 -413
  1094. package/.docs/raw/reference/voice/murf.mdx +0 -253
  1095. package/.docs/raw/reference/voice/openai-realtime.mdx +0 -376
  1096. package/.docs/raw/reference/voice/openai.mdx +0 -169
  1097. package/.docs/raw/reference/voice/playai.mdx +0 -163
  1098. package/.docs/raw/reference/voice/sarvam.mdx +0 -260
  1099. package/.docs/raw/reference/voice/speechify.mdx +0 -147
  1100. package/.docs/raw/reference/voice/voice.addInstructions.mdx +0 -72
  1101. package/.docs/raw/reference/voice/voice.addTools.mdx +0 -83
  1102. package/.docs/raw/reference/voice/voice.answer.mdx +0 -69
  1103. package/.docs/raw/reference/voice/voice.close.mdx +0 -56
  1104. package/.docs/raw/reference/voice/voice.connect.mdx +0 -123
  1105. package/.docs/raw/reference/voice/voice.events.mdx +0 -85
  1106. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +0 -298
  1107. package/.docs/raw/reference/voice/voice.listen.mdx +0 -201
  1108. package/.docs/raw/reference/voice/voice.off.mdx +0 -74
  1109. package/.docs/raw/reference/voice/voice.on.mdx +0 -132
  1110. package/.docs/raw/reference/voice/voice.send.mdx +0 -81
  1111. package/.docs/raw/reference/voice/voice.speak.mdx +0 -206
  1112. package/.docs/raw/reference/voice/voice.updateConfig.mdx +0 -92
  1113. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +0 -58
  1114. package/.docs/raw/reference/workflows/run-methods/resume.mdx +0 -137
  1115. package/.docs/raw/reference/workflows/run-methods/start.mdx +0 -134
  1116. package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -74
  1117. package/.docs/raw/reference/workflows/run.mdx +0 -104
  1118. package/.docs/raw/reference/workflows/step.mdx +0 -155
  1119. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +0 -48
  1120. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +0 -30
  1121. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +0 -65
  1122. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +0 -52
  1123. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +0 -52
  1124. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +0 -60
  1125. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +0 -43
  1126. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +0 -43
  1127. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
  1128. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +0 -61
  1129. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +0 -61
  1130. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +0 -44
  1131. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
  1132. package/.docs/raw/reference/workflows/workflow.mdx +0 -132
  1133. package/.docs/raw/scorers/custom-scorers.mdx +0 -473
  1134. package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -26
  1135. package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
  1136. package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
  1137. package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
  1138. package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -48
  1139. package/.docs/raw/scorers/overview.mdx +0 -138
  1140. package/.docs/raw/server-db/custom-api-routes.mdx +0 -67
  1141. package/.docs/raw/server-db/local-dev-playground.mdx +0 -233
  1142. package/.docs/raw/server-db/mastra-client.mdx +0 -274
  1143. package/.docs/raw/server-db/middleware.mdx +0 -173
  1144. package/.docs/raw/server-db/production-server.mdx +0 -91
  1145. package/.docs/raw/server-db/runtime-context.mdx +0 -190
  1146. package/.docs/raw/server-db/storage.mdx +0 -514
  1147. package/.docs/raw/streaming/events.mdx +0 -223
  1148. package/.docs/raw/streaming/overview.mdx +0 -177
  1149. package/.docs/raw/streaming/tool-streaming.mdx +0 -143
  1150. package/.docs/raw/streaming/workflow-streaming.mdx +0 -124
  1151. package/.docs/raw/tools-mcp/advanced-usage.mdx +0 -128
  1152. package/.docs/raw/tools-mcp/mcp-overview.mdx +0 -370
  1153. package/.docs/raw/tools-mcp/overview.mdx +0 -93
  1154. package/.docs/raw/voice/overview.mdx +0 -944
  1155. package/.docs/raw/voice/speech-to-speech.mdx +0 -105
  1156. package/.docs/raw/voice/speech-to-text.mdx +0 -86
  1157. package/.docs/raw/voice/text-to-speech.mdx +0 -90
  1158. package/.docs/raw/workflows/control-flow.mdx +0 -265
  1159. package/.docs/raw/workflows/error-handling.mdx +0 -213
  1160. package/.docs/raw/workflows/inngest-workflow.mdx +0 -359
  1161. package/.docs/raw/workflows/input-data-mapping.mdx +0 -107
  1162. package/.docs/raw/workflows/overview.mdx +0 -277
  1163. package/.docs/raw/workflows/snapshots.mdx +0 -250
  1164. package/.docs/raw/workflows/suspend-and-resume.mdx +0 -298
  1165. package/.docs/raw/workflows/using-with-agents-and-tools.mdx +0 -350
  1166. package/.docs/raw/workflows-legacy/control-flow.mdx +0 -776
  1167. package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -237
  1168. package/.docs/raw/workflows-legacy/error-handling.mdx +0 -185
  1169. package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -354
  1170. package/.docs/raw/workflows-legacy/overview.mdx +0 -180
  1171. package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -154
  1172. package/.docs/raw/workflows-legacy/steps.mdx +0 -113
  1173. package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -404
  1174. package/.docs/raw/workflows-legacy/variables.mdx +0 -316
  1175. package/dist/chunk-TUAHUTTB.js +0 -356
  1176. package/dist/prepare-docs/code-examples.d.ts +0 -5
  1177. package/dist/prepare-docs/code-examples.d.ts.map +0 -1
  1178. package/dist/prepare-docs/copy-raw.d.ts +0 -2
  1179. package/dist/prepare-docs/copy-raw.d.ts.map +0 -1
  1180. package/dist/prepare-docs/package-changes.d.ts +0 -5
  1181. package/dist/prepare-docs/package-changes.d.ts.map +0 -1
  1182. package/dist/prepare-docs/prepare.d.ts +0 -2
  1183. package/dist/prepare-docs/prepare.d.ts.map +0 -1
  1184. package/dist/prepare-docs/prepare.js +0 -1
  1185. package/dist/tools/__tests__/test-setup.d.ts +0 -5
  1186. package/dist/tools/__tests__/test-setup.d.ts.map +0 -1
  1187. package/dist/tools/blog.d.ts +0 -22
  1188. package/dist/tools/blog.d.ts.map +0 -1
  1189. package/dist/tools/changes.d.ts +0 -22
  1190. package/dist/tools/changes.d.ts.map +0 -1
  1191. package/dist/tools/examples.d.ts +0 -28
  1192. package/dist/tools/examples.d.ts.map +0 -1
  1193. /package/.docs/{raw/course → course}/01-first-agent/01-introduction-to-mastra.md +0 -0
  1194. /package/.docs/{raw/course → course}/01-first-agent/02-what-is-mastra.md +0 -0
  1195. /package/.docs/{raw/course → course}/01-first-agent/03-verifying-installation.md +0 -0
  1196. /package/.docs/{raw/course → course}/01-first-agent/06-understanding-system-prompts.md +0 -0
  1197. /package/.docs/{raw/course → course}/01-first-agent/10-understanding-tools.md +0 -0
  1198. /package/.docs/{raw/course → course}/01-first-agent/14-understanding-memory.md +0 -0
  1199. /package/.docs/{raw/course → course}/01-first-agent/18-conclusion.md +0 -0
  1200. /package/.docs/{raw/course → course}/02-agent-tools-mcp/01-introduction-to-mcp.md +0 -0
  1201. /package/.docs/{raw/course → course}/02-agent-tools-mcp/02-installing-mcp.md +0 -0
  1202. /package/.docs/{raw/course → course}/02-agent-tools-mcp/06-testing-mcp-setup.md +0 -0
  1203. /package/.docs/{raw/course → course}/02-agent-tools-mcp/11-testing-zapier-integration.md +0 -0
  1204. /package/.docs/{raw/course → course}/02-agent-tools-mcp/17-testing-github-integration.md +0 -0
  1205. /package/.docs/{raw/course → course}/02-agent-tools-mcp/19-what-is-hackernews-mcp.md +0 -0
  1206. /package/.docs/{raw/course → course}/02-agent-tools-mcp/22-testing-hackernews-integration.md +0 -0
  1207. /package/.docs/{raw/course → course}/02-agent-tools-mcp/23-troubleshooting-hackernews.md +0 -0
  1208. /package/.docs/{raw/course → course}/02-agent-tools-mcp/24-what-is-filesystem-mcp.md +0 -0
  1209. /package/.docs/{raw/course → course}/02-agent-tools-mcp/25-creating-notes-directory.md +0 -0
  1210. /package/.docs/{raw/course → course}/02-agent-tools-mcp/28-testing-filesystem-integration.md +0 -0
  1211. /package/.docs/{raw/course → course}/02-agent-tools-mcp/29-troubleshooting-filesystem.md +0 -0
  1212. /package/.docs/{raw/course → course}/03-agent-memory/01-understanding-memory.md +0 -0
  1213. /package/.docs/{raw/course → course}/03-agent-memory/02-why-memory-matters.md +0 -0
  1214. /package/.docs/{raw/course → course}/03-agent-memory/06-testing-memory-agent.md +0 -0
  1215. /package/.docs/{raw/course → course}/03-agent-memory/11-testing-conversation-history.md +0 -0
  1216. /package/.docs/{raw/course → course}/03-agent-memory/14-what-is-semantic-recall.md +0 -0
  1217. /package/.docs/{raw/course → course}/03-agent-memory/15-how-semantic-recall-works.md +0 -0
  1218. /package/.docs/{raw/course → course}/03-agent-memory/17-testing-semantic-recall.md +0 -0
  1219. /package/.docs/{raw/course → course}/03-agent-memory/19-what-is-working-memory.md +0 -0
  1220. /package/.docs/{raw/course → course}/03-agent-memory/20-how-working-memory-works.md +0 -0
  1221. /package/.docs/{raw/course → course}/03-agent-memory/23-testing-working-memory.md +0 -0
  1222. /package/.docs/{raw/course → course}/03-agent-memory/24-working-memory-in-practice.md +0 -0
  1223. /package/.docs/{raw/course → course}/03-agent-memory/28-testing-memory-enhanced-agents.md +0 -0
  1224. /package/.docs/{raw/course → course}/03-agent-memory/29-memory-best-practices.md +0 -0
  1225. /package/.docs/{raw/course → course}/03-agent-memory/30-conclusion.md +0 -0
  1226. /package/.docs/{raw/course → course}/04-workflows/22-conclusion.md +0 -0
@@ -0,0 +1,203 @@
1
+ # OpenAI Realtime Voice
2
+
3
+ The OpenAIRealtimeVoice class provides real-time voice interaction capabilities using OpenAI's WebSocket-based API. It supports real time speech to speech, voice activity detection, and event-based audio streaming.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
9
+ import { playAudio, getMicrophoneStream } from '@mastra/node-audio'
10
+
11
+ // Initialize with default configuration using environment variables
12
+ const voice = new OpenAIRealtimeVoice()
13
+
14
+ // Or initialize with specific configuration
15
+ const voiceWithConfig = new OpenAIRealtimeVoice({
16
+ apiKey: 'your-openai-api-key',
17
+ model: 'gpt-5.1-realtime-preview-2024-12-17',
18
+ speaker: 'alloy', // Default voice
19
+ })
20
+
21
+ voiceWithConfig.updateSession({
22
+ turn_detection: {
23
+ type: 'server_vad',
24
+ threshold: 0.6,
25
+ silence_duration_ms: 1200,
26
+ },
27
+ })
28
+
29
+ // Establish connection
30
+ await voice.connect()
31
+
32
+ // Set up event listeners
33
+ voice.on('speaker', ({ audio }) => {
34
+ // Handle audio data (Int16Array) pcm format by default
35
+ playAudio(audio)
36
+ })
37
+
38
+ voice.on('writing', ({ text, role }) => {
39
+ // Handle transcribed text
40
+ console.log(`${role}: ${text}`)
41
+ })
42
+
43
+ // Convert text to speech
44
+ await voice.speak('Hello, how can I help you today?', {
45
+ speaker: 'echo', // Override default voice
46
+ })
47
+
48
+ // Process audio input
49
+ const microphoneStream = getMicrophoneStream()
50
+ await voice.send(microphoneStream)
51
+
52
+ // When done, disconnect
53
+ voice.connect()
54
+ ```
55
+
56
+ ## Configuration
57
+
58
+ ### Constructor Options
59
+
60
+ **model?:** (`string`): The model ID to use for real-time voice interactions. (Default: `'gpt-5.1-realtime-preview-2024-12-17'`)
61
+
62
+ **apiKey?:** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
63
+
64
+ **speaker?:** (`string`): Default voice ID for speech synthesis. (Default: `'alloy'`)
65
+
66
+ ### Voice Activity Detection (VAD) Configuration
67
+
68
+ **type?:** (`string`): Type of VAD to use. Server-side VAD provides better accuracy. (Default: `'server_vad'`)
69
+
70
+ **threshold?:** (`number`): Speech detection sensitivity (0.0-1.0). (Default: `0.5`)
71
+
72
+ **prefix\_padding\_ms?:** (`number`): Milliseconds of audio to include before speech is detected. (Default: `1000`)
73
+
74
+ **silence\_duration\_ms?:** (`number`): Milliseconds of silence before ending a turn. (Default: `1000`)
75
+
76
+ ## Methods
77
+
78
+ ### connect()
79
+
80
+ Establishes a connection to the OpenAI realtime service. Must be called before using speak, listen, or send functions.
81
+
82
+ **returns:** (`Promise<void>`): Promise that resolves when the connection is established.
83
+
84
+ ### speak()
85
+
86
+ Emits a speaking event using the configured voice model. Can accept either a string or a readable stream as input.
87
+
88
+ **input:** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
89
+
90
+ **options.speaker?:** (`string`): Voice ID to use for this specific speech request. (Default: `Constructor's speaker value`)
91
+
92
+ Returns: `Promise<void>`
93
+
94
+ ### listen()
95
+
96
+ Processes audio input for speech recognition. Takes a readable stream of audio data and emits a 'listening' event with the transcribed text.
97
+
98
+ **audioData:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
99
+
100
+ Returns: `Promise<void>`
101
+
102
+ ### send()
103
+
104
+ Streams audio data in real-time to the OpenAI service for continuous audio streaming scenarios like live microphone input.
105
+
106
+ **audioData:** (`NodeJS.ReadableStream`): Audio stream to send to the service.
107
+
108
+ Returns: `Promise<void>`
109
+
110
+ ### updateConfig()
111
+
112
+ Updates the session configuration for the voice instance. This can be used to modify voice settings, turn detection, and other parameters.
113
+
114
+ **sessionConfig:** (`Realtime.SessionConfig`): New session configuration to apply.
115
+
116
+ Returns: `void`
117
+
118
+ ### addTools()
119
+
120
+ Adds a set of tools to the voice instance. Tools allow the model to perform additional actions during conversations. When OpenAIRealtimeVoice is added to an Agent, any tools configured for the Agent will automatically be available to the voice interface.
121
+
122
+ **tools?:** (`ToolsInput`): Tools configuration to equip.
123
+
124
+ Returns: `void`
125
+
126
+ ### close()
127
+
128
+ Disconnects from the OpenAI realtime session and cleans up resources. Should be called when you're done with the voice instance.
129
+
130
+ Returns: `void`
131
+
132
+ ### getSpeakers()
133
+
134
+ Returns a list of available voice speakers.
135
+
136
+ Returns: `Promise<Array<{ voiceId: string; [key: string]: any }>>`
137
+
138
+ ### on()
139
+
140
+ Registers an event listener for voice events.
141
+
142
+ **event:** (`string`): Name of the event to listen for.
143
+
144
+ **callback:** (`Function`): Function to call when the event occurs.
145
+
146
+ Returns: `void`
147
+
148
+ ### off()
149
+
150
+ Removes a previously registered event listener.
151
+
152
+ **event:** (`string`): Name of the event to stop listening to.
153
+
154
+ **callback:** (`Function`): The specific callback function to remove.
155
+
156
+ Returns: `void`
157
+
158
+ ## Events
159
+
160
+ The OpenAIRealtimeVoice class emits the following events:
161
+
162
+ **speaking:** (`event`): Emitted when audio data is received from the model. Callback receives { audio: Int16Array }.
163
+
164
+ **writing:** (`event`): Emitted when transcribed text is available. Callback receives { text: string, role: string }.
165
+
166
+ **error:** (`event`): Emitted when an error occurs. Callback receives the error object.
167
+
168
+ ### OpenAI Realtime Events
169
+
170
+ You can also listen to [OpenAI Realtime utility events](https://github.com/openai/openai-realtime-api-beta#reference-client-utility-events) by prefixing with 'openAIRealtime:':
171
+
172
+ **openAIRealtime:conversation.created:** (`event`): Emitted when a new conversation is created.
173
+
174
+ **openAIRealtime:conversation.interrupted:** (`event`): Emitted when a conversation is interrupted.
175
+
176
+ **openAIRealtime:conversation.updated:** (`event`): Emitted when a conversation is updated.
177
+
178
+ **openAIRealtime:conversation.item.appended:** (`event`): Emitted when an item is appended to the conversation.
179
+
180
+ **openAIRealtime:conversation.item.completed:** (`event`): Emitted when an item in the conversation is completed.
181
+
182
+ ## Available Voices
183
+
184
+ The following voice options are available:
185
+
186
+ - `alloy`: Neutral and balanced
187
+ - `ash`: Clear and precise
188
+ - `ballad`: Melodic and smooth
189
+ - `coral`: Warm and friendly
190
+ - `echo`: Resonant and deep
191
+ - `sage`: Calm and thoughtful
192
+ - `shimmer`: Bright and energetic
193
+ - `verse`: Versatile and expressive
194
+
195
+ ## Notes
196
+
197
+ - API keys can be provided via constructor options or the `OPENAI_API_KEY` environment variable
198
+ - The OpenAI Realtime Voice API uses WebSockets for real-time communication
199
+ - Server-side Voice Activity Detection (VAD) provides better accuracy for speech detection
200
+ - All audio data is processed as Int16Array format
201
+ - The voice instance must be connected with `connect()` before using other methods
202
+ - Always call `close()` when done to properly clean up resources
203
+ - Memory management is handled by OpenAI Realtime API
@@ -0,0 +1,88 @@
1
+ # OpenAI
2
+
3
+ The OpenAIVoice class in Mastra provides text-to-speech and speech-to-text capabilities using OpenAI's models.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { OpenAIVoice } from '@mastra/voice-openai'
9
+
10
+ // Initialize with default configuration using environment variables
11
+ const voice = new OpenAIVoice()
12
+
13
+ // Or initialize with specific configuration
14
+ const voiceWithConfig = new OpenAIVoice({
15
+ speechModel: {
16
+ name: 'tts-1-hd',
17
+ apiKey: 'your-openai-api-key',
18
+ },
19
+ listeningModel: {
20
+ name: 'whisper-1',
21
+ apiKey: 'your-openai-api-key',
22
+ },
23
+ speaker: 'alloy', // Default voice
24
+ })
25
+
26
+ // Convert text to speech
27
+ const audioStream = await voice.speak('Hello, how can I help you?', {
28
+ speaker: 'nova', // Override default voice
29
+ speed: 1.2, // Adjust speech speed
30
+ })
31
+
32
+ // Convert speech to text
33
+ const text = await voice.listen(audioStream, {
34
+ filetype: 'mp3',
35
+ })
36
+ ```
37
+
38
+ ## Configuration
39
+
40
+ ### Constructor Options
41
+
42
+ **speechModel?:** (`OpenAIConfig`): Configuration for text-to-speech synthesis. (Default: `{ name: 'tts-1' }`)
43
+
44
+ **listeningModel?:** (`OpenAIConfig`): Configuration for speech-to-text recognition. (Default: `{ name: 'whisper-1' }`)
45
+
46
+ **speaker?:** (`OpenAIVoiceId`): Default voice ID for speech synthesis. (Default: `'alloy'`)
47
+
48
+ ### OpenAIConfig
49
+
50
+ **name?:** (`'tts-1' | 'tts-1-hd' | 'whisper-1'`): Model name. Use 'tts-1-hd' for higher quality audio.
51
+
52
+ **apiKey?:** (`string`): OpenAI API key. Falls back to OPENAI\_API\_KEY environment variable.
53
+
54
+ ## Methods
55
+
56
+ ### speak()
57
+
58
+ Converts text to speech using OpenAI's text-to-speech models.
59
+
60
+ **input:** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
61
+
62
+ **options.speaker?:** (`OpenAIVoiceId`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
63
+
64
+ **options.speed?:** (`number`): Speech speed multiplier. (Default: `1.0`)
65
+
66
+ Returns: `Promise<NodeJS.ReadableStream>`
67
+
68
+ ### listen()
69
+
70
+ Transcribes audio using OpenAI's Whisper model.
71
+
72
+ **audioStream:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
73
+
74
+ **options.filetype?:** (`string`): Audio format of the input stream. (Default: `'mp3'`)
75
+
76
+ Returns: `Promise<string>`
77
+
78
+ ### getSpeakers()
79
+
80
+ Returns an array of available voice options, where each node contains:
81
+
82
+ **voiceId:** (`string`): Unique identifier for the voice
83
+
84
+ ## Notes
85
+
86
+ - API keys can be provided via constructor options or the `OPENAI_API_KEY` environment variable
87
+ - The `tts-1-hd` model provides higher quality audio but may have slower processing times
88
+ - Speech recognition supports multiple audio formats including mp3, wav, and webm
@@ -0,0 +1,80 @@
1
+ # PlayAI
2
+
3
+ The PlayAI voice implementation in Mastra provides text-to-speech capabilities using PlayAI's API.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { PlayAIVoice } from '@mastra/voice-playai'
9
+
10
+ // Initialize with default configuration (uses PLAYAI_API_KEY environment variable and PLAYAI_USER_ID environment variable)
11
+ const voice = new PlayAIVoice()
12
+
13
+ // Initialize with default configuration
14
+ const voice = new PlayAIVoice({
15
+ speechModel: {
16
+ name: 'PlayDialog',
17
+ apiKey: process.env.PLAYAI_API_KEY,
18
+ userId: process.env.PLAYAI_USER_ID,
19
+ },
20
+ speaker: 'Angelo', // Default voice
21
+ })
22
+
23
+ // Convert text to speech with a specific voice
24
+ const audioStream = await voice.speak('Hello, world!', {
25
+ speaker:
26
+ 's3://voice-cloning-zero-shot/b27bc13e-996f-4841-b584-4d35801aea98/original/manifest.json', // Dexter voice
27
+ })
28
+ ```
29
+
30
+ ## Constructor Parameters
31
+
32
+ **speechModel?:** (`PlayAIConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'PlayDialog' }`)
33
+
34
+ **speaker?:** (`string`): Default voice ID to use for speech synthesis (Default: `First available voice ID`)
35
+
36
+ ### PlayAIConfig
37
+
38
+ **name?:** (`'PlayDialog' | 'Play3.0-mini'`): The PlayAI model to use (Default: `'PlayDialog'`)
39
+
40
+ **apiKey?:** (`string`): PlayAI API key. Falls back to PLAYAI\_API\_KEY environment variable
41
+
42
+ **userId?:** (`string`): PlayAI user ID. Falls back to PLAYAI\_USER\_ID environment variable
43
+
44
+ ## Methods
45
+
46
+ ### speak()
47
+
48
+ Converts text to speech using the configured speech model and voice.
49
+
50
+ **input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
51
+
52
+ **options.speaker?:** (`string`): Override the default speaker for this request (Default: `Constructor's speaker value`)
53
+
54
+ Returns: `Promise<NodeJS.ReadableStream>`.
55
+
56
+ ### getSpeakers()
57
+
58
+ Returns an array of available voice options, where each node contains:
59
+
60
+ **name:** (`string`): Name of the voice
61
+
62
+ **accent:** (`string`): Accent of the voice (e.g., 'US', 'British', 'Australian')
63
+
64
+ **gender:** (`'M' | 'F'`): Gender of the voice
65
+
66
+ **age:** (`'Young' | 'Middle' | 'Old'`): Age category of the voice
67
+
68
+ **style:** (`'Conversational' | 'Narrative'`): Speaking style of the voice
69
+
70
+ **voiceId:** (`string`): Unique identifier for the voice
71
+
72
+ ### listen()
73
+
74
+ This method is not supported by PlayAI and will throw an error. PlayAI does not provide speech-to-text functionality.
75
+
76
+ ## Notes
77
+
78
+ - PlayAI requires both an API key and a user ID for authentication
79
+ - The service offers two models: 'PlayDialog' and 'Play3.0-mini'
80
+ - Each voice has a unique S3 manifest ID that must be used when making API calls
@@ -0,0 +1,126 @@
1
+ # Sarvam
2
+
3
+ The SarvamVoice class in Mastra provides text-to-speech and speech-to-text capabilities using Sarvam AI models.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { SarvamVoice } from '@mastra/voice-sarvam'
9
+
10
+ // Initialize with default configuration using environment variables
11
+ const voice = new SarvamVoice()
12
+
13
+ // Or initialize with specific configuration
14
+ const voiceWithConfig = new SarvamVoice({
15
+ speechModel: {
16
+ model: 'bulbul:v1',
17
+ apiKey: process.env.SARVAM_API_KEY!,
18
+ language: 'en-IN',
19
+ properties: {
20
+ pitch: 0,
21
+ pace: 1.65,
22
+ loudness: 1.5,
23
+ speech_sample_rate: 8000,
24
+ enable_preprocessing: false,
25
+ eng_interpolation_wt: 123,
26
+ },
27
+ },
28
+ listeningModel: {
29
+ model: 'saarika:v2',
30
+ apiKey: process.env.SARVAM_API_KEY!,
31
+ languageCode: 'en-IN',
32
+ filetype: 'wav',
33
+ },
34
+ speaker: 'meera', // Default voice
35
+ })
36
+
37
+ // Convert text to speech
38
+ const audioStream = await voice.speak('Hello, how can I help you?')
39
+
40
+ // Convert speech to text
41
+ const text = await voice.listen(audioStream, {
42
+ filetype: 'wav',
43
+ })
44
+ ```
45
+
46
+ ### Sarvam API Docs -
47
+
48
+ <https://docs.sarvam.ai/api-reference-docs/endpoints/text-to-speech>
49
+
50
+ ## Configuration
51
+
52
+ ### Constructor Options
53
+
54
+ **speechModel?:** (`SarvamVoiceConfig`): Configuration for text-to-speech synthesis. (Default: `{ model: 'bulbul:v1', language: 'en-IN' }`)
55
+
56
+ **speaker?:** (`SarvamVoiceId`): The speaker to be used for the output audio. If not provided, Meera will be used as default. AvailableOptions - meera, pavithra, maitreyi, arvind, amol, amartya, diya, neel, misha, vian, arjun, maya (Default: `'meera'`)
57
+
58
+ **listeningModel?:** (`SarvamListenOptions`): Configuration for speech-to-text recognition. (Default: `{ model: 'saarika:v2', language_code: 'unknown' }`)
59
+
60
+ ### SarvamVoiceConfig
61
+
62
+ **apiKey?:** (`string`): Sarvam API key. Falls back to SARVAM\_API\_KEY environment variable.
63
+
64
+ **model?:** (`SarvamTTSModel`): Specifies the model to use for text-to-speech conversion. (Default: `'bulbul:v1'`)
65
+
66
+ **language:** (`SarvamTTSLanguage`): Target language for speech synthesis. Available options: hi-IN, bn-IN, kn-IN, ml-IN, mr-IN, od-IN, pa-IN, ta-IN, te-IN, en-IN, gu-IN (Default: `'en-IN'`)
67
+
68
+ **properties?:** (`object`): Additional voice properties for customization.
69
+
70
+ **properties.pitch?:** (`number`): Controls the pitch of the audio. Lower values result in a deeper voice, while higher values make it sharper. The suitable range is between -0.75 and 0.75.
71
+
72
+ **properties.pace?:** (`number`): Controls the speed of the audio. Lower values result in slower speech, while higher values make it faster. The suitable range is between 0.5 and 2.0. Default is 1.0. Required range: 0.3 <= x <= 3
73
+
74
+ **properties.loudness?:** (`number`): Controls the loudness of the audio. Lower values result in quieter audio, while higher values make it louder. The suitable range is between 0.3 and 3.0. Required range: 0 <= x <= 3
75
+
76
+ **properties.speech\_sample\_rate?:** (`8000 | 16000 | 22050`): Audio sample rate in Hz.
77
+
78
+ **properties.enable\_preprocessing?:** (`boolean`): Controls whether normalization of English words and numeric entities (e.g., numbers, dates) is performed. Set to true for better handling of mixed-language text. Default is false.
79
+
80
+ **properties.eng\_interpolation\_wt?:** (`number`): Weight for interpolating with English speaker at encoder.
81
+
82
+ ### SarvamListenOptions
83
+
84
+ **apiKey?:** (`string`): Sarvam API key. Falls back to SARVAM\_API\_KEY environment variable.
85
+
86
+ **model?:** (`SarvamSTTModel`): Specifies the model to use for speech-to-text conversion. Note:- Default model is saarika:v2 . Available options: saarika:v1, saarika:v2, saarika:flash (Default: `'saarika:v2'`)
87
+
88
+ **languageCode?:** (`SarvamSTTLanguage`): Specifies the language of the input audio. This parameter is required to ensure accurate transcription. For the saarika:v1 model, this parameter is mandatory. For the saarika:v2 model, it is optional. unknown: Use this when the language is not known; the API will detect it automatically. Note:- that the saarika:v1 model does not support unknown language code. Available options: unknown, hi-IN, bn-IN, kn-IN, ml-IN, mr-IN, od-IN, pa-IN, ta-IN, te-IN, en-IN, gu-IN (Default: `'unknown'`)
89
+
90
+ **filetype?:** (`'mp3' | 'wav'`): Audio format of the input stream.
91
+
92
+ ## Methods
93
+
94
+ ### speak()
95
+
96
+ Converts text to speech using Sarvam's text-to-speech models.
97
+
98
+ **input:** (`string | NodeJS.ReadableStream`): Text or text stream to convert to speech.
99
+
100
+ **options.speaker?:** (`SarvamVoiceId`): Voice ID to use for speech synthesis. (Default: `Constructor's speaker value`)
101
+
102
+ Returns: `Promise<NodeJS.ReadableStream>`
103
+
104
+ ### listen()
105
+
106
+ Transcribes audio using Sarvam's speech recognition models.
107
+
108
+ **input:** (`NodeJS.ReadableStream`): Audio stream to transcribe.
109
+
110
+ **options?:** (`SarvamListenOptions`): Configuration options for speech recognition.
111
+
112
+ Returns: `Promise<string>`
113
+
114
+ ### getSpeakers()
115
+
116
+ Returns an array of available voice options.
117
+
118
+ Returns: `Promise<Array<{voiceId: SarvamVoiceId}>>`
119
+
120
+ ## Notes
121
+
122
+ - API key can be provided via constructor options or the `SARVAM_API_KEY` environment variable
123
+ - If no API key is provided, the constructor will throw an error
124
+ - The service communicates with the Sarvam AI API at `https://api.sarvam.ai`
125
+ - Audio is returned as a stream containing binary audio data
126
+ - Speech recognition supports mp3 and wav audio formats
@@ -0,0 +1,75 @@
1
+ # Speechify
2
+
3
+ The Speechify voice implementation in Mastra provides text-to-speech capabilities using Speechify's API.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { SpeechifyVoice } from '@mastra/voice-speechify'
9
+
10
+ // Initialize with default configuration (uses SPEECHIFY_API_KEY environment variable)
11
+ const voice = new SpeechifyVoice()
12
+
13
+ // Initialize with custom configuration
14
+ const voice = new SpeechifyVoice({
15
+ speechModel: {
16
+ name: 'simba-english',
17
+ apiKey: 'your-api-key',
18
+ },
19
+ speaker: 'george', // Default voice
20
+ })
21
+
22
+ // Convert text to speech
23
+ const audioStream = await voice.speak('Hello, world!', {
24
+ speaker: 'henry', // Override default voice
25
+ })
26
+ ```
27
+
28
+ ## Constructor Parameters
29
+
30
+ **speechModel?:** (`SpeechifyConfig`): Configuration for text-to-speech functionality (Default: `{ name: 'simba-english' }`)
31
+
32
+ **speaker?:** (`SpeechifyVoiceId`): Default voice ID to use for speech synthesis (Default: `'george'`)
33
+
34
+ ### SpeechifyConfig
35
+
36
+ **name?:** (`VoiceModelName`): The Speechify model to use (Default: `'simba-english'`)
37
+
38
+ **apiKey?:** (`string`): Speechify API key. Falls back to SPEECHIFY\_API\_KEY environment variable
39
+
40
+ ## Methods
41
+
42
+ ### speak()
43
+
44
+ Converts text to speech using the configured speech model and voice.
45
+
46
+ **input:** (`string | NodeJS.ReadableStream`): Text to convert to speech. If a stream is provided, it will be converted to text first.
47
+
48
+ **options.speaker?:** (`string`): Override the default speaker for this request (Default: `Constructor's speaker value`)
49
+
50
+ **options.model?:** (`VoiceModelName`): Override the default model for this request (Default: `Constructor's model value`)
51
+
52
+ Returns: `Promise<NodeJS.ReadableStream>`
53
+
54
+ ### getSpeakers()
55
+
56
+ Returns an array of available voice options, where each node contains:
57
+
58
+ **voiceId:** (`string`): Unique identifier for the voice
59
+
60
+ **name:** (`string`): Display name of the voice
61
+
62
+ **language:** (`string`): Language code for the voice
63
+
64
+ **gender:** (`string`): Gender of the voice
65
+
66
+ ### listen()
67
+
68
+ This method is not supported by Speechify and will throw an error. Speechify does not provide speech-to-text functionality.
69
+
70
+ ## Notes
71
+
72
+ - Speechify requires an API key for authentication
73
+ - The default model is 'simba-english'
74
+ - Speech-to-text functionality is not supported
75
+ - Additional audio stream options can be passed through the speak() method's options parameter
@@ -0,0 +1,55 @@
1
+ # voice.addInstructions()
2
+
3
+ The `addInstructions()` method equips a voice provider with instructions that guide the model's behavior during real-time interactions. This is particularly useful for real-time voice providers that maintain context across a conversation.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
9
+ import { Agent } from '@mastra/core/agent'
10
+
11
+ // Initialize a real-time voice provider
12
+ const voice = new OpenAIRealtimeVoice({
13
+ realtimeConfig: {
14
+ model: 'gpt-5.1-realtime',
15
+ apiKey: process.env.OPENAI_API_KEY,
16
+ },
17
+ })
18
+
19
+ // Create an agent with the voice provider
20
+ const agent = new Agent({
21
+ name: 'Customer Support Agent',
22
+ instructions: 'You are a helpful customer support agent for a software company.',
23
+ model: 'openai/gpt-5.1',
24
+ voice,
25
+ })
26
+
27
+ // Add additional instructions to the voice provider
28
+ voice.addInstructions(`
29
+ When speaking to customers:
30
+ - Always introduce yourself as the customer support agent
31
+ - Speak clearly and concisely
32
+ - Ask clarifying questions when needed
33
+ - Summarize the conversation at the end
34
+ `)
35
+
36
+ // Connect to the real-time service
37
+ await voice.connect()
38
+ ```
39
+
40
+ ## Parameters
41
+
42
+ **instructions:** (`string`): Instructions to guide the voice model's behavior
43
+
44
+ ## Return Value
45
+
46
+ This method does not return a value.
47
+
48
+ ## Notes
49
+
50
+ - Instructions are most effective when they are clear, specific, and relevant to the voice interaction
51
+ - This method is primarily used with real-time voice providers that maintain conversation context
52
+ - If called on a voice provider that doesn't support instructions, it will log a warning and do nothing
53
+ - Instructions added with this method are typically combined with any instructions provided by an associated Agent
54
+ - For best results, add instructions before starting a conversation (before calling `connect()`)
55
+ - Multiple calls to `addInstructions()` may either replace or append to existing instructions, depending on the provider implementation
@@ -0,0 +1,67 @@
1
+ # voice.addTools()
2
+
3
+ The `addTools()` method equips a voice provider with tools (functions) that can be called by the model during real-time interactions. This enables voice assistants to perform actions like searching for information, making calculations, or interacting with external systems.
4
+
5
+ ## Usage Example
6
+
7
+ ```typescript
8
+ import { OpenAIRealtimeVoice } from '@mastra/voice-openai-realtime'
9
+ import { createTool } from '@mastra/core/tools'
10
+ import { z } from 'zod'
11
+
12
+ // Define tools
13
+ const weatherTool = createTool({
14
+ id: 'getWeather',
15
+ description: 'Get the current weather for a location',
16
+ inputSchema: z.object({
17
+ location: z.string().describe('The city and state, e.g. San Francisco, CA'),
18
+ }),
19
+ outputSchema: z.object({
20
+ message: z.string(),
21
+ }),
22
+ execute: async inputData => {
23
+ // Fetch weather data from an API
24
+ const response = await fetch(
25
+ `https://api.weather.com?location=${encodeURIComponent(inputData.location)}`,
26
+ )
27
+ const data = await response.json()
28
+ return {
29
+ message: `The current temperature in ${inputData.location} is ${data.temperature}°F with ${data.conditions}.`,
30
+ }
31
+ },
32
+ })
33
+
34
+ // Initialize a real-time voice provider
35
+ const voice = new OpenAIRealtimeVoice({
36
+ realtimeConfig: {
37
+ model: 'gpt-5.1-realtime',
38
+ apiKey: process.env.OPENAI_API_KEY,
39
+ },
40
+ })
41
+
42
+ // Add tools to the voice provider
43
+ voice.addTools({
44
+ getWeather: weatherTool,
45
+ })
46
+
47
+ // Connect to the real-time service
48
+ await voice.connect()
49
+ ```
50
+
51
+ ## Parameters
52
+
53
+ **tools:** (`ToolsInput`): Object containing tool definitions that can be called by the voice model
54
+
55
+ ## Return Value
56
+
57
+ This method does not return a value.
58
+
59
+ ## Notes
60
+
61
+ - Tools must follow the Mastra tool format with name, description, input schema, and execute function
62
+ - This method is primarily used with real-time voice providers that support function calling
63
+ - If called on a voice provider that doesn't support tools, it will log a warning and do nothing
64
+ - Tools added with this method are typically combined with any tools provided by an associated Agent
65
+ - For best results, add tools before starting a conversation (before calling `connect()`)
66
+ - The voice provider will automatically handle the invocation of tool handlers when the model decides to use them
67
+ - Multiple calls to `addTools()` may either replace or merge with existing tools, depending on the provider implementation