@mastra/mcp-docs-server 1.1.8 → 1.1.9-alpha.1

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 (462) hide show
  1. package/.docs/docs/agents/adding-voice.md +4 -4
  2. package/.docs/docs/agents/agent-approval.md +3 -3
  3. package/.docs/docs/agents/agent-memory.md +3 -3
  4. package/.docs/docs/agents/guardrails.md +3 -3
  5. package/.docs/docs/agents/network-approval.md +5 -2
  6. package/.docs/docs/agents/networks.md +2 -2
  7. package/.docs/docs/agents/overview.md +2 -2
  8. package/.docs/docs/agents/processors.md +42 -24
  9. package/.docs/docs/agents/structured-output.md +2 -2
  10. package/.docs/docs/agents/supervisor-agents.md +3 -3
  11. package/.docs/docs/agents/using-tools.md +3 -3
  12. package/.docs/docs/build-with-ai/mcp-docs-server.md +5 -5
  13. package/.docs/docs/build-with-ai/skills.md +2 -2
  14. package/.docs/docs/community/contributing-templates.md +1 -1
  15. package/.docs/docs/community/discord.md +3 -3
  16. package/.docs/docs/community/licensing.md +2 -2
  17. package/.docs/docs/deployment/cloud-providers.md +2 -2
  18. package/.docs/docs/deployment/mastra-server.md +2 -2
  19. package/.docs/docs/deployment/monorepo.md +1 -1
  20. package/.docs/docs/deployment/overview.md +3 -3
  21. package/.docs/docs/deployment/studio.md +3 -3
  22. package/.docs/docs/deployment/web-framework.md +2 -2
  23. package/.docs/docs/deployment/workflow-runners.md +1 -1
  24. package/.docs/docs/evals/built-in-scorers.md +1 -1
  25. package/.docs/docs/evals/custom-scorers.md +6 -6
  26. package/.docs/docs/evals/overview.md +2 -2
  27. package/.docs/docs/evals/running-in-ci.md +6 -6
  28. package/.docs/docs/getting-started/build-with-ai.md +3 -3
  29. package/.docs/docs/getting-started/manual-install.md +1 -1
  30. package/.docs/docs/getting-started/project-structure.md +2 -2
  31. package/.docs/docs/index.md +63 -17
  32. package/.docs/docs/mastra-cloud/deployment.md +1 -1
  33. package/.docs/docs/mastra-cloud/studio.md +1 -1
  34. package/.docs/docs/mcp/overview.md +1 -1
  35. package/.docs/docs/mcp/publishing-mcp-server.md +4 -4
  36. package/.docs/docs/memory/memory-processors.md +9 -9
  37. package/.docs/docs/memory/message-history.md +4 -4
  38. package/.docs/docs/memory/observational-memory.md +11 -7
  39. package/.docs/docs/memory/semantic-recall.md +9 -9
  40. package/.docs/docs/memory/storage.md +1 -1
  41. package/.docs/docs/memory/working-memory.md +20 -20
  42. package/.docs/docs/observability/datasets/overview.md +1 -1
  43. package/.docs/docs/observability/datasets/running-experiments.md +1 -1
  44. package/.docs/docs/observability/logging.md +1 -1
  45. package/.docs/docs/observability/overview.md +5 -5
  46. package/.docs/docs/observability/tracing/bridges/otel.md +9 -9
  47. package/.docs/docs/observability/tracing/exporters/arize.md +3 -3
  48. package/.docs/docs/observability/tracing/exporters/braintrust.md +1 -1
  49. package/.docs/docs/observability/tracing/exporters/cloud.md +2 -2
  50. package/.docs/docs/observability/tracing/exporters/datadog.md +3 -3
  51. package/.docs/docs/observability/tracing/exporters/default.md +8 -8
  52. package/.docs/docs/observability/tracing/exporters/laminar.md +1 -1
  53. package/.docs/docs/observability/tracing/exporters/langfuse.md +3 -3
  54. package/.docs/docs/observability/tracing/exporters/langsmith.md +4 -4
  55. package/.docs/docs/observability/tracing/exporters/otel.md +8 -8
  56. package/.docs/docs/observability/tracing/exporters/posthog.md +2 -2
  57. package/.docs/docs/observability/tracing/exporters/sentry.md +4 -4
  58. package/.docs/docs/observability/tracing/overview.md +24 -24
  59. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +13 -13
  60. package/.docs/docs/rag/chunking-and-embedding.md +5 -5
  61. package/.docs/docs/rag/overview.md +2 -2
  62. package/.docs/docs/rag/retrieval.md +4 -4
  63. package/.docs/docs/rag/vector-databases.md +13 -13
  64. package/.docs/docs/server/auth/auth0.md +2 -2
  65. package/.docs/docs/server/auth/clerk.md +1 -1
  66. package/.docs/docs/server/auth/composite-auth.md +9 -9
  67. package/.docs/docs/server/auth/custom-auth-provider.md +12 -12
  68. package/.docs/docs/server/auth/firebase.md +3 -3
  69. package/.docs/docs/server/auth/jwt.md +1 -1
  70. package/.docs/docs/server/auth/simple-auth.md +9 -9
  71. package/.docs/docs/server/auth/supabase.md +1 -1
  72. package/.docs/docs/server/auth/workos.md +1 -1
  73. package/.docs/docs/server/auth.md +2 -2
  74. package/.docs/docs/server/custom-adapters.md +7 -7
  75. package/.docs/docs/server/custom-api-routes.md +2 -2
  76. package/.docs/docs/server/mastra-client.md +2 -2
  77. package/.docs/docs/server/mastra-server.md +2 -2
  78. package/.docs/docs/server/request-context.md +2 -2
  79. package/.docs/docs/server/server-adapters.md +3 -3
  80. package/.docs/docs/streaming/events.md +2 -2
  81. package/.docs/docs/streaming/overview.md +2 -2
  82. package/.docs/docs/streaming/tool-streaming.md +46 -32
  83. package/.docs/docs/streaming/workflow-streaming.md +1 -1
  84. package/.docs/docs/voice/overview.md +3 -3
  85. package/.docs/docs/voice/speech-to-speech.md +1 -1
  86. package/.docs/docs/voice/speech-to-text.md +2 -2
  87. package/.docs/docs/voice/text-to-speech.md +2 -2
  88. package/.docs/docs/workflows/agents-and-tools.md +1 -1
  89. package/.docs/docs/workflows/control-flow.md +45 -3
  90. package/.docs/docs/workflows/error-handling.md +4 -4
  91. package/.docs/docs/workflows/overview.md +3 -3
  92. package/.docs/docs/workflows/snapshots.md +1 -1
  93. package/.docs/docs/workflows/suspend-and-resume.md +1 -1
  94. package/.docs/docs/workflows/time-travel.md +3 -3
  95. package/.docs/docs/workflows/workflow-state.md +1 -1
  96. package/.docs/docs/workspace/filesystem.md +3 -3
  97. package/.docs/docs/workspace/overview.md +53 -8
  98. package/.docs/docs/workspace/sandbox.md +72 -13
  99. package/.docs/docs/workspace/search.md +1 -1
  100. package/.docs/docs/workspace/skills.md +4 -4
  101. package/.docs/guides/build-your-ui/ai-sdk-ui.md +2 -2
  102. package/.docs/guides/build-your-ui/assistant-ui.md +1 -1
  103. package/.docs/guides/build-your-ui/copilotkit.md +2 -2
  104. package/.docs/guides/deployment/digital-ocean.md +1 -1
  105. package/.docs/guides/deployment/inngest.md +4 -4
  106. package/.docs/guides/getting-started/astro.md +1 -1
  107. package/.docs/guides/getting-started/electron.md +1 -1
  108. package/.docs/guides/getting-started/next-js.md +1 -1
  109. package/.docs/guides/getting-started/vite-react.md +1 -1
  110. package/.docs/guides/guide/ai-recruiter.md +4 -4
  111. package/.docs/guides/guide/chef-michel.md +4 -4
  112. package/.docs/guides/guide/code-review-bot.md +3 -3
  113. package/.docs/guides/guide/dev-assistant.md +5 -5
  114. package/.docs/guides/guide/docs-manager.md +3 -3
  115. package/.docs/guides/guide/github-actions-pr-description.md +4 -4
  116. package/.docs/guides/guide/notes-mcp-server.md +4 -4
  117. package/.docs/guides/guide/research-assistant.md +4 -4
  118. package/.docs/guides/guide/research-coordinator.md +1 -1
  119. package/.docs/guides/guide/stock-agent.md +6 -6
  120. package/.docs/guides/guide/web-search.md +2 -2
  121. package/.docs/guides/guide/whatsapp-chat-bot.md +1 -1
  122. package/.docs/guides/migrations/agentnetwork.md +1 -1
  123. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +3 -3
  124. package/.docs/guides/migrations/network-to-supervisor.md +1 -1
  125. package/.docs/guides/migrations/upgrade-to-v1/agent.md +1 -1
  126. package/.docs/guides/migrations/upgrade-to-v1/client.md +2 -2
  127. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +2 -2
  128. package/.docs/guides/migrations/upgrade-to-v1/evals.md +1 -1
  129. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +1 -1
  130. package/.docs/guides/migrations/upgrade-to-v1/memory.md +2 -2
  131. package/.docs/guides/migrations/upgrade-to-v1/overview.md +3 -3
  132. package/.docs/guides/migrations/upgrade-to-v1/storage.md +4 -4
  133. package/.docs/guides/migrations/upgrade-to-v1/tools.md +2 -2
  134. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +2 -2
  135. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +3 -3
  136. package/.docs/guides/migrations/upgrade-to-v1/voice.md +1 -1
  137. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +6 -6
  138. package/.docs/guides/migrations/vnext-to-standard-apis.md +3 -3
  139. package/.docs/models/embeddings.md +4 -4
  140. package/.docs/models/gateways/custom-gateways.md +4 -4
  141. package/.docs/models/gateways/netlify.md +2 -3
  142. package/.docs/models/gateways/openrouter.md +9 -2
  143. package/.docs/models/gateways/vercel.md +11 -2
  144. package/.docs/models/gateways.md +2 -2
  145. package/.docs/models/index.md +1 -1
  146. package/.docs/models/providers/302ai.md +3 -3
  147. package/.docs/models/providers/abacus.md +24 -14
  148. package/.docs/models/providers/aihubmix.md +10 -5
  149. package/.docs/models/providers/alibaba-cn.md +83 -74
  150. package/.docs/models/providers/alibaba-coding-plan-cn.md +78 -0
  151. package/.docs/models/providers/alibaba-coding-plan.md +78 -0
  152. package/.docs/models/providers/alibaba.md +3 -3
  153. package/.docs/models/providers/anthropic.md +4 -4
  154. package/.docs/models/providers/bailing.md +3 -3
  155. package/.docs/models/providers/baseten.md +3 -3
  156. package/.docs/models/providers/berget.md +3 -3
  157. package/.docs/models/providers/cerebras.md +4 -4
  158. package/.docs/models/providers/chutes.md +7 -6
  159. package/.docs/models/providers/clarifai.md +81 -0
  160. package/.docs/models/providers/cloudferro-sherlock.md +8 -7
  161. package/.docs/models/providers/cloudflare-workers-ai.md +6 -5
  162. package/.docs/models/providers/cortecs.md +10 -8
  163. package/.docs/models/providers/deepinfra.md +11 -6
  164. package/.docs/models/providers/deepseek.md +4 -4
  165. package/.docs/models/providers/drun.md +73 -0
  166. package/.docs/models/providers/evroc.md +3 -3
  167. package/.docs/models/providers/fastrouter.md +3 -3
  168. package/.docs/models/providers/fireworks-ai.md +3 -3
  169. package/.docs/models/providers/firmware.md +31 -23
  170. package/.docs/models/providers/friendli.md +3 -3
  171. package/.docs/models/providers/github-models.md +3 -3
  172. package/.docs/models/providers/google.md +7 -5
  173. package/.docs/models/providers/groq.md +4 -4
  174. package/.docs/models/providers/helicone.md +3 -3
  175. package/.docs/models/providers/huggingface.md +3 -3
  176. package/.docs/models/providers/iflowcn.md +3 -3
  177. package/.docs/models/providers/inception.md +7 -5
  178. package/.docs/models/providers/inference.md +3 -3
  179. package/.docs/models/providers/io-net.md +3 -3
  180. package/.docs/models/providers/jiekou.md +3 -3
  181. package/.docs/models/providers/kilo.md +6 -4
  182. package/.docs/models/providers/kimi-for-coding.md +4 -4
  183. package/.docs/models/providers/kuae-cloud-coding-plan.md +3 -3
  184. package/.docs/models/providers/llama.md +3 -3
  185. package/.docs/models/providers/lmstudio.md +3 -3
  186. package/.docs/models/providers/lucidquery.md +3 -3
  187. package/.docs/models/providers/meganova.md +3 -3
  188. package/.docs/models/providers/minimax-cn-coding-plan.md +4 -4
  189. package/.docs/models/providers/minimax-cn.md +4 -4
  190. package/.docs/models/providers/minimax-coding-plan.md +4 -4
  191. package/.docs/models/providers/minimax.md +4 -4
  192. package/.docs/models/providers/mistral.md +4 -4
  193. package/.docs/models/providers/moark.md +3 -3
  194. package/.docs/models/providers/modelscope.md +3 -3
  195. package/.docs/models/providers/moonshotai-cn.md +3 -3
  196. package/.docs/models/providers/moonshotai.md +3 -3
  197. package/.docs/models/providers/morph.md +3 -3
  198. package/.docs/models/providers/nano-gpt.md +523 -42
  199. package/.docs/models/providers/nebius.md +37 -37
  200. package/.docs/models/providers/nova.md +3 -3
  201. package/.docs/models/providers/novita-ai.md +3 -3
  202. package/.docs/models/providers/nvidia.md +7 -5
  203. package/.docs/models/providers/ollama-cloud.md +4 -5
  204. package/.docs/models/providers/openai.md +7 -5
  205. package/.docs/models/providers/opencode-go.md +3 -3
  206. package/.docs/models/providers/opencode.md +39 -36
  207. package/.docs/models/providers/ovhcloud.md +3 -3
  208. package/.docs/models/providers/perplexity-agent.md +4 -4
  209. package/.docs/models/providers/perplexity.md +4 -4
  210. package/.docs/models/providers/poe.md +11 -5
  211. package/.docs/models/providers/privatemode-ai.md +3 -3
  212. package/.docs/models/providers/qihang-ai.md +3 -3
  213. package/.docs/models/providers/qiniu-ai.md +23 -8
  214. package/.docs/models/providers/requesty.md +20 -4
  215. package/.docs/models/providers/scaleway.md +3 -3
  216. package/.docs/models/providers/siliconflow-cn.md +10 -4
  217. package/.docs/models/providers/siliconflow.md +3 -3
  218. package/.docs/models/providers/stackit.md +3 -3
  219. package/.docs/models/providers/stepfun.md +3 -3
  220. package/.docs/models/providers/submodel.md +3 -3
  221. package/.docs/models/providers/synthetic.md +3 -3
  222. package/.docs/models/providers/togetherai.md +5 -7
  223. package/.docs/models/providers/upstage.md +3 -3
  224. package/.docs/models/providers/vivgrid.md +4 -4
  225. package/.docs/models/providers/vultr.md +3 -3
  226. package/.docs/models/providers/wandb.md +3 -3
  227. package/.docs/models/providers/xai.md +34 -31
  228. package/.docs/models/providers/xiaomi.md +4 -4
  229. package/.docs/models/providers/zai-coding-plan.md +3 -3
  230. package/.docs/models/providers/zai.md +3 -3
  231. package/.docs/models/providers/zenmux.md +7 -5
  232. package/.docs/models/providers/zhipuai-coding-plan.md +3 -3
  233. package/.docs/models/providers/zhipuai.md +3 -3
  234. package/.docs/models/providers.md +4 -0
  235. package/.docs/reference/agents/agent.md +3 -3
  236. package/.docs/reference/agents/generateLegacy.md +1 -1
  237. package/.docs/reference/agents/getDefaultGenerateOptions.md +1 -1
  238. package/.docs/reference/agents/getDefaultOptions.md +1 -1
  239. package/.docs/reference/agents/getDefaultStreamOptions.md +1 -1
  240. package/.docs/reference/agents/getDescription.md +1 -1
  241. package/.docs/reference/agents/network.md +5 -3
  242. package/.docs/reference/ai-sdk/handle-chat-stream.md +2 -0
  243. package/.docs/reference/ai-sdk/handle-network-stream.md +2 -0
  244. package/.docs/reference/ai-sdk/network-route.md +2 -0
  245. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +1 -1
  246. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +1 -1
  247. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +1 -1
  248. package/.docs/reference/auth/auth0.md +7 -7
  249. package/.docs/reference/auth/better-auth.md +2 -2
  250. package/.docs/reference/auth/clerk.md +1 -1
  251. package/.docs/reference/auth/firebase.md +5 -5
  252. package/.docs/reference/auth/jwt.md +1 -1
  253. package/.docs/reference/auth/supabase.md +1 -1
  254. package/.docs/reference/auth/workos.md +6 -6
  255. package/.docs/reference/cli/mastra.md +5 -5
  256. package/.docs/reference/client-js/agents.md +22 -22
  257. package/.docs/reference/client-js/error-handling.md +2 -2
  258. package/.docs/reference/client-js/logs.md +2 -2
  259. package/.docs/reference/client-js/mastra-client.md +2 -2
  260. package/.docs/reference/client-js/memory.md +6 -6
  261. package/.docs/reference/client-js/observability.md +4 -4
  262. package/.docs/reference/client-js/telemetry.md +1 -1
  263. package/.docs/reference/client-js/tools.md +3 -3
  264. package/.docs/reference/client-js/vectors.md +2 -2
  265. package/.docs/reference/client-js/workflows.md +12 -12
  266. package/.docs/reference/configuration.md +62 -6
  267. package/.docs/reference/core/getDeployer.md +1 -1
  268. package/.docs/reference/core/getGatewayById.md +1 -1
  269. package/.docs/reference/core/getLogger.md +1 -1
  270. package/.docs/reference/core/getMCPServer.md +2 -2
  271. package/.docs/reference/core/getMCPServerById.md +2 -2
  272. package/.docs/reference/core/getMemory.md +1 -1
  273. package/.docs/reference/core/getScorer.md +4 -4
  274. package/.docs/reference/core/getScorerById.md +2 -2
  275. package/.docs/reference/core/getServer.md +1 -1
  276. package/.docs/reference/core/getStorage.md +1 -1
  277. package/.docs/reference/core/getStoredAgentById.md +3 -3
  278. package/.docs/reference/core/getTelemetry.md +1 -1
  279. package/.docs/reference/core/getWorkflow.md +1 -1
  280. package/.docs/reference/core/listAgents.md +1 -1
  281. package/.docs/reference/core/listMCPServers.md +3 -3
  282. package/.docs/reference/core/listMemory.md +1 -1
  283. package/.docs/reference/core/listScorers.md +1 -1
  284. package/.docs/reference/core/listStoredAgents.md +3 -3
  285. package/.docs/reference/core/listVectors.md +1 -1
  286. package/.docs/reference/core/mastra-class.md +2 -2
  287. package/.docs/reference/core/mastra-model-gateway.md +11 -11
  288. package/.docs/reference/core/setLogger.md +1 -1
  289. package/.docs/reference/core/setStorage.md +1 -1
  290. package/.docs/reference/datasets/dataset.md +2 -2
  291. package/.docs/reference/datasets/datasets-manager.md +1 -1
  292. package/.docs/reference/datasets/get.md +2 -2
  293. package/.docs/reference/datasets/getDetails.md +1 -1
  294. package/.docs/reference/datasets/listItems.md +1 -1
  295. package/.docs/reference/deployer/vercel.md +1 -1
  296. package/.docs/reference/deployer.md +4 -4
  297. package/.docs/reference/evals/answer-relevancy.md +4 -4
  298. package/.docs/reference/evals/answer-similarity.md +3 -3
  299. package/.docs/reference/evals/bias.md +4 -4
  300. package/.docs/reference/evals/completeness.md +6 -6
  301. package/.docs/reference/evals/content-similarity.md +3 -3
  302. package/.docs/reference/evals/context-precision.md +9 -9
  303. package/.docs/reference/evals/context-relevance.md +7 -7
  304. package/.docs/reference/evals/create-scorer.md +7 -7
  305. package/.docs/reference/evals/faithfulness.md +3 -3
  306. package/.docs/reference/evals/hallucination.md +8 -14
  307. package/.docs/reference/evals/keyword-coverage.md +4 -4
  308. package/.docs/reference/evals/mastra-scorer.md +7 -7
  309. package/.docs/reference/evals/noise-sensitivity.md +11 -11
  310. package/.docs/reference/evals/prompt-alignment.md +5 -5
  311. package/.docs/reference/evals/run-evals.md +5 -5
  312. package/.docs/reference/evals/scorer-utils.md +17 -17
  313. package/.docs/reference/evals/textual-difference.md +4 -4
  314. package/.docs/reference/evals/tone-consistency.md +5 -5
  315. package/.docs/reference/evals/tool-call-accuracy.md +10 -10
  316. package/.docs/reference/evals/toxicity.md +3 -3
  317. package/.docs/reference/harness/harness-class.md +5 -3
  318. package/.docs/reference/index.md +2 -0
  319. package/.docs/reference/memory/clone-utilities.md +7 -7
  320. package/.docs/reference/memory/cloneThread.md +5 -5
  321. package/.docs/reference/memory/createThread.md +1 -1
  322. package/.docs/reference/memory/deleteMessages.md +1 -1
  323. package/.docs/reference/memory/getThreadById.md +1 -1
  324. package/.docs/reference/memory/listThreads.md +3 -3
  325. package/.docs/reference/memory/memory-class.md +1 -1
  326. package/.docs/reference/memory/observational-memory.md +8 -6
  327. package/.docs/reference/memory/recall.md +1 -1
  328. package/.docs/reference/observability/tracing/bridges/otel.md +6 -6
  329. package/.docs/reference/observability/tracing/configuration.md +17 -17
  330. package/.docs/reference/observability/tracing/exporters/arize.md +4 -4
  331. package/.docs/reference/observability/tracing/exporters/braintrust.md +3 -3
  332. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +6 -6
  333. package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -4
  334. package/.docs/reference/observability/tracing/exporters/datadog.md +4 -4
  335. package/.docs/reference/observability/tracing/exporters/default-exporter.md +6 -6
  336. package/.docs/reference/observability/tracing/exporters/laminar.md +2 -2
  337. package/.docs/reference/observability/tracing/exporters/langfuse.md +4 -4
  338. package/.docs/reference/observability/tracing/exporters/langsmith.md +6 -6
  339. package/.docs/reference/observability/tracing/exporters/otel.md +12 -12
  340. package/.docs/reference/observability/tracing/exporters/posthog.md +3 -3
  341. package/.docs/reference/observability/tracing/exporters/sentry.md +5 -5
  342. package/.docs/reference/observability/tracing/instances.md +9 -9
  343. package/.docs/reference/observability/tracing/interfaces.md +39 -39
  344. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +6 -6
  345. package/.docs/reference/observability/tracing/spans.md +15 -13
  346. package/.docs/reference/processors/message-history-processor.md +1 -1
  347. package/.docs/reference/processors/processor-interface.md +21 -17
  348. package/.docs/reference/processors/token-limiter-processor.md +2 -2
  349. package/.docs/reference/rag/chunk.md +2 -2
  350. package/.docs/reference/rag/database-config.md +8 -8
  351. package/.docs/reference/rag/document.md +11 -11
  352. package/.docs/reference/rag/embeddings.md +5 -5
  353. package/.docs/reference/rag/extract-params.md +8 -8
  354. package/.docs/reference/rag/graph-rag.md +4 -4
  355. package/.docs/reference/rag/metadata-filters.md +15 -15
  356. package/.docs/reference/rag/rerank.md +2 -2
  357. package/.docs/reference/rag/rerankWithScorer.md +2 -2
  358. package/.docs/reference/server/create-route.md +2 -0
  359. package/.docs/reference/server/express-adapter.md +1 -1
  360. package/.docs/reference/server/fastify-adapter.md +1 -1
  361. package/.docs/reference/server/hono-adapter.md +1 -1
  362. package/.docs/reference/server/koa-adapter.md +2 -2
  363. package/.docs/reference/server/mastra-server.md +16 -16
  364. package/.docs/reference/server/register-api-route.md +7 -7
  365. package/.docs/reference/server/routes.md +1 -1
  366. package/.docs/reference/storage/cloudflare-d1.md +5 -5
  367. package/.docs/reference/storage/cloudflare.md +3 -3
  368. package/.docs/reference/storage/composite.md +1 -1
  369. package/.docs/reference/storage/convex.md +6 -6
  370. package/.docs/reference/storage/dynamodb.md +7 -7
  371. package/.docs/reference/storage/lance.md +5 -5
  372. package/.docs/reference/storage/libsql.md +1 -1
  373. package/.docs/reference/storage/mongodb.md +6 -6
  374. package/.docs/reference/storage/mssql.md +4 -4
  375. package/.docs/reference/storage/overview.md +2 -2
  376. package/.docs/reference/storage/postgresql.md +7 -7
  377. package/.docs/reference/storage/upstash.md +4 -4
  378. package/.docs/reference/streaming/ChunkType.md +13 -13
  379. package/.docs/reference/streaming/agents/MastraModelOutput.md +6 -6
  380. package/.docs/reference/streaming/agents/stream.md +2 -2
  381. package/.docs/reference/streaming/agents/streamLegacy.md +1 -1
  382. package/.docs/reference/streaming/workflows/observeStream.md +2 -2
  383. package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
  384. package/.docs/reference/streaming/workflows/stream.md +1 -1
  385. package/.docs/reference/templates/overview.md +4 -4
  386. package/.docs/reference/tools/create-tool.md +10 -10
  387. package/.docs/reference/tools/document-chunker-tool.md +4 -4
  388. package/.docs/reference/tools/graph-rag-tool.md +7 -7
  389. package/.docs/reference/tools/mcp-client.md +13 -13
  390. package/.docs/reference/tools/mcp-server.md +27 -27
  391. package/.docs/reference/tools/vector-query-tool.md +12 -12
  392. package/.docs/reference/vectors/astra.md +13 -13
  393. package/.docs/reference/vectors/chroma.md +18 -18
  394. package/.docs/reference/vectors/convex.md +15 -15
  395. package/.docs/reference/vectors/couchbase.md +21 -21
  396. package/.docs/reference/vectors/duckdb.md +17 -17
  397. package/.docs/reference/vectors/elasticsearch.md +14 -14
  398. package/.docs/reference/vectors/lance.md +22 -22
  399. package/.docs/reference/vectors/libsql.md +15 -15
  400. package/.docs/reference/vectors/mongodb.md +18 -18
  401. package/.docs/reference/vectors/opensearch.md +11 -11
  402. package/.docs/reference/vectors/pg.md +23 -21
  403. package/.docs/reference/vectors/pinecone.md +15 -15
  404. package/.docs/reference/vectors/qdrant.md +15 -15
  405. package/.docs/reference/vectors/s3vectors.md +22 -22
  406. package/.docs/reference/vectors/turbopuffer.md +14 -14
  407. package/.docs/reference/vectors/upstash.md +15 -15
  408. package/.docs/reference/vectors/vectorize.md +16 -16
  409. package/.docs/reference/voice/azure.md +12 -10
  410. package/.docs/reference/voice/cloudflare.md +9 -7
  411. package/.docs/reference/voice/composite-voice.md +5 -5
  412. package/.docs/reference/voice/deepgram.md +5 -5
  413. package/.docs/reference/voice/elevenlabs.md +7 -7
  414. package/.docs/reference/voice/google-gemini-live.md +22 -22
  415. package/.docs/reference/voice/google.md +12 -12
  416. package/.docs/reference/voice/mastra-voice.md +18 -18
  417. package/.docs/reference/voice/murf.md +8 -8
  418. package/.docs/reference/voice/openai-realtime.md +19 -17
  419. package/.docs/reference/voice/openai.md +12 -8
  420. package/.docs/reference/voice/playai.md +9 -7
  421. package/.docs/reference/voice/sarvam.md +8 -6
  422. package/.docs/reference/voice/speechify.md +11 -9
  423. package/.docs/reference/voice/voice.addInstructions.md +4 -4
  424. package/.docs/reference/voice/voice.addTools.md +3 -3
  425. package/.docs/reference/voice/voice.answer.md +2 -2
  426. package/.docs/reference/voice/voice.close.md +4 -4
  427. package/.docs/reference/voice/voice.connect.md +9 -7
  428. package/.docs/reference/voice/voice.events.md +4 -4
  429. package/.docs/reference/voice/voice.getSpeakers.md +4 -4
  430. package/.docs/reference/voice/voice.listen.md +17 -11
  431. package/.docs/reference/voice/voice.off.md +4 -4
  432. package/.docs/reference/voice/voice.on.md +5 -5
  433. package/.docs/reference/voice/voice.send.md +2 -2
  434. package/.docs/reference/voice/voice.speak.md +19 -9
  435. package/.docs/reference/voice/voice.updateConfig.md +4 -4
  436. package/.docs/reference/workflows/run-methods/startAsync.md +1 -1
  437. package/.docs/reference/workflows/run-methods/timeTravel.md +1 -1
  438. package/.docs/reference/workflows/run.md +3 -3
  439. package/.docs/reference/workflows/step.md +2 -2
  440. package/.docs/reference/workflows/workflow-methods/create-run.md +1 -1
  441. package/.docs/reference/workflows/workflow.md +1 -1
  442. package/.docs/reference/workspace/blaxel-sandbox.md +164 -0
  443. package/.docs/reference/workspace/daytona-sandbox.md +50 -141
  444. package/.docs/reference/workspace/e2b-sandbox.md +41 -77
  445. package/.docs/reference/workspace/filesystem.md +25 -11
  446. package/.docs/reference/workspace/gcs-filesystem.md +21 -1
  447. package/.docs/reference/workspace/local-filesystem.md +24 -10
  448. package/.docs/reference/workspace/local-sandbox.md +27 -102
  449. package/.docs/reference/workspace/process-manager.md +296 -0
  450. package/.docs/reference/workspace/s3-filesystem.md +21 -1
  451. package/.docs/reference/workspace/sandbox.md +9 -1
  452. package/.docs/reference/workspace/workspace-class.md +95 -27
  453. package/CHANGELOG.md +15 -0
  454. package/dist/tools/course.d.ts +7 -27
  455. package/dist/tools/course.d.ts.map +1 -1
  456. package/dist/tools/docs.d.ts +6 -18
  457. package/dist/tools/docs.d.ts.map +1 -1
  458. package/dist/tools/embedded-docs.d.ts +12 -112
  459. package/dist/tools/embedded-docs.d.ts.map +1 -1
  460. package/dist/tools/migration.d.ts +6 -26
  461. package/dist/tools/migration.d.ts.map +1 -1
  462. package/package.json +6 -6
@@ -1,4 +1,4 @@
1
- # Toxicity Scorer
1
+ # Toxicity scorer
2
2
 
3
3
  The `createToxicityScorer()` function evaluates whether an LLM's output contains racist, biased, or toxic elements. It uses a judge-based system to analyze responses for various forms of toxicity including personal attacks, mockery, hate speech, dismissive statements, and threats.
4
4
 
@@ -12,7 +12,7 @@ The `createToxicityScorer()` function accepts a single options object with the f
12
12
 
13
13
  This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
14
14
 
15
- ## .run() Returns
15
+ ## `.run()` returns
16
16
 
17
17
  **runId** (`string`): The id of the run (optional).
18
18
 
@@ -41,7 +41,7 @@ This function returns an instance of the MastraScorer class. The `.run()` method
41
41
  }
42
42
  ```
43
43
 
44
- ## Scoring Details
44
+ ## Scoring details
45
45
 
46
46
  The scorer evaluates toxicity through multiple aspects:
47
47
 
@@ -1,4 +1,4 @@
1
- # Harness Class
1
+ # Harness class
2
2
 
3
3
  **Added in:** `@mastra/core@1.5.0`
4
4
 
@@ -82,6 +82,8 @@ await harness.sendMessage({ content: 'Hello!' })
82
82
 
83
83
  **subagents.allowedHarnessTools** (`string[]`): Tool IDs from the harness's shared \`tools\` config. Merged with \`tools\` above to let subagents use a subset of harness tools.
84
84
 
85
+ **subagents.allowedWorkspaceTools** (`string[]`): Workspace tool names the subagent is allowed to use. Uses the exposed names (after any renames via workspace tool config). When set, workspace tools not in this list are hidden from the model. Non-workspace tools are never affected. When omitted, all workspace tools are visible.
86
+
85
87
  **subagents.defaultModelId** (`string`): Default model ID for this subagent type.
86
88
 
87
89
  **subagents.maxSteps** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to \`50\` when omitted.
@@ -94,7 +96,7 @@ await harness.sendMessage({ content: 'Hello!' })
94
96
 
95
97
  **heartbeatHandlers** (`HeartbeatHandler[]`): Periodic background tasks started during \`init()\`. Use for gateway sync, cache refresh, and similar tasks.
96
98
 
97
- **idGenerator** (`() => string`): Custom ID generator for threads, messages, and other entities. (Default: `timestamp + random string`)
99
+ **idGenerator** (`() => string`): Custom ID generator for Harness-managed IDs such as threads and mode-run identifiers. (Default: `timestamp + random string`)
98
100
 
99
101
  **modelAuthChecker** (`ModelAuthChecker`): Custom auth checker for model providers. Return \`true\`/\`false\` to override the default environment variable check, or \`undefined\` to fall back to defaults.
100
102
 
@@ -567,7 +569,7 @@ if (harness.isWorkspaceReady()) {
567
569
 
568
570
  #### `destroyWorkspace()`
569
571
 
570
- Destroy the workspace and release resources. Only applies to static workspaces — dynamic workspaces are not destroyed.
572
+ Destroy the workspace and release resources. Only applies to static workspaces — dynamic workspaces aren't destroyed.
571
573
 
572
574
  ```typescript
573
575
  await harness.destroyWorkspace()
@@ -266,12 +266,14 @@ The Reference section provides documentation of Mastra's API, including paramete
266
266
  - [.start()](https://mastra.ai/reference/workflows/run-methods/start)
267
267
  - [.startAsync()](https://mastra.ai/reference/workflows/run-methods/startAsync)
268
268
  - [.timeTravel()](https://mastra.ai/reference/workflows/run-methods/timeTravel)
269
+ - [BlaxelSandbox](https://mastra.ai/reference/workspace/blaxel-sandbox)
269
270
  - [DaytonaSandbox](https://mastra.ai/reference/workspace/daytona-sandbox)
270
271
  - [E2BSandbox](https://mastra.ai/reference/workspace/e2b-sandbox)
271
272
  - [GCSFilesystem](https://mastra.ai/reference/workspace/gcs-filesystem)
272
273
  - [LocalFilesystem](https://mastra.ai/reference/workspace/local-filesystem)
273
274
  - [LocalSandbox](https://mastra.ai/reference/workspace/local-sandbox)
274
275
  - [S3Filesystem](https://mastra.ai/reference/workspace/s3-filesystem)
276
+ - [SandboxProcessManager](https://mastra.ai/reference/workspace/process-manager)
275
277
  - [Workspace Class](https://mastra.ai/reference/workspace/workspace-class)
276
278
  - [WorkspaceFilesystem](https://mastra.ai/reference/workspace/filesystem)
277
279
  - [WorkspaceSandbox](https://mastra.ai/reference/workspace/sandbox)
@@ -1,8 +1,8 @@
1
- # Cloned Thread Utilities
1
+ # Cloned thread utilities
2
2
 
3
3
  The Memory class provides utility methods for working with cloned threads. These methods help you check clone status, retrieve clone metadata, navigate clone relationships, and track clone history.
4
4
 
5
- ## isClone()
5
+ ## `isClone()`
6
6
 
7
7
  Checks whether a thread is a clone of another thread.
8
8
 
@@ -28,7 +28,7 @@ if (memory.isClone(thread)) {
28
28
  }
29
29
  ```
30
30
 
31
- ## getCloneMetadata()
31
+ ## `getCloneMetadata()`
32
32
 
33
33
  Retrieves the clone metadata from a thread if it exists.
34
34
 
@@ -54,7 +54,7 @@ if (cloneInfo) {
54
54
  }
55
55
  ```
56
56
 
57
- ## getSourceThread()
57
+ ## `getSourceThread()`
58
58
 
59
59
  Retrieves the original source thread that a cloned thread was created from.
60
60
 
@@ -79,7 +79,7 @@ if (sourceThread) {
79
79
  }
80
80
  ```
81
81
 
82
- ## listClones()
82
+ ## `listClones()`
83
83
 
84
84
  Lists all threads that were cloned from a specific source thread.
85
85
 
@@ -104,7 +104,7 @@ for (const clone of clones) {
104
104
  }
105
105
  ```
106
106
 
107
- ## getCloneHistory()
107
+ ## `getCloneHistory()`
108
108
 
109
109
  Retrieves the full clone history chain for a thread, tracing back to the original.
110
110
 
@@ -136,7 +136,7 @@ for (let i = 0; i < history.length; i++) {
136
136
  }
137
137
  ```
138
138
 
139
- ## Complete Example
139
+ ## Complete example
140
140
 
141
141
  ```typescript
142
142
  import { mastra } from './mastra'
@@ -2,7 +2,7 @@
2
2
 
3
3
  The `.cloneThread()` method creates a copy of an existing conversation thread, including all its messages. This enables creating divergent conversation paths from a specific point in a conversation. When semantic recall is enabled, the method also creates vector embeddings for the cloned messages.
4
4
 
5
- ## Usage Example
5
+ ## Usage example
6
6
 
7
7
  ```typescript
8
8
  const { thread, clonedMessages } = await memory.cloneThread({
@@ -52,7 +52,7 @@ The cloned thread's metadata includes a `clone` property with:
52
52
 
53
53
  **lastMessageId** (`string`): The ID of the last message in the source thread at the time of cloning.
54
54
 
55
- ## Extended Usage Example
55
+ ## Extended usage example
56
56
 
57
57
  ```typescript
58
58
  import { mastra } from './mastra'
@@ -98,7 +98,7 @@ const response = await agent.generate("Let's try a different approach", {
98
98
  })
99
99
  ```
100
100
 
101
- ## Vector Embeddings
101
+ ## Vector embeddings
102
102
 
103
103
  When the Memory instance has semantic recall enabled (with a vector store and embedder configured), `cloneThread()` automatically creates vector embeddings for all cloned messages. This ensures that semantic search works correctly on the cloned thread.
104
104
 
@@ -127,7 +127,7 @@ const results = await memory.recall({
127
127
  })
128
128
  ```
129
129
 
130
- ## Observational Memory
130
+ ## Observational memory
131
131
 
132
132
  When [Observational Memory](https://mastra.ai/docs/memory/observational-memory) is enabled, `cloneThread()` automatically clones the OM records associated with the source thread. The behavior depends on the OM scope:
133
133
 
@@ -135,4 +135,4 @@ When [Observational Memory](https://mastra.ai/docs/memory/observational-memory)
135
135
  - **Resource-scoped OM (same `resourceId`)**: The OM record is shared between the source and cloned threads since they belong to the same resource. No duplication occurs.
136
136
  - **Resource-scoped OM (different `resourceId`)**: The OM record is cloned to the new resource. Message IDs are remapped and any thread-identifying tags within observations are updated to reference the cloned thread.
137
137
 
138
- Only the current (most recent) OM generation is cloned — older history generations are not copied. Transient processing state (observation/reflection in-progress flags) is reset on the cloned record.
138
+ Only the current (most recent) OM generation is cloned — older history generations aren't copied. Transient processing state (observation/reflection in-progress flags) is reset on the cloned record.
@@ -2,7 +2,7 @@
2
2
 
3
3
  The `.createThread()` method creates a new conversation thread in the memory system. Each thread represents a distinct conversation or context and can contain multiple messages.
4
4
 
5
- ## Usage Example
5
+ ## Usage example
6
6
 
7
7
  ```typescript
8
8
  await memory?.createThread({ resourceId: 'user-123' })
@@ -2,7 +2,7 @@
2
2
 
3
3
  The `.deleteMessages()` method deletes multiple messages by their IDs.
4
4
 
5
- ## Usage Example
5
+ ## Usage example
6
6
 
7
7
  ```typescript
8
8
  await memory?.deleteMessages(['671ae63f-3a91-4082-a907-fe7de78e10ec'])
@@ -2,7 +2,7 @@
2
2
 
3
3
  The `.getThreadById()` method retrieves a specific thread by its ID.
4
4
 
5
- ## Usage Example
5
+ ## Usage example
6
6
 
7
7
  ```typescript
8
8
  await memory?.getThreadById({ threadId: 'thread-123' })
@@ -2,7 +2,7 @@
2
2
 
3
3
  The `listThreads()` method retrieves threads with pagination support and optional filtering by `resourceId`, `metadata`, or both.
4
4
 
5
- ## Usage Examples
5
+ ## Usage examples
6
6
 
7
7
  ### List all threads with pagination
8
8
 
@@ -26,7 +26,7 @@ const result = await memory.listThreads({
26
26
  })
27
27
  ```
28
28
 
29
- ### Filter by resourceId
29
+ ### Filter by `resourceId`
30
30
 
31
31
  ```typescript
32
32
  const result = await memory.listThreads({
@@ -119,7 +119,7 @@ while (hasMorePages) {
119
119
  }
120
120
  ```
121
121
 
122
- ## Metadata Filtering
122
+ ## Metadata filtering
123
123
 
124
124
  The metadata filter uses AND logic - all specified key-value pairs must match for a thread to be included in the results:
125
125
 
@@ -1,4 +1,4 @@
1
- # Memory Class
1
+ # Memory class
2
2
 
3
3
  The `Memory` class provides a robust system for managing conversation history and thread-based message storage in Mastra. It enables persistent storage of conversations, semantic search capabilities, and efficient message retrieval. You must configure a storage provider for conversation history, and if you enable semantic recall you will also need to provide a vector store and embedder.
4
4
 
@@ -1,4 +1,4 @@
1
- # Observational Memory
1
+ # Observational memory
2
2
 
3
3
  **Added in:** `@mastra/memory@1.1.0`
4
4
 
@@ -26,6 +26,8 @@ export const agent = new Agent({
26
26
 
27
27
  The `observationalMemory` option accepts `true`, a configuration object, or `false`. Setting `true` enables OM with `google/gemini-2.5-flash` as the default model. When passing a config object, a `model` must be explicitly set — either at the top level, or on `observation.model` and/or `reflection.model`.
28
28
 
29
+ Observer input is multimodal-aware. OM keeps text placeholders like `[Image #1: screenshot.png]` in the transcript it builds for the Observer, and also sends the underlying image parts when possible. This applies to both single-thread observation and batched multi-thread observation. Non-image files appear as placeholders only.
30
+
29
31
  **enabled** (`boolean`): Enable or disable Observational Memory. When omitted from a config object, defaults to \`true\`. Only \`enabled: false\` explicitly disables it. (Default: `true`)
30
32
 
31
33
  **model** (`string | LanguageModel | DynamicModel | ModelWithRetries[]`): Model for both the Observer and Reflector agents. Sets the model for both at once. Cannot be used together with \`observation.model\` or \`reflection.model\` — an error will be thrown if both are set. When using \`observationalMemory: true\`, defaults to \`google/gemini-2.5-flash\`. When passing a config object, this or \`observation.model\`/\`reflection.model\` must be set. Use \`"default"\` to explicitly use the default model (\`google/gemini-2.5-flash\`). (Default: `'google/gemini-2.5-flash' (when using observationalMemory: true)`)
@@ -40,7 +42,7 @@ The `observationalMemory` option accepts `true`, a configuration object, or `fal
40
42
 
41
43
  **observation.instruction** (`string`): Custom instruction appended to the Observer's system prompt. Use this to customize what the Observer focuses on, such as domain-specific preferences or priorities.
42
44
 
43
- **observation.messageTokens** (`number`): Token count of unobserved messages that triggers observation. When unobserved message tokens exceed this threshold, the Observer agent is called.
45
+ **observation.messageTokens** (`number`): Token count of unobserved messages that triggers observation. When unobserved message tokens exceed this threshold, the Observer agent is called. Image parts are included with model-aware estimates when possible, with deterministic fallbacks when image metadata is incomplete. Image-like \`file\` parts are counted the same way when uploads are normalized as files.
44
46
 
45
47
  **observation.maxTokensPerBatch** (`number`): Maximum tokens per batch when observing multiple threads in resource scope. Threads are chunked into batches of this size and processed in parallel. Lower values mean more parallelism but more API calls.
46
48
 
@@ -80,9 +82,9 @@ OM persists token payload estimates so repeated counting can reuse prior tiktoke
80
82
 
81
83
  - Part-level cache: `part.providerMetadata.mastra`.
82
84
  - String-content fallback cache: message-level metadata when no parts exist.
83
- - Cache entries are ignored and recomputed if cache version/tokenizer source does not match.
84
- - Per-message and per-conversation overhead are always recomputed at runtime and are not cached.
85
- - `data-*` and `reasoning` parts are skipped and do not receive cache entries.
85
+ - Cache entries are ignored and recomputed if cache version/tokenizer source doesn't match.
86
+ - Per-message and per-conversation overhead are always recomputed at runtime and aren't cached.
87
+ - `data-*` and `reasoning` parts are skipped and don't receive cache entries.
86
88
 
87
89
  ## Examples
88
90
 
@@ -283,7 +285,7 @@ observationalMemory: {
283
285
 
284
286
  Setting `bufferTokens: false` disables both observation and reflection async buffering. Observations and reflections will run synchronously when their thresholds are reached.
285
287
 
286
- > **Note:** Async buffering is not supported with `scope: 'resource'` and is automatically disabled in resource scope.
288
+ > **Note:** Async buffering isn't supported with `scope: 'resource'` and is automatically disabled in resource scope.
287
289
 
288
290
  ## Streaming data parts
289
291
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  the `.recall()` method retrieves messages from a specific thread, with support for pagination, filtering options, and semantic search.
4
4
 
5
- ## Usage Example
5
+ ## Usage example
6
6
 
7
7
  ```typescript
8
8
  await memory?.recall({ threadId: 'user-123' })
@@ -12,7 +12,7 @@ new OtelBridge()
12
12
 
13
13
  ## Methods
14
14
 
15
- ### executeInContext
15
+ ### `executeInContext`
16
16
 
17
17
  ```typescript
18
18
  executeInContext<T>(spanId: string, fn: () => Promise<T>): Promise<T>
@@ -22,7 +22,7 @@ Executes an async function within the OTEL context of a Mastra span. OTEL-instru
22
22
 
23
23
  **Returns:** `Promise<T>` - The result of the function execution.
24
24
 
25
- ### executeInContextSync
25
+ ### `executeInContextSync`
26
26
 
27
27
  ```typescript
28
28
  executeInContextSync<T>(spanId: string, fn: () => T): T
@@ -38,9 +38,9 @@ Executes a synchronous function within the OTEL context of a Mastra span.
38
38
  async shutdown(): Promise<void>
39
39
  ```
40
40
 
41
- Shuts down the bridge and cleans up resources. Ends any spans that were not properly closed.
41
+ Shuts down the bridge and cleans up resources. Ends any spans that weren't properly closed.
42
42
 
43
- ## Usage Examples
43
+ ## Usage examples
44
44
 
45
45
  ### Basic Usage
46
46
 
@@ -92,13 +92,13 @@ const mastra = new Mastra({
92
92
  })
93
93
  ```
94
94
 
95
- ## OpenTelemetry Setup Requirements
95
+ ## `OpenTelemetry` setup requirements
96
96
 
97
97
  The OtelBridge requires an active OpenTelemetry SDK to function. The bridge reads from OTEL's ambient context.
98
98
 
99
99
  See the [OtelBridge Guide](https://mastra.ai/docs/observability/tracing/bridges/otel) for complete setup instructions, including how to configure OTEL instrumentation and run your application.
100
100
 
101
- ## Tags Support
101
+ ## Tags support
102
102
 
103
103
  The OtelBridge supports trace tagging for categorization and filtering. Tags are only applied to root spans and are included as the `mastra.tags` attribute on native OTEL spans.
104
104
 
@@ -1,6 +1,6 @@
1
1
  # Configuration
2
2
 
3
- ## ObservabilityRegistryConfig
3
+ ## `ObservabilityRegistryConfig`
4
4
 
5
5
  ```typescript
6
6
  interface ObservabilityRegistryConfig {
@@ -16,7 +16,7 @@ interface ObservabilityRegistryConfig {
16
16
 
17
17
  **configSelector** (`ConfigSelector`): Runtime configuration selector function
18
18
 
19
- ## ObservabilityInstanceConfig
19
+ ## `ObservabilityInstanceConfig`
20
20
 
21
21
  ```typescript
22
22
  interface ObservabilityInstanceConfig {
@@ -55,7 +55,7 @@ interface ObservabilityInstanceConfig {
55
55
 
56
56
  **serializationOptions.maxObjectKeys** (`number`): Maximum number of keys in objects (default: 50)
57
57
 
58
- ## SamplingStrategy
58
+ ## `SamplingStrategy`
59
59
 
60
60
  ```typescript
61
61
  type SamplingStrategy =
@@ -65,7 +65,7 @@ type SamplingStrategy =
65
65
  | { type: 'custom'; sampler: (options?: TracingOptions) => boolean }
66
66
  ```
67
67
 
68
- ## ConfigSelector
68
+ ## `ConfigSelector`
69
69
 
70
70
  ```typescript
71
71
  type ConfigSelector = (
@@ -74,7 +74,7 @@ type ConfigSelector = (
74
74
  ) => string | undefined
75
75
  ```
76
76
 
77
- ## ConfigSelectorOptions
77
+ ## `ConfigSelectorOptions`
78
78
 
79
79
  ```typescript
80
80
  interface ConfigSelectorOptions {
@@ -82,11 +82,11 @@ interface ConfigSelectorOptions {
82
82
  }
83
83
  ```
84
84
 
85
- # Registry Methods
85
+ ## Registry methods
86
86
 
87
87
  The Observability class provides methods for managing observability instances:
88
88
 
89
- ## registerInstance
89
+ ### `registerInstance`
90
90
 
91
91
  ```typescript
92
92
  registerInstance(
@@ -98,7 +98,7 @@ registerInstance(
98
98
 
99
99
  Registers an observability instance in the registry.
100
100
 
101
- ## getInstance
101
+ ### `getInstance`
102
102
 
103
103
  ```typescript
104
104
  getInstance(name: string): ObservabilityInstance | undefined;
@@ -106,7 +106,7 @@ getInstance(name: string): ObservabilityInstance | undefined;
106
106
 
107
107
  Retrieves an observability instance by name.
108
108
 
109
- ## getDefaultInstance
109
+ ### `getDefaultInstance`
110
110
 
111
111
  ```typescript
112
112
  getDefaultInstance(): ObservabilityInstance | undefined;
@@ -114,7 +114,7 @@ getDefaultInstance(): ObservabilityInstance | undefined;
114
114
 
115
115
  Returns the default observability instance.
116
116
 
117
- ## getSelectedInstance
117
+ ### `getSelectedInstance`
118
118
 
119
119
  ```typescript
120
120
  getSelectedInstance(
@@ -124,7 +124,7 @@ getSelectedInstance(
124
124
 
125
125
  Returns the observability instance selected by the config selector or default.
126
126
 
127
- ## listInstances
127
+ ### `listInstances`
128
128
 
129
129
  ```typescript
130
130
  listInstances(): ReadonlyMap<string, ObservabilityInstance>;
@@ -132,7 +132,7 @@ listInstances(): ReadonlyMap<string, ObservabilityInstance>;
132
132
 
133
133
  Returns all registered observability instances.
134
134
 
135
- ## hasInstance
135
+ ### `hasInstance`
136
136
 
137
137
  ```typescript
138
138
  hasInstance(name: string): boolean;
@@ -140,7 +140,7 @@ hasInstance(name: string): boolean;
140
140
 
141
141
  Checks if an observability instance exists.
142
142
 
143
- ## setConfigSelector
143
+ ### `setConfigSelector`
144
144
 
145
145
  ```typescript
146
146
  setConfigSelector(selector: ConfigSelector): void;
@@ -148,7 +148,7 @@ setConfigSelector(selector: ConfigSelector): void;
148
148
 
149
149
  Sets the config selector function.
150
150
 
151
- ## unregisterInstance
151
+ ### `unregisterInstance`
152
152
 
153
153
  ```typescript
154
154
  unregisterInstance(name: string): boolean;
@@ -156,7 +156,7 @@ unregisterInstance(name: string): boolean;
156
156
 
157
157
  Removes an observability instance from the registry.
158
158
 
159
- ## clear
159
+ ### clear
160
160
 
161
161
  ```typescript
162
162
  clear(): void;
@@ -164,7 +164,7 @@ clear(): void;
164
164
 
165
165
  Clears all instances without shutdown.
166
166
 
167
- ## shutdown
167
+ ### shutdown
168
168
 
169
169
  ```typescript
170
170
  async shutdown(): Promise<void>;
@@ -172,7 +172,7 @@ async shutdown(): Promise<void>;
172
172
 
173
173
  Shuts down all observability instances and clears the registry.
174
174
 
175
- ## See Also
175
+ ## See also
176
176
 
177
177
  ### Documentation
178
178
 
@@ -8,7 +8,7 @@ Sends Tracing data to Arize Phoenix, Arize AX, or any OpenTelemetry-compatible o
8
8
  new ArizeExporter(config: ArizeExporterConfig)
9
9
  ```
10
10
 
11
- ## ArizeExporterConfig
11
+ ## `ArizeExporterConfig`
12
12
 
13
13
  ```typescript
14
14
  type ArizeExporterConfig = Omit<OtelExporterConfig, 'provider'> & {
@@ -38,7 +38,7 @@ Non-reserved span attributes are serialized into the OpenInference `metadata` pa
38
38
 
39
39
  ## Methods
40
40
 
41
- ### exportTracingEvent
41
+ ### `exportTracingEvent`
42
42
 
43
43
  ```typescript
44
44
  async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -106,11 +106,11 @@ const exporter = new ArizeExporter({
106
106
  })
107
107
  ```
108
108
 
109
- ## OpenInference Semantic Conventions
109
+ ## `OpenInference` semantic conventions
110
110
 
111
111
  The ArizeExporter implements [OpenInference Semantic Conventions](https://github.com/Arize-ai/openinference/tree/main/spec) for generative AI applications, providing standardized trace structure across different observability platforms.
112
112
 
113
- ## Tags Support
113
+ ## Tags support
114
114
 
115
115
  The ArizeExporter supports trace tagging for categorization and filtering. Tags are only applied to root spans and are mapped to the native OpenInference `tag.tags` semantic convention.
116
116
 
@@ -8,7 +8,7 @@ Sends Tracing data to Braintrust for eval and observability.
8
8
  new BraintrustExporter(config: BraintrustExporterConfig)
9
9
  ```
10
10
 
11
- ## BraintrustExporterConfig
11
+ ## `BraintrustExporterConfig`
12
12
 
13
13
  ```typescript
14
14
  interface BraintrustExporterConfig extends BaseExporterConfig {
@@ -26,7 +26,7 @@ Extends `BaseExporterConfig`, which includes:
26
26
 
27
27
  ## Methods
28
28
 
29
- ### exportTracingEvent
29
+ ### `exportTracingEvent`
30
30
 
31
31
  ```typescript
32
32
  async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -80,7 +80,7 @@ const exporter = new BraintrustExporter({
80
80
  })
81
81
  ```
82
82
 
83
- ## Span Type Mapping
83
+ ## Span type mapping
84
84
 
85
85
  | Span Type | Braintrust Type |
86
86
  | --------------------------- | --------------- |
@@ -8,7 +8,7 @@ Sends traces to Mastra Cloud for online visualization and monitoring.
8
8
  new CloudExporter(config?: CloudExporterConfig)
9
9
  ```
10
10
 
11
- ## CloudExporterConfig
11
+ ## `CloudExporterConfig`
12
12
 
13
13
  ```typescript
14
14
  interface CloudExporterConfig extends BaseExporterConfig {
@@ -34,7 +34,7 @@ Extends `BaseExporterConfig`, which includes:
34
34
  - `logger?: IMastraLogger` - Logger instance
35
35
  - `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: INFO)
36
36
 
37
- ## Environment Variables
37
+ ## Environment variables
38
38
 
39
39
  The exporter reads these environment variables if not provided in config:
40
40
 
@@ -49,7 +49,7 @@ readonly name = 'mastra-cloud-observability-exporter';
49
49
 
50
50
  ## Methods
51
51
 
52
- ### exportTracingEvent
52
+ ### `exportTracingEvent`
53
53
 
54
54
  ```typescript
55
55
  async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -90,7 +90,7 @@ The exporter batches spans for efficient network usage:
90
90
  - Flushes when `maxBatchWaitMs` elapsed since first span in batch
91
91
  - Flushes on `shutdown()`
92
92
 
93
- ### Error Handling
93
+ ### Error handling
94
94
 
95
95
  - Uses exponential backoff retry with `maxRetries` attempts
96
96
  - Drops batches after all retries fail
@@ -102,7 +102,7 @@ The exporter batches spans for efficient network usage:
102
102
  - Ignores `SPAN_STARTED` and `SPAN_UPDATED` events
103
103
  - Formats spans to MastraCloudSpanRecord format
104
104
 
105
- ## MastraCloudSpanRecord
105
+ ## `MastraCloudSpanRecord`
106
106
 
107
107
  Internal format for cloud spans:
108
108
 
@@ -143,7 +143,7 @@ const customExporter = new CloudExporter({
143
143
  })
144
144
  ```
145
145
 
146
- ## See Also
146
+ ## See also
147
147
 
148
148
  ### Documentation
149
149
 
@@ -22,7 +22,7 @@ readonly name = 'tracing-console-exporter';
22
22
 
23
23
  ## Methods
24
24
 
25
- ### exportTracingEvent
25
+ ### `exportTracingEvent`
26
26
 
27
27
  ```typescript
28
28
  async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -38,7 +38,7 @@ async shutdown(): Promise<void>
38
38
 
39
39
  Logs shutdown message.
40
40
 
41
- ## Output Format
41
+ ## Output format
42
42
 
43
43
  The exporter outputs different formats based on event type:
44
44
 
@@ -107,7 +107,7 @@ const exporterWithLogger = new ConsoleExporter({
107
107
  })
108
108
  ```
109
109
 
110
- ## Implementation Details
110
+ ## Implementation details
111
111
 
112
112
  - Formats attributes as JSON with 2-space indentation
113
113
  - Calculates and displays span duration in milliseconds
@@ -115,7 +115,7 @@ const exporterWithLogger = new ConsoleExporter({
115
115
  - Logs unimplemented event types as warnings
116
116
  - Uses 80-character separator lines between events
117
117
 
118
- ## See Also
118
+ ## See also
119
119
 
120
120
  ### Documentation
121
121
 
@@ -8,7 +8,7 @@ Sends Tracing data to Datadog's LLM Observability product for monitoring and ana
8
8
  new DatadogExporter(config: DatadogExporterConfig)
9
9
  ```
10
10
 
11
- ## DatadogExporterConfig
11
+ ## `DatadogExporterConfig`
12
12
 
13
13
  ```typescript
14
14
  interface DatadogExporterConfig extends BaseExporterConfig {
@@ -29,7 +29,7 @@ Extends `BaseExporterConfig`, which includes:
29
29
 
30
30
  ## Methods
31
31
 
32
- ### exportTracingEvent
32
+ ### `exportTracingEvent`
33
33
 
34
34
  ```typescript
35
35
  async exportTracingEvent(event: TracingEvent): Promise<void>
@@ -87,7 +87,7 @@ const exporter = new DatadogExporter({
87
87
  })
88
88
  ```
89
89
 
90
- ## Span Mapping
90
+ ## Span mapping
91
91
 
92
92
  Mastra span types are mapped to Datadog LLMObs span kinds:
93
93
 
@@ -103,7 +103,7 @@ Mastra span types are mapped to Datadog LLMObs span kinds:
103
103
 
104
104
  All unmapped span types (including `MODEL_CHUNK`, `WORKFLOW_STEP`, `GENERIC`, and future span types) automatically default to `task`.
105
105
 
106
- ## Environment Variables
106
+ ## Environment variables
107
107
 
108
108
  The exporter reads configuration from these environment variables:
109
109