@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
@@ -10,7 +10,7 @@ The `getScorers()` method returns all scorers that have been registered with the
10
10
  ## Usage Example
11
11
 
12
12
  ```typescript
13
- import { mastra } from './mastra';
13
+ import { mastra } from "./mastra";
14
14
 
15
15
  // Get all registered scorers
16
16
  const allScorers = mastra.getScorers();
@@ -30,7 +30,8 @@ This method takes no parameters.
30
30
  {
31
31
  name: "scorers",
32
32
  type: "Record<string, MastraScorer> | undefined",
33
- description: "An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.",
33
+ description:
34
+ "An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.",
34
35
  },
35
36
  ]}
36
37
  />
@@ -24,12 +24,13 @@ This method does not accept any parameters.
24
24
  {
25
25
  name: "server",
26
26
  type: "ServerConfig | undefined",
27
- description: "The configured server configuration including port, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.",
27
+ description:
28
+ "The configured server configuration including port, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.",
28
29
  },
29
30
  ]}
30
31
  />
31
32
 
32
33
  ## Related
33
34
 
34
- - [Server deployment](../../docs/deployment/server-deployment.mdx)
35
- - [Server configuration](../../docs/server-db/custom-api-routes.mdx)
35
+ - [Server deployment](/docs/deployment/server-deployment)
36
+ - [Server configuration](/docs/server-db/custom-api-routes)
@@ -24,12 +24,13 @@ This method does not accept any parameters.
24
24
  {
25
25
  name: "storage",
26
26
  type: "MastraStorage | undefined",
27
- description: "The configured storage instance, or undefined if no storage has been configured.",
27
+ description:
28
+ "The configured storage instance, or undefined if no storage has been configured.",
28
29
  },
29
30
  ]}
30
31
  />
31
32
 
32
33
  ## Related
33
34
 
34
- - [Storage overview](../../docs/server-db/storage.mdx)
35
- - [Storage reference](../../reference/storage/libsql.mdx)
35
+ - [Storage overview](/docs/server-db/storage)
36
+ - [Storage reference](/reference/storage/libsql)
@@ -24,12 +24,13 @@ This method does not accept any parameters.
24
24
  {
25
25
  name: "telemetry",
26
26
  type: "Telemetry | undefined",
27
- description: "The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.",
27
+ description:
28
+ "The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.",
28
29
  },
29
30
  ]}
30
31
  />
31
32
 
32
33
  ## Related
33
34
 
34
- - [AI tracing](../../docs/observability/ai-tracing.mdx)
35
- - [Telemetry reference](../../reference/observability/otel-config.mdx)
35
+ - [AI tracing](/docs/observability/ai-tracing/overview)
36
+ - [Telemetry reference](/reference/observability/otel-tracing/otel-config)
@@ -20,7 +20,8 @@ mastra.getVector("testVectorStore");
20
20
  {
21
21
  name: "name",
22
22
  type: "TVectorName extends keyof TVectors",
23
- description: "The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.",
23
+ description:
24
+ "The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.",
24
25
  },
25
26
  ]}
26
27
  />
@@ -32,12 +33,13 @@ mastra.getVector("testVectorStore");
32
33
  {
33
34
  name: "vector",
34
35
  type: "TVectors[TVectorName]",
35
- description: "The vector store instance with the specified name. Throws an error if the vector store is not found.",
36
+ description:
37
+ "The vector store instance with the specified name. Throws an error if the vector store is not found.",
36
38
  },
37
39
  ]}
38
40
  />
39
41
 
40
42
  ## Related
41
43
 
42
- - [Vector stores overview](../../docs/rag/vector-databases.mdx)
43
- - [RAG overview](../../docs/rag/overview.mdx)
44
+ - [Vector stores overview](/docs/rag/vector-databases)
45
+ - [RAG overview](/docs/rag/overview)
@@ -24,12 +24,13 @@ This method does not accept any parameters.
24
24
  {
25
25
  name: "vectors",
26
26
  type: "TVectors",
27
- description: "A record of all configured vector stores, where keys are vector store names and values are vector store instances.",
27
+ description:
28
+ "A record of all configured vector stores, where keys are vector store names and values are vector store instances.",
28
29
  },
29
30
  ]}
30
31
  />
31
32
 
32
33
  ## Related
33
34
 
34
- - [Vector stores overview](../../docs/rag/vector-databases.mdx)
35
- - [RAG overview](../../docs/rag/overview.mdx)
35
+ - [Vector stores overview](/docs/rag/vector-databases)
36
+ - [RAG overview](/docs/rag/overview)
@@ -20,12 +20,14 @@ mastra.getWorkflow("testWorkflow");
20
20
  {
21
21
  name: "id",
22
22
  type: "TWorkflowId extends keyof TWorkflows",
23
- description: "The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.",
23
+ description:
24
+ "The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.",
24
25
  },
25
26
  {
26
27
  name: "options",
27
28
  type: "{ serialized?: boolean }",
28
- description: "Optional configuration object. When `serialized` is true, returns only the workflow name instead of the full workflow instance.",
29
+ description:
30
+ "Optional configuration object. When `serialized` is true, returns only the workflow name instead of the full workflow instance.",
29
31
  optional: true,
30
32
  },
31
33
  ]}
@@ -38,11 +40,12 @@ mastra.getWorkflow("testWorkflow");
38
40
  {
39
41
  name: "workflow",
40
42
  type: "TWorkflows[TWorkflowId]",
41
- description: "The workflow instance with the specified ID. Throws an error if the workflow is not found.",
43
+ description:
44
+ "The workflow instance with the specified ID. Throws an error if the workflow is not found.",
42
45
  },
43
46
  ]}
44
47
  />
45
48
 
46
49
  ## Related
47
50
 
48
- - [Workflows overview](../../docs/workflows/overview.mdx)
51
+ - [Workflows overview](/docs/workflows/overview)
@@ -20,7 +20,8 @@ mastra.getWorkflows();
20
20
  {
21
21
  name: "options",
22
22
  type: "{ serialized?: boolean }",
23
- description: "Optional configuration object. When `serialized` is true, returns simplified workflow objects with only the name property instead of full workflow instances.",
23
+ description:
24
+ "Optional configuration object. When `serialized` is true, returns simplified workflow objects with only the name property instead of full workflow instances.",
24
25
  optional: true,
25
26
  },
26
27
  ]}
@@ -33,11 +34,12 @@ mastra.getWorkflows();
33
34
  {
34
35
  name: "workflows",
35
36
  type: "Record<string, Workflow>",
36
- description: "A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).",
37
+ description:
38
+ "A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).",
37
39
  },
38
40
  ]}
39
41
  />
40
42
 
41
43
  ## Related
42
44
 
43
- - [Workflows overview](../../docs/workflows/overview.mdx)
45
+ - [Workflows overview](/docs/workflows/overview)
@@ -12,15 +12,14 @@ Think of `Mastra` as a top-level registry:
12
12
  - Registering **integrations** makes them accessible to **agents**, **workflows**, and **tools** alike.
13
13
  - **tools** aren’t registered on `Mastra` directly but are associated with agents and discovered automatically.
14
14
 
15
-
16
15
  ## Usage example
17
16
 
18
- ```typescript filename="src/mastra/index.ts"
19
- import { Mastra } from '@mastra/core/mastra';
20
- import { PinoLogger } from '@mastra/loggers';
21
- import { LibSQLStore } from '@mastra/libsql';
22
- import { weatherWorkflow } from './workflows/weather-workflow';
23
- import { weatherAgent } from './agents/weather-agent';
17
+ ```typescript title="src/mastra/index.ts"
18
+ import { Mastra } from "@mastra/core/mastra";
19
+ import { PinoLogger } from "@mastra/loggers";
20
+ import { LibSQLStore } from "@mastra/libsql";
21
+ import { weatherWorkflow } from "./workflows/weather-workflow";
22
+ import { weatherAgent } from "./agents/weather-agent";
24
23
 
25
24
  export const mastra = new Mastra({
26
25
  workflows: { weatherWorkflow },
@@ -29,8 +28,8 @@ export const mastra = new Mastra({
29
28
  url: ":memory:",
30
29
  }),
31
30
  logger: new PinoLogger({
32
- name: 'Mastra',
33
- level: 'info',
31
+ name: "Mastra",
32
+ level: "info",
34
33
  }),
35
34
  });
36
35
  ```
@@ -77,7 +76,8 @@ export const mastra = new Mastra({
77
76
  {
78
77
  name: "idGenerator",
79
78
  type: "() => string",
80
- description: "Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.",
79
+ description:
80
+ "Custom ID generator function. Used by agents, workflows, memory, and other components to generate unique identifiers.",
81
81
  isOptional: true,
82
82
  },
83
83
  {
@@ -125,19 +125,19 @@ export const mastra = new Mastra({
125
125
  {
126
126
  name: "bundler",
127
127
  type: "BundlerConfig",
128
- description: "Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.",
128
+ description:
129
+ "Configuration for the asset bundler with options for externals, sourcemap, and transpilePackages.",
129
130
  isOptional: true,
130
- defaultValue: "{ externals: [], sourcemap: false, transpilePackages: [] }",
131
+ defaultValue:
132
+ "{ externals: [], sourcemap: false, transpilePackages: [] }",
131
133
  },
132
134
  {
133
135
  name: "scorers",
134
136
  type: "Record<string, MastraScorer>",
135
- description: "Scorers to register for scoring traces and overriding default scorers used during agent generation or workflow execution. Structured as a key-value pair, with keys being the scorer name and values being the scorer instance.",
137
+ description:
138
+ "Scorers to register for scoring traces and overriding default scorers used during agent generation or workflow execution. Structured as a key-value pair, with keys being the scorer name and values being the scorer instance.",
136
139
  isOptional: true,
137
140
  defaultValue: "{}",
138
141
  },
139
142
  ]}
140
143
  />
141
-
142
-
143
-
@@ -20,7 +20,8 @@ mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
20
20
  {
21
21
  name: "options",
22
22
  type: "{ logger: TLogger }",
23
- description: "An object containing the logger instance to set for all components.",
23
+ description:
24
+ "An object containing the logger instance to set for all components.",
24
25
  },
25
26
  ]}
26
27
  />
@@ -32,7 +33,8 @@ mastra.setLogger({ logger: new PinoLogger({ name: "testLogger" }) });
32
33
  {
33
34
  name: "logger",
34
35
  type: "TLogger",
35
- description: "The logger instance to set for all components (agents, workflows, etc.).",
36
+ description:
37
+ "The logger instance to set for all components (agents, workflows, etc.).",
36
38
  },
37
39
  ]}
38
40
  />
@@ -43,5 +45,5 @@ This method does not return a value.
43
45
 
44
46
  ## Related
45
47
 
46
- - [Logging overview](../../docs/observability/logging.mdx)
47
- - [Logger reference](../../reference/observability/logger.mdx)
48
+ - [Logging overview](/docs/observability/logging)
49
+ - [Logger reference](/reference/observability/logging/pino-logger)
@@ -12,8 +12,8 @@ The `.setStorage()` method is used to set the storage instance for the Mastra in
12
12
  ```typescript copy
13
13
  mastra.setStorage(
14
14
  new LibSQLStore({
15
- url: ":memory:"
16
- })
15
+ url: ":memory:",
16
+ }),
17
17
  );
18
18
  ```
19
19
 
@@ -35,5 +35,5 @@ This method does not return a value.
35
35
 
36
36
  ## Related
37
37
 
38
- - [Storage overview](../../docs/server-db/storage.mdx)
39
- - [Storage reference](../../reference/storage/libsql.mdx)
38
+ - [Storage overview](/docs/server-db/storage)
39
+ - [Storage reference](/reference/storage/libsql)
@@ -20,7 +20,8 @@ mastra.setTelemetry({ export: { type: "console" } });
20
20
  {
21
21
  name: "telemetry",
22
22
  type: "OtelConfig",
23
- description: "The telemetry configuration object to set for all components.",
23
+ description:
24
+ "The telemetry configuration object to set for all components.",
24
25
  },
25
26
  ]}
26
27
  />
@@ -31,5 +32,5 @@ This method does not return a value.
31
32
 
32
33
  ## Related
33
34
 
34
- - [Logging](../../docs/observability/logging.mdx)
35
- - [PinoLogger](../../reference/observability/logger.mdx)
35
+ - [Logging](/docs/observability/logging)
36
+ - [PinoLogger](/reference/observability/logging/pino-logger)
@@ -1,15 +1,15 @@
1
1
  ---
2
- title: "Cloudflare Deployer"
2
+ title: "Reference: CloudflareDeployer | Deployer | Mastra Docs"
3
3
  description: "Documentation for the CloudflareDeployer class, which deploys Mastra applications to Cloudflare Workers."
4
4
  ---
5
5
 
6
6
  # CloudflareDeployer
7
7
 
8
- The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/deployer) class with Cloudflare specific functionality.
8
+ The `CloudflareDeployer` class handles deployment of standalone Mastra applications to Cloudflare Workers. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Cloudflare specific functionality.
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
14
  import { CloudflareDeployer } from "@mastra/deployer-cloudflare";
15
15
 
@@ -60,7 +60,8 @@ export const mastra = new Mastra({
60
60
  {
61
61
  name: "routes",
62
62
  type: "CFRoute[]",
63
- description: "Array of route configurations for your worker. Each route requires: pattern (string), zone_name (string), custom_domain (boolean, optional).",
63
+ description:
64
+ "Array of route configurations for your worker. Each route requires: pattern (string), zone_name (string), custom_domain (boolean, optional).",
64
65
  isOptional: true,
65
66
  },
66
67
  {
@@ -72,19 +73,22 @@ export const mastra = new Mastra({
72
73
  {
73
74
  name: "env",
74
75
  type: "Record<string, any>",
75
- description: "Environment variables to be included in the worker configuration.",
76
+ description:
77
+ "Environment variables to be included in the worker configuration.",
76
78
  isOptional: true,
77
79
  },
78
80
  {
79
81
  name: "d1Databases",
80
82
  type: "D1DatabaseBinding[]",
81
- description: "Array of D1 database bindings. Each binding requires: binding (string), database_name (string), database_id (string), preview_database_id (string, optional).",
83
+ description:
84
+ "Array of D1 database bindings. Each binding requires: binding (string), database_name (string), database_id (string), preview_database_id (string, optional).",
82
85
  isOptional: true,
83
86
  },
84
87
  {
85
88
  name: "kvNamespaces",
86
89
  type: "KVNamespaceBinding[]",
87
- description: "Array of KV namespace bindings. Each binding requires: binding (string), id (string).",
90
+ description:
91
+ "Array of KV namespace bindings. Each binding requires: binding (string), id (string).",
88
92
  isOptional: true,
89
93
  },
90
94
  ]}
@@ -1,6 +1,7 @@
1
1
  ---
2
- title: "Mastra Deployer"
2
+ title: "Reference: Deployer | Deployer | Mastra Docs"
3
3
  description: Documentation for the Deployer abstract class, which handles packaging and deployment of Mastra applications.
4
+ asIndexPage: true
4
5
  ---
5
6
 
6
7
  # Deployer
@@ -1,20 +1,20 @@
1
1
  ---
2
- title: "Netlify Deployer"
2
+ title: "Reference: NetlifyDeployer | Deployer | Mastra Docs"
3
3
  description: "Documentation for the NetlifyDeployer class, which deploys Mastra applications to Netlify Functions."
4
4
  ---
5
5
 
6
6
  # NetlifyDeployer
7
7
 
8
- The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/deployer) class with Netlify specific functionality.
8
+ The `NetlifyDeployer` class handles deployment of standalone Mastra applications to Netlify. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Netlify specific functionality.
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
14
  import { NetlifyDeployer } from "@mastra/deployer-netlify";
15
15
 
16
16
  export const mastra = new Mastra({
17
17
  // ...
18
- deployer: new NetlifyDeployer()
18
+ deployer: new NetlifyDeployer(),
19
19
  });
20
20
  ```
@@ -1,21 +1,21 @@
1
1
  ---
2
- title: "Vercel Deployer"
2
+ title: "Reference: VercelDeployer | Deployer | Mastra Docs"
3
3
  description: "Documentation for the VercelDeployer class, which deploys Mastra applications to Vercel."
4
4
  ---
5
5
 
6
6
  # VercelDeployer
7
7
 
8
- The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/deployer) class with Vercel specific functionality.
8
+ The `VercelDeployer` class handles deployment of standalone Mastra applications to Vercel. It manages configuration, deployment, and extends the base [Deployer](/reference/deployer/) class with Vercel specific functionality.
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
14
  import { VercelDeployer } from "@mastra/deployer-vercel";
15
15
 
16
16
  export const mastra = new Mastra({
17
17
  // ...
18
- deployer: new VercelDeployer()
18
+ deployer: new VercelDeployer(),
19
19
  });
20
20
  ```
21
21
 
@@ -31,7 +31,7 @@ These options are merged into `.vercel/output/functions/index.func/.vc-config.js
31
31
 
32
32
  ### Example with overrides
33
33
 
34
- ```typescript filename="src/mastra/index.ts" showLineNumbers copy
34
+ ```typescript title="src/mastra/index.ts" showLineNumbers copy
35
35
  import { Mastra } from "@mastra/core/mastra";
36
36
  import { VercelDeployer } from "@mastra/deployer-vercel";
37
37
 
@@ -43,4 +43,4 @@ export const mastra = new Mastra({
43
43
  regions: ["sfo1", "iad1"],
44
44
  }),
45
45
  });
46
- ```
46
+ ```
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Answer Relevancy | Metrics | Evals | Mastra Docs"
2
+ title: "Reference: AnswerRelevancyMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Answer Relevancy Metric in Mastra, which evaluates how well LLM outputs address the input query.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # AnswerRelevancyMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `AnswerRelevancyMetric` class evaluates how well an LLM's output answers or addresses the input query. It uses a judge-based system to determine relevancy and provides detailed scoring and reasoning.
13
13
 
@@ -130,7 +130,6 @@ The metric evaluates relevancy through query-answer alignment, considering compl
130
130
  ### Scoring Process
131
131
 
132
132
  1. Statement Analysis:
133
-
134
133
  - Breaks output into meaningful statements while preserving context
135
134
  - Evaluates each statement against query requirements
136
135
 
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Bias | Output Metrics | Evals | Mastra Docs"
2
+ title: "Reference: BiasMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Bias Metric in Mastra, which evaluates LLM outputs for various forms of bias, including gender, political, racial/ethnic, or geographical bias.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # BiasMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `BiasMetric` class evaluates whether an LLM's output contains various forms of bias, including gender, political, racial/ethnic, or geographical bias. This metric is particularly useful for detecting unintended biases that may emerge after fine-tuning models or applying optimizations.
13
13
 
@@ -137,7 +137,6 @@ The metric evaluates bias through opinion analysis based on:
137
137
  ### Scoring Process
138
138
 
139
139
  1. Extracts opinions from text:
140
-
141
140
  - Identifies subjective statements
142
141
  - Excludes factual claims
143
142
  - Includes cited opinions
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Completeness | Metrics | Evals | Mastra Docs"
2
+ title: "Reference: CompletenessMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Completeness Metric in Mastra, which evaluates how thoroughly LLM outputs cover key elements present in the input.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # CompletenessMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `CompletenessMetric` class evaluates how thoroughly an LLM's output covers the key elements present in the input. It analyzes nouns, verbs, topics, and terms to determine coverage and provides a detailed completeness score.
13
13
 
@@ -130,7 +130,6 @@ The metric evaluates completeness through linguistic element coverage analysis.
130
130
  ### Scoring Process
131
131
 
132
132
  1. Extracts key elements:
133
-
134
133
  - Nouns and named entities
135
134
  - Action verbs
136
135
  - Topic-specific terms
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Content Similarity | Evals | Mastra Docs"
2
+ title: "Reference: ContentSimilarityMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Content Similarity Metric in Mastra, which measures textual similarity between strings and provides a matching score.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # ContentSimilarityMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `ContentSimilarityMetric` class measures the textual similarity between two strings, providing a score that indicates how closely they match. It supports configurable options for case sensitivity and whitespace handling.
13
13
 
@@ -118,7 +118,6 @@ The metric evaluates textual similarity through character-level matching and con
118
118
  ### Scoring Process
119
119
 
120
120
  1. Normalizes text:
121
-
122
121
  - Case normalization (if ignoreCase: true)
123
122
  - Whitespace normalization (if ignoreWhitespace: true)
124
123
 
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Context Position | Metrics | Evals | Mastra Docs"
2
+ title: "Reference: ContextPositionMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Context Position Metric in Mastra, which evaluates the ordering of context nodes based on their relevance to the query and output.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # ContextPositionMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `ContextPositionMetric` class evaluates how well context nodes are ordered based on their relevance to the query and output. It uses position-weighted scoring to emphasize the importance of having the most relevant context pieces appear earlier in the sequence.
13
13
 
@@ -132,7 +132,6 @@ The metric evaluates context positioning through binary relevance assessment and
132
132
  ### Scoring Process
133
133
 
134
134
  1. Evaluates context relevance:
135
-
136
135
  - Assigns binary verdict (yes/no) to each piece
137
136
  - Records position in sequence
138
137
  - Documents relevance reasoning
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Context Precision | Metrics | Evals | Mastra Docs"
2
+ title: "Reference: ContextPrecisionMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Context Precision Metric in Mastra, which evaluates the relevance and precision of retrieved context nodes for generating expected outputs.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # ContextPrecisionMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `ContextPrecisionMetric` class evaluates how relevant and precise the retrieved context nodes are for generating the expected output. It uses a judge-based system to analyze each context piece's contribution and provides weighted scoring based on position.
13
13
 
@@ -132,7 +132,6 @@ The metric evaluates context precision through binary relevance assessment and M
132
132
  ### Scoring Process
133
133
 
134
134
  1. Assigns binary relevance scores:
135
-
136
135
  - Relevant context: 1
137
136
  - Irrelevant context: 0
138
137
 
@@ -1,13 +1,13 @@
1
1
  ---
2
- title: "Reference: Context Relevancy | Evals | Mastra Docs"
2
+ title: "Reference: ContextRelevancyMetric | Evals | Mastra Docs"
3
3
  description: Documentation for the Context Relevancy Metric, which evaluates the relevance of retrieved context in RAG pipelines.
4
4
  ---
5
5
 
6
- import { ScorerCallout } from '@/components/scorer-callout'
7
-
8
6
  # ContextRelevancyMetric
9
7
 
10
- <ScorerCallout />
8
+ :::info Scorers
9
+ This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
10
+ :::
11
11
 
12
12
  The `ContextRelevancyMetric` class evaluates the quality of your RAG (Retrieval-Augmented Generation) pipeline's retriever by measuring how relevant the retrieved context is to the input query. It uses an LLM-based evaluation system that first extracts statements from the context and then assesses their relevance to the input.
13
13
 
@@ -134,7 +134,6 @@ The metric evaluates how well retrieved context matches the query through binary
134
134
  ### Scoring Process
135
135
 
136
136
  1. Extracts statements from context:
137
-
138
137
  - Breaks down context into meaningful units
139
138
  - Preserves semantic relationships
140
139