@mastra/mcp-docs-server 1.0.0-beta.1 → 1.0.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (397) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +9 -9
  2. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +35 -35
  3. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +11 -11
  4. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +17 -17
  5. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +11 -11
  6. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +11 -11
  7. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +14 -0
  8. package/.docs/organized/changelogs/%40mastra%2Fcore.md +172 -172
  9. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +10 -10
  10. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +20 -20
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +11 -11
  12. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +11 -11
  13. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +34 -34
  14. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +14 -14
  15. package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
  16. package/.docs/organized/changelogs/%40mastra%2Flance.md +14 -14
  17. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
  18. package/.docs/organized/changelogs/%40mastra%2Floggers.md +10 -10
  19. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +27 -27
  20. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +23 -23
  21. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +10 -10
  22. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +11 -11
  23. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +26 -26
  24. package/.docs/organized/changelogs/%40mastra%2Fpg.md +11 -11
  25. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +11 -11
  26. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +48 -48
  27. package/.docs/organized/changelogs/%40mastra%2Frag.md +11 -11
  28. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  29. package/.docs/organized/changelogs/%40mastra%2Fserver.md +17 -17
  30. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +14 -14
  31. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +12 -12
  32. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
  33. package/.docs/organized/changelogs/create-mastra.md +15 -15
  34. package/.docs/organized/changelogs/mastra.md +37 -37
  35. package/.docs/organized/code-examples/ai-elements.md +1 -1
  36. package/.docs/organized/code-examples/ai-sdk-useChat.md +1 -1
  37. package/.docs/organized/code-examples/ai-sdk-v5.md +1 -1
  38. package/.docs/organized/code-examples/assistant-ui.md +1 -1
  39. package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
  40. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +1 -1
  41. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +1 -1
  42. package/.docs/organized/code-examples/client-side-tools.md +1 -1
  43. package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
  44. package/.docs/organized/code-examples/fireworks-r1.md +1 -1
  45. package/.docs/organized/code-examples/heads-up-game.md +1 -1
  46. package/.docs/organized/code-examples/mcp-configuration.md +0 -3
  47. package/.docs/organized/code-examples/memory-per-resource-example.md +1 -1
  48. package/.docs/organized/code-examples/openapi-spec-writer.md +1 -1
  49. package/.docs/organized/code-examples/quick-start.md +1 -1
  50. package/.docs/organized/code-examples/stock-price-tool.md +1 -21
  51. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  52. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  53. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  54. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  55. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
  56. package/.docs/raw/agents/adding-voice.mdx +1 -1
  57. package/.docs/raw/agents/agent-memory.mdx +1 -1
  58. package/.docs/raw/agents/guardrails.mdx +1 -1
  59. package/.docs/raw/agents/human-in-the-loop-with-tools.mdx +90 -0
  60. package/.docs/raw/agents/networks.mdx +1 -1
  61. package/.docs/raw/agents/overview.mdx +8 -13
  62. package/.docs/raw/agents/using-tools.mdx +10 -9
  63. package/.docs/raw/auth/auth0.mdx +1 -1
  64. package/.docs/raw/auth/clerk.mdx +1 -1
  65. package/.docs/raw/auth/firebase.mdx +1 -1
  66. package/.docs/raw/auth/index.mdx +1 -1
  67. package/.docs/raw/auth/jwt.mdx +1 -1
  68. package/.docs/raw/auth/supabase.mdx +1 -1
  69. package/.docs/raw/auth/workos.mdx +1 -1
  70. package/.docs/raw/community/contributing-templates.mdx +1 -1
  71. package/.docs/raw/community/discord.mdx +2 -2
  72. package/.docs/raw/community/licensing.mdx +1 -1
  73. package/.docs/raw/deployment/{server-deployment.mdx → building-mastra.mdx} +4 -4
  74. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +2 -2
  75. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +3 -3
  76. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +2 -2
  77. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/cloudflare-deployer.mdx +1 -1
  78. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +2 -2
  79. package/.docs/raw/deployment/cloud-providers/index.mdx +8 -4
  80. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/netlify-deployer.mdx +1 -1
  81. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/vercel-deployer.mdx +1 -1
  82. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/dashboard.mdx +3 -3
  83. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/observability.mdx +2 -2
  84. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/overview.mdx +3 -3
  85. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/setting-up.mdx +4 -4
  86. package/.docs/raw/deployment/monorepo.mdx +3 -3
  87. package/.docs/raw/deployment/overview.mdx +5 -5
  88. package/.docs/raw/deployment/web-framework.mdx +1 -1
  89. package/.docs/raw/evals/{off-the-shelf-scorers.mdx → built-in-scorers.mdx} +17 -15
  90. package/.docs/raw/evals/custom-scorers.mdx +1 -1
  91. package/.docs/raw/evals/overview.mdx +3 -3
  92. package/.docs/raw/evals/running-in-ci.mdx +2 -2
  93. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +15 -128
  94. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +71 -19
  95. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +8 -29
  96. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +91 -267
  97. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -3
  98. package/.docs/raw/frameworks/servers/express.mdx +1 -1
  99. package/.docs/raw/frameworks/web-frameworks/astro.mdx +1 -1
  100. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +1 -1
  101. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +1 -1
  102. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +1 -1
  103. package/.docs/raw/getting-started/mcp-docs-server.mdx +6 -6
  104. package/.docs/raw/getting-started/project-structure.mdx +1 -1
  105. package/.docs/raw/getting-started/quickstart.mdx +27 -0
  106. package/.docs/raw/getting-started/studio.mdx +3 -3
  107. package/.docs/raw/getting-started/templates.mdx +1 -1
  108. package/.docs/raw/guides/guide/ai-recruiter.mdx +1 -1
  109. package/.docs/raw/guides/guide/chef-michel.mdx +1 -1
  110. package/.docs/raw/{getting-started/installation.mdx → guides/guide/manual-install.mdx} +6 -80
  111. package/.docs/raw/guides/guide/notes-mcp-server.mdx +2 -2
  112. package/.docs/raw/guides/guide/research-assistant.mdx +2 -2
  113. package/.docs/raw/guides/guide/stock-agent.mdx +1 -1
  114. package/.docs/raw/guides/guide/web-search.mdx +1 -1
  115. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +119 -0
  116. package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +11 -1
  117. package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +42 -2
  118. package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +31 -1
  119. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +27 -3
  120. package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +1 -1
  121. package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +28 -0
  122. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +25 -3
  123. package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +80 -0
  124. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +60 -0
  125. package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +25 -1
  126. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +43 -1
  127. package/.docs/raw/guides/quickstarts/nextjs.mdx +18 -17
  128. package/.docs/raw/guides/quickstarts/standalone-server.mdx +86 -0
  129. package/.docs/raw/index.mdx +3 -3
  130. package/.docs/raw/logging.mdx +7 -7
  131. package/.docs/raw/mcp/overview.mdx +360 -0
  132. package/.docs/raw/mcp/publishing-mcp-server.mdx +139 -0
  133. package/.docs/raw/memory/conversation-history.mdx +1 -1
  134. package/.docs/raw/memory/memory-processors.mdx +1 -1
  135. package/.docs/raw/memory/overview.mdx +2 -2
  136. package/.docs/raw/memory/semantic-recall.mdx +2 -2
  137. package/.docs/raw/memory/storage/memory-with-libsql.mdx +1 -4
  138. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +152 -0
  139. package/.docs/raw/memory/storage/memory-with-pg.mdx +1 -4
  140. package/.docs/raw/memory/storage/memory-with-upstash.mdx +1 -4
  141. package/.docs/raw/memory/threads-and-resources.mdx +1 -1
  142. package/.docs/raw/memory/working-memory.mdx +1 -1
  143. package/.docs/raw/observability/overview.mdx +2 -2
  144. package/.docs/raw/observability/tracing/exporters/arize.mdx +1 -1
  145. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +1 -1
  146. package/.docs/raw/observability/tracing/exporters/cloud.mdx +2 -2
  147. package/.docs/raw/observability/tracing/exporters/default.mdx +1 -1
  148. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -1
  149. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +1 -1
  150. package/.docs/raw/observability/tracing/exporters/otel.mdx +1 -1
  151. package/.docs/raw/observability/tracing/overview.mdx +2 -2
  152. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +2 -2
  153. package/.docs/raw/rag/overview.mdx +1 -1
  154. package/.docs/raw/rag/retrieval.mdx +1 -1
  155. package/.docs/raw/rag/vector-databases.mdx +1 -1
  156. package/.docs/raw/reference/agents/agent.mdx +1 -2
  157. package/.docs/raw/reference/agents/generate.mdx +1 -1
  158. package/.docs/raw/reference/agents/generateLegacy.mdx +1 -1
  159. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +1 -1
  160. package/.docs/raw/reference/agents/getDefaultOptions.mdx +1 -1
  161. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +1 -1
  162. package/.docs/raw/reference/agents/getDescription.mdx +1 -1
  163. package/.docs/raw/reference/agents/getInstructions.mdx +1 -1
  164. package/.docs/raw/reference/agents/getLLM.mdx +1 -1
  165. package/.docs/raw/reference/agents/getMemory.mdx +1 -1
  166. package/.docs/raw/reference/agents/getModel.mdx +1 -1
  167. package/.docs/raw/reference/agents/getTools.mdx +69 -0
  168. package/.docs/raw/reference/agents/getVoice.mdx +1 -1
  169. package/.docs/raw/reference/agents/listAgents.mdx +1 -1
  170. package/.docs/raw/reference/agents/listScorers.mdx +1 -1
  171. package/.docs/raw/reference/agents/listTools.mdx +2 -2
  172. package/.docs/raw/reference/agents/listWorkflows.mdx +1 -1
  173. package/.docs/raw/reference/agents/network.mdx +1 -1
  174. package/.docs/raw/reference/auth/auth0.mdx +1 -1
  175. package/.docs/raw/reference/auth/clerk.mdx +1 -1
  176. package/.docs/raw/reference/auth/firebase.mdx +1 -1
  177. package/.docs/raw/reference/auth/jwt.mdx +1 -1
  178. package/.docs/raw/reference/auth/supabase.mdx +1 -1
  179. package/.docs/raw/reference/auth/workos.mdx +1 -1
  180. package/.docs/raw/reference/cli/create-mastra.mdx +1 -1
  181. package/.docs/raw/reference/cli/mastra.mdx +4 -4
  182. package/.docs/raw/reference/client-js/agents.mdx +1 -1
  183. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  184. package/.docs/raw/reference/client-js/logs.mdx +1 -1
  185. package/.docs/raw/reference/client-js/mastra-client.mdx +2 -2
  186. package/.docs/raw/reference/client-js/memory.mdx +1 -1
  187. package/.docs/raw/reference/client-js/observability.mdx +1 -1
  188. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  189. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  190. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  191. package/.docs/raw/reference/client-js/workflows.mdx +1 -1
  192. package/.docs/raw/reference/core/addGateway.mdx +59 -0
  193. package/.docs/raw/reference/core/getAgent.mdx +1 -1
  194. package/.docs/raw/reference/core/getAgentById.mdx +1 -1
  195. package/.docs/raw/reference/core/getDeployer.mdx +1 -1
  196. package/.docs/raw/reference/core/getGateway.mdx +59 -0
  197. package/.docs/raw/reference/core/getGatewayById.mdx +62 -0
  198. package/.docs/raw/reference/core/getLogger.mdx +1 -1
  199. package/.docs/raw/reference/core/getMCPServer.mdx +2 -2
  200. package/.docs/raw/reference/core/getMCPServerById.mdx +2 -2
  201. package/.docs/raw/reference/core/getScorer.mdx +1 -1
  202. package/.docs/raw/reference/core/getScorerById.mdx +1 -1
  203. package/.docs/raw/reference/core/getServer.mdx +2 -2
  204. package/.docs/raw/reference/core/getStorage.mdx +1 -1
  205. package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
  206. package/.docs/raw/reference/core/getVector.mdx +1 -1
  207. package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
  208. package/.docs/raw/reference/core/listAgents.mdx +1 -1
  209. package/.docs/raw/reference/core/listGateways.mdx +53 -0
  210. package/.docs/raw/reference/core/listLogs.mdx +1 -1
  211. package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
  212. package/.docs/raw/reference/core/listMCPServers.mdx +2 -2
  213. package/.docs/raw/reference/core/listScorers.mdx +1 -1
  214. package/.docs/raw/reference/core/listVectors.mdx +1 -1
  215. package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
  216. package/.docs/raw/reference/core/mastra-class.mdx +9 -1
  217. package/.docs/raw/reference/core/mastra-model-gateway.mdx +241 -0
  218. package/.docs/raw/reference/core/setLogger.mdx +1 -1
  219. package/.docs/raw/reference/core/setStorage.mdx +1 -1
  220. package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
  221. package/.docs/raw/reference/deployer/cloudflare.mdx +1 -1
  222. package/.docs/raw/reference/deployer/deployer.mdx +1 -1
  223. package/.docs/raw/reference/deployer/netlify.mdx +1 -1
  224. package/.docs/raw/reference/deployer/vercel.mdx +1 -1
  225. package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
  226. package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
  227. package/.docs/raw/reference/evals/bias.mdx +1 -1
  228. package/.docs/raw/reference/evals/completeness.mdx +1 -1
  229. package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
  230. package/.docs/raw/reference/evals/context-precision.mdx +1 -1
  231. package/.docs/raw/reference/evals/context-relevance.mdx +1 -1
  232. package/.docs/raw/reference/evals/create-scorer.mdx +1 -1
  233. package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
  234. package/.docs/raw/reference/evals/hallucination.mdx +1 -1
  235. package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
  236. package/.docs/raw/reference/evals/mastra-scorer.mdx +1 -1
  237. package/.docs/raw/reference/evals/noise-sensitivity.mdx +1 -1
  238. package/.docs/raw/reference/evals/prompt-alignment.mdx +1 -1
  239. package/.docs/raw/reference/evals/run-evals.mdx +1 -1
  240. package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
  241. package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
  242. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +1 -1
  243. package/.docs/raw/reference/evals/toxicity.mdx +1 -1
  244. package/.docs/raw/reference/logging/pino-logger.mdx +2 -2
  245. package/.docs/raw/reference/memory/createThread.mdx +1 -1
  246. package/.docs/raw/reference/memory/deleteMessages.mdx +1 -1
  247. package/.docs/raw/reference/memory/getThreadById.mdx +1 -1
  248. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +1 -1
  249. package/.docs/raw/reference/memory/memory-class.mdx +1 -1
  250. package/.docs/raw/reference/memory/query.mdx +1 -1
  251. package/.docs/raw/reference/memory/recall.mdx +1 -1
  252. package/.docs/raw/reference/observability/tracing/configuration.mdx +2 -2
  253. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +1 -1
  254. package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +1 -1
  255. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +1 -1
  256. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +1 -1
  257. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +1 -1
  258. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
  259. package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +1 -1
  260. package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +1 -1
  261. package/.docs/raw/reference/observability/tracing/instances.mdx +2 -2
  262. package/.docs/raw/reference/observability/tracing/interfaces.mdx +2 -2
  263. package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +1 -1
  264. package/.docs/raw/reference/observability/tracing/spans.mdx +2 -2
  265. package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
  266. package/.docs/raw/reference/processors/language-detector.mdx +1 -1
  267. package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
  268. package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
  269. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
  270. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
  271. package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
  272. package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
  273. package/.docs/raw/reference/rag/chunk.mdx +1 -1
  274. package/.docs/raw/reference/rag/database-config.mdx +1 -1
  275. package/.docs/raw/reference/rag/document.mdx +1 -1
  276. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  277. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  278. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  279. package/.docs/raw/reference/rag/metadata-filters.mdx +1 -1
  280. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  281. package/.docs/raw/reference/rag/rerankWithScorer.mdx +1 -1
  282. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  283. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  284. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  285. package/.docs/raw/reference/storage/lance.mdx +1 -1
  286. package/.docs/raw/reference/storage/libsql.mdx +1 -1
  287. package/.docs/raw/reference/storage/mongodb.mdx +1 -1
  288. package/.docs/raw/reference/storage/mssql.mdx +1 -1
  289. package/.docs/raw/reference/storage/postgresql.mdx +1 -1
  290. package/.docs/raw/reference/storage/upstash.mdx +1 -1
  291. package/.docs/raw/reference/streaming/ChunkType.mdx +1 -1
  292. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +1 -1
  293. package/.docs/raw/reference/streaming/agents/stream.mdx +1 -1
  294. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +1 -1
  295. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
  296. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +1 -1
  297. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +1 -1
  298. package/.docs/raw/reference/streaming/workflows/stream.mdx +1 -1
  299. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +1 -1
  300. package/.docs/raw/reference/templates/overview.mdx +1 -1
  301. package/.docs/raw/reference/tools/client.mdx +1 -1
  302. package/.docs/raw/reference/tools/create-tool.mdx +3 -4
  303. package/.docs/raw/reference/tools/document-chunker-tool.mdx +1 -1
  304. package/.docs/raw/reference/tools/graph-rag-tool.mdx +2 -2
  305. package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
  306. package/.docs/raw/reference/tools/mcp-server.mdx +55 -6
  307. package/.docs/raw/reference/tools/vector-query-tool.mdx +2 -2
  308. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  309. package/.docs/raw/reference/vectors/chroma.mdx +1 -1
  310. package/.docs/raw/reference/vectors/couchbase.mdx +1 -1
  311. package/.docs/raw/reference/vectors/lance.mdx +1 -1
  312. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  313. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  314. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  315. package/.docs/raw/reference/vectors/pg.mdx +1 -1
  316. package/.docs/raw/reference/vectors/pinecone.mdx +22 -2
  317. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  318. package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
  319. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  320. package/.docs/raw/reference/vectors/upstash.mdx +1 -1
  321. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  322. package/.docs/raw/reference/voice/azure.mdx +96 -81
  323. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  324. package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
  325. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  326. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  327. package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
  328. package/.docs/raw/reference/voice/google.mdx +1 -1
  329. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  330. package/.docs/raw/reference/voice/murf.mdx +1 -1
  331. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  332. package/.docs/raw/reference/voice/openai.mdx +1 -1
  333. package/.docs/raw/reference/voice/playai.mdx +1 -1
  334. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  335. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  336. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  337. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  338. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  339. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  340. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  341. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  342. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +1 -1
  343. package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
  344. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  345. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  346. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  347. package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
  348. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  349. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +1 -1
  350. package/.docs/raw/reference/workflows/run-methods/resume.mdx +1 -1
  351. package/.docs/raw/reference/workflows/run-methods/start.mdx +1 -1
  352. package/.docs/raw/reference/workflows/run.mdx +1 -1
  353. package/.docs/raw/reference/workflows/step.mdx +1 -1
  354. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
  355. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  356. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +1 -1
  357. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
  358. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
  359. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  360. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +1 -1
  361. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  362. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +1 -1
  363. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
  364. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
  365. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  366. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
  367. package/.docs/raw/reference/workflows/workflow.mdx +2 -2
  368. package/.docs/raw/server-db/custom-api-routes.mdx +1 -1
  369. package/.docs/raw/server-db/mastra-client.mdx +2 -2
  370. package/.docs/raw/server-db/{production-server.mdx → mastra-server.mdx} +2 -2
  371. package/.docs/raw/server-db/middleware.mdx +31 -31
  372. package/.docs/raw/server-db/request-context.mdx +3 -3
  373. package/.docs/raw/server-db/storage.mdx +1 -1
  374. package/.docs/raw/streaming/events.mdx +1 -1
  375. package/.docs/raw/streaming/overview.mdx +1 -1
  376. package/.docs/raw/streaming/tool-streaming.mdx +1 -1
  377. package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
  378. package/.docs/raw/tools-mcp/advanced-usage.mdx +1 -1
  379. package/.docs/raw/tools-mcp/mcp-overview.mdx +1 -1
  380. package/.docs/raw/tools-mcp/overview.mdx +1 -1
  381. package/.docs/raw/voice/overview.mdx +1 -1
  382. package/.docs/raw/voice/speech-to-speech.mdx +1 -1
  383. package/.docs/raw/voice/speech-to-text.mdx +1 -1
  384. package/.docs/raw/voice/text-to-speech.mdx +1 -1
  385. package/.docs/raw/workflows/agents-and-tools.mdx +2 -4
  386. package/.docs/raw/workflows/control-flow.mdx +6 -1
  387. package/.docs/raw/workflows/error-handling.mdx +4 -4
  388. package/.docs/raw/workflows/human-in-the-loop.mdx +160 -213
  389. package/.docs/raw/workflows/inngest-workflow.mdx +1 -1
  390. package/.docs/raw/workflows/input-data-mapping.mdx +1 -1
  391. package/.docs/raw/workflows/overview.mdx +10 -2
  392. package/.docs/raw/workflows/snapshots.mdx +4 -3
  393. package/.docs/raw/workflows/suspend-and-resume.mdx +72 -224
  394. package/CHANGELOG.md +26 -0
  395. package/dist/stdio.js +16 -18
  396. package/package.json +10 -14
  397. package/.docs/raw/deployment/serverless-platforms/index.mdx +0 -58
@@ -0,0 +1,152 @@
1
+ ---
2
+ title: "Example: Memory with MongoDB | Memory"
3
+ description: Example for how to use Mastra's memory system with MongoDB storage and vector capabilities.
4
+ ---
5
+
6
+ # Memory with MongoDB
7
+
8
+ This example demonstrates how to use Mastra's memory system with MongoDB as the storage backend.
9
+
10
+ ## Prerequisites
11
+
12
+ This example uses the `openai` model and requires a MongoDB database. Make sure to add the following to your `.env` file:
13
+
14
+ ```bash title=".env" copy
15
+ OPENAI_API_KEY=<your-api-key>
16
+ MONGODB_URI=<your-connection-string>
17
+ MONGODB_DB_NAME=<your-db-name>
18
+ ```
19
+
20
+ And install the following package:
21
+
22
+ ```bash copy
23
+ npm install @mastra/mongodb@beta
24
+ ```
25
+
26
+ ## Adding memory to an agent
27
+
28
+ To add MongoDB memory to an agent use the `Memory` class and create a new `storage` key using `MongoDBStore`. The configuration supports both local and remote MongoDB instances.
29
+
30
+ ```typescript title="src/mastra/agents/example-mongodb-agent.ts" showLineNumbers copy
31
+ import { Memory } from "@mastra/memory";
32
+ import { Agent } from "@mastra/core/agent";
33
+ import { openai } from "@ai-sdk/openai";
34
+ import { MongoDBStore } from "@mastra/mongodb";
35
+
36
+ export const mongodbAgent = new Agent({
37
+ id: "mongodb-agent",
38
+ name: "mongodb-agent",
39
+ instructions:
40
+ "You are an AI agent with the ability to automatically recall memories from previous interactions.",
41
+ model: openai("gpt-4o"),
42
+ memory: new Memory({
43
+ storage: new MongoDBStore({
44
+ url: process.env.MONGODB_URI!,
45
+ dbName: process.env.MONGODB_DB_NAME!,
46
+ }),
47
+ options: {
48
+ threads: {
49
+ generateTitle: true,
50
+ },
51
+ },
52
+ }),
53
+ });
54
+ ```
55
+
56
+ ## Vector embeddings with MongoDB
57
+
58
+ Embeddings are numeric vectors used by memory's `semanticRecall` to retrieve related messages by meaning (not keywords).
59
+
60
+ > Note: You must use a deployment hosted on MongoDB Atlas to successfully use the MongoDB Vector database.
61
+
62
+ This setup uses FastEmbed, a local embedding model, to generate vector embeddings.
63
+ To use this, install `@mastra/fastembed`:
64
+
65
+ ```bash copy
66
+ npm install @mastra/fastembed@beta
67
+ ```
68
+
69
+ Add the following to your agent:
70
+
71
+ ```typescript title="src/mastra/agents/example-mongodb-agent.ts" showLineNumbers copy
72
+ import { Memory } from "@mastra/memory";
73
+ import { Agent } from "@mastra/core/agent";
74
+ import { openai } from "@ai-sdk/openai";
75
+ import { MongoDBStore, MongoDBVector } from "@mastra/mongodb";
76
+ import { fastembed } from "@mastra/fastembed";
77
+
78
+ export const mongodbAgent = new Agent({
79
+ id: "mongodb-agent",
80
+ name: "mongodb-agent",
81
+ instructions:
82
+ "You are an AI agent with the ability to automatically recall memories from previous interactions.",
83
+ model: openai("gpt-4o"),
84
+ memory: new Memory({
85
+ storage: new MongoDBStore({
86
+ url: process.env.MONGODB_URI!,
87
+ dbName: process.env.MONGODB_DB_NAME!,
88
+ }),
89
+ vector: new MongoDBVector({
90
+ uri: process.env.MONGODB_URI!,
91
+ dbName: process.env.MONGODB_DB_NAME!,
92
+ }),
93
+ embedder: fastembed,
94
+ options: {
95
+ lastMessages: 10,
96
+ semanticRecall: {
97
+ topK: 3,
98
+ messageRange: 2,
99
+ },
100
+ threads: {
101
+ generateTitle: true, // generates descriptive thread titles automatically
102
+ },
103
+ },
104
+ }),
105
+ });
106
+ ```
107
+
108
+ ## Usage example
109
+
110
+ Use `memoryOptions` to scope recall for this request. Set `lastMessages: 5` to limit recency-based recall, and use `semanticRecall` to fetch the `topK: 3` most relevant messages, including `messageRange: 2` neighboring messages for context around each match.
111
+
112
+ ```typescript title="src/test-mongodb-agent.ts" showLineNumbers copy
113
+ import "dotenv/config";
114
+
115
+ import { mastra } from "./mastra";
116
+
117
+ const threadId = "123";
118
+ const resourceId = "user-456";
119
+
120
+ const agent = mastra.getAgent("mongodbAgent");
121
+
122
+ const message = await agent.stream("My name is Mastra", {
123
+ memory: {
124
+ thread: threadId,
125
+ resource: resourceId,
126
+ },
127
+ });
128
+
129
+ await message.textStream.pipeTo(new WritableStream());
130
+
131
+ const stream = await agent.stream("What's my name?", {
132
+ memory: {
133
+ thread: threadId,
134
+ resource: resourceId,
135
+ },
136
+ memoryOptions: {
137
+ lastMessages: 5,
138
+ semanticRecall: {
139
+ topK: 3,
140
+ messageRange: 2,
141
+ },
142
+ },
143
+ });
144
+
145
+ for await (const chunk of stream.textStream) {
146
+ process.stdout.write(chunk);
147
+ }
148
+ ```
149
+
150
+ ## Related
151
+
152
+ - [Calling Agents](/docs/v1/agents/overview)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Memory with Postgres | Memory | Mastra Docs"
2
+ title: "Memory with Postgres | Memory"
3
3
  description: Example for how to use Mastra's memory system with PostgreSQL storage and vector capabilities.
4
4
  ---
5
5
 
@@ -138,6 +138,3 @@ for await (const chunk of stream.textStream) {
138
138
  }
139
139
  ```
140
140
 
141
- ## Related
142
-
143
- - [Calling Agents](/examples/v1/agents/calling-agents)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Memory with Upstash | Memory | Mastra Docs"
2
+ title: "Memory with Upstash | Memory"
3
3
  description: Example for how to use Mastra's memory system with Upstash Redis storage and vector capabilities.
4
4
  ---
5
5
 
@@ -146,6 +146,3 @@ for await (const chunk of stream.textStream) {
146
146
  }
147
147
  ```
148
148
 
149
- ## Related
150
-
151
- - [Calling Agents](/examples/v1/agents/calling-agents)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Memory threads and resources | Memory | Mastra Docs"
2
+ title: "Memory threads and resources | Memory"
3
3
  description: "Learn how Mastra's memory system works with working memory, conversation history, and semantic recall."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Working Memory | Memory | Mastra Docs"
2
+ title: "Working Memory | Memory"
3
3
  description: "Learn how to configure working memory in Mastra to store persistent user data, preferences."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Observability Overview | Observability | Mastra Docs"
2
+ title: "Observability Overview | Observability"
3
3
  description: Monitor and debug applications with Mastra's Observability features.
4
4
  ---
5
5
 
@@ -49,5 +49,5 @@ We also support various external tracing providers like Langfuse, Braintrust, an
49
49
 
50
50
  - **[Set up Tracing](/docs/v1/observability/tracing/overview)**: Configure tracing for your application
51
51
  - **[Configure Logging](/docs/v1/logging)**: Add structured logging
52
- - **[View Examples](/examples/v1/observability/basic-tracing)**: See observability in action
52
+ - **[View Examples](/examples/v1/observability/basic-ai-tracing)**: See observability in action
53
53
  - **[API Reference](/reference/v1/observability/tracing/instances)**: Detailed configuration options
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Arize Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "Arize Exporter | Tracing | Observability"
3
3
  description: "Send traces to Arize Phoenix or Arize AX using OpenTelemetry and OpenInference"
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Braintrust Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "Braintrust Exporter | Tracing | Observability"
3
3
  description: "Send traces to Braintrust for evaluation and monitoring"
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Cloud Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "Cloud Exporter | Tracing | Observability"
3
3
  description: "Send traces to Mastra Cloud for production monitoring"
4
4
  ---
5
5
 
@@ -112,4 +112,4 @@ CloudExporter uses intelligent batching to optimize network usage. Traces are bu
112
112
 
113
113
  - [Tracing Overview](/docs/v1/observability/tracing/overview)
114
114
  - [DefaultExporter](/docs/v1/observability/tracing/exporters/default)
115
- - [Mastra Cloud Documentation](https://cloud.mastra.ai/docs)
115
+ - [Mastra Cloud Documentation](/docs/v1/deployment/mastra-cloud/overview)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Default Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "Default Exporter | Tracing | Observability"
3
3
  description: "Store traces locally for development and debugging"
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Langfuse Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "Langfuse Exporter | Tracing | Observability"
3
3
  description: "Send traces to Langfuse for LLM observability and analytics"
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "LangSmith Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "LangSmith Exporter | Tracing | Observability"
3
3
  description: "Send traces to LangSmith for LLM observability and evaluation"
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "OpenTelemetry Exporter | Tracing | Observability | Mastra Docs"
2
+ title: "OpenTelemetry Exporter | Tracing | Observability"
3
3
  description: "Send traces to any OpenTelemetry-compatible observability platform"
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Tracing | Observability | Mastra Docs"
2
+ title: "Tracing | Observability"
3
3
  description: "Set up Tracing for Mastra applications"
4
4
  ---
5
5
 
@@ -753,7 +753,7 @@ Mastra automatically creates spans for:
753
753
 
754
754
  ### Examples
755
755
 
756
- - [Basic Tracing Example](/examples/v1/observability/basic-tracing) - Working implementation
756
+ - [Basic Tracing Example](/examples/v1/observability/basic-ai-tracing) - Working implementation
757
757
 
758
758
  ### Reference Documentation
759
759
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Sensitive Data Filter | Processors | Observability | Mastra Docs"
2
+ title: "Sensitive Data Filter | Processors | Observability"
3
3
  description: "Protect sensitive information in your traces with automatic data redaction"
4
4
  ---
5
5
 
@@ -293,4 +293,4 @@ This ensures that processing errors don't prevent traces from being exported or
293
293
  ## Related
294
294
 
295
295
  - [SensitiveDataFilter API](/reference/v1/observability/tracing/processors/sensitive-data-filter)
296
- - [Basic Tracing Example](/examples/v1/observability/basic-tracing)
296
+ - [Basic Tracing Example](/examples/v1/observability/basic-ai-tracing)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "RAG (Retrieval-Augmented Generation) in Mastra | RAG | Mastra Docs"
2
+ title: "RAG (Retrieval-Augmented Generation) in Mastra | RAG"
3
3
  description: Overview of Retrieval-Augmented Generation (RAG) in Mastra, detailing its capabilities for enhancing LLM outputs with relevant context.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Retrieval, Semantic Search, Reranking | RAG | Mastra Docs"
2
+ title: "Retrieval, Semantic Search, Reranking | RAG"
3
3
  description: Guide on retrieval processes in Mastra's RAG systems, including semantic search, filtering, and re-ranking.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Storing Embeddings in A Vector Database | RAG | Mastra Docs"
2
+ title: "Storing Embeddings in A Vector Database | RAG"
3
3
  description: Guide on vector storage options in Mastra, including embedded and dedicated vector databases for similarity search.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent Class | Agents | Mastra Docs"
2
+ title: "Reference: Agent Class | Agents"
3
3
  description: "Documentation for the `Agent` class in Mastra, which provides the foundation for creating AI agents with various capabilities."
4
4
  ---
5
5
 
@@ -245,4 +245,3 @@ export const agent = new Agent({
245
245
  ## Related
246
246
 
247
247
  - [Agents overview](/docs/v1/agents/overview)
248
- - [Calling Agents](/examples/v1/agents/calling-agents)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.generate() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.generate() | Agents"
3
3
  description: "Documentation for the `Agent.generate()` method in Mastra agents, which enables non-streaming generation of responses with enhanced capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.generateLegacy() (Legacy) | Agents | Mastra Docs"
2
+ title: "Reference: Agent.generateLegacy() (Legacy) | Agents"
3
3
  description: "Documentation for the legacy `Agent.generateLegacy()` method in Mastra agents. This method is deprecated and will be removed in a future version."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getDefaultGenerateOptionsLegacy() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getDefaultGenerateOptionsLegacy() | Agents"
3
3
  description: "Documentation for the `Agent.getDefaultGenerateOptionsLegacy()` method in Mastra agents, which retrieves the default options used for generateLegacy calls."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getDefaultOptions() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getDefaultOptions() | Agents"
3
3
  description: "Documentation for the `Agent.getDefaultOptions()` method in Mastra agents, which retrieves the default options used for stream and generate calls."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getDefaultStreamOptionsLegacy() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getDefaultStreamOptionsLegacy() | Agents"
3
3
  description: "Documentation for the `Agent.getDefaultStreamOptionsLegacy()` method in Mastra agents, which retrieves the default options used for streamLegacy calls."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getDescription() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getDescription() | Agents"
3
3
  description: "Documentation for the `Agent.getDescription()` method in Mastra agents, which retrieves the agent's description."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getInstructions() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getInstructions() | Agents"
3
3
  description: "Documentation for the `Agent.getInstructions()` method in Mastra agents, which retrieves the instructions that guide the agent's behavior."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getLLM() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getLLM() | Agents"
3
3
  description: "Documentation for the `Agent.getLLM()` method in Mastra agents, which retrieves the language model instance."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getMemory() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getMemory() | Agents"
3
3
  description: "Documentation for the `Agent.getMemory()` method in Mastra agents, which retrieves the memory system associated with the agent."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getModel() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getModel() | Agents"
3
3
  description: "Documentation for the `Agent.getModel()` method in Mastra agents, which retrieves the language model that powers the agent."
4
4
  ---
5
5
 
@@ -0,0 +1,69 @@
1
+ ---
2
+ title: "Reference: Agent.getTools() | Agents"
3
+ description: "Documentation for the `Agent.getTools()` method in Mastra agents, which retrieves the tools that the agent can use."
4
+ ---
5
+
6
+ # Agent.getTools()
7
+
8
+ The `.getTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
9
+
10
+ ## Usage example
11
+
12
+ ```typescript copy
13
+ await agent.getTools();
14
+ ```
15
+
16
+ ## Parameters
17
+
18
+ <PropertiesTable
19
+ content={[
20
+ {
21
+ name: "options",
22
+ type: "{ requestContext?: RequestContext }",
23
+ isOptional: true,
24
+ defaultValue: "{}",
25
+ description: "Optional configuration object containing runtime context.",
26
+ },
27
+ ]}
28
+ />
29
+
30
+ ## Returns
31
+
32
+ <PropertiesTable
33
+ content={[
34
+ {
35
+ name: "tools",
36
+ type: "TTools | Promise<TTools>",
37
+ description:
38
+ "The tools configured for the agent, either as a direct object or a promise that resolves to the tools.",
39
+ },
40
+ ]}
41
+ />
42
+
43
+ ## Extended usage example
44
+
45
+ ```typescript copy
46
+ await agent.getTools({
47
+ requestContext: new RequestContext(),
48
+ });
49
+ ```
50
+
51
+ ### Options parameters
52
+
53
+ <PropertiesTable
54
+ content={[
55
+ {
56
+ name: "requestContext",
57
+ type: "RequestContext",
58
+ isOptional: true,
59
+ defaultValue: "new RequestContext()",
60
+ description:
61
+ "Runtime context for dependency injection and contextual information.",
62
+ },
63
+ ]}
64
+ />
65
+
66
+ ## Related
67
+
68
+ - [Using tools with agents](/docs/v1/agents/using-tools)
69
+ - [MCP Overview](/docs/v1/mcp/overview)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.getVoice() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.getVoice() | Agents"
3
3
  description: "Documentation for the `Agent.getVoice()` method in Mastra agents, which retrieves the voice provider for speech capabilities."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.listAgents() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.listAgents() | Agents"
3
3
  description: "Documentation for the `Agent.listAgents()` method in Mastra agents, which retrieves the sub-agents that the agent can access."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.listScorers() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.listScorers() | Agents"
3
3
  description: "Documentation for the `Agent.listScorers()` method in Mastra agents, which retrieves the scoring configuration."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.listTools() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.listTools() | Agents"
3
3
  description: "Documentation for the `Agent.listTools()` method in Mastra agents, which retrieves the tools that the agent can use."
4
4
  ---
5
5
 
@@ -66,4 +66,4 @@ await agent.listTools({
66
66
  ## Related
67
67
 
68
68
  - [Using tools with agents](/docs/v1/agents/using-tools)
69
- - [Creating tools](/docs/v1/tools-mcp/overview)
69
+ - [Creating tools](/docs/v1/mcp/overview)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.listWorkflows() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.listWorkflows() | Agents"
3
3
  description: "Documentation for the `Agent.listWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agent.network() | Agents | Mastra Docs"
2
+ title: "Reference: Agent.network() | Agents"
3
3
  description: "Documentation for the `Agent.network()` method in Mastra agents, which enables multi-agent collaboration and routing."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraAuthAuth0 Class | Auth | Mastra Docs"
2
+ title: "Reference: MastraAuthAuth0 Class | Auth"
3
3
  description: "API reference for the MastraAuthAuth0 class, which authenticates Mastra applications using Auth0 authentication."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraAuthClerk Class | Auth | Mastra Docs"
2
+ title: "Reference: MastraAuthClerk Class | Auth"
3
3
  description: "API reference for the MastraAuthClerk class, which authenticates Mastra applications using Clerk authentication."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraAuthFirebase Class | Auth | Mastra Docs"
2
+ title: "Reference: MastraAuthFirebase Class | Auth"
3
3
  description: "API reference for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraJwtAuth Class | Auth | Mastra Docs"
2
+ title: "Reference: MastraJwtAuth Class | Auth"
3
3
  description: "API reference for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraAuthSupabase Class | Auth | Mastra Docs"
2
+ title: "Reference: MastraAuthSupabase Class | Auth"
3
3
  description: "API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: MastraAuthWorkos Class | Auth | Mastra Docs"
2
+ title: "Reference: MastraAuthWorkos Class | Auth"
3
3
  description: "API reference for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication."
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: create-mastra | CLI | Mastra Docs"
2
+ title: "Reference: create-mastra | CLI"
3
3
  description: Documentation for the create-mastra command, which creates a new Mastra project with interactive setup options.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: CLI Commands | CLI | Mastra Docs"
2
+ title: "Reference: CLI Commands | CLI"
3
3
  description: Documentation for the Mastra CLI to develop, build, and start your project.
4
4
  ---
5
5
 
@@ -23,11 +23,11 @@ Enable local HTTPS support. [Learn more](/docs/v1/getting-started/studio#local-h
23
23
 
24
24
  #### `--inspect`
25
25
 
26
- Start the development server in inspect mode, helpful for debugging. This can't be used together with `--inspect-brk`.
26
+ Start the development server in inspect mode, helpful for debugging. Optionally specify a custom host and port (e.g., `--inspect=0.0.0.0:9229` for Docker). This can't be used together with `--inspect-brk`.
27
27
 
28
28
  #### `--inspect-brk`
29
29
 
30
- Start the development server in inspect mode and break at the beginning of the script. This can't be used together with `--inspect`.
30
+ Start the development server in inspect mode and break at the beginning of the script. Optionally specify a custom host and port (e.g., `--inspect-brk=0.0.0.0:9229`). This can't be used together with `--inspect`.
31
31
 
32
32
  #### `--custom-args`
33
33
 
@@ -85,7 +85,7 @@ Under the hood Mastra's Rollup server locates your Mastra entry file and bundles
85
85
 
86
86
  The output in `.mastra` can be deployed to any cloud server using [`mastra start`](#mastra-start).
87
87
 
88
- If you're deploying to a [serverless platform](/docs/v1/deployment/serverless-platforms) you need to install the correct deployer in order to receive the correct output in `.mastra`.
88
+ If you're deploying to a [serverless platform](/docs/v1/deployment/cloud-providers) you need to install the correct deployer in order to receive the correct output in `.mastra`.
89
89
 
90
90
  It accepts [common flags][common-flags].
91
91
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Agents API | Client SDK | Mastra Docs"
2
+ title: "Reference: Agents API | Client SDK"
3
3
  description: Learn how to interact with Mastra AI agents, including generating responses, streaming interactions, and managing agent tools using the client-js SDK.
4
4
  ---
5
5