@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
@@ -3,8 +3,6 @@ title: "Cloud Exporter | AI Tracing | Observability | Mastra Docs"
3
3
  description: "Send traces to Mastra Cloud for production monitoring"
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # Cloud Exporter
9
7
 
10
8
  The `CloudExporter` sends traces to Mastra Cloud for centralized monitoring and team collaboration. It's automatically enabled when using the default observability configuration with a valid access token.
@@ -12,6 +10,7 @@ The `CloudExporter` sends traces to Mastra Cloud for centralized monitoring and
12
10
  ## When to Use CloudExporter
13
11
 
14
12
  CloudExporter is ideal for:
13
+
15
14
  - **Production monitoring** - Centralized trace visualization
16
15
  - **Team collaboration** - Share traces across your organization
17
16
  - **Advanced analytics** - Insights and performance metrics
@@ -25,13 +24,13 @@ CloudExporter is ideal for:
25
24
  2. **Access Token**: Generate in Mastra Cloud → Settings → API Tokens
26
25
  3. **Environment Variables**: Set your credentials:
27
26
 
28
- ```bash filename=".env"
27
+ ```bash title=".env"
29
28
  MASTRA_CLOUD_ACCESS_TOKEN=mst_xxxxxxxxxxxxxxxx
30
29
  ```
31
30
 
32
31
  ### Basic Setup
33
32
 
34
- ```typescript filename="src/mastra/index.ts"
33
+ ```typescript title="src/mastra/index.ts"
35
34
  import { Mastra } from "@mastra/core";
36
35
  import { CloudExporter } from "@mastra/core/ai-tracing";
37
36
 
@@ -39,9 +38,9 @@ export const mastra = new Mastra({
39
38
  observability: {
40
39
  configs: {
41
40
  production: {
42
- serviceName: 'my-service',
41
+ serviceName: "my-service",
43
42
  exporters: [
44
- new CloudExporter(), // Uses MASTRA_CLOUD_ACCESS_TOKEN env var
43
+ new CloudExporter(), // Uses MASTRA_CLOUD_ACCESS_TOKEN env var
45
44
  ],
46
45
  },
47
46
  },
@@ -56,7 +55,7 @@ When using the default observability configuration, CloudExporter is automatical
56
55
  ```typescript
57
56
  export const mastra = new Mastra({
58
57
  observability: {
59
- default: { enabled: true }, // Automatically includes CloudExporter if token exists
58
+ default: { enabled: true }, // Automatically includes CloudExporter if token exists
60
59
  },
61
60
  });
62
61
  ```
@@ -69,15 +68,15 @@ new CloudExporter({
69
68
  accessToken: process.env.MASTRA_CLOUD_ACCESS_TOKEN,
70
69
 
71
70
  // Optional - for self-hosted Mastra Cloud
72
- endpoint: 'https://cloud.your-domain.com',
71
+ endpoint: "https://cloud.your-domain.com",
73
72
 
74
73
  // Batching configuration
75
- maxBatchSize: 1000, // Max spans per batch
76
- maxBatchWaitMs: 5000, // Max wait before sending batch
74
+ maxBatchSize: 1000, // Max spans per batch
75
+ maxBatchWaitMs: 5000, // Max wait before sending batch
77
76
 
78
77
  // Diagnostic logging
79
- logLevel: 'info', // debug | info | warn | error
80
- })
78
+ logLevel: "info", // debug | info | warn | error
79
+ });
81
80
  ```
82
81
 
83
82
  ## Viewing Traces
@@ -102,9 +101,11 @@ new CloudExporter({
102
101
 
103
102
  ## Performance
104
103
 
105
- <Callout type="info">
106
- CloudExporter uses intelligent batching to optimize network usage. Traces are buffered and sent in batches, reducing overhead while maintaining near real-time visibility.
107
- </Callout>
104
+ :::info
105
+
106
+ CloudExporter uses intelligent batching to optimize network usage. Traces are buffered and sent in batches, reducing overhead while maintaining near real-time visibility.
107
+
108
+ :::
108
109
 
109
110
  ### Batching Behavior
110
111
 
@@ -117,4 +118,4 @@ new CloudExporter({
117
118
 
118
119
  - [AI Tracing Overview](/docs/observability/ai-tracing/overview)
119
120
  - [DefaultExporter](/docs/observability/ai-tracing/exporters/default)
120
- - [Mastra Cloud Documentation](https://cloud.mastra.ai/docs)
121
+ - [Mastra Cloud Documentation](https://cloud.mastra.ai/docs)
@@ -10,6 +10,7 @@ The `DefaultExporter` persists traces to your configured storage backend, making
10
10
  ## When to Use DefaultExporter
11
11
 
12
12
  DefaultExporter is ideal for:
13
+
13
14
  - **Local development** - Debug and analyze traces offline
14
15
  - **Data ownership** - Complete control over your trace data
15
16
  - **Zero dependencies** - No external services required
@@ -24,22 +25,20 @@ DefaultExporter is ideal for:
24
25
 
25
26
  ### Basic Setup
26
27
 
27
- ```typescript filename="src/mastra/index.ts"
28
+ ```typescript title="src/mastra/index.ts"
28
29
  import { Mastra } from "@mastra/core";
29
30
  import { DefaultExporter } from "@mastra/core/ai-tracing";
30
31
  import { LibSQLStore } from "@mastra/libsql";
31
32
 
32
33
  export const mastra = new Mastra({
33
34
  storage: new LibSQLStore({
34
- url: "file:./mastra.db", // Required for trace persistence
35
+ url: "file:./mastra.db", // Required for trace persistence
35
36
  }),
36
37
  observability: {
37
38
  configs: {
38
39
  local: {
39
- serviceName: 'my-service',
40
- exporters: [
41
- new DefaultExporter(),
42
- ],
40
+ serviceName: "my-service",
41
+ exporters: [new DefaultExporter()],
43
42
  },
44
43
  },
45
44
  },
@@ -56,7 +55,7 @@ export const mastra = new Mastra({
56
55
  url: "file:./mastra.db",
57
56
  }),
58
57
  observability: {
59
- default: { enabled: true }, // Automatically includes DefaultExporter
58
+ default: { enabled: true }, // Automatically includes DefaultExporter
60
59
  },
61
60
  });
62
61
  ```
@@ -78,25 +77,25 @@ DefaultExporter automatically selects the optimal tracing strategy based on your
78
77
 
79
78
  ### Available Strategies
80
79
 
81
- | Strategy | Description | Use Case |
82
- |----------|-------------|----------|
83
- | **realtime** | Process each event immediately | Development, debugging, low traffic |
84
- | **batch-with-updates** | Buffer events and batch write with full lifecycle support | Low volume Production |
85
- | **insert-only** | Only process completed spans, ignore updates | High volume Production |
80
+ | Strategy | Description | Use Case |
81
+ | ---------------------- | --------------------------------------------------------- | ----------------------------------- |
82
+ | **realtime** | Process each event immediately | Development, debugging, low traffic |
83
+ | **batch-with-updates** | Buffer events and batch write with full lifecycle support | Low volume Production |
84
+ | **insert-only** | Only process completed spans, ignore updates | High volume Production |
86
85
 
87
86
  ### Strategy Configuration
88
87
 
89
88
  ```typescript
90
89
  new DefaultExporter({
91
- strategy: 'auto', // Default - let storage provider decide
90
+ strategy: "auto", // Default - let storage provider decide
92
91
  // or explicitly set:
93
92
  // strategy: 'realtime' | 'batch-with-updates' | 'insert-only'
94
93
 
95
94
  // Batching configuration (applies to both batch-with-updates and insert-only)
96
- maxBatchSize: 1000, // Max spans per batch
97
- maxBatchWaitMs: 5000, // Max wait before flushing
98
- maxBufferSize: 10000, // Max spans to buffer
99
- })
95
+ maxBatchSize: 1000, // Max spans per batch
96
+ maxBatchWaitMs: 5000, // Max wait before flushing
97
+ maxBufferSize: 10000, // Max spans to buffer
98
+ });
100
99
  ```
101
100
 
102
101
  ## Storage Provider Support
@@ -105,10 +104,10 @@ Different storage providers support different tracing strategies.
105
104
 
106
105
  If you set the strategy to `'auto'`, the `DefaultExporter` automatically selects the optimal strategy for the storage provider. If you set the strategy to a mode that the storage provider doesn't support, you will get an error message.
107
106
 
108
- | Storage Provider | Preferred Strategy | Supported Strategies | Notes |
109
- |-----------------|-------------------|---------------------|--------|
110
- | **[LibSQL](/reference/storage/libsql)** | batch-with-updates | realtime, batch-with-updates, insert-only | Default storage, good for development |
111
- | **[PostgreSQL](/reference/storage/postgresql)** | batch-with-updates | batch-with-updates, insert-only | Recommended for production |
107
+ | Storage Provider | Preferred Strategy | Supported Strategies | Notes |
108
+ | ----------------------------------------------- | ------------------ | ----------------------------------------- | ------------------------------------- |
109
+ | **[LibSQL](/reference/storage/libsql)** | batch-with-updates | realtime, batch-with-updates, insert-only | Default storage, good for development |
110
+ | **[PostgreSQL](/reference/storage/postgresql)** | batch-with-updates | batch-with-updates, insert-only | Recommended for production |
112
111
 
113
112
  ### Strategy Benefits
114
113
 
@@ -140,29 +139,29 @@ The DefaultExporter includes robust error handling for production use:
140
139
 
141
140
  ```typescript
142
141
  // Zero config - recommended for most users
143
- new DefaultExporter()
142
+ new DefaultExporter();
144
143
 
145
144
  // Development override
146
145
  new DefaultExporter({
147
- strategy: 'realtime', // Immediate visibility for debugging
148
- })
146
+ strategy: "realtime", // Immediate visibility for debugging
147
+ });
149
148
 
150
149
  // High-throughput production
151
150
  new DefaultExporter({
152
- maxBatchSize: 2000, // Larger batches
153
- maxBatchWaitMs: 10000, // Wait longer to fill batches
154
- maxBufferSize: 50000, // Handle longer outages
155
- })
151
+ maxBatchSize: 2000, // Larger batches
152
+ maxBatchWaitMs: 10000, // Wait longer to fill batches
153
+ maxBufferSize: 50000, // Handle longer outages
154
+ });
156
155
 
157
156
  // Low-latency production
158
157
  new DefaultExporter({
159
- maxBatchSize: 100, // Smaller batches
160
- maxBatchWaitMs: 1000, // Flush quickly
161
- })
158
+ maxBatchSize: 100, // Smaller batches
159
+ maxBatchWaitMs: 1000, // Flush quickly
160
+ });
162
161
  ```
163
162
 
164
163
  ## Related
165
164
 
166
165
  - [AI Tracing Overview](/docs/observability/ai-tracing/overview)
167
166
  - [CloudExporter](/docs/observability/ai-tracing/exporters/cloud)
168
- - [Storage Configuration](/docs/storage/overview)
167
+ - [Storage Configuration](/docs/server-db/storage)
@@ -3,8 +3,6 @@ title: "Langfuse Exporter | AI Tracing | Observability | Mastra Docs"
3
3
  description: "Send AI traces to Langfuse for LLM observability and analytics"
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # Langfuse Exporter
9
7
 
10
8
  [Langfuse](https://langfuse.com/) is an open-source observability platform specifically designed for LLM applications. The Langfuse exporter sends your AI traces to Langfuse, providing detailed insights into model performance, token usage, and conversation flows.
@@ -12,6 +10,7 @@ import { Callout } from "nextra/components";
12
10
  ## When to Use Langfuse
13
11
 
14
12
  Langfuse is ideal when you need:
13
+
15
14
  - **LLM-specific analytics** - Token usage, costs, latency breakdown
16
15
  - **Conversation tracking** - Session-based trace grouping
17
16
  - **Quality scoring** - Manual and automated evaluation scores
@@ -32,7 +31,7 @@ npm install @mastra/langfuse
32
31
  2. **API Keys**: Create public/secret key pair in Langfuse Settings → API Keys
33
32
  3. **Environment Variables**: Set your credentials
34
33
 
35
- ```bash filename=".env"
34
+ ```bash title=".env"
36
35
  LANGFUSE_PUBLIC_KEY=pk-lf-xxxxxxxxxxxx
37
36
  LANGFUSE_SECRET_KEY=sk-lf-xxxxxxxxxxxx
38
37
  LANGFUSE_BASE_URL=https://cloud.langfuse.com # Or your self-hosted URL
@@ -40,7 +39,7 @@ LANGFUSE_BASE_URL=https://cloud.langfuse.com # Or your self-hosted URL
40
39
 
41
40
  ### Basic Setup
42
41
 
43
- ```typescript filename="src/mastra/index.ts"
42
+ ```typescript title="src/mastra/index.ts"
44
43
  import { Mastra } from "@mastra/core";
45
44
  import { LangfuseExporter } from "@mastra/langfuse";
46
45
 
@@ -48,7 +47,7 @@ export const mastra = new Mastra({
48
47
  observability: {
49
48
  configs: {
50
49
  langfuse: {
51
- serviceName: 'my-service',
50
+ serviceName: "my-service",
52
51
  exporters: [
53
52
  new LangfuseExporter({
54
53
  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
@@ -72,25 +71,27 @@ export const mastra = new Mastra({
72
71
  The Langfuse exporter supports two modes for sending traces:
73
72
 
74
73
  #### Realtime Mode (Development)
74
+
75
75
  Traces appear immediately in Langfuse dashboard, ideal for debugging:
76
76
 
77
77
  ```typescript
78
78
  new LangfuseExporter({
79
79
  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
80
80
  secretKey: process.env.LANGFUSE_SECRET_KEY!,
81
- realtime: true, // Flush after each event
82
- })
81
+ realtime: true, // Flush after each event
82
+ });
83
83
  ```
84
84
 
85
85
  #### Batch Mode (Production)
86
+
86
87
  Better performance with automatic batching:
87
88
 
88
89
  ```typescript
89
90
  new LangfuseExporter({
90
91
  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
91
92
  secretKey: process.env.LANGFUSE_SECRET_KEY!,
92
- realtime: false, // Default - batch traces
93
- })
93
+ realtime: false, // Default - batch traces
94
+ });
94
95
  ```
95
96
 
96
97
  ### Complete Configuration
@@ -102,20 +103,20 @@ new LangfuseExporter({
102
103
  secretKey: process.env.LANGFUSE_SECRET_KEY!,
103
104
 
104
105
  // Optional settings
105
- baseUrl: process.env.LANGFUSE_BASE_URL, // Default: https://cloud.langfuse.com
106
- realtime: process.env.NODE_ENV === 'development', // Dynamic mode selection
107
- logLevel: 'info', // Diagnostic logging: debug | info | warn | error
106
+ baseUrl: process.env.LANGFUSE_BASE_URL, // Default: https://cloud.langfuse.com
107
+ realtime: process.env.NODE_ENV === "development", // Dynamic mode selection
108
+ logLevel: "info", // Diagnostic logging: debug | info | warn | error
108
109
 
109
110
  // Langfuse-specific options
110
111
  options: {
111
- environment: process.env.NODE_ENV, // Shows in UI for filtering
112
- version: process.env.APP_VERSION, // Track different versions
113
- release: process.env.GIT_COMMIT, // Git commit hash
112
+ environment: process.env.NODE_ENV, // Shows in UI for filtering
113
+ version: process.env.APP_VERSION, // Track different versions
114
+ release: process.env.GIT_COMMIT, // Git commit hash
114
115
  },
115
- })
116
+ });
116
117
  ```
117
118
 
118
119
  ## Related
119
120
 
120
121
  - [AI Tracing Overview](/docs/observability/ai-tracing/overview)
121
- - [Langfuse Documentation](https://langfuse.com/docs)
122
+ - [Langfuse Documentation](https://langfuse.com/docs)
@@ -3,8 +3,6 @@ title: "LangSmith Exporter | AI Tracing | Observability | Mastra Docs"
3
3
  description: "Send AI traces to LangSmith for LLM observability and evaluation"
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # LangSmith Exporter
9
7
 
10
8
  [LangSmith](https://smith.langchain.com/) is LangChain's platform for monitoring and evaluating LLM applications. The LangSmith exporter sends your AI traces to LangSmith, providing insights into model performance, debugging capabilities, and evaluation workflows.
@@ -12,6 +10,7 @@ import { Callout } from "nextra/components";
12
10
  ## When to Use LangSmith
13
11
 
14
12
  LangSmith is ideal when you need:
13
+
15
14
  - **LangChain ecosystem integration** - Native support for LangChain applications
16
15
  - **Debugging and testing** - Detailed trace visualization and replay
17
16
  - **Evaluation pipelines** - Built-in evaluation and dataset management
@@ -32,14 +31,14 @@ npm install @mastra/langsmith
32
31
  2. **API Key**: Generate an API key in LangSmith Settings → API Keys
33
32
  3. **Environment Variables**: Set your credentials
34
33
 
35
- ```bash filename=".env"
34
+ ```bash title=".env"
36
35
  LANGSMITH_API_KEY=ls-xxxxxxxxxxxx
37
36
  LANGSMITH_BASE_URL=https://api.smith.langchain.com # Optional for self-hosted
38
37
  ```
39
38
 
40
39
  ### Basic Setup
41
40
 
42
- ```typescript filename="src/mastra/index.ts"
41
+ ```typescript title="src/mastra/index.ts"
43
42
  import { Mastra } from "@mastra/core";
44
43
  import { LangSmithExporter } from "@mastra/langsmith";
45
44
 
@@ -47,7 +46,7 @@ export const mastra = new Mastra({
47
46
  observability: {
48
47
  configs: {
49
48
  langsmith: {
50
- serviceName: 'my-service',
49
+ serviceName: "my-service",
51
50
  exporters: [
52
51
  new LangSmithExporter({
53
52
  apiKey: process.env.LANGSMITH_API_KEY,
@@ -69,20 +68,21 @@ new LangSmithExporter({
69
68
  apiKey: process.env.LANGSMITH_API_KEY!,
70
69
 
71
70
  // Optional settings
72
- apiUrl: process.env.LANGSMITH_BASE_URL, // Default: https://api.smith.langchain.com
73
- callerOptions: { // HTTP client options
74
- timeout: 30000, // Request timeout in ms
75
- maxRetries: 3, // Retry attempts
71
+ apiUrl: process.env.LANGSMITH_BASE_URL, // Default: https://api.smith.langchain.com
72
+ callerOptions: {
73
+ // HTTP client options
74
+ timeout: 30000, // Request timeout in ms
75
+ maxRetries: 3, // Retry attempts
76
76
  },
77
- logLevel: 'info', // Diagnostic logging: debug | info | warn | error
77
+ logLevel: "info", // Diagnostic logging: debug | info | warn | error
78
78
 
79
79
  // LangSmith-specific options
80
- hideInputs: false, // Hide input data in UI
81
- hideOutputs: false, // Hide output data in UI
82
- })
80
+ hideInputs: false, // Hide input data in UI
81
+ hideOutputs: false, // Hide output data in UI
82
+ });
83
83
  ```
84
84
 
85
85
  ## Related
86
86
 
87
87
  - [AI Tracing Overview](/docs/observability/ai-tracing/overview)
88
- - [LangSmith Documentation](https://docs.smith.langchain.com/)
88
+ - [LangSmith Documentation](https://docs.smith.langchain.com/)
@@ -3,19 +3,20 @@ title: "OpenTelemetry Exporter | AI Tracing | Observability | Mastra Docs"
3
3
  description: "Send AI traces to any OpenTelemetry-compatible observability platform"
4
4
  ---
5
5
 
6
- import { Callout } from "nextra/components";
7
-
8
6
  # OpenTelemetry Exporter
9
7
 
10
- <Callout type="warning">
8
+ :::warning
9
+
11
10
  The OpenTelemetry exporter is currently **experimental**. APIs and configuration options may change in future releases.
12
- </Callout>
11
+
12
+ :::
13
13
 
14
14
  The OpenTelemetry (OTEL) exporter sends your AI traces to any OTEL-compatible observability platform using standardized [OpenTelemetry Semantic Conventions for GenAI](https://opentelemetry.io/docs/specs/semconv/gen-ai/). This ensures broad compatibility with platforms like Datadog, New Relic, SigNoz, Dash0, Traceloop, Laminar, and more.
15
15
 
16
16
  ## When to Use OTEL Exporter
17
17
 
18
18
  The OTEL exporter is ideal when you need:
19
+
19
20
  - **Platform flexibility** - Send traces to any OTEL-compatible backend
20
21
  - **Standards compliance** - Follow OpenTelemetry GenAI semantic conventions
21
22
  - **Multi-vendor support** - Configure once, switch providers easily
@@ -50,7 +51,7 @@ npm install @mastra/otel-exporter @opentelemetry/exporter-trace-otlp-http
50
51
 
51
52
  [Dash0](https://www.dash0.com/) provides real-time observability with automatic insights.
52
53
 
53
- ```typescript filename="src/mastra/index.ts"
54
+ ```typescript title="src/mastra/index.ts"
54
55
  import { Mastra } from "@mastra/core";
55
56
  import { OtelExporter } from "@mastra/otel-exporter";
56
57
 
@@ -58,18 +59,19 @@ export const mastra = new Mastra({
58
59
  observability: {
59
60
  configs: {
60
61
  otel: {
61
- serviceName: 'my-service',
62
+ serviceName: "my-service",
62
63
  exporters: [
63
64
  new OtelExporter({
64
65
  provider: {
65
66
  dash0: {
66
67
  apiKey: process.env.DASH0_API_KEY,
67
68
  endpoint: process.env.DASH0_ENDPOINT, // e.g., 'ingress.us-west-2.aws.dash0.com:4317'
68
- dataset: 'production', // Optional dataset name
69
- }
69
+ dataset: "production", // Optional dataset name
70
+ },
70
71
  },
71
- resourceAttributes: { // Optional OpenTelemetry Resource Attributes for the trace
72
- ['deployment.environment']: 'dev',
72
+ resourceAttributes: {
73
+ // Optional OpenTelemetry Resource Attributes for the trace
74
+ ["deployment.environment"]: "dev",
73
75
  },
74
76
  }),
75
77
  ],
@@ -79,87 +81,89 @@ export const mastra = new Mastra({
79
81
  });
80
82
  ```
81
83
 
82
- <Callout type="info">
84
+ :::info
85
+
83
86
  Get your Dash0 endpoint from your dashboard. It should be in the format `ingress.{region}.aws.dash0.com:4317`.
84
- </Callout>
87
+
88
+ :::
85
89
 
86
90
  ### SigNoz
87
91
 
88
92
  [SigNoz](https://signoz.io/) is an open-source APM alternative with built-in AI tracing support.
89
93
 
90
- ```typescript filename="src/mastra/index.ts"
94
+ ```typescript title="src/mastra/index.ts"
91
95
  new OtelExporter({
92
96
  provider: {
93
97
  signoz: {
94
98
  apiKey: process.env.SIGNOZ_API_KEY,
95
- region: 'us', // 'us' | 'eu' | 'in'
99
+ region: "us", // 'us' | 'eu' | 'in'
96
100
  // endpoint: 'https://my-signoz.example.com', // For self-hosted
97
- }
101
+ },
98
102
  },
99
- })
103
+ });
100
104
  ```
101
105
 
102
106
  ### New Relic
103
107
 
104
108
  [New Relic](https://newrelic.com/) provides comprehensive observability with AI monitoring capabilities.
105
109
 
106
- ```typescript filename="src/mastra/index.ts"
110
+ ```typescript title="src/mastra/index.ts"
107
111
  new OtelExporter({
108
112
  provider: {
109
113
  newrelic: {
110
114
  apiKey: process.env.NEW_RELIC_LICENSE_KEY,
111
115
  // endpoint: 'https://otlp.eu01.nr-data.net', // For EU region
112
- }
116
+ },
113
117
  },
114
- })
118
+ });
115
119
  ```
116
120
 
117
121
  ### Traceloop
118
122
 
119
123
  [Traceloop](https://www.traceloop.com/) specializes in LLM observability with automatic prompt tracking.
120
124
 
121
- ```typescript filename="src/mastra/index.ts"
125
+ ```typescript title="src/mastra/index.ts"
122
126
  new OtelExporter({
123
127
  provider: {
124
128
  traceloop: {
125
129
  apiKey: process.env.TRACELOOP_API_KEY,
126
- destinationId: 'my-destination', // Optional
127
- }
130
+ destinationId: "my-destination", // Optional
131
+ },
128
132
  },
129
- })
133
+ });
130
134
  ```
131
135
 
132
136
  ### Laminar
133
137
 
134
138
  [Laminar](https://www.lmnr.ai/) provides specialized LLM observability and analytics.
135
139
 
136
- ```typescript filename="src/mastra/index.ts"
140
+ ```typescript title="src/mastra/index.ts"
137
141
  new OtelExporter({
138
142
  provider: {
139
143
  laminar: {
140
144
  apiKey: process.env.LMNR_PROJECT_API_KEY,
141
145
  // teamId: process.env.LAMINAR_TEAM_ID, // Optional, for backwards compatibility
142
- }
146
+ },
143
147
  },
144
- })
148
+ });
145
149
  ```
146
150
 
147
151
  ### Custom/Generic OTEL Endpoints
148
152
 
149
153
  For other OTEL-compatible platforms or custom collectors:
150
154
 
151
- ```typescript filename="src/mastra/index.ts"
155
+ ```typescript title="src/mastra/index.ts"
152
156
  new OtelExporter({
153
157
  provider: {
154
158
  custom: {
155
- endpoint: 'https://your-collector.example.com/v1/traces',
156
- protocol: 'http/protobuf', // 'http/json' | 'http/protobuf' | 'grpc'
159
+ endpoint: "https://your-collector.example.com/v1/traces",
160
+ protocol: "http/protobuf", // 'http/json' | 'http/protobuf' | 'grpc'
157
161
  headers: {
158
- 'x-api-key': process.env.API_KEY,
162
+ "x-api-key": process.env.API_KEY,
159
163
  },
160
- }
164
+ },
161
165
  },
162
- })
166
+ });
163
167
  ```
164
168
 
165
169
  ## Configuration Options
@@ -174,12 +178,12 @@ new OtelExporter({
174
178
  },
175
179
 
176
180
  // Export configuration
177
- timeout: 30000, // Export timeout in milliseconds
178
- batchSize: 100, // Number of spans per batch
181
+ timeout: 30000, // Export timeout in milliseconds
182
+ batchSize: 100, // Number of spans per batch
179
183
 
180
184
  // Debug options
181
- logLevel: 'info', // 'debug' | 'info' | 'warn' | 'error'
182
- })
185
+ logLevel: "info", // 'debug' | 'info' | 'warn' | 'error'
186
+ });
183
187
  ```
184
188
 
185
189
  ## OpenTelemetry Semantic Conventions
@@ -187,12 +191,14 @@ new OtelExporter({
187
191
  The exporter follows [OpenTelemetry Semantic Conventions for GenAI](https://opentelemetry.io/docs/specs/semconv/gen-ai/), ensuring compatibility with observability platforms:
188
192
 
189
193
  ### Span Naming
194
+
190
195
  - **LLM Operations**: `chat {model}` or `tool_selection {model}`
191
196
  - **Tool Execution**: `tool.execute {tool_name}`
192
197
  - **Agent Runs**: `agent.{agent_id}`
193
198
  - **Workflow Runs**: `workflow.{workflow_id}`
194
199
 
195
200
  ### Key Attributes
201
+
196
202
  - `gen_ai.operation.name` - Operation type (chat, tool.execute, etc.)
197
203
  - `gen_ai.system` - AI provider (openai, anthropic, etc.)
198
204
  - `gen_ai.request.model` - Model identifier
@@ -204,6 +210,7 @@ The exporter follows [OpenTelemetry Semantic Conventions for GenAI](https://open
204
210
  ## Buffering Strategy
205
211
 
206
212
  The exporter buffers spans until a trace is complete:
213
+
207
214
  1. Collects all spans for a trace
208
215
  2. Waits 5 seconds after root span completes
209
216
  3. Exports complete trace with preserved parent-child relationships
@@ -213,24 +220,27 @@ The exporter buffers spans until a trace is complete:
213
220
 
214
221
  Choose the right protocol package based on your provider:
215
222
 
216
- | Provider | Protocol | Required Package |
217
- |----------|----------|------------------|
218
- | Dash0 | gRPC | `@opentelemetry/exporter-trace-otlp-grpc` |
219
- | SigNoz | HTTP/Protobuf | `@opentelemetry/exporter-trace-otlp-proto` |
223
+ | Provider | Protocol | Required Package |
224
+ | --------- | ------------- | ------------------------------------------ |
225
+ | Dash0 | gRPC | `@opentelemetry/exporter-trace-otlp-grpc` |
226
+ | SigNoz | HTTP/Protobuf | `@opentelemetry/exporter-trace-otlp-proto` |
220
227
  | New Relic | HTTP/Protobuf | `@opentelemetry/exporter-trace-otlp-proto` |
221
- | Traceloop | HTTP/JSON | `@opentelemetry/exporter-trace-otlp-http` |
222
- | Laminar | HTTP/Protobuf | `@opentelemetry/exporter-trace-otlp-proto` |
223
- | Custom | Varies | Depends on your collector |
228
+ | Traceloop | HTTP/JSON | `@opentelemetry/exporter-trace-otlp-http` |
229
+ | Laminar | HTTP/Protobuf | `@opentelemetry/exporter-trace-otlp-proto` |
230
+ | Custom | Varies | Depends on your collector |
231
+
232
+ :::warning
224
233
 
225
- <Callout type="warning">
226
234
  Make sure to install the correct protocol package for your provider. The exporter will provide a helpful error message if the wrong package is installed.
227
- </Callout>
235
+
236
+ :::
228
237
 
229
238
  ## Troubleshooting
230
239
 
231
240
  ### Missing Dependency Error
232
241
 
233
242
  If you see an error like:
243
+
234
244
  ```
235
245
  HTTP/Protobuf exporter is not installed (required for signoz).
236
246
  To use HTTP/Protobuf export, install the required package:
@@ -250,4 +260,4 @@ Install the suggested package for your provider.
250
260
 
251
261
  - [AI Tracing Overview](/docs/observability/ai-tracing/overview)
252
262
  - [OpenTelemetry GenAI Conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/)
253
- - [OTEL Exporter Reference](/reference/observability/ai-tracing/exporters/otel)
263
+ - [OTEL Exporter Reference](/reference/observability/ai-tracing/exporters/otel)