@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,9 @@
1
1
  ---
2
- title: "Span | AI Tracing | Reference"
2
+ title: "Reference: Span | Observability | Mastra Docs"
3
3
  description: Span interfaces, methods, and lifecycle events
4
4
  ---
5
5
 
6
- import { PropertiesTable } from "@/components/properties-table";
6
+ import PropertiesTable from "@site/src/components/PropertiesTable";
7
7
 
8
8
  # Span
9
9
 
@@ -15,34 +15,34 @@ Base interface for all span types.
15
15
  interface BaseSpan<TType extends AISpanType> {
16
16
  /** Unique span identifier */
17
17
  id: string;
18
-
18
+
19
19
  /** OpenTelemetry-compatible trace ID (32 hex chars) */
20
20
  traceId: string;
21
-
21
+
22
22
  /** Name of the span */
23
23
  name: string;
24
-
24
+
25
25
  /** Type of the span */
26
26
  type: TType;
27
-
27
+
28
28
  /** When span started */
29
29
  startTime: Date;
30
-
30
+
31
31
  /** When span ended */
32
32
  endTime?: Date;
33
-
33
+
34
34
  /** Type-specific attributes */
35
35
  attributes?: AISpanTypeMap[TType];
36
-
36
+
37
37
  /** User-defined metadata */
38
38
  metadata?: Record<string, any>;
39
-
39
+
40
40
  /** Input passed at the start of the span */
41
41
  input?: any;
42
-
42
+
43
43
  /** Output generated at the end of the span */
44
44
  output?: any;
45
-
45
+
46
46
  /** Error information if span failed */
47
47
  errorInfo?: {
48
48
  message: string;
@@ -51,7 +51,7 @@ interface BaseSpan<TType extends AISpanType> {
51
51
  category?: string;
52
52
  details?: Record<string, any>;
53
53
  };
54
-
54
+
55
55
  /** Is an event span? (occurs at startTime, has no endTime) */
56
56
  isEvent: boolean;
57
57
  }
@@ -65,10 +65,10 @@ AI Span interface, used internally for tracing. Extends BaseSpan with lifecycle
65
65
  interface AISpan<TType extends AISpanType> extends BaseSpan<TType> {
66
66
  /** Is an internal span? (spans internal to the operation of mastra) */
67
67
  isInternal: boolean;
68
-
68
+
69
69
  /** Parent span reference (undefined for root spans) */
70
70
  parent?: AnyAISpan;
71
-
71
+
72
72
  /** Pointer to the AITracing instance */
73
73
  aiTracing: AITracing;
74
74
  }
@@ -301,7 +301,7 @@ Exported AI Span interface, used for tracing exporters. A lightweight version of
301
301
  interface ExportedAISpan<TType extends AISpanType> extends BaseSpan<TType> {
302
302
  /** Parent span id reference (undefined for root spans) */
303
303
  parentSpanId?: string;
304
-
304
+
305
305
  /** TRUE if the span is the root span of a trace */
306
306
  isRootSpan: boolean;
307
307
  }
@@ -316,13 +316,13 @@ Events emitted during the span lifecycle.
316
316
  ```typescript
317
317
  enum AITracingEventType {
318
318
  /** Emitted when a span is created and started */
319
- SPAN_STARTED = 'span_started',
320
-
319
+ SPAN_STARTED = "span_started",
320
+
321
321
  /** Emitted when a span is updated via update() */
322
- SPAN_UPDATED = 'span_updated',
323
-
322
+ SPAN_UPDATED = "span_updated",
323
+
324
324
  /** Emitted when a span is ended via end() or error() */
325
- SPAN_ENDED = 'span_ended',
325
+ SPAN_ENDED = "span_ended",
326
326
  }
327
327
  ```
328
328
 
@@ -330,9 +330,9 @@ enum AITracingEventType {
330
330
 
331
331
  ```typescript
332
332
  type AITracingEvent =
333
- | { type: 'span_started'; exportedSpan: AnyExportedAISpan }
334
- | { type: 'span_updated'; exportedSpan: AnyExportedAISpan }
335
- | { type: 'span_ended'; exportedSpan: AnyExportedAISpan };
333
+ | { type: "span_started"; exportedSpan: AnyExportedAISpan }
334
+ | { type: "span_updated"; exportedSpan: AnyExportedAISpan }
335
+ | { type: "span_ended"; exportedSpan: AnyExportedAISpan };
336
336
  ```
337
337
 
338
338
  Exporters receive these events to process and send trace data to observability platforms.
@@ -358,14 +358,17 @@ Union type for cases that need to handle any exported span type.
358
358
  ## See Also
359
359
 
360
360
  ### Documentation
361
+
361
362
  - [AI Tracing Overview](/docs/observability/ai-tracing/overview) - Concepts and usage
362
363
  - [Creating Child Spans](/docs/observability/ai-tracing/overview#creating-child-spans) - Practical examples
363
364
  - [Retrieving Trace IDs](/docs/observability/ai-tracing/overview#retrieving-trace-ids) - Using trace IDs
364
365
 
365
366
  ### Reference
366
- - [AITracing Classes](/reference/observability/ai-tracing/ai-tracing) - Core tracing classes
367
+
368
+ - [AITracing Classes](/reference/observability/ai-tracing/) - Core tracing classes
367
369
  - [Interfaces](/reference/observability/ai-tracing/interfaces) - Complete type reference
368
370
  - [Configuration](/reference/observability/ai-tracing/configuration) - Configuration options
369
371
 
370
372
  ### Examples
371
- - [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Working with spans
373
+
374
+ - [Basic AI Tracing](/examples/observability/basic-ai-tracing) - Working with spans
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: PinoLogger | Mastra Observability Docs"
2
+ title: "Reference: PinoLogger | Observability | Mastra Docs"
3
3
  description: Documentation for PinoLogger, which provides methods to record events at various severity levels.
4
4
  ---
5
5
 
@@ -7,19 +7,19 @@ description: Documentation for PinoLogger, which provides methods to record even
7
7
 
8
8
  A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
9
9
 
10
- When deploying to Mastra Cloud, logs are displayed on the [Logs](../../../docs/mastra-cloud/dashboard.mdx#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
10
+ When deploying to Mastra Cloud, logs are displayed on the [Logs](/docs/mastra-cloud/dashboard#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
11
11
 
12
12
  ## Usage example
13
13
 
14
- ```typescript filename="src/mastra/index.ts" showLineNumbers copy
15
- import { Mastra } from '@mastra/core/mastra';
16
- import { PinoLogger } from '@mastra/loggers';
14
+ ```typescript title="src/mastra/index.ts" showLineNumbers copy
15
+ import { Mastra } from "@mastra/core/mastra";
16
+ import { PinoLogger } from "@mastra/loggers";
17
17
 
18
18
  export const mastra = new Mastra({
19
19
  // ...
20
20
  logger: new PinoLogger({
21
- name: 'Mastra',
22
- level: 'info',
21
+ name: "Mastra",
22
+ level: "info",
23
23
  }),
24
24
  });
25
25
  ```
@@ -33,10 +33,11 @@ export const mastra = new Mastra({
33
33
  type: "string",
34
34
  description: "A label used to group and identify logs from this logger.",
35
35
  },
36
- {
36
+ {
37
37
  name: "level",
38
38
  type: `"debug" | "info" | "warn" | "error"`,
39
- description: "Sets the minimum log level. Messages below this level are ignored.",
39
+ description:
40
+ "Sets the minimum log level. Messages below this level are ignored.",
40
41
  },
41
42
  {
42
43
  name: "transports",
@@ -58,13 +59,11 @@ export const mastra = new Mastra({
58
59
  ]}
59
60
  />
60
61
 
61
-
62
62
  ## File transport (structured logs)
63
63
 
64
64
  Writes structured logs to a file using the `FileTransport`. The logger accepts a plain message as the first argument and structured metadata as the second argument. These are internally converted to a `BaseLogMessage` and persisted to the configured file path.
65
65
 
66
-
67
- ```typescript filename="src/mastra/loggers/file-transport.ts" showLineNumbers copy
66
+ ```typescript title="src/mastra/loggers/file-transport.ts" showLineNumbers copy
68
67
  import { FileTransport } from "@mastra/loggers/file";
69
68
  import { PinoLogger } from "@mastra/loggers/pino";
70
69
 
@@ -88,7 +87,7 @@ fileLogger.warn("Low disk space", {
88
87
 
89
88
  Streams structured logs to a remote Redis list using the `UpstashTransport`. The logger accepts a string message and a structured metadata object. This enables centralized logging for distributed environments, supporting filtering by `destinationPath`, `type`, and `runId`.
90
89
 
91
- ```typescript filename="src/mastra/loggers/upstash-transport.ts" showLineNumbers copy
90
+ ```typescript title="src/mastra/loggers/upstash-transport.ts" showLineNumbers copy
92
91
  import { UpstashTransport } from "@mastra/loggers/upstash";
93
92
  import { PinoLogger } from "@mastra/loggers/pino";
94
93
 
@@ -105,7 +104,6 @@ export const upstashLogger = new PinoLogger({
105
104
  });
106
105
  ```
107
106
 
108
-
109
107
  ### Upstash transport usage
110
108
 
111
109
  ```typescript showLineNumbers copy
@@ -124,7 +122,7 @@ You can create custom transports using the `createCustomTransport` utility to in
124
122
 
125
123
  Creates a custom transport using `createCustomTransport` and integrates it with a third-party logging stream such as `pino-sentry-transport`. This allows forwarding logs to an external system like Sentry for advanced monitoring and observability.
126
124
 
127
- ```typescript filename="src/mastra/loggers/sentry-transport.ts" showLineNumbers copy
125
+ ```typescript title="src/mastra/loggers/sentry-transport.ts" showLineNumbers copy
128
126
  import { createCustomTransport } from "@mastra/core/loggers";
129
127
  import { PinoLogger } from "@mastra/loggers/pino";
130
128
  import pinoSentry from "pino-sentry-transport";
@@ -1,9 +1,9 @@
1
1
  ---
2
- title: "Reference: OtelConfig | Mastra Observability Docs"
2
+ title: "Reference: `OtelConfig` | Observability | Mastra Docs"
3
3
  description: Documentation for the OtelConfig object, which configures OpenTelemetry instrumentation, tracing, and exporting behavior.
4
4
  ---
5
5
 
6
- # `OtelConfig`
6
+ # OtelConfig
7
7
 
8
8
  The `OtelConfig` object is used to configure OpenTelemetry instrumentation, tracing, and exporting behavior within your application. By adjusting its properties, you can control how telemetry data (such as traces) is collected, sampled, and exported.
9
9
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Arize AX Integration | Mastra Observability Docs"
2
+ title: "Reference: Arize AX | Observability | Mastra Docs"
3
3
  description: Documentation for integrating Arize AX with Mastra, a comprehensive AI observability platform for monitoring and evaluating LLM applications.
4
4
  ---
5
5
 
@@ -54,8 +54,8 @@ export const mastra = new Mastra({
54
54
  exporter: new OpenInferenceOTLPTraceExporter({
55
55
  url: "https://otlp.arize.com/v1/traces",
56
56
  headers: {
57
- "space_id": process.env.ARIZE_SPACE_ID!,
58
- "api_key": process.env.ARIZE_API_KEY!,
57
+ space_id: process.env.ARIZE_SPACE_ID!,
58
+ api_key: process.env.ARIZE_API_KEY!,
59
59
  },
60
60
  spanFilter: isOpenInferenceSpan,
61
61
  }),
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Arize Phoenix Integration | Mastra Observability Docs"
2
+ title: "Reference: Arize Phoenix | Observability | Mastra Docs"
3
3
  description: Documentation for integrating Arize Phoenix with Mastra, an open-source AI observability platform for monitoring and evaluating LLM applications.
4
4
  ---
5
5
 
@@ -114,6 +114,7 @@ All traces follow OpenTelemetry standards and include relevant metadata such as
114
114
  ## Dashboard
115
115
 
116
116
  Once configured, you can view your traces and analytics in Phoenix:
117
+
117
118
  - **Phoenix Cloud**: [app.phoenix.arize.com](https://app.phoenix.arize.com)
118
119
  - **Self-hosted**: Your Phoenix instance URL (e.g., `http://localhost:6006`)
119
120
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Dash0 Integration | Mastra Observability Docs"
2
+ title: "Reference: Dash0 | Observability | Mastra Docs"
3
3
  description: Documentation for integrating Mastra with Dash0, an Open Telemetry native observability solution.
4
4
  ---
5
5
 
@@ -1,22 +1,20 @@
1
1
  ---
2
- title: "OTLP Providers | Observability | Mastra Docs"
2
+ title: "Reference: OTLP Providers | Observability | Mastra Docs"
3
3
  description: Overview of OTLP observability providers.
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # OTLP Providers
9
7
 
10
8
  These providers are supported with OTLP-based tracing:
11
9
 
12
- - [Arize AX](./providers/arize-ax.mdx)
13
- - [Arize Phoenix](./providers/arize-phoenix.mdx)
14
- - [Braintrust](./providers/braintrust.mdx)
15
- - [Dash0](./providers/dash0.mdx)
16
- - [Laminar](./providers/laminar.mdx)
17
- - [Langfuse](./providers/langfuse.mdx)
18
- - [Langsmith](./providers/langsmith.mdx)
19
- - [LangWatch](./providers/langwatch.mdx)
20
- - [New Relic](./providers/new-relic.mdx)
21
- - [SigNoz](./providers/signoz.mdx)
22
- - [Traceloop](./providers/traceloop.mdx)
10
+ - [Arize AX](./arize-ax)
11
+ - [Arize Phoenix](./arize-phoenix)
12
+ - [Braintrust](./braintrust)
13
+ - [Dash0](./dash0)
14
+ - [Laminar](./laminar)
15
+ - [Langfuse](./langfuse)
16
+ - [Langsmith](./langsmith)
17
+ - [LangWatch](./langwatch)
18
+ - [New Relic](./new-relic)
19
+ - [SigNoz](./signoz)
20
+ - [Traceloop](./traceloop)
@@ -11,7 +11,6 @@ This tutorial shows how to set up Keywords AI tracing with [Mastra](https://mast
11
11
 
12
12
  To help you get started quickly, we’ve provided a pre-built example. You can find the code [on GitHub](https://github.com/Keywords-AI/keywordsai-example-projects/tree/main/mastra-ai-weather-agent).
13
13
 
14
-
15
14
  ## Setup
16
15
 
17
16
  Here's the tutorial about the Mastra Weather Agent example.
@@ -30,7 +29,7 @@ Copy the example environment file and add your API keys:
30
29
  cp .env.local.example .env.local
31
30
  ```
32
31
 
33
- Update .env.local with your credentials:
32
+ Update .env.local with your credentials:
34
33
 
35
34
  ```bash .env.local copy
36
35
  OPENAI_API_KEY=your-openai-api-key
@@ -42,7 +41,7 @@ KEYWORDSAI_BASE_URL=https://api.keywordsai.co
42
41
 
43
42
  Configure with KeywordsAI telemetry in `src/mastra/index.ts`:
44
43
 
45
- ```typescript filename="src/mastra/index.ts" showLineNumbers copy
44
+ ```typescript title="src/mastra/index.ts" showLineNumbers copy
46
45
 
47
46
  import { Mastra } from "@mastra/core/mastra";
48
47
  import { KeywordsAIExporter } from "@keywordsai/exporter-vercel";
@@ -66,6 +65,7 @@ telemetry: {
66
65
  ```bash copy
67
66
  mastra dev
68
67
  ```
68
+
69
69
  This opens the Mastra playground where you can interact with the weather agent.
70
70
 
71
71
  ## Observability
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Laminar Integration | Mastra Observability Docs"
2
+ title: "Reference: Laminar | Observability | Mastra Docs"
3
3
  description: Documentation for integrating Laminar with Mastra, a specialized observability platform for LLM applications.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Langfuse Integration | Mastra Observability Docs"
2
+ title: "Reference: Langfuse | Observability | Mastra Docs"
3
3
  description: Documentation for integrating Langfuse with Mastra, an open-source observability platform for LLM applications.
4
4
  ---
5
5
 
@@ -52,8 +52,8 @@ export const mastra = new Mastra({
52
52
  telemetry: {
53
53
  enabled: true,
54
54
  export: {
55
- type: 'otlp',
56
- endpoint: 'https://cloud.langfuse.com/api/public/otel/v1/traces', // or your preferred endpoint
55
+ type: "otlp",
56
+ endpoint: "https://cloud.langfuse.com/api/public/otel/v1/traces", // or your preferred endpoint
57
57
  headers: {
58
58
  Authorization: `Basic ${AUTH_STRING}`, // Your base64-encoded auth string
59
59
  },
@@ -72,7 +72,7 @@ export const mastra = new Mastra({
72
72
  telemetry: {
73
73
  enabled: true,
74
74
  export: {
75
- type: 'otlp',
75
+ type: "otlp",
76
76
  // endpoint and headers will be read from OTEL_EXPORTER_OTLP_* env vars
77
77
  },
78
78
  },
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: LangSmith Integration | Mastra Observability Docs"
2
+ title: "Reference: LangSmith | Observability | Mastra Docs"
3
3
  description: Documentation for integrating LangSmith with Mastra, a platform for debugging, testing, evaluating, and monitoring LLM applications.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: LangWatch Integration | Mastra Observability Docs"
2
+ title: "Reference: LangWatch | Observability | Mastra Docs"
3
3
  description: Documentation for integrating LangWatch with Mastra, a specialized observability platform for LLM applications.
4
4
  ---
5
5
 
@@ -31,7 +31,7 @@ export const mastra = new Mastra({
31
31
  export: {
32
32
  type: "custom",
33
33
  exporter: new LangWatchExporter({
34
- apiKey: process.env.LANGWATCH_API_KEY
34
+ apiKey: process.env.LANGWATCH_API_KEY,
35
35
  }),
36
36
  },
37
37
  },
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: New Relic Integration | Mastra Observability Docs"
2
+ title: "Reference: New Relic | Observability | Mastra Docs"
3
3
  description: Documentation for integrating New Relic with Mastra, a comprehensive observability platform supporting OpenTelemetry for full-stack monitoring.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: SigNoz Integration | Mastra Observability Docs"
2
+ title: "Reference: SigNoz | Observability | Mastra Docs"
3
3
  description: Documentation for integrating SigNoz with Mastra, an open-source APM and observability platform providing full-stack monitoring through OpenTelemetry.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Traceloop Integration | Mastra Observability Docs"
2
+ title: "Reference: Traceloop | Observability | Mastra Docs"
3
3
  description: Documentation for integrating Traceloop with Mastra, an OpenTelemetry-native observability platform for LLM applications.
4
4
  ---
5
5
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Batch Parts Processor | Processors | Mastra Docs"
2
+ title: "Reference: BatchPartsProcessor | Processors | Mastra Docs"
3
3
  description: "Documentation for the BatchPartsProcessor in Mastra, which batches multiple stream parts together to reduce frequency of emissions."
4
4
  ---
5
5
 
@@ -15,7 +15,7 @@ import { BatchPartsProcessor } from "@mastra/core/processors";
15
15
  const processor = new BatchPartsProcessor({
16
16
  batchSize: 5,
17
17
  maxWaitTime: 100,
18
- emitOnNonText: true
18
+ emitOnNonText: true,
19
19
  });
20
20
  ```
21
21
 
@@ -46,14 +46,16 @@ const processor = new BatchPartsProcessor({
46
46
  {
47
47
  name: "maxWaitTime",
48
48
  type: "number",
49
- description: "Maximum time to wait before emitting a batch (in milliseconds). If set, will emit the current batch even if it hasn't reached batchSize",
49
+ description:
50
+ "Maximum time to wait before emitting a batch (in milliseconds). If set, will emit the current batch even if it hasn't reached batchSize",
50
51
  isOptional: true,
51
52
  default: "undefined (no timeout)",
52
53
  },
53
54
  {
54
55
  name: "emitOnNonText",
55
56
  type: "boolean",
56
- description: "Whether to emit immediately when a non-text part is encountered",
57
+ description:
58
+ "Whether to emit immediately when a non-text part is encountered",
57
59
  isOptional: true,
58
60
  default: "true",
59
61
  },
@@ -79,7 +81,8 @@ const processor = new BatchPartsProcessor({
79
81
  {
80
82
  name: "flush",
81
83
  type: "(state?: BatchPartsState) => ChunkType | null",
82
- description: "Force flush any remaining batched parts when the stream ends",
84
+ description:
85
+ "Force flush any remaining batched parts when the stream ends",
83
86
  isOptional: false,
84
87
  },
85
88
  ]}
@@ -87,7 +90,7 @@ const processor = new BatchPartsProcessor({
87
90
 
88
91
  ## Extended usage example
89
92
 
90
- ```typescript filename="src/mastra/agents/batched-agent.ts" showLineNumbers copy
93
+ ```typescript title="src/mastra/agents/batched-agent.ts" showLineNumbers copy
91
94
  import { openai } from "@ai-sdk/openai";
92
95
  import { Agent } from "@mastra/core/agent";
93
96
  import { BatchPartsProcessor } from "@mastra/core/processors";
@@ -100,12 +103,12 @@ export const agent = new Agent({
100
103
  new BatchPartsProcessor({
101
104
  batchSize: 5,
102
105
  maxWaitTime: 100,
103
- emitOnNonText: true
104
- })
105
- ]
106
+ emitOnNonText: true,
107
+ }),
108
+ ],
106
109
  });
107
110
  ```
108
111
 
109
112
  ## Related
110
113
 
111
- - [Output Processors documentation](/docs/agents/output-processors)
114
+ - [Output Processors documentation](/docs/agents/guardrails)
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: "Reference: Language Detector | Processors | Mastra Docs"
2
+ title: "Reference: LanguageDetector | Processors | Mastra Docs"
3
3
  description: "Documentation for the LanguageDetector in Mastra, which detects language and can translate content in AI responses."
4
4
  ---
5
5
 
@@ -17,7 +17,7 @@ const processor = new LanguageDetector({
17
17
  model: openai("gpt-4.1-nano"),
18
18
  targetLanguages: ["English", "en"],
19
19
  threshold: 0.8,
20
- strategy: "translate"
20
+ strategy: "translate",
21
21
  });
22
22
  ```
23
23
 
@@ -28,7 +28,8 @@ const processor = new LanguageDetector({
28
28
  {
29
29
  name: "options",
30
30
  type: "Options",
31
- description: "Configuration options for language detection and translation",
31
+ description:
32
+ "Configuration options for language detection and translation",
32
33
  isOptional: false,
33
34
  },
34
35
  ]}
@@ -47,42 +48,48 @@ const processor = new LanguageDetector({
47
48
  {
48
49
  name: "targetLanguages",
49
50
  type: "string[]",
50
- description: "Target language(s) for the project. If content is detected in a different language, it may be translated. Can be language name ('English') or ISO code ('en')",
51
+ description:
52
+ "Target language(s) for the project. If content is detected in a different language, it may be translated. Can be language name ('English') or ISO code ('en')",
51
53
  isOptional: true,
52
54
  default: "['English', 'en']",
53
55
  },
54
56
  {
55
57
  name: "threshold",
56
58
  type: "number",
57
- description: "Confidence threshold for language detection (0-1). Only process when detection confidence exceeds this threshold",
59
+ description:
60
+ "Confidence threshold for language detection (0-1). Only process when detection confidence exceeds this threshold",
58
61
  isOptional: true,
59
62
  default: "0.7",
60
63
  },
61
64
  {
62
65
  name: "strategy",
63
66
  type: "'detect' | 'translate' | 'block' | 'warn'",
64
- description: "Strategy when non-target language is detected: 'detect' only detects language, 'translate' automatically translates to target language, 'block' rejects content not in target language, 'warn' logs warning but allows through",
67
+ description:
68
+ "Strategy when non-target language is detected: 'detect' only detects language, 'translate' automatically translates to target language, 'block' rejects content not in target language, 'warn' logs warning but allows through",
65
69
  isOptional: true,
66
70
  default: "'detect'",
67
71
  },
68
72
  {
69
73
  name: "preserveOriginal",
70
74
  type: "boolean",
71
- description: "Whether to preserve original content in message metadata. Useful for audit trails and debugging",
75
+ description:
76
+ "Whether to preserve original content in message metadata. Useful for audit trails and debugging",
72
77
  isOptional: true,
73
78
  default: "true",
74
79
  },
75
80
  {
76
81
  name: "instructions",
77
82
  type: "string",
78
- description: "Custom detection instructions for the agent. If not provided, uses default instructions",
83
+ description:
84
+ "Custom detection instructions for the agent. If not provided, uses default instructions",
79
85
  isOptional: true,
80
86
  default: "undefined",
81
87
  },
82
88
  {
83
89
  name: "minTextLength",
84
90
  type: "number",
85
- description: "Minimum text length to perform detection. Short text is often unreliable for language detection",
91
+ description:
92
+ "Minimum text length to perform detection. Short text is often unreliable for language detection",
86
93
  isOptional: true,
87
94
  default: "10",
88
95
  },
@@ -96,7 +103,8 @@ const processor = new LanguageDetector({
96
103
  {
97
104
  name: "translationQuality",
98
105
  type: "'speed' | 'quality' | 'balanced'",
99
- description: "Translation quality preference: 'speed' prioritizes fast translation, 'quality' prioritizes accuracy, 'balanced' balances between speed and quality",
106
+ description:
107
+ "Translation quality preference: 'speed' prioritizes fast translation, 'quality' prioritizes accuracy, 'balanced' balances between speed and quality",
100
108
  isOptional: true,
101
109
  default: "'quality'",
102
110
  },
@@ -116,7 +124,8 @@ const processor = new LanguageDetector({
116
124
  {
117
125
  name: "processInput",
118
126
  type: "(args: { messages: MastraMessageV2[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraMessageV2[]>",
119
- description: "Processes input messages to detect language and optionally translate content before sending to LLM",
127
+ description:
128
+ "Processes input messages to detect language and optionally translate content before sending to LLM",
120
129
  isOptional: false,
121
130
  },
122
131
  ]}
@@ -124,7 +133,7 @@ const processor = new LanguageDetector({
124
133
 
125
134
  ## Extended usage example
126
135
 
127
- ```typescript filename="src/mastra/agents/multilingual-agent.ts" showLineNumbers copy
136
+ ```typescript title="src/mastra/agents/multilingual-agent.ts" showLineNumbers copy
128
137
  import { openai } from "@ai-sdk/openai";
129
138
  import { Agent } from "@mastra/core/agent";
130
139
  import { LanguageDetector } from "@mastra/core/processors";
@@ -140,15 +149,16 @@ export const agent = new Agent({
140
149
  threshold: 0.8,
141
150
  strategy: "translate",
142
151
  preserveOriginal: true,
143
- instructions: "Detect language and translate non-English content to English while preserving original intent",
152
+ instructions:
153
+ "Detect language and translate non-English content to English while preserving original intent",
144
154
  minTextLength: 10,
145
155
  includeDetectionDetails: true,
146
- translationQuality: "quality"
147
- })
148
- ]
156
+ translationQuality: "quality",
157
+ }),
158
+ ],
149
159
  });
150
160
  ```
151
161
 
152
162
  ## Related
153
163
 
154
- - [Input Processors](/docs/agents/input-processors)
164
+ - [Input Processors](/docs/agents/guardrails)