@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,9 +1,10 @@
1
1
  ---
2
- title: "MastraAuthSupabase Class"
2
+ title: "MastraAuthSupabase Class | Auth | Mastra Docs"
3
3
  description: "Documentation for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
4
4
  ---
5
5
 
6
- import { Tabs, Tab } from "@/components/tabs";
6
+ import Tabs from "@theme/Tabs";
7
+ import TabItem from "@theme/TabItem";
7
8
 
8
9
  # MastraAuthSupabase Class
9
10
 
@@ -13,7 +14,7 @@ The `MastraAuthSupabase` class provides authentication for Mastra using Supabase
13
14
 
14
15
  This example uses Supabase Auth. Make sure to add your Supabase credentials to your `.env` file and ensure your Supabase project is properly configured.
15
16
 
16
- ```env filename=".env" copy
17
+ ```env title=".env" copy
17
18
  SUPABASE_URL=https://your-project.supabase.co
18
19
  SUPABASE_ANON_KEY=your-anon-key
19
20
  ```
@@ -30,16 +31,16 @@ npm install @mastra/auth-supabase@latest
30
31
 
31
32
  ## Usage example
32
33
 
33
- ```typescript {2,7-9} filename="src/mastra/index.ts" showLineNumbers copy
34
+ ```typescript {2,7-9} title="src/mastra/index.ts" showLineNumbers copy
34
35
  import { Mastra } from "@mastra/core/mastra";
35
- import { MastraAuthSupabase } from '@mastra/auth-supabase';
36
+ import { MastraAuthSupabase } from "@mastra/auth-supabase";
36
37
 
37
38
  export const mastra = new Mastra({
38
39
  // ..
39
40
  server: {
40
41
  experimental_auth: new MastraAuthSupabase({
41
42
  url: process.env.SUPABASE_URL,
42
- anonKey: process.env.SUPABASE_ANON_KEY
43
+ anonKey: process.env.SUPABASE_ANON_KEY,
43
44
  }),
44
45
  },
45
46
  });
@@ -47,7 +48,7 @@ export const mastra = new Mastra({
47
48
 
48
49
  > **Note:** The default `authorizeUser` method checks the `isAdmin` column in the `users` table in the `public` schema. To customize user authorization, provide a custom `authorizeUser` function when constructing the provider.
49
50
 
50
- > See the [MastraAuthSupabase](/reference/auth/supabase.mdx) API reference for all available configuration options.
51
+ > See the [MastraAuthSupabase](/reference/auth/supabase) API reference for all available configuration options.
51
52
 
52
53
  ## Client-side setup
53
54
 
@@ -57,7 +58,7 @@ When using Supabase auth, you'll need to retrieve the access token from Supabase
57
58
 
58
59
  Use the Supabase client to authenticate users and retrieve their access token:
59
60
 
60
- ```typescript filename="lib/auth.ts" showLineNumbers copy
61
+ ```typescript title="lib/auth.ts" showLineNumbers copy
61
62
  import { createClient } from "@supabase/supabase-js";
62
63
 
63
64
  const supabase = createClient("<supabase-url>", "<supabase-key>");
@@ -76,28 +77,28 @@ const accessToken = authTokenResponse.data?.session?.access_token;
76
77
 
77
78
  When `experimental_auth` is enabled, all requests made with `MastraClient` must include a valid Supabase access token in the `Authorization` header:
78
79
 
79
- ```typescript {6} filename="lib/mastra/mastra-client.ts" showLineNumbers copy
80
+ ```typescript {6} title="lib/mastra/mastra-client.ts" showLineNumbers copy
80
81
  import { MastraClient } from "@mastra/client-js";
81
82
 
82
83
  export const mastraClient = new MastraClient({
83
84
  baseUrl: "https://<mastra-api-url>",
84
85
  headers: {
85
- Authorization: `Bearer ${accessToken}`
86
- }
86
+ Authorization: `Bearer ${accessToken}`,
87
+ },
87
88
  });
88
89
  ```
89
90
 
90
91
  > **Note:** The access token must be prefixed with `Bearer` in the Authorization header.
91
92
 
92
- > See [Mastra Client SDK](/docs/server-db/mastra-client.mdx) for more configuration options.
93
+ > See [Mastra Client SDK](/docs/server-db/mastra-client) for more configuration options.
93
94
 
94
95
  ### Making authenticated requests
95
96
 
96
97
  Once `MastraClient` is configured with the Supabase access token, you can send authenticated requests:
97
98
 
98
- <Tabs items={["MastraClient", "curl"]}>
99
- <Tab>
100
- ```tsx filename="src/components/test-agent.tsx" showLineNumbers copy
99
+ <Tabs>
100
+ <TabItem value="curl" label="cURL">
101
+ ```tsx title="src/components/test-agent.tsx" showLineNumbers copy
101
102
  import { mastraClient } from "../../lib/mastra-client";
102
103
 
103
104
  export const TestAgent = () => {
@@ -114,8 +115,9 @@ Once `MastraClient` is configured with the Supabase access token, you can send a
114
115
  return <button onClick={handleClick}>Test Agent</button>;
115
116
  };
116
117
  ```
117
- </Tab>
118
- <Tab>
118
+
119
+ </TabItem>
120
+ <TabItem value="react" label="React">
119
121
  ```bash copy
120
122
  curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
121
123
  -H "Content-Type: application/json" \
@@ -124,5 +126,5 @@ Once `MastraClient` is configured with the Supabase access token, you can send a
124
126
  "messages": "Weather in London"
125
127
  }'
126
128
  ```
127
- </Tab>
129
+ </TabItem>
128
130
  </Tabs>
@@ -1,9 +1,10 @@
1
1
  ---
2
- title: "MastraAuthWorkos Class"
2
+ title: "MastraAuthWorkos Class | Auth | Mastra Docs"
3
3
  description: "Documentation for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication."
4
4
  ---
5
5
 
6
- import { Tabs, Tab } from "@/components/tabs";
6
+ import Tabs from "@theme/Tabs";
7
+ import TabItem from "@theme/TabItem";
7
8
 
8
9
  # MastraAuthWorkos Class
9
10
 
@@ -18,7 +19,7 @@ This example uses WorkOS authentication. Make sure to:
18
19
  3. Configure your redirect URIs and allowed origins
19
20
  4. Set up Organizations and configure user roles as needed
20
21
 
21
- ```env filename=".env" copy
22
+ ```env title=".env" copy
22
23
  WORKOS_API_KEY=sk_live_...
23
24
  WORKOS_CLIENT_ID=client_...
24
25
  ```
@@ -39,9 +40,9 @@ npm install @mastra/auth-workos@latest
39
40
 
40
41
  ### Basic usage with environment variables
41
42
 
42
- ```typescript {2,7} filename="src/mastra/index.ts" showLineNumbers copy
43
+ ```typescript {2,7} title="src/mastra/index.ts" showLineNumbers copy
43
44
  import { Mastra } from "@mastra/core/mastra";
44
- import { MastraAuthWorkos } from '@mastra/auth-workos';
45
+ import { MastraAuthWorkos } from "@mastra/auth-workos";
45
46
 
46
47
  export const mastra = new Mastra({
47
48
  // ..
@@ -53,16 +54,16 @@ export const mastra = new Mastra({
53
54
 
54
55
  ### Custom configuration
55
56
 
56
- ```typescript {2,7-10} filename="src/mastra/index.ts" showLineNumbers copy
57
+ ```typescript {2,7-10} title="src/mastra/index.ts" showLineNumbers copy
57
58
  import { Mastra } from "@mastra/core/mastra";
58
- import { MastraAuthWorkos } from '@mastra/auth-workos';
59
+ import { MastraAuthWorkos } from "@mastra/auth-workos";
59
60
 
60
61
  export const mastra = new Mastra({
61
62
  // ..
62
63
  server: {
63
64
  experimental_auth: new MastraAuthWorkos({
64
65
  apiKey: process.env.WORKOS_API_KEY,
65
- clientId: process.env.WORKOS_CLIENT_ID
66
+ clientId: process.env.WORKOS_CLIENT_ID,
66
67
  }),
67
68
  },
68
69
  });
@@ -81,8 +82,8 @@ By default, `MastraAuthWorkos` checks whether the authenticated user has an 'adm
81
82
 
82
83
  To customize user authorization, provide a custom `authorizeUser` function:
83
84
 
84
- ```typescript filename="src/mastra/auth.ts" showLineNumbers copy
85
- import { MastraAuthWorkos } from '@mastra/auth-workos';
85
+ ```typescript title="src/mastra/auth.ts" showLineNumbers copy
86
+ import { MastraAuthWorkos } from "@mastra/auth-workos";
86
87
 
87
88
  const workosAuth = new MastraAuthWorkos({
88
89
  apiKey: process.env.WORKOS_API_KEY,
@@ -111,16 +112,20 @@ npm install @workos-inc/node
111
112
 
112
113
  After users complete the WorkOS authentication flow and return with an authorization code, exchange it for an access token:
113
114
 
114
- ```typescript filename="lib/auth.ts" showLineNumbers copy
115
- import { WorkOS } from '@workos-inc/node';
115
+ ```typescript title="lib/auth.ts" showLineNumbers copy
116
+ import { WorkOS } from "@workos-inc/node";
116
117
 
117
118
  const workos = new WorkOS(process.env.WORKOS_API_KEY);
118
119
 
119
- export const authenticateWithWorkos = async (code: string, clientId: string) => {
120
- const authenticationResponse = await workos.userManagement.authenticateWithCode({
121
- code,
122
- clientId,
123
- });
120
+ export const authenticateWithWorkos = async (
121
+ code: string,
122
+ clientId: string,
123
+ ) => {
124
+ const authenticationResponse =
125
+ await workos.userManagement.authenticateWithCode({
126
+ code,
127
+ clientId,
128
+ });
124
129
 
125
130
  return authenticationResponse.accessToken;
126
131
  };
@@ -132,15 +137,15 @@ export const authenticateWithWorkos = async (code: string, clientId: string) =>
132
137
 
133
138
  When `experimental_auth` is enabled, all requests made with `MastraClient` must include a valid WorkOS access token in the `Authorization` header:
134
139
 
135
- ```typescript filename="lib/mastra/mastra-client.ts" showLineNumbers copy
140
+ ```typescript title="lib/mastra/mastra-client.ts" showLineNumbers copy
136
141
  import { MastraClient } from "@mastra/client-js";
137
142
 
138
143
  export const createMastraClient = (accessToken: string) => {
139
144
  return new MastraClient({
140
145
  baseUrl: "https://<mastra-api-url>",
141
146
  headers: {
142
- Authorization: `Bearer ${accessToken}`
143
- }
147
+ Authorization: `Bearer ${accessToken}`,
148
+ },
144
149
  });
145
150
  };
146
151
  ```
@@ -153,9 +158,9 @@ export const createMastraClient = (accessToken: string) => {
153
158
 
154
159
  Once `MastraClient` is configured with the WorkOS access token, you can send authenticated requests:
155
160
 
156
- <Tabs items={["JavaScript/Node.js", "curl"]}>
157
- <Tab>
158
- ```typescript filename="src/api/agents.ts" showLineNumbers copy
161
+ <Tabs>
162
+ <TabItem value="curl" label="cURL">
163
+ ```typescript title="src/api/agents.ts" showLineNumbers copy
159
164
  import { WorkOS } from '@workos-inc/node';
160
165
  import { MastraClient } from '@mastra/client-js';
161
166
 
@@ -184,8 +189,9 @@ Once `MastraClient` is configured with the WorkOS access token, you can send aut
184
189
  return response.text;
185
190
  };
186
191
  ```
187
- </Tab>
188
- <Tab>
192
+
193
+ </TabItem>
194
+ <TabItem value="react" label="React">
189
195
  ```bash copy
190
196
  curl -X POST http://localhost:4111/api/agents/weatherAgent/generate \
191
197
  -H "Content-Type: application/json" \
@@ -194,5 +200,5 @@ Once `MastraClient` is configured with the WorkOS access token, you can send aut
194
200
  "messages": "Weather in London"
195
201
  }'
196
202
  ```
197
- </Tab>
203
+ </TabItem>
198
204
  </Tabs>
@@ -1,10 +1,8 @@
1
1
  ---
2
- title: "Contributing Templates"
2
+ title: "Contributing Templates | Community | Mastra Docs"
3
3
  description: "How to contribute your own templates to the Mastra ecosystem"
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # Contributing Templates
9
7
 
10
8
  The Mastra community plays a vital role in creating templates that showcase innovative application patterns. This guide explains how to contribute your own templates to the Mastra ecosystem.
@@ -15,7 +13,7 @@ The Mastra community plays a vital role in creating templates that showcase inno
15
13
 
16
14
  Before creating a template, ensure you understand:
17
15
 
18
- - [Templates Reference](/reference/templates) - Technical requirements and conventions
16
+ - [Templates Reference](/reference/templates/overview) - Technical requirements and conventions
19
17
  - [Project Structure](/docs/getting-started/project-structure) - Standard Mastra project organization
20
18
  - Community guidelines and quality standards
21
19
 
@@ -58,7 +56,7 @@ Templates must meet these quality benchmarks:
58
56
 
59
57
  ### 1. Prepare Your Template
60
58
 
61
- Ensure your template meets all requirements outlined in the [Templates Reference](/reference/templates):
59
+ Ensure your template meets all requirements outlined in the [Templates Reference](/reference/templates/overview):
62
60
 
63
61
  - Proper project structure in `src/mastra/` directory
64
62
  - Standard TypeScript configuration
@@ -188,6 +186,8 @@ Ready to contribute a template?
188
186
  4. **Build and test** - Create a working, well-documented template
189
187
  5. **Submit for review** - Use the contribution form to submit your template
190
188
 
191
- <Callout type="info">
189
+ :::info
190
+
192
191
  Your contributions help grow the Mastra ecosystem and provide valuable resources for the entire community. We look forward to seeing your innovative templates!
193
- </Callout>
192
+
193
+ :::
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Discord Community and Bot | Documentation | Mastra"
2
+ title: "Discord Community | Community | Mastra Docs"
3
3
  description: Information about the Mastra Discord community and MCP bot.
4
4
  ---
5
5
 
@@ -9,4 +9,4 @@ The Discord server has over 1000 members and serves as the main discussion forum
9
9
 
10
10
  ## Discord MCP Bot
11
11
 
12
- In addition to community members, we have an (experimental!) Discord bot that can also help answer questions. It uses [Model Context Protocol (MCP)](/docs/agents/mcp-guide). You can ask it a question with `/ask` (either in public channels or DMs) and clear history (in DMs only) with `/cleardm`.
12
+ In addition to community members, we have an (experimental!) Discord bot that can also help answer questions. It uses [Model Context Protocol (MCP)](/docs/tools-mcp/mcp-overview). You can ask it a question with `/ask` (either in public channels or DMs) and clear history (in DMs only) with `/cleardm`.
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Licensing"
2
+ title: "License | Community | Mastra Docs"
3
3
  description: "Mastra License"
4
4
  ---
5
5
 
@@ -1,32 +0,0 @@
1
- # Updating Your Mastra Export
2
-
3
- Make sure to update your `src/mastra/index.ts` file to include your new comprehensive memory agent:
4
-
5
- ```typescript
6
- import { Mastra } from "@mastra/core";
7
- import { memoryMasterAgent } from "./agents/memory-agent";
8
-
9
- export const mastra: Mastra = new Mastra({
10
- agents: {
11
- memoryMasterAgent,
12
- },
13
- });
14
- ```
15
-
16
- This step is essential for making your comprehensive memory agent available in the Mastra playground. The `mastra` export is the main entry point for your Mastra application, and it needs to include all the agents you want to use.
17
-
18
- By adding your `memoryMasterAgent` to the `agents` object in the Mastra configuration, you're registering it with the Mastra system, making it available for use in the playground and other parts of your application.
19
-
20
- If you have multiple agents, you can include them all in the `agents` object:
21
-
22
- ```typescript
23
- export const mastra: Mastra = new Mastra({
24
- agents: {
25
- memoryMasterAgent,
26
- learningAssistantAgent,
27
- // Other agents...
28
- },
29
- });
30
- ```
31
-
32
- This allows you to switch between different agents in the playground, each with its own specialized memory configuration and capabilities.
@@ -1,20 +1,23 @@
1
1
  ---
2
- title: "Amazon EC2"
2
+ title: "Amazon EC2 | Deployment | Mastra Docs"
3
3
  description: "Deploy your Mastra applications to Amazon EC2."
4
4
  ---
5
5
 
6
- import { Callout, Steps, Tabs } from "nextra/components";
6
+ import Steps from "@site/src/components/Steps";
7
+ import StepItem from "@site/src/components/StepItem";
8
+ import Tabs from "@theme/Tabs";
9
+ import TabItem from "@theme/TabItem";
7
10
 
8
11
  # Amazon EC2
9
12
 
10
13
  Deploy your Mastra applications to Amazon EC2 (Elastic Cloud Compute).
11
14
 
12
- <Callout>
13
- This guide assumes your Mastra application has been created using the default
14
- `npx create-mastra@latest` command.
15
- For more information on how to create a new Mastra application,
16
- refer to our [getting started guide](/docs/getting-started/installation)
17
- </Callout>
15
+ :::note
16
+ This guide assumes your Mastra application has been created using the default
17
+ `npx create-mastra@latest` command.
18
+ For more information on how to create a new Mastra application,
19
+ refer to our [getting started guide](/docs/getting-started/installation)
20
+ :::
18
21
 
19
22
  ## Prerequisites
20
23
 
@@ -29,26 +32,26 @@ Deploy your Mastra applications to Amazon EC2 (Elastic Cloud Compute).
29
32
 
30
33
  <Steps>
31
34
 
32
- ### Clone your Mastra application
35
+ <StepItem>
33
36
 
34
37
  Connect to your EC2 instance and clone your repository:
35
38
 
36
- <Tabs items={["Public Repository", "Private Repository"]}>
37
- <Tabs.Tab>
39
+ <Tabs>
40
+ <TabItem value="public" label="Public Repository">
38
41
 
39
42
  ```bash copy
40
43
  git clone https://github.com/<your-username>/<your-repository>.git
41
44
  ```
42
45
 
43
- </Tabs.Tab>
46
+ </TabItem>
44
47
 
45
- <Tabs.Tab>
48
+ <TabItem value="private" label="Private Repository">
46
49
 
47
50
  ```bash copy
48
51
  git clone https://<your-username>:<your-personal-access-token>@github.com/<your-username>/<your-repository>.git
49
52
  ```
50
53
 
51
- </Tabs.Tab>
54
+ </TabItem>
52
55
  </Tabs>
53
56
 
54
57
  Navigate to the repository directory:
@@ -57,13 +60,19 @@ Navigate to the repository directory:
57
60
  cd "<your-repository>"
58
61
  ```
59
62
 
60
- ### Install dependencies
63
+ </StepItem>
64
+
65
+ <StepItem>
66
+
67
+ Install dependencies:
61
68
 
62
69
  ```bash copy
63
70
  npm install
64
71
  ```
65
72
 
66
- ### Set up environment variables
73
+ </StepItem>
74
+
75
+ <StepItem>
67
76
 
68
77
  Create a `.env` file and add your environment variables:
69
78
 
@@ -78,21 +87,31 @@ OPENAI_API_KEY=<your-openai-api-key>
78
87
  # Add other required environment variables
79
88
  ```
80
89
 
81
- ### Build the application
90
+ </StepItem>
91
+
92
+ <StepItem>
93
+
94
+ Build the application:
82
95
 
83
96
  ```bash copy
84
97
  npm run build
85
98
  ```
86
99
 
87
- ### Run the application
100
+ </StepItem>
101
+
102
+ <StepItem>
103
+
104
+ Run the application:
88
105
 
89
106
  ```bash copy
90
107
  node --import=./.mastra/output/instrumentation.mjs --env-file=".env" .mastra/output/index.mjs
91
108
  ```
92
109
 
93
- <Callout>
110
+ :::note
94
111
  Your Mastra application will run on port 4111 by default. Ensure your reverse proxy is configured to forward requests to this port.
95
- </Callout>
112
+ :::
113
+
114
+ </StepItem>
96
115
 
97
116
  </Steps>
98
117
 
@@ -100,7 +119,7 @@ Your Mastra application will run on port 4111 by default. Ensure your reverse pr
100
119
 
101
120
  You can now connect to your Mastra server from your client application using a `MastraClient` from the `@mastra/client-js` package.
102
121
 
103
- Refer to the [`MastraClient` documentation](/docs/client-js/overview) for more information.
122
+ Refer to the [`MastraClient` documentation](/reference/client-js/mastra-client) for more information.
104
123
 
105
124
  ```typescript copy showLineNumbers
106
125
  import { MastraClient } from "@mastra/client-js";
@@ -112,4 +131,4 @@ const mastraClient = new MastraClient({
112
131
 
113
132
  ## Next steps
114
133
 
115
- - [Mastra Client SDK](/docs/client-js/overview)
134
+ - [Mastra Client SDK](/reference/client-js/mastra-client)