@mastra/mcp-docs-server 1.0.0-beta.2 → 1.0.0-beta.4

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 (391) hide show
  1. package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +9 -9
  2. package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +55 -55
  3. package/.docs/organized/changelogs/%40mastra%2Fauth.md +6 -0
  4. package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +11 -11
  5. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +21 -21
  6. package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +11 -11
  7. package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +11 -11
  8. package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +6 -0
  9. package/.docs/organized/changelogs/%40mastra%2Fcore.md +207 -207
  10. package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +10 -10
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +20 -20
  12. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +11 -11
  13. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +11 -11
  14. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +34 -34
  15. package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +14 -14
  16. package/.docs/organized/changelogs/%40mastra%2Fevals.md +10 -10
  17. package/.docs/organized/changelogs/%40mastra%2Flance.md +14 -14
  18. package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
  19. package/.docs/organized/changelogs/%40mastra%2Floggers.md +10 -10
  20. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +24 -24
  21. package/.docs/organized/changelogs/%40mastra%2Fmcp.md +12 -12
  22. package/.docs/organized/changelogs/%40mastra%2Fmemory.md +10 -10
  23. package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +11 -11
  24. package/.docs/organized/changelogs/%40mastra%2Fmssql.md +11 -11
  25. package/.docs/organized/changelogs/%40mastra%2Fpg.md +11 -11
  26. package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +11 -11
  27. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +44 -44
  28. package/.docs/organized/changelogs/%40mastra%2Frag.md +11 -11
  29. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  30. package/.docs/organized/changelogs/%40mastra%2Fserver.md +19 -19
  31. package/.docs/organized/changelogs/%40mastra%2Fupstash.md +14 -14
  32. package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +21 -21
  33. package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +10 -10
  34. package/.docs/organized/changelogs/create-mastra.md +21 -21
  35. package/.docs/organized/changelogs/mastra.md +47 -47
  36. package/.docs/organized/code-examples/ai-elements.md +1 -1
  37. package/.docs/organized/code-examples/ai-sdk-useChat.md +1 -1
  38. package/.docs/organized/code-examples/ai-sdk-v5.md +1 -1
  39. package/.docs/organized/code-examples/assistant-ui.md +1 -1
  40. package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
  41. package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +1 -1
  42. package/.docs/organized/code-examples/bird-checker-with-nextjs.md +1 -1
  43. package/.docs/organized/code-examples/client-side-tools.md +1 -1
  44. package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
  45. package/.docs/organized/code-examples/fireworks-r1.md +1 -1
  46. package/.docs/organized/code-examples/heads-up-game.md +1 -1
  47. package/.docs/organized/code-examples/mcp-configuration.md +0 -3
  48. package/.docs/organized/code-examples/memory-per-resource-example.md +1 -1
  49. package/.docs/organized/code-examples/openapi-spec-writer.md +1 -1
  50. package/.docs/organized/code-examples/quick-start.md +1 -1
  51. package/.docs/organized/code-examples/stock-price-tool.md +1 -21
  52. package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
  53. package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
  54. package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
  55. package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
  56. package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
  57. package/.docs/raw/agents/adding-voice.mdx +50 -1
  58. package/.docs/raw/agents/agent-memory.mdx +1 -1
  59. package/.docs/raw/agents/guardrails.mdx +1 -1
  60. package/.docs/raw/agents/human-in-the-loop-with-tools.mdx +90 -0
  61. package/.docs/raw/agents/networks.mdx +1 -1
  62. package/.docs/raw/agents/overview.mdx +8 -13
  63. package/.docs/raw/agents/using-tools.mdx +10 -9
  64. package/.docs/raw/auth/auth0.mdx +1 -1
  65. package/.docs/raw/auth/clerk.mdx +1 -1
  66. package/.docs/raw/auth/firebase.mdx +1 -1
  67. package/.docs/raw/auth/index.mdx +1 -1
  68. package/.docs/raw/auth/jwt.mdx +1 -1
  69. package/.docs/raw/auth/supabase.mdx +1 -1
  70. package/.docs/raw/auth/workos.mdx +1 -1
  71. package/.docs/raw/community/contributing-templates.mdx +1 -1
  72. package/.docs/raw/community/discord.mdx +2 -2
  73. package/.docs/raw/community/licensing.mdx +1 -1
  74. package/.docs/raw/deployment/{server-deployment.mdx → building-mastra.mdx} +4 -4
  75. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +2 -2
  76. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +3 -3
  77. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +2 -2
  78. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/cloudflare-deployer.mdx +1 -1
  79. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +2 -2
  80. package/.docs/raw/deployment/cloud-providers/index.mdx +8 -4
  81. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/netlify-deployer.mdx +1 -1
  82. package/.docs/raw/deployment/{serverless-platforms → cloud-providers}/vercel-deployer.mdx +1 -1
  83. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/dashboard.mdx +3 -3
  84. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/observability.mdx +2 -2
  85. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/overview.mdx +3 -3
  86. package/.docs/raw/{mastra-cloud → deployment/mastra-cloud}/setting-up.mdx +4 -4
  87. package/.docs/raw/deployment/monorepo.mdx +3 -3
  88. package/.docs/raw/deployment/overview.mdx +5 -5
  89. package/.docs/raw/deployment/web-framework.mdx +1 -1
  90. package/.docs/raw/evals/{off-the-shelf-scorers.mdx → built-in-scorers.mdx} +17 -15
  91. package/.docs/raw/evals/custom-scorers.mdx +1 -1
  92. package/.docs/raw/evals/overview.mdx +3 -3
  93. package/.docs/raw/evals/running-in-ci.mdx +2 -2
  94. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +11 -128
  95. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +71 -19
  96. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +8 -29
  97. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +91 -267
  98. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +3 -3
  99. package/.docs/raw/frameworks/servers/express.mdx +1 -1
  100. package/.docs/raw/frameworks/web-frameworks/astro.mdx +1 -1
  101. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +1 -1
  102. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +1 -1
  103. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +1 -1
  104. package/.docs/raw/getting-started/mcp-docs-server.mdx +6 -6
  105. package/.docs/raw/getting-started/project-structure.mdx +1 -1
  106. package/.docs/raw/getting-started/quickstart.mdx +27 -0
  107. package/.docs/raw/getting-started/studio.mdx +3 -3
  108. package/.docs/raw/getting-started/templates.mdx +1 -1
  109. package/.docs/raw/guides/guide/ai-recruiter.mdx +1 -1
  110. package/.docs/raw/guides/guide/chef-michel.mdx +1 -1
  111. package/.docs/raw/{getting-started/installation.mdx → guides/guide/manual-install.mdx} +6 -80
  112. package/.docs/raw/guides/guide/notes-mcp-server.mdx +2 -2
  113. package/.docs/raw/guides/guide/research-assistant.mdx +2 -2
  114. package/.docs/raw/guides/guide/stock-agent.mdx +1 -1
  115. package/.docs/raw/guides/guide/web-search.mdx +1 -1
  116. package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +119 -0
  117. package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +1 -1
  118. package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +9 -1
  119. package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +60 -0
  120. package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +12 -0
  121. package/.docs/raw/guides/quickstarts/nextjs.mdx +18 -17
  122. package/.docs/raw/guides/quickstarts/standalone-server.mdx +86 -0
  123. package/.docs/raw/index.mdx +3 -3
  124. package/.docs/raw/logging.mdx +7 -7
  125. package/.docs/raw/mcp/overview.mdx +360 -0
  126. package/.docs/raw/mcp/publishing-mcp-server.mdx +139 -0
  127. package/.docs/raw/memory/conversation-history.mdx +1 -1
  128. package/.docs/raw/memory/memory-processors.mdx +1 -1
  129. package/.docs/raw/memory/overview.mdx +1 -1
  130. package/.docs/raw/memory/semantic-recall.mdx +1 -1
  131. package/.docs/raw/memory/storage/memory-with-libsql.mdx +1 -4
  132. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +1 -1
  133. package/.docs/raw/memory/storage/memory-with-pg.mdx +1 -4
  134. package/.docs/raw/memory/storage/memory-with-upstash.mdx +1 -4
  135. package/.docs/raw/memory/threads-and-resources.mdx +1 -1
  136. package/.docs/raw/memory/working-memory.mdx +1 -1
  137. package/.docs/raw/observability/overview.mdx +2 -2
  138. package/.docs/raw/observability/tracing/exporters/arize.mdx +1 -1
  139. package/.docs/raw/observability/tracing/exporters/braintrust.mdx +1 -1
  140. package/.docs/raw/observability/tracing/exporters/cloud.mdx +2 -2
  141. package/.docs/raw/observability/tracing/exporters/default.mdx +1 -1
  142. package/.docs/raw/observability/tracing/exporters/langfuse.mdx +1 -1
  143. package/.docs/raw/observability/tracing/exporters/langsmith.mdx +1 -1
  144. package/.docs/raw/observability/tracing/exporters/otel.mdx +1 -1
  145. package/.docs/raw/observability/tracing/overview.mdx +2 -2
  146. package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +2 -2
  147. package/.docs/raw/rag/overview.mdx +1 -1
  148. package/.docs/raw/rag/retrieval.mdx +1 -1
  149. package/.docs/raw/rag/vector-databases.mdx +1 -1
  150. package/.docs/raw/reference/agents/agent.mdx +1 -2
  151. package/.docs/raw/reference/agents/generate.mdx +12 -93
  152. package/.docs/raw/reference/agents/generateLegacy.mdx +1 -1
  153. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +1 -1
  154. package/.docs/raw/reference/agents/getDefaultOptions.mdx +1 -1
  155. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +1 -1
  156. package/.docs/raw/reference/agents/getDescription.mdx +1 -1
  157. package/.docs/raw/reference/agents/getInstructions.mdx +1 -1
  158. package/.docs/raw/reference/agents/getLLM.mdx +1 -1
  159. package/.docs/raw/reference/agents/getMemory.mdx +1 -1
  160. package/.docs/raw/reference/agents/getModel.mdx +1 -1
  161. package/.docs/raw/reference/agents/getTools.mdx +69 -0
  162. package/.docs/raw/reference/agents/getVoice.mdx +1 -1
  163. package/.docs/raw/reference/agents/listAgents.mdx +1 -1
  164. package/.docs/raw/reference/agents/listScorers.mdx +1 -1
  165. package/.docs/raw/reference/agents/listTools.mdx +2 -2
  166. package/.docs/raw/reference/agents/listWorkflows.mdx +1 -1
  167. package/.docs/raw/reference/agents/network.mdx +4 -86
  168. package/.docs/raw/reference/auth/auth0.mdx +1 -1
  169. package/.docs/raw/reference/auth/clerk.mdx +1 -1
  170. package/.docs/raw/reference/auth/firebase.mdx +1 -1
  171. package/.docs/raw/reference/auth/jwt.mdx +1 -1
  172. package/.docs/raw/reference/auth/supabase.mdx +1 -1
  173. package/.docs/raw/reference/auth/workos.mdx +1 -1
  174. package/.docs/raw/reference/cli/create-mastra.mdx +1 -1
  175. package/.docs/raw/reference/cli/mastra.mdx +4 -4
  176. package/.docs/raw/reference/client-js/agents.mdx +1 -1
  177. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  178. package/.docs/raw/reference/client-js/logs.mdx +1 -1
  179. package/.docs/raw/reference/client-js/mastra-client.mdx +2 -2
  180. package/.docs/raw/reference/client-js/memory.mdx +1 -1
  181. package/.docs/raw/reference/client-js/observability.mdx +1 -1
  182. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  183. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  184. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  185. package/.docs/raw/reference/client-js/workflows.mdx +1 -1
  186. package/.docs/raw/reference/core/addGateway.mdx +59 -0
  187. package/.docs/raw/reference/core/getAgent.mdx +1 -1
  188. package/.docs/raw/reference/core/getAgentById.mdx +1 -1
  189. package/.docs/raw/reference/core/getDeployer.mdx +1 -1
  190. package/.docs/raw/reference/core/getGateway.mdx +59 -0
  191. package/.docs/raw/reference/core/getGatewayById.mdx +62 -0
  192. package/.docs/raw/reference/core/getLogger.mdx +1 -1
  193. package/.docs/raw/reference/core/getMCPServer.mdx +2 -2
  194. package/.docs/raw/reference/core/getMCPServerById.mdx +2 -2
  195. package/.docs/raw/reference/core/getScorer.mdx +1 -1
  196. package/.docs/raw/reference/core/getScorerById.mdx +1 -1
  197. package/.docs/raw/reference/core/getServer.mdx +2 -2
  198. package/.docs/raw/reference/core/getStorage.mdx +1 -1
  199. package/.docs/raw/reference/core/getTelemetry.mdx +1 -1
  200. package/.docs/raw/reference/core/getVector.mdx +1 -1
  201. package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
  202. package/.docs/raw/reference/core/listAgents.mdx +1 -1
  203. package/.docs/raw/reference/core/listGateways.mdx +53 -0
  204. package/.docs/raw/reference/core/listLogs.mdx +1 -1
  205. package/.docs/raw/reference/core/listLogsByRunId.mdx +1 -1
  206. package/.docs/raw/reference/core/listMCPServers.mdx +2 -2
  207. package/.docs/raw/reference/core/listScorers.mdx +1 -1
  208. package/.docs/raw/reference/core/listVectors.mdx +1 -1
  209. package/.docs/raw/reference/core/listWorkflows.mdx +1 -1
  210. package/.docs/raw/reference/core/mastra-class.mdx +9 -1
  211. package/.docs/raw/reference/core/mastra-model-gateway.mdx +241 -0
  212. package/.docs/raw/reference/core/setLogger.mdx +1 -1
  213. package/.docs/raw/reference/core/setStorage.mdx +1 -1
  214. package/.docs/raw/reference/core/setTelemetry.mdx +1 -1
  215. package/.docs/raw/reference/deployer/cloudflare.mdx +1 -1
  216. package/.docs/raw/reference/deployer/deployer.mdx +1 -1
  217. package/.docs/raw/reference/deployer/netlify.mdx +1 -1
  218. package/.docs/raw/reference/deployer/vercel.mdx +1 -1
  219. package/.docs/raw/reference/evals/answer-relevancy.mdx +1 -1
  220. package/.docs/raw/reference/evals/answer-similarity.mdx +1 -1
  221. package/.docs/raw/reference/evals/bias.mdx +1 -1
  222. package/.docs/raw/reference/evals/completeness.mdx +1 -1
  223. package/.docs/raw/reference/evals/content-similarity.mdx +1 -1
  224. package/.docs/raw/reference/evals/context-precision.mdx +1 -1
  225. package/.docs/raw/reference/evals/context-relevance.mdx +1 -1
  226. package/.docs/raw/reference/evals/create-scorer.mdx +1 -1
  227. package/.docs/raw/reference/evals/faithfulness.mdx +1 -1
  228. package/.docs/raw/reference/evals/hallucination.mdx +1 -1
  229. package/.docs/raw/reference/evals/keyword-coverage.mdx +1 -1
  230. package/.docs/raw/reference/evals/mastra-scorer.mdx +1 -1
  231. package/.docs/raw/reference/evals/noise-sensitivity.mdx +1 -1
  232. package/.docs/raw/reference/evals/prompt-alignment.mdx +1 -1
  233. package/.docs/raw/reference/evals/run-evals.mdx +1 -1
  234. package/.docs/raw/reference/evals/textual-difference.mdx +1 -1
  235. package/.docs/raw/reference/evals/tone-consistency.mdx +1 -1
  236. package/.docs/raw/reference/evals/tool-call-accuracy.mdx +1 -1
  237. package/.docs/raw/reference/evals/toxicity.mdx +1 -1
  238. package/.docs/raw/reference/logging/pino-logger.mdx +2 -2
  239. package/.docs/raw/reference/memory/createThread.mdx +1 -1
  240. package/.docs/raw/reference/memory/deleteMessages.mdx +1 -1
  241. package/.docs/raw/reference/memory/getThreadById.mdx +1 -1
  242. package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +1 -1
  243. package/.docs/raw/reference/memory/memory-class.mdx +1 -1
  244. package/.docs/raw/reference/memory/query.mdx +1 -1
  245. package/.docs/raw/reference/memory/recall.mdx +1 -1
  246. package/.docs/raw/reference/observability/tracing/configuration.mdx +2 -2
  247. package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +1 -1
  248. package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +1 -1
  249. package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +1 -1
  250. package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +1 -1
  251. package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +1 -1
  252. package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +1 -1
  253. package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +1 -1
  254. package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +1 -1
  255. package/.docs/raw/reference/observability/tracing/instances.mdx +2 -2
  256. package/.docs/raw/reference/observability/tracing/interfaces.mdx +2 -2
  257. package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +1 -1
  258. package/.docs/raw/reference/observability/tracing/spans.mdx +2 -2
  259. package/.docs/raw/reference/processors/batch-parts-processor.mdx +1 -1
  260. package/.docs/raw/reference/processors/language-detector.mdx +1 -1
  261. package/.docs/raw/reference/processors/moderation-processor.mdx +1 -1
  262. package/.docs/raw/reference/processors/pii-detector.mdx +1 -1
  263. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +1 -1
  264. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +1 -1
  265. package/.docs/raw/reference/processors/token-limiter-processor.mdx +1 -1
  266. package/.docs/raw/reference/processors/unicode-normalizer.mdx +1 -1
  267. package/.docs/raw/reference/rag/chunk.mdx +1 -1
  268. package/.docs/raw/reference/rag/database-config.mdx +1 -1
  269. package/.docs/raw/reference/rag/document.mdx +1 -1
  270. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  271. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  272. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  273. package/.docs/raw/reference/rag/metadata-filters.mdx +1 -1
  274. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  275. package/.docs/raw/reference/rag/rerankWithScorer.mdx +1 -1
  276. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  277. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  278. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  279. package/.docs/raw/reference/storage/lance.mdx +1 -1
  280. package/.docs/raw/reference/storage/libsql.mdx +1 -1
  281. package/.docs/raw/reference/storage/mongodb.mdx +1 -1
  282. package/.docs/raw/reference/storage/mssql.mdx +1 -1
  283. package/.docs/raw/reference/storage/postgresql.mdx +1 -1
  284. package/.docs/raw/reference/storage/upstash.mdx +1 -1
  285. package/.docs/raw/reference/streaming/ChunkType.mdx +1 -1
  286. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +1 -1
  287. package/.docs/raw/reference/streaming/agents/stream.mdx +4 -93
  288. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +1 -1
  289. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +1 -1
  290. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +1 -1
  291. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +1 -1
  292. package/.docs/raw/reference/streaming/workflows/stream.mdx +1 -1
  293. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +1 -1
  294. package/.docs/raw/reference/templates/overview.mdx +1 -1
  295. package/.docs/raw/reference/tools/client.mdx +1 -1
  296. package/.docs/raw/reference/tools/create-tool.mdx +3 -4
  297. package/.docs/raw/reference/tools/document-chunker-tool.mdx +1 -1
  298. package/.docs/raw/reference/tools/graph-rag-tool.mdx +2 -2
  299. package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
  300. package/.docs/raw/reference/tools/mcp-server.mdx +6 -6
  301. package/.docs/raw/reference/tools/vector-query-tool.mdx +2 -2
  302. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  303. package/.docs/raw/reference/vectors/chroma.mdx +1 -1
  304. package/.docs/raw/reference/vectors/couchbase.mdx +1 -1
  305. package/.docs/raw/reference/vectors/lance.mdx +1 -1
  306. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  307. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  308. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  309. package/.docs/raw/reference/vectors/pg.mdx +1 -1
  310. package/.docs/raw/reference/vectors/pinecone.mdx +22 -2
  311. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  312. package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
  313. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  314. package/.docs/raw/reference/vectors/upstash.mdx +1 -1
  315. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  316. package/.docs/raw/reference/voice/azure.mdx +96 -81
  317. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  318. package/.docs/raw/reference/voice/composite-voice.mdx +72 -29
  319. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  320. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  321. package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
  322. package/.docs/raw/reference/voice/google.mdx +1 -1
  323. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  324. package/.docs/raw/reference/voice/murf.mdx +1 -1
  325. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  326. package/.docs/raw/reference/voice/openai.mdx +1 -1
  327. package/.docs/raw/reference/voice/playai.mdx +1 -1
  328. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  329. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  330. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  331. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  332. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  333. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  334. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  335. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  336. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +1 -1
  337. package/.docs/raw/reference/voice/voice.listen.mdx +87 -53
  338. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  339. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  340. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  341. package/.docs/raw/reference/voice/voice.speak.mdx +76 -41
  342. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  343. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +1 -1
  344. package/.docs/raw/reference/workflows/run-methods/resume.mdx +1 -1
  345. package/.docs/raw/reference/workflows/run-methods/start.mdx +1 -1
  346. package/.docs/raw/reference/workflows/run.mdx +1 -1
  347. package/.docs/raw/reference/workflows/step.mdx +1 -1
  348. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +1 -1
  349. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  350. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +1 -1
  351. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
  352. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
  353. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  354. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +1 -1
  355. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  356. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +1 -1
  357. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
  358. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
  359. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  360. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
  361. package/.docs/raw/reference/workflows/workflow.mdx +2 -2
  362. package/.docs/raw/server-db/custom-api-routes.mdx +1 -1
  363. package/.docs/raw/server-db/mastra-client.mdx +2 -2
  364. package/.docs/raw/server-db/{production-server.mdx → mastra-server.mdx} +2 -2
  365. package/.docs/raw/server-db/middleware.mdx +31 -31
  366. package/.docs/raw/server-db/request-context.mdx +3 -3
  367. package/.docs/raw/server-db/storage.mdx +1 -1
  368. package/.docs/raw/streaming/events.mdx +1 -1
  369. package/.docs/raw/streaming/overview.mdx +1 -1
  370. package/.docs/raw/streaming/tool-streaming.mdx +1 -1
  371. package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
  372. package/.docs/raw/tools-mcp/advanced-usage.mdx +1 -1
  373. package/.docs/raw/tools-mcp/mcp-overview.mdx +1 -1
  374. package/.docs/raw/tools-mcp/overview.mdx +1 -1
  375. package/.docs/raw/voice/overview.mdx +68 -1
  376. package/.docs/raw/voice/speech-to-speech.mdx +1 -1
  377. package/.docs/raw/voice/speech-to-text.mdx +1 -1
  378. package/.docs/raw/voice/text-to-speech.mdx +1 -1
  379. package/.docs/raw/workflows/agents-and-tools.mdx +2 -4
  380. package/.docs/raw/workflows/control-flow.mdx +6 -1
  381. package/.docs/raw/workflows/error-handling.mdx +4 -4
  382. package/.docs/raw/workflows/human-in-the-loop.mdx +160 -213
  383. package/.docs/raw/workflows/inngest-workflow.mdx +1 -1
  384. package/.docs/raw/workflows/input-data-mapping.mdx +1 -1
  385. package/.docs/raw/workflows/overview.mdx +11 -3
  386. package/.docs/raw/workflows/snapshots.mdx +4 -3
  387. package/.docs/raw/workflows/suspend-and-resume.mdx +72 -224
  388. package/CHANGELOG.md +23 -0
  389. package/dist/stdio.js +11 -9
  390. package/package.json +10 -14
  391. package/.docs/raw/deployment/serverless-platforms/index.mdx +0 -58
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Memory with LibSQL | Memory | Mastra Docs"
2
+ title: "Memory with LibSQL | Memory"
3
3
  description: Example for how to use Mastra's memory system with LibSQL storage and vector database backend.
4
4
  ---
5
5
 
@@ -140,6 +140,3 @@ for await (const chunk of stream.textStream) {
140
140
  }
141
141
  ```
142
142
 
143
- ## Related
144
-
145
- - [Calling Agents](/examples/v1/agents/calling-agents)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Example: Memory with MongoDB | Memory | Mastra Docs"
2
+ title: "Example: Memory with MongoDB | Memory"
3
3
  description: Example for how to use Mastra's memory system with MongoDB storage and vector capabilities.
4
4
  ---
5
5
 
@@ -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,8 +1,10 @@
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
 
6
+ import { MODEL_SETTINGS_OBJECT } from "@site/src/components/ModelSettingsProperties";
7
+
6
8
  # Agent.generate()
7
9
 
8
10
  The `.generate()` method enables non-streaming response generation from an agent, with enhanced capabilities and flexible output formats. It accepts messages and optional generation options, supporting both Mastra’s native format and AI SDK v5 compatibility.
@@ -17,6 +19,14 @@ const mastraResult = await agent.generate("message for agent");
17
19
  const aiSdkResult = await agent.generate("message for agent", {
18
20
  format: "aisdk",
19
21
  });
22
+
23
+ // With model settings (e.g., limiting output tokens)
24
+ const limitedResult = await agent.generate("Write a short poem about coding", {
25
+ modelSettings: {
26
+ maxOutputTokens: 50,
27
+ temperature: 0.7,
28
+ },
29
+ });
20
30
  ```
21
31
 
22
32
  :::info
@@ -392,91 +402,7 @@ const aiSdkResult = await agent.generate("message for agent", {
392
402
  },
393
403
  ],
394
404
  },
395
- {
396
- name: "modelSettings",
397
- type: "CallSettings",
398
- isOptional: true,
399
- description: "Model-specific settings like temperature, topP, etc.",
400
- properties: [
401
- {
402
- parameters: [
403
- {
404
- name: "temperature",
405
- type: "number",
406
- isOptional: true,
407
- description:
408
- "Controls randomness in generation (0-2). Higher values make output more random.",
409
- },
410
- ],
411
- },
412
- {
413
- parameters: [
414
- {
415
- name: "maxRetries",
416
- type: "number",
417
- isOptional: true,
418
- description:
419
- "Maximum number of retry attempts for failed requests.",
420
- },
421
- ],
422
- },
423
- {
424
- parameters: [
425
- {
426
- name: "topP",
427
- type: "number",
428
- isOptional: true,
429
- description:
430
- "Nucleus sampling parameter (0-1). Controls diversity of generated text.",
431
- },
432
- ],
433
- },
434
- {
435
- parameters: [
436
- {
437
- name: "topK",
438
- type: "number",
439
- isOptional: true,
440
- description:
441
- "Top-k sampling parameter. Limits vocabulary to k most likely tokens.",
442
- },
443
- ],
444
- },
445
- {
446
- parameters: [
447
- {
448
- name: "presencePenalty",
449
- type: "number",
450
- isOptional: true,
451
- description:
452
- "Penalty for token presence (-2 to 2). Reduces repetition.",
453
- },
454
- ],
455
- },
456
- {
457
- parameters: [
458
- {
459
- name: "frequencyPenalty",
460
- type: "number",
461
- isOptional: true,
462
- description:
463
- "Penalty for token frequency (-2 to 2). Reduces repetition of frequent tokens.",
464
- },
465
- ],
466
- },
467
- {
468
- parameters: [
469
- {
470
- name: "stopSequences",
471
- type: "string[]",
472
- isOptional: true,
473
- description:
474
- "Array of strings that will stop generation when encountered.",
475
- },
476
- ],
477
- },
478
- ],
479
- },
405
+ MODEL_SETTINGS_OBJECT,
480
406
  {
481
407
  name: "threadId",
482
408
  type: "string",
@@ -652,13 +578,6 @@ const aiSdkResult = await agent.generate("message for agent", {
652
578
  },
653
579
  ],
654
580
  },
655
- {
656
- name: "maxTokens",
657
- type: "number",
658
- isOptional: true,
659
- description:
660
- "Conditions for stopping execution (e.g., step count, token limit).",
661
- },
662
581
  ]}
663
582
  />
664
583
 
@@ -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,8 +1,10 @@
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
 
6
+ import { MODEL_SETTINGS_OBJECT } from "@site/src/components/ModelSettingsProperties";
7
+
6
8
  # Agent.network()
7
9
 
8
10
  :::caution Experimental Feature
@@ -208,91 +210,7 @@ await agent.network(`
208
210
  },
209
211
  ],
210
212
  },
211
- {
212
- name: "modelSettings",
213
- type: "CallSettings",
214
- isOptional: true,
215
- description:
216
- "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
217
- properties: [
218
- {
219
- parameters: [
220
- {
221
- name: "temperature",
222
- type: "number",
223
- isOptional: true,
224
- description:
225
- "Controls randomness in the model's output. Higher values (e.g., 0.8) make the output more random, lower values (e.g., 0.2) make it more focused and deterministic.",
226
- },
227
- ],
228
- },
229
- {
230
- parameters: [
231
- {
232
- name: "maxRetries",
233
- type: "number",
234
- isOptional: true,
235
- description: "Maximum number of retries for failed requests.",
236
- },
237
- ],
238
- },
239
- {
240
- parameters: [
241
- {
242
- name: "topP",
243
- type: "number",
244
- isOptional: true,
245
- description:
246
- "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both.",
247
- },
248
- ],
249
- },
250
- {
251
- parameters: [
252
- {
253
- name: "topK",
254
- type: "number",
255
- isOptional: true,
256
- description:
257
- "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.",
258
- },
259
- ],
260
- },
261
- {
262
- parameters: [
263
- {
264
- name: "presencePenalty",
265
- type: "number",
266
- isOptional: true,
267
- description:
268
- "Presence penalty setting. It affects the likelihood of the model to repeat information that is already in the prompt. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
269
- },
270
- ],
271
- },
272
- {
273
- parameters: [
274
- {
275
- name: "frequencyPenalty",
276
- type: "number",
277
- isOptional: true,
278
- description:
279
- "Frequency penalty setting. It affects the likelihood of the model to repeatedly use the same words or phrases. A number between -1 (increase repetition) and 1 (maximum penalty, decrease repetition).",
280
- },
281
- ],
282
- },
283
- {
284
- parameters: [
285
- {
286
- name: "stopSequences",
287
- type: "string[]",
288
- isOptional: true,
289
- description:
290
- "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.",
291
- },
292
- ],
293
- },
294
- ],
295
- },
213
+ MODEL_SETTINGS_OBJECT,
296
214
  {
297
215
  name: "runId",
298
216
  type: "string",
@@ -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