@mastra/mcp-docs-server 0.13.37 → 0.13.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (397) hide show
  1. package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +2 -0
  2. package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
  3. package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
  4. package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
  5. package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +23 -23
  6. package/.docs/organized/changelogs/%40mastra%2Fcore.md +69 -69
  7. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +17 -17
  8. package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +17 -17
  9. package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +17 -17
  10. package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +17 -17
  11. package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +25 -25
  12. package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
  13. package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +27 -27
  14. package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
  15. package/.docs/organized/changelogs/%40mastra%2Fserver.md +23 -23
  16. package/.docs/organized/changelogs/create-mastra.md +5 -5
  17. package/.docs/organized/changelogs/mastra.md +17 -17
  18. package/.docs/raw/agents/adding-voice.mdx +20 -9
  19. package/.docs/raw/agents/agent-memory.mdx +55 -39
  20. package/.docs/raw/agents/guardrails.mdx +68 -61
  21. package/.docs/raw/agents/networks.mdx +50 -46
  22. package/.docs/raw/agents/overview.mdx +125 -88
  23. package/.docs/raw/agents/using-tools.mdx +14 -15
  24. package/.docs/raw/auth/auth0.mdx +28 -27
  25. package/.docs/raw/auth/clerk.mdx +22 -20
  26. package/.docs/raw/auth/firebase.mdx +42 -39
  27. package/.docs/raw/auth/index.mdx +1 -1
  28. package/.docs/raw/auth/jwt.mdx +18 -16
  29. package/.docs/raw/auth/supabase.mdx +20 -18
  30. package/.docs/raw/auth/workos.mdx +32 -26
  31. package/.docs/raw/community/contributing-templates.mdx +7 -7
  32. package/.docs/raw/community/discord.mdx +2 -2
  33. package/.docs/raw/community/licensing.mdx +1 -1
  34. package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
  35. package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
  36. package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
  37. package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
  38. package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
  39. package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
  40. package/.docs/raw/deployment/monorepo.mdx +32 -42
  41. package/.docs/raw/deployment/overview.mdx +15 -15
  42. package/.docs/raw/deployment/server-deployment.mdx +18 -23
  43. package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
  44. package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
  45. package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
  46. package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
  47. package/.docs/raw/deployment/web-framework.mdx +14 -14
  48. package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +138 -145
  49. package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
  50. package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
  51. package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
  52. package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +59 -48
  53. package/.docs/raw/frameworks/servers/express.mdx +45 -44
  54. package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
  55. package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
  56. package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +189 -164
  57. package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
  58. package/.docs/raw/getting-started/installation.mdx +164 -133
  59. package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
  60. package/.docs/raw/getting-started/project-structure.mdx +34 -42
  61. package/.docs/raw/getting-started/studio.mdx +40 -58
  62. package/.docs/raw/getting-started/templates.mdx +22 -27
  63. package/.docs/raw/index.mdx +9 -9
  64. package/.docs/raw/mastra-cloud/dashboard.mdx +10 -10
  65. package/.docs/raw/mastra-cloud/observability.mdx +7 -8
  66. package/.docs/raw/mastra-cloud/overview.mdx +16 -22
  67. package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
  68. package/.docs/raw/memory/conversation-history.mdx +2 -2
  69. package/.docs/raw/memory/overview.mdx +21 -23
  70. package/.docs/raw/memory/semantic-recall.mdx +14 -13
  71. package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
  72. package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
  73. package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
  74. package/.docs/raw/memory/threads-and-resources.mdx +23 -20
  75. package/.docs/raw/memory/working-memory.mdx +27 -38
  76. package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
  77. package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
  78. package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
  79. package/.docs/raw/observability/ai-tracing/exporters/default.mdx +31 -32
  80. package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
  81. package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
  82. package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
  83. package/.docs/raw/observability/ai-tracing/overview.mdx +145 -122
  84. package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
  85. package/.docs/raw/observability/logging.mdx +14 -17
  86. package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
  87. package/.docs/raw/observability/otel-tracing.mdx +17 -18
  88. package/.docs/raw/observability/overview.mdx +14 -10
  89. package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
  90. package/.docs/raw/rag/overview.mdx +5 -5
  91. package/.docs/raw/rag/retrieval.mdx +125 -107
  92. package/.docs/raw/rag/vector-databases.mdx +232 -223
  93. package/.docs/raw/reference/agents/agent.mdx +54 -41
  94. package/.docs/raw/reference/agents/generate.mdx +367 -261
  95. package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
  96. package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
  97. package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
  98. package/.docs/raw/reference/agents/getDescription.mdx +3 -2
  99. package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
  100. package/.docs/raw/reference/agents/getLLM.mdx +11 -7
  101. package/.docs/raw/reference/agents/getMemory.mdx +7 -5
  102. package/.docs/raw/reference/agents/getModel.mdx +7 -5
  103. package/.docs/raw/reference/agents/getScorers.mdx +7 -5
  104. package/.docs/raw/reference/agents/getTools.mdx +7 -5
  105. package/.docs/raw/reference/agents/getVoice.mdx +7 -5
  106. package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
  107. package/.docs/raw/reference/agents/listAgents.mdx +6 -4
  108. package/.docs/raw/reference/agents/network.mdx +171 -116
  109. package/.docs/raw/reference/auth/auth0.mdx +18 -14
  110. package/.docs/raw/reference/auth/clerk.mdx +15 -12
  111. package/.docs/raw/reference/auth/firebase.mdx +23 -16
  112. package/.docs/raw/reference/auth/jwt.mdx +7 -6
  113. package/.docs/raw/reference/auth/supabase.mdx +13 -10
  114. package/.docs/raw/reference/auth/workos.mdx +17 -13
  115. package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
  116. package/.docs/raw/reference/cli/mastra.mdx +11 -11
  117. package/.docs/raw/reference/client-js/agents.mdx +40 -43
  118. package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
  119. package/.docs/raw/reference/client-js/logs.mdx +1 -1
  120. package/.docs/raw/reference/client-js/mastra-client.mdx +21 -13
  121. package/.docs/raw/reference/client-js/memory.mdx +6 -2
  122. package/.docs/raw/reference/client-js/observability.mdx +10 -9
  123. package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
  124. package/.docs/raw/reference/client-js/tools.mdx +1 -1
  125. package/.docs/raw/reference/client-js/vectors.mdx +1 -1
  126. package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
  127. package/.docs/raw/reference/client-js/workflows.mdx +7 -7
  128. package/.docs/raw/reference/core/getAgent.mdx +6 -5
  129. package/.docs/raw/reference/core/getAgentById.mdx +5 -4
  130. package/.docs/raw/reference/core/getAgents.mdx +3 -3
  131. package/.docs/raw/reference/core/getDeployer.mdx +4 -3
  132. package/.docs/raw/reference/core/getLogger.mdx +4 -3
  133. package/.docs/raw/reference/core/getLogs.mdx +10 -6
  134. package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
  135. package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
  136. package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
  137. package/.docs/raw/reference/core/getMemory.mdx +4 -3
  138. package/.docs/raw/reference/core/getScorer.mdx +15 -12
  139. package/.docs/raw/reference/core/getScorerByName.mdx +12 -9
  140. package/.docs/raw/reference/core/getScorers.mdx +3 -2
  141. package/.docs/raw/reference/core/getServer.mdx +4 -3
  142. package/.docs/raw/reference/core/getStorage.mdx +4 -3
  143. package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
  144. package/.docs/raw/reference/core/getVector.mdx +6 -4
  145. package/.docs/raw/reference/core/getVectors.mdx +4 -3
  146. package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
  147. package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
  148. package/.docs/raw/reference/core/mastra-class.mdx +16 -16
  149. package/.docs/raw/reference/core/setLogger.mdx +6 -4
  150. package/.docs/raw/reference/core/setStorage.mdx +4 -4
  151. package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
  152. package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
  153. package/.docs/raw/reference/deployer/deployer.mdx +2 -1
  154. package/.docs/raw/reference/deployer/netlify.mdx +4 -4
  155. package/.docs/raw/reference/deployer/vercel.mdx +6 -6
  156. package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
  157. package/.docs/raw/reference/evals/bias.mdx +4 -5
  158. package/.docs/raw/reference/evals/completeness.mdx +4 -5
  159. package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
  160. package/.docs/raw/reference/evals/context-position.mdx +4 -5
  161. package/.docs/raw/reference/evals/context-precision.mdx +4 -5
  162. package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
  163. package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
  164. package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
  165. package/.docs/raw/reference/evals/hallucination.mdx +4 -6
  166. package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
  167. package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
  168. package/.docs/raw/reference/evals/summarization.mdx +4 -6
  169. package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
  170. package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
  171. package/.docs/raw/reference/evals/toxicity.mdx +4 -5
  172. package/.docs/raw/reference/index.mdx +3 -3
  173. package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
  174. package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
  175. package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
  176. package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
  177. package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
  178. package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
  179. package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
  180. package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
  181. package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
  182. package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
  183. package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
  184. package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
  185. package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
  186. package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
  187. package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
  188. package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
  189. package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
  190. package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
  191. package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
  192. package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
  193. package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
  194. package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
  195. package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
  196. package/.docs/raw/reference/memory/createThread.mdx +10 -10
  197. package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
  198. package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
  199. package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
  200. package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
  201. package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +53 -46
  202. package/.docs/raw/reference/memory/query.mdx +39 -25
  203. package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -5
  204. package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
  205. package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
  206. package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
  207. package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
  208. package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
  209. package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
  210. package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
  211. package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
  212. package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
  213. package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +115 -106
  214. package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
  215. package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
  216. package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
  217. package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
  218. package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
  219. package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
  220. package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
  221. package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
  222. package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +3 -3
  223. package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
  224. package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
  225. package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
  226. package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
  227. package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
  228. package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
  229. package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
  230. package/.docs/raw/reference/processors/batch-parts-processor.mdx +13 -10
  231. package/.docs/raw/reference/processors/language-detector.mdx +27 -17
  232. package/.docs/raw/reference/processors/moderation-processor.mdx +26 -17
  233. package/.docs/raw/reference/processors/pii-detector.mdx +28 -18
  234. package/.docs/raw/reference/processors/prompt-injection-detector.mdx +25 -17
  235. package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +26 -17
  236. package/.docs/raw/reference/processors/token-limiter-processor.mdx +22 -15
  237. package/.docs/raw/reference/processors/unicode-normalizer.mdx +13 -12
  238. package/.docs/raw/reference/rag/chunk.mdx +41 -23
  239. package/.docs/raw/reference/rag/database-config.mdx +56 -38
  240. package/.docs/raw/reference/rag/document.mdx +1 -1
  241. package/.docs/raw/reference/rag/embeddings.mdx +1 -1
  242. package/.docs/raw/reference/rag/extract-params.mdx +1 -1
  243. package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
  244. package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
  245. package/.docs/raw/reference/rag/rerank.mdx +1 -1
  246. package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
  247. package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
  248. package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
  249. package/.docs/raw/reference/scorers/bias.mdx +22 -19
  250. package/.docs/raw/reference/scorers/completeness.mdx +21 -16
  251. package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
  252. package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
  253. package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
  254. package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
  255. package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
  256. package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
  257. package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
  258. package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
  259. package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
  260. package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
  261. package/.docs/raw/reference/scorers/run-experiment.mdx +40 -31
  262. package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
  263. package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
  264. package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
  265. package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
  266. package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
  267. package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
  268. package/.docs/raw/reference/storage/dynamodb.mdx +1 -1
  269. package/.docs/raw/reference/storage/lance.mdx +1 -1
  270. package/.docs/raw/reference/storage/libsql.mdx +2 -2
  271. package/.docs/raw/reference/storage/mongodb.mdx +4 -5
  272. package/.docs/raw/reference/storage/mssql.mdx +5 -4
  273. package/.docs/raw/reference/storage/postgresql.mdx +35 -33
  274. package/.docs/raw/reference/storage/upstash.mdx +6 -5
  275. package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
  276. package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
  277. package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
  278. package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
  279. package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
  280. package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
  281. package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +24 -20
  282. package/.docs/raw/reference/streaming/workflows/stream.mdx +35 -26
  283. package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +36 -27
  284. package/.docs/raw/reference/templates/overview.mdx +16 -39
  285. package/.docs/raw/reference/tools/client.mdx +1 -1
  286. package/.docs/raw/reference/tools/create-tool.mdx +45 -35
  287. package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
  288. package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
  289. package/.docs/raw/reference/tools/mcp-client.mdx +70 -64
  290. package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
  291. package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
  292. package/.docs/raw/reference/vectors/astra.mdx +1 -1
  293. package/.docs/raw/reference/vectors/chroma.mdx +25 -19
  294. package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
  295. package/.docs/raw/reference/vectors/lance.mdx +5 -6
  296. package/.docs/raw/reference/vectors/libsql.mdx +1 -1
  297. package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
  298. package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
  299. package/.docs/raw/reference/vectors/pg.mdx +8 -4
  300. package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
  301. package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
  302. package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
  303. package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
  304. package/.docs/raw/reference/vectors/upstash.mdx +33 -25
  305. package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
  306. package/.docs/raw/reference/voice/azure.mdx +1 -1
  307. package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
  308. package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
  309. package/.docs/raw/reference/voice/deepgram.mdx +1 -1
  310. package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
  311. package/.docs/raw/reference/voice/google-gemini-live.mdx +6 -4
  312. package/.docs/raw/reference/voice/google.mdx +1 -1
  313. package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
  314. package/.docs/raw/reference/voice/murf.mdx +1 -1
  315. package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
  316. package/.docs/raw/reference/voice/openai.mdx +1 -1
  317. package/.docs/raw/reference/voice/playai.mdx +1 -1
  318. package/.docs/raw/reference/voice/sarvam.mdx +1 -1
  319. package/.docs/raw/reference/voice/speechify.mdx +1 -1
  320. package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
  321. package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
  322. package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
  323. package/.docs/raw/reference/voice/voice.close.mdx +1 -1
  324. package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
  325. package/.docs/raw/reference/voice/voice.events.mdx +1 -1
  326. package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
  327. package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
  328. package/.docs/raw/reference/voice/voice.off.mdx +1 -1
  329. package/.docs/raw/reference/voice/voice.on.mdx +1 -1
  330. package/.docs/raw/reference/voice/voice.send.mdx +1 -1
  331. package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
  332. package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
  333. package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
  334. package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
  335. package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
  336. package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
  337. package/.docs/raw/reference/workflows/run.mdx +7 -10
  338. package/.docs/raw/reference/workflows/step.mdx +15 -12
  339. package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
  340. package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
  341. package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -7
  342. package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
  343. package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
  344. package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
  345. package/.docs/raw/reference/workflows/workflow-methods/map.mdx +3 -2
  346. package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
  347. package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
  348. package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
  349. package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
  350. package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
  351. package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
  352. package/.docs/raw/reference/workflows/workflow.mdx +13 -10
  353. package/.docs/raw/scorers/custom-scorers.mdx +58 -48
  354. package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
  355. package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
  356. package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
  357. package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
  358. package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
  359. package/.docs/raw/scorers/overview.mdx +20 -19
  360. package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
  361. package/.docs/raw/server-db/mastra-client.mdx +56 -54
  362. package/.docs/raw/server-db/middleware.mdx +11 -7
  363. package/.docs/raw/server-db/production-server.mdx +5 -7
  364. package/.docs/raw/server-db/runtime-context.mdx +41 -38
  365. package/.docs/raw/server-db/storage.mdx +82 -87
  366. package/.docs/raw/streaming/events.mdx +24 -16
  367. package/.docs/raw/streaming/overview.mdx +17 -18
  368. package/.docs/raw/streaming/tool-streaming.mdx +9 -10
  369. package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
  370. package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
  371. package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
  372. package/.docs/raw/tools-mcp/overview.mdx +9 -14
  373. package/.docs/raw/voice/overview.mdx +273 -250
  374. package/.docs/raw/voice/speech-to-speech.mdx +14 -12
  375. package/.docs/raw/voice/speech-to-text.mdx +2 -2
  376. package/.docs/raw/voice/text-to-speech.mdx +2 -2
  377. package/.docs/raw/workflows/agents-and-tools.mdx +29 -28
  378. package/.docs/raw/workflows/control-flow.mdx +24 -24
  379. package/.docs/raw/workflows/error-handling.mdx +15 -17
  380. package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
  381. package/.docs/raw/workflows/inngest-workflow.mdx +33 -29
  382. package/.docs/raw/workflows/input-data-mapping.mdx +9 -9
  383. package/.docs/raw/workflows/overview.mdx +60 -60
  384. package/.docs/raw/workflows/snapshots.mdx +54 -36
  385. package/.docs/raw/workflows/suspend-and-resume.mdx +52 -57
  386. package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
  387. package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
  388. package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
  389. package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
  390. package/.docs/raw/workflows-legacy/overview.mdx +28 -26
  391. package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
  392. package/.docs/raw/workflows-legacy/steps.mdx +5 -3
  393. package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
  394. package/.docs/raw/workflows-legacy/variables.mdx +10 -8
  395. package/CHANGELOG.md +14 -0
  396. package/package.json +5 -5
  397. package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
@@ -1,29 +1,30 @@
1
1
  ---
2
- title: "Reference: Agent.network() (Experimental) | Agents | Mastra Docs"
2
+ title: "Reference: Agent.network() | Agents | Mastra Docs"
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 { NetworkCallout } from "@/components/network-callout.tsx"
7
-
8
6
  # Agent.network()
9
7
 
10
- <NetworkCallout />
8
+ :::caution Experimental Feature
9
+ This is an experimental API that may change in future versions. The `network()` method enables multi-agent collaboration and workflow orchestration. Use with caution in production environments.
10
+ :::
11
11
 
12
12
  The `.network()` method enables multi-agent collaboration and routing. This method accepts messages and optional execution options.
13
13
 
14
14
  ## Usage example
15
15
 
16
16
  ```typescript copy
17
- import { Agent } from '@mastra/core/agent';
18
- import { openai } from '@ai-sdk/openai';
19
- import { agent1, agent2 } from './agents';
20
- import { workflow1 } from './workflows';
21
- import { tool1, tool2 } from './tools';
17
+ import { Agent } from "@mastra/core/agent";
18
+ import { openai } from "@ai-sdk/openai";
19
+ import { agent1, agent2 } from "./agents";
20
+ import { workflow1 } from "./workflows";
21
+ import { tool1, tool2 } from "./tools";
22
22
 
23
23
  const agent = new Agent({
24
- name: 'network-agent',
25
- instructions: 'You are a network agent that can help users with a variety of tasks.',
26
- model: openai('gpt-4o'),
24
+ name: "network-agent",
25
+ instructions:
26
+ "You are a network agent that can help users with a variety of tasks.",
27
+ model: openai("gpt-4o"),
27
28
  agents: {
28
29
  agent1,
29
30
  agent2,
@@ -35,7 +36,7 @@ const agent = new Agent({
35
36
  tool1,
36
37
  tool2,
37
38
  },
38
- })
39
+ });
39
40
 
40
41
  await agent.network(`
41
42
  Find me the weather in Tokyo.
@@ -50,7 +51,8 @@ await agent.network(`
50
51
  {
51
52
  name: "messages",
52
53
  type: "string | string[] | CoreMessage[] | AiMessageType[] | UIMessageWithMetadata[]",
53
- description: "The messages to send to the agent. Can be a single string, array of strings, or structured message objects.",
54
+ description:
55
+ "The messages to send to the agent. Can be a single string, array of strings, or structured message objects.",
54
56
  },
55
57
  {
56
58
  name: "options",
@@ -75,49 +77,63 @@ await agent.network(`
75
77
  name: "memory",
76
78
  type: "object",
77
79
  isOptional: true,
78
- description: "Configuration for memory. This is the preferred way to manage memory.",
80
+ description:
81
+ "Configuration for memory. This is the preferred way to manage memory.",
79
82
  properties: [
80
83
  {
81
- parameters: [{
84
+ parameters: [
85
+ {
82
86
  name: "thread",
83
87
  type: "string | { id: string; metadata?: Record<string, any>, title?: string }",
84
88
  isOptional: false,
85
- description: "The conversation thread, as a string ID or an object with an `id` and optional `metadata`."
86
- }]
89
+ description:
90
+ "The conversation thread, as a string ID or an object with an `id` and optional `metadata`.",
91
+ },
92
+ ],
87
93
  },
88
94
  {
89
- parameters: [{
95
+ parameters: [
96
+ {
90
97
  name: "resource",
91
98
  type: "string",
92
99
  isOptional: false,
93
- description: "Identifier for the user or resource associated with the thread."
94
- }]
100
+ description:
101
+ "Identifier for the user or resource associated with the thread.",
102
+ },
103
+ ],
95
104
  },
96
105
  {
97
- parameters: [{
106
+ parameters: [
107
+ {
98
108
  name: "options",
99
109
  type: "MemoryConfig",
100
110
  isOptional: true,
101
- description: "Configuration for memory behavior, like message history and semantic recall."
102
- }]
103
- }
104
- ]
111
+ description:
112
+ "Configuration for memory behavior, like message history and semantic recall.",
113
+ },
114
+ ],
115
+ },
116
+ ],
105
117
  },
106
118
  {
107
119
  name: "tracingContext",
108
120
  type: "TracingContext",
109
121
  isOptional: true,
110
- description: "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
122
+ description:
123
+ "AI tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
111
124
  properties: [
112
125
  {
113
- parameters: [{
114
- name: "currentSpan",
115
- type: "AISpan",
116
- isOptional: true,
117
- description: "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution."
118
- }]
119
- }
120
- ]
126
+ parameters: [
127
+ {
128
+ name: "currentSpan",
129
+ type: "AISpan",
130
+ isOptional: true,
131
+ description:
132
+ "Current AI span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
133
+ },
134
+ ],
135
+ },
136
+ ],
121
137
  },
122
138
  {
123
139
  name: "tracingOptions",
@@ -126,14 +142,17 @@ await agent.network(`
126
142
  description: "Options for AI tracing configuration.",
127
143
  properties: [
128
144
  {
129
- parameters: [{
130
- name: "metadata",
131
- type: "Record<string, any>",
132
- isOptional: true,
133
- description: "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags."
134
- }]
135
- }
136
- ]
145
+ parameters: [
146
+ {
147
+ name: "metadata",
148
+ type: "Record<string, any>",
149
+ isOptional: true,
150
+ description:
151
+ "Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.",
152
+ },
153
+ ],
154
+ },
155
+ ],
137
156
  },
138
157
  {
139
158
  name: "telemetry",
@@ -143,38 +162,50 @@ await agent.network(`
143
162
  "Settings for OTLP telemetry collection during streaming (not AI tracing).",
144
163
  properties: [
145
164
  {
146
- parameters: [{
147
- name: "isEnabled",
148
- type: "boolean",
149
- isOptional: true,
150
- description: "Enable or disable telemetry. Disabled by default while experimental."
151
- }]
165
+ parameters: [
166
+ {
167
+ name: "isEnabled",
168
+ type: "boolean",
169
+ isOptional: true,
170
+ description:
171
+ "Enable or disable telemetry. Disabled by default while experimental.",
172
+ },
173
+ ],
152
174
  },
153
175
  {
154
- parameters: [{
155
- name: "recordInputs",
156
- type: "boolean",
157
- isOptional: true,
158
- description: "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information."
159
- }]
176
+ parameters: [
177
+ {
178
+ name: "recordInputs",
179
+ type: "boolean",
180
+ isOptional: true,
181
+ description:
182
+ "Enable or disable input recording. Enabled by default. You might want to disable input recording to avoid recording sensitive information.",
183
+ },
184
+ ],
160
185
  },
161
186
  {
162
- parameters: [{
163
- name: "recordOutputs",
164
- type: "boolean",
165
- isOptional: true,
166
- description: "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information."
167
- }]
187
+ parameters: [
188
+ {
189
+ name: "recordOutputs",
190
+ type: "boolean",
191
+ isOptional: true,
192
+ description:
193
+ "Enable or disable output recording. Enabled by default. You might want to disable output recording to avoid recording sensitive information.",
194
+ },
195
+ ],
168
196
  },
169
197
  {
170
- parameters: [{
171
- name: "functionId",
172
- type: "string",
173
- isOptional: true,
174
- description: "Identifier for this function. Used to group telemetry data by function."
175
- }]
176
- }
177
- ]
198
+ parameters: [
199
+ {
200
+ name: "functionId",
201
+ type: "string",
202
+ isOptional: true,
203
+ description:
204
+ "Identifier for this function. Used to group telemetry data by function.",
205
+ },
206
+ ],
207
+ },
208
+ ],
178
209
  },
179
210
  {
180
211
  name: "modelSettings",
@@ -184,80 +215,103 @@ await agent.network(`
184
215
  "Model-specific settings like temperature, maxTokens, topP, etc. These are passed to the underlying language model.",
185
216
  properties: [
186
217
  {
187
- parameters: [{
188
- name: "temperature",
189
- type: "number",
190
- isOptional: true,
191
- description: "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."
192
- }]
218
+ parameters: [
219
+ {
220
+ name: "temperature",
221
+ type: "number",
222
+ isOptional: true,
223
+ description:
224
+ "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.",
225
+ },
226
+ ],
193
227
  },
194
228
  {
195
- parameters: [{
196
- name: "maxRetries",
197
- type: "number",
198
- isOptional: true,
199
- description: "Maximum number of retries for failed requests."
200
- }]
229
+ parameters: [
230
+ {
231
+ name: "maxRetries",
232
+ type: "number",
233
+ isOptional: true,
234
+ description: "Maximum number of retries for failed requests.",
235
+ },
236
+ ],
201
237
  },
202
238
  {
203
- parameters: [{
204
- name: "topP",
205
- type: "number",
206
- isOptional: true,
207
- description: "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both."
208
- }]
239
+ parameters: [
240
+ {
241
+ name: "topP",
242
+ type: "number",
243
+ isOptional: true,
244
+ description:
245
+ "Nucleus sampling. This is a number between 0 and 1. It is recommended to set either temperature or topP, but not both.",
246
+ },
247
+ ],
209
248
  },
210
249
  {
211
- parameters: [{
212
- name: "topK",
213
- type: "number",
214
- isOptional: true,
215
- description: "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses."
216
- }]
250
+ parameters: [
251
+ {
252
+ name: "topK",
253
+ type: "number",
254
+ isOptional: true,
255
+ description:
256
+ "Only sample from the top K options for each subsequent token. Used to remove 'long tail' low probability responses.",
257
+ },
258
+ ],
217
259
  },
218
260
  {
219
- parameters: [{
220
- name: "presencePenalty",
221
- type: "number",
222
- isOptional: true,
223
- description: "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)."
224
- }]
261
+ parameters: [
262
+ {
263
+ name: "presencePenalty",
264
+ type: "number",
265
+ isOptional: true,
266
+ description:
267
+ "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).",
268
+ },
269
+ ],
225
270
  },
226
271
  {
227
- parameters: [{
228
- name: "frequencyPenalty",
229
- type: "number",
230
- isOptional: true,
231
- description: "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)."
232
- }]
272
+ parameters: [
273
+ {
274
+ name: "frequencyPenalty",
275
+ type: "number",
276
+ isOptional: true,
277
+ description:
278
+ "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).",
279
+ },
280
+ ],
233
281
  },
234
282
  {
235
- parameters: [{
236
- name: "stopSequences",
237
- type: "string[]",
238
- isOptional: true,
239
- description: "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated."
240
- }]
283
+ parameters: [
284
+ {
285
+ name: "stopSequences",
286
+ type: "string[]",
287
+ isOptional: true,
288
+ description:
289
+ "Stop sequences. If set, the model will stop generating text when one of the stop sequences is generated.",
290
+ },
291
+ ],
241
292
  },
242
- ]
293
+ ],
243
294
  },
244
295
  {
245
296
  name: "runId",
246
297
  type: "string",
247
298
  isOptional: true,
248
- description: "Unique ID for this generation run. Useful for tracking and debugging purposes.",
299
+ description:
300
+ "Unique ID for this generation run. Useful for tracking and debugging purposes.",
249
301
  },
250
302
  {
251
303
  name: "runtimeContext",
252
304
  type: "RuntimeContext",
253
305
  isOptional: true,
254
- description: "Runtime context for dependency injection and contextual information.",
306
+ description:
307
+ "Runtime context for dependency injection and contextual information.",
255
308
  },
256
309
  {
257
310
  name: "traceId",
258
311
  type: "string",
259
312
  isOptional: true,
260
- description: "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
313
+ description:
314
+ "The trace ID associated with this execution when AI tracing is enabled. Use this to correlate logs and debug execution flow.",
261
315
  },
262
316
  ]}
263
317
  />
@@ -269,7 +323,8 @@ await agent.network(`
269
323
  {
270
324
  name: "stream",
271
325
  type: "MastraAgentNetworkStream<NetworkChunkType>",
272
- description: "A custom stream that extends ReadableStream<NetworkChunkType> with additional network-specific properties",
326
+ description:
327
+ "A custom stream that extends ReadableStream<NetworkChunkType> with additional network-specific properties",
273
328
  },
274
329
  {
275
330
  name: "status",
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "MastraAuthAuth0 Class"
2
+ title: "Reference: MastraAuthAuth0 Class | Auth | Mastra Docs"
3
3
  description: "API reference for the MastraAuthAuth0 class, which authenticates Mastra applications using Auth0 authentication."
4
4
  ---
5
5
 
@@ -9,16 +9,16 @@ The `MastraAuthAuth0` class provides authentication for Mastra using Auth0. It v
9
9
 
10
10
  ## Usage example
11
11
 
12
- ```typescript filename="src/mastra/index.ts" showLineNumbers copy
12
+ ```typescript title="src/mastra/index.ts" showLineNumbers copy
13
13
  import { Mastra } from "@mastra/core/mastra";
14
- import { MastraAuthAuth0 } from '@mastra/auth-auth0';
14
+ import { MastraAuthAuth0 } from "@mastra/auth-auth0";
15
15
 
16
16
  export const mastra = new Mastra({
17
17
  // ..
18
18
  server: {
19
19
  experimental_auth: new MastraAuthAuth0({
20
20
  domain: process.env.AUTH0_DOMAIN,
21
- audience: process.env.AUTH0_AUDIENCE
21
+ audience: process.env.AUTH0_AUDIENCE,
22
22
  }),
23
23
  },
24
24
  });
@@ -33,28 +33,31 @@ export const mastra = new Mastra({
33
33
  {
34
34
  name: "domain",
35
35
  type: "string",
36
- description: "Your Auth0 domain (e.g., your-tenant.auth0.com). This is used to verify JWT tokens issued by your Auth0 tenant.",
36
+ description:
37
+ "Your Auth0 domain (e.g., your-tenant.auth0.com). This is used to verify JWT tokens issued by your Auth0 tenant.",
37
38
  isOptional: true,
38
- defaultValue: "process.env.AUTH0_DOMAIN"
39
+ defaultValue: "process.env.AUTH0_DOMAIN",
39
40
  },
40
41
  {
41
42
  name: "audience",
42
43
  type: "string",
43
- description: "Your Auth0 API identifier/audience. This ensures tokens are intended for your specific API.",
44
+ description:
45
+ "Your Auth0 API identifier/audience. This ensures tokens are intended for your specific API.",
44
46
  isOptional: true,
45
- defaultValue: "process.env.AUTH0_AUDIENCE"
47
+ defaultValue: "process.env.AUTH0_AUDIENCE",
46
48
  },
47
49
  {
48
50
  name: "name",
49
51
  type: "string",
50
52
  description: "Custom name for the auth provider instance.",
51
53
  isOptional: true,
52
- defaultValue: '"auth0"'
54
+ defaultValue: '"auth0"',
53
55
  },
54
56
  {
55
57
  name: "authorizeUser",
56
58
  type: "(user: Auth0User) => Promise<boolean> | boolean",
57
- description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users with valid tokens.",
59
+ description:
60
+ "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users with valid tokens.",
58
61
  isOptional: true,
59
62
  },
60
63
  ]}
@@ -69,13 +72,15 @@ The following environment variables are automatically used when constructor opti
69
72
  {
70
73
  name: "AUTH0_DOMAIN",
71
74
  type: "string",
72
- description: "Your Auth0 domain. Can be found in your Auth0 Dashboard under Applications > Settings.",
75
+ description:
76
+ "Your Auth0 domain. Can be found in your Auth0 Dashboard under Applications > Settings.",
73
77
  isOptional: true,
74
78
  },
75
79
  {
76
80
  name: "AUTH0_AUDIENCE",
77
81
  type: "string",
78
- description: "Your Auth0 API identifier. This is the identifier you set when creating an API in your Auth0 Dashboard.",
82
+ description:
83
+ "Your Auth0 API identifier. This is the identifier you set when creating an API in your Auth0 Dashboard.",
79
84
  isOptional: true,
80
85
  },
81
86
  ]}
@@ -113,5 +118,4 @@ The exact properties available depend on your Auth0 configuration, scopes reques
113
118
 
114
119
  ## Related
115
120
 
116
- [MastraAuthAuth0 Class](/docs/auth/auth0.mdx)
117
-
121
+ [MastraAuthAuth0 Class](/docs/auth/auth0)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "MastraAuthClerk Class"
2
+ title: "Reference: MastraAuthClerk Class | Auth | Mastra Docs"
3
3
  description: "API reference for the MastraAuthClerk class, which authenticates Mastra applications using Clerk authentication."
4
4
  ---
5
5
 
@@ -9,9 +9,9 @@ The `MastraAuthClerk` class provides authentication for Mastra applications usin
9
9
 
10
10
  ## Usage example
11
11
 
12
- ```typescript filename="src/mastra/index.ts" showLineNumbers copy
12
+ ```typescript title="src/mastra/index.ts" showLineNumbers copy
13
13
  import { Mastra } from "@mastra/core/mastra";
14
- import { MastraAuthClerk } from '@mastra/auth-clerk';
14
+ import { MastraAuthClerk } from "@mastra/auth-clerk";
15
15
 
16
16
  export const mastra = new Mastra({
17
17
  // ..
@@ -32,23 +32,26 @@ export const mastra = new Mastra({
32
32
  {
33
33
  name: "publishableKey",
34
34
  type: "string",
35
- description: "Your Clerk publishable key. Can be found in your Clerk Dashboard under API Keys.",
35
+ description:
36
+ "Your Clerk publishable key. Can be found in your Clerk Dashboard under API Keys.",
36
37
  isOptional: true,
37
- defaultValue: "process.env.CLERK_PUBLISHABLE_KEY"
38
+ defaultValue: "process.env.CLERK_PUBLISHABLE_KEY",
38
39
  },
39
40
  {
40
41
  name: "secretKey",
41
42
  type: "string",
42
- description: "Your Clerk secret key. Used for server-side authentication and token verification.",
43
+ description:
44
+ "Your Clerk secret key. Used for server-side authentication and token verification.",
43
45
  isOptional: true,
44
- defaultValue: "process.env.CLERK_SECRET_KEY"
46
+ defaultValue: "process.env.CLERK_SECRET_KEY",
45
47
  },
46
48
  {
47
49
  name: "jwksUri",
48
50
  type: "string",
49
- description: "The JWKS URI from your Clerk application. Used to verify JWT signatures.",
51
+ description:
52
+ "The JWKS URI from your Clerk application. Used to verify JWT signatures.",
50
53
  isOptional: true,
51
- defaultValue: "process.env.CLERK_JWKS_URI"
54
+ defaultValue: "process.env.CLERK_JWKS_URI",
52
55
  },
53
56
  {
54
57
  name: "name",
@@ -59,7 +62,8 @@ export const mastra = new Mastra({
59
62
  {
60
63
  name: "authorizeUser",
61
64
  type: "(user: User, request: HonoRequest) => Promise<boolean> | boolean",
62
- description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users.",
65
+ description:
66
+ "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, allows all authenticated users.",
63
67
  isOptional: true,
64
68
  },
65
69
  ]}
@@ -67,5 +71,4 @@ export const mastra = new Mastra({
67
71
 
68
72
  ## Related
69
73
 
70
- [MastraAuthClerk Class](/docs/auth/clerk.mdx)
71
-
74
+ [MastraAuthClerk Class](/docs/auth/clerk)