@mastra/core 1.6.0 → 1.7.0

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 (453) hide show
  1. package/CHANGELOG.md +236 -0
  2. package/dist/agent/agent.d.ts +6 -0
  3. package/dist/agent/agent.d.ts.map +1 -1
  4. package/dist/agent/index.cjs +8 -8
  5. package/dist/agent/index.js +1 -1
  6. package/dist/{chunk-VJWRJWSC.cjs → chunk-2X66GWF5.cjs} +94 -16
  7. package/dist/chunk-2X66GWF5.cjs.map +1 -0
  8. package/dist/{chunk-YM6245EM.js → chunk-6OXW5E2O.js} +3 -3
  9. package/dist/{chunk-YM6245EM.js.map → chunk-6OXW5E2O.js.map} +1 -1
  10. package/dist/{chunk-XWZAKKFT.cjs → chunk-6QBN6MZY.cjs} +14 -14
  11. package/dist/{chunk-XWZAKKFT.cjs.map → chunk-6QBN6MZY.cjs.map} +1 -1
  12. package/dist/{chunk-AYHSPIT6.cjs → chunk-7UAJ6LMR.cjs} +820 -259
  13. package/dist/chunk-7UAJ6LMR.cjs.map +1 -0
  14. package/dist/{chunk-RZNHRIM7.cjs → chunk-A72NTLFT.cjs} +5 -5
  15. package/dist/{chunk-RZNHRIM7.cjs.map → chunk-A72NTLFT.cjs.map} +1 -1
  16. package/dist/{chunk-EEU5NHHU.js → chunk-DFCRXDVK.js} +3 -3
  17. package/dist/{chunk-EEU5NHHU.js.map → chunk-DFCRXDVK.js.map} +1 -1
  18. package/dist/{chunk-5K45E5VE.js → chunk-GPJGPARM.js} +3 -2
  19. package/dist/chunk-GPJGPARM.js.map +1 -0
  20. package/dist/{chunk-LNKS4TJ6.cjs → chunk-HB6T4554.cjs} +8 -7
  21. package/dist/chunk-HB6T4554.cjs.map +1 -0
  22. package/dist/{chunk-DGS2KGDI.js → chunk-KUXNBWN7.js} +6 -5
  23. package/dist/chunk-KUXNBWN7.js.map +1 -0
  24. package/dist/{chunk-IHDE4CJV.js → chunk-QSHV7GPT.js} +89 -12
  25. package/dist/chunk-QSHV7GPT.js.map +1 -0
  26. package/dist/{chunk-3U3XFMGJ.cjs → chunk-QTAS3HND.cjs} +13 -8
  27. package/dist/chunk-QTAS3HND.cjs.map +1 -0
  28. package/dist/{chunk-RHKNKJNM.js → chunk-QWTB53GS.js} +4 -4
  29. package/dist/{chunk-RHKNKJNM.js.map → chunk-QWTB53GS.js.map} +1 -1
  30. package/dist/{chunk-4WG5K4CK.js → chunk-R4N65TLG.js} +7 -7
  31. package/dist/{chunk-4WG5K4CK.js.map → chunk-R4N65TLG.js.map} +1 -1
  32. package/dist/{chunk-5VQPSWPG.cjs → chunk-RABITNTG.cjs} +48 -48
  33. package/dist/{chunk-5VQPSWPG.cjs.map → chunk-RABITNTG.cjs.map} +1 -1
  34. package/dist/{chunk-TVPANHLE.cjs → chunk-SBOHDNIZ.cjs} +3 -2
  35. package/dist/chunk-SBOHDNIZ.cjs.map +1 -0
  36. package/dist/{chunk-MWGGSA5Q.js → chunk-T6GAM3SQ.js} +10 -5
  37. package/dist/chunk-T6GAM3SQ.js.map +1 -0
  38. package/dist/{chunk-TL2TTA4X.cjs → chunk-YQG7NBPR.cjs} +9 -9
  39. package/dist/{chunk-TL2TTA4X.cjs.map → chunk-YQG7NBPR.cjs.map} +1 -1
  40. package/dist/{chunk-XB3DA67Q.js → chunk-ZSBM2SVU.js} +818 -259
  41. package/dist/chunk-ZSBM2SVU.js.map +1 -0
  42. package/dist/datasets/experiment/scorer.d.ts.map +1 -1
  43. package/dist/datasets/index.cjs +17 -17
  44. package/dist/datasets/index.js +2 -2
  45. package/dist/evals/index.cjs +20 -20
  46. package/dist/evals/index.js +3 -3
  47. package/dist/evals/scoreTraces/index.cjs +7 -6
  48. package/dist/evals/scoreTraces/index.cjs.map +1 -1
  49. package/dist/evals/scoreTraces/index.js +4 -3
  50. package/dist/evals/scoreTraces/index.js.map +1 -1
  51. package/dist/evals/scoreTraces/scoreTracesWorkflow.d.ts.map +1 -1
  52. package/dist/harness/harness.d.ts +21 -1
  53. package/dist/harness/harness.d.ts.map +1 -1
  54. package/dist/harness/index.cjs +422 -5
  55. package/dist/harness/index.cjs.map +1 -1
  56. package/dist/harness/index.d.ts +2 -1
  57. package/dist/harness/index.d.ts.map +1 -1
  58. package/dist/harness/index.js +418 -3
  59. package/dist/harness/index.js.map +1 -1
  60. package/dist/harness/types.d.ts +151 -0
  61. package/dist/harness/types.d.ts.map +1 -1
  62. package/dist/index.cjs +2 -2
  63. package/dist/index.js +1 -1
  64. package/dist/loop/index.cjs +12 -12
  65. package/dist/loop/index.js +1 -1
  66. package/dist/loop/test-utils/tools.d.ts.map +1 -1
  67. package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
  68. package/dist/mastra/hooks.d.ts.map +1 -1
  69. package/dist/mastra/index.cjs +2 -2
  70. package/dist/mastra/index.js +1 -1
  71. package/dist/memory/index.cjs +14 -14
  72. package/dist/memory/index.js +1 -1
  73. package/dist/processor-provider/index.cjs +10 -10
  74. package/dist/processor-provider/index.js +1 -1
  75. package/dist/processors/index.cjs +45 -41
  76. package/dist/processors/index.js +1 -1
  77. package/dist/processors/processors/index.d.ts +1 -0
  78. package/dist/processors/processors/index.d.ts.map +1 -1
  79. package/dist/processors/processors/workspace-instructions.d.ts +50 -0
  80. package/dist/processors/processors/workspace-instructions.d.ts.map +1 -0
  81. package/dist/relevance/index.cjs +3 -3
  82. package/dist/relevance/index.js +1 -1
  83. package/dist/storage/constants.cjs +56 -56
  84. package/dist/storage/constants.d.ts.map +1 -1
  85. package/dist/storage/constants.js +1 -1
  86. package/dist/storage/index.cjs +160 -160
  87. package/dist/storage/index.js +2 -2
  88. package/dist/storage/types.d.ts +2 -0
  89. package/dist/storage/types.d.ts.map +1 -1
  90. package/dist/stream/aisdk/v5/compat/prepare-tools.d.ts.map +1 -1
  91. package/dist/stream/base/output.d.ts.map +1 -1
  92. package/dist/stream/index.cjs +8 -8
  93. package/dist/stream/index.js +1 -1
  94. package/dist/tool-loop-agent/index.cjs +4 -4
  95. package/dist/tool-loop-agent/index.js +1 -1
  96. package/dist/vector/index.cjs +7 -7
  97. package/dist/vector/index.js +1 -1
  98. package/dist/workflows/evented/index.cjs +10 -10
  99. package/dist/workflows/evented/index.js +1 -1
  100. package/dist/workflows/index.cjs +25 -25
  101. package/dist/workflows/index.js +1 -1
  102. package/dist/workspace/constants/index.d.ts +2 -0
  103. package/dist/workspace/constants/index.d.ts.map +1 -1
  104. package/dist/workspace/errors.d.ts +1 -1
  105. package/dist/workspace/errors.d.ts.map +1 -1
  106. package/dist/workspace/filesystem/composite-filesystem.d.ts +4 -1
  107. package/dist/workspace/filesystem/composite-filesystem.d.ts.map +1 -1
  108. package/dist/workspace/filesystem/file-write-lock.d.ts +35 -0
  109. package/dist/workspace/filesystem/file-write-lock.d.ts.map +1 -0
  110. package/dist/workspace/filesystem/filesystem.d.ts +5 -1
  111. package/dist/workspace/filesystem/filesystem.d.ts.map +1 -1
  112. package/dist/workspace/filesystem/index.d.ts +1 -0
  113. package/dist/workspace/filesystem/index.d.ts.map +1 -1
  114. package/dist/workspace/filesystem/local-filesystem.d.ts +17 -1
  115. package/dist/workspace/filesystem/local-filesystem.d.ts.map +1 -1
  116. package/dist/workspace/index.cjs +72 -64
  117. package/dist/workspace/index.d.ts +3 -2
  118. package/dist/workspace/index.d.ts.map +1 -1
  119. package/dist/workspace/index.js +1 -1
  120. package/dist/workspace/lifecycle.d.ts +1 -9
  121. package/dist/workspace/lifecycle.d.ts.map +1 -1
  122. package/dist/workspace/sandbox/index.d.ts +2 -0
  123. package/dist/workspace/sandbox/index.d.ts.map +1 -1
  124. package/dist/workspace/sandbox/local-process-manager.d.ts +18 -0
  125. package/dist/workspace/sandbox/local-process-manager.d.ts.map +1 -0
  126. package/dist/workspace/sandbox/local-sandbox.d.ts +49 -35
  127. package/dist/workspace/sandbox/local-sandbox.d.ts.map +1 -1
  128. package/dist/workspace/sandbox/mastra-sandbox.d.ts +45 -11
  129. package/dist/workspace/sandbox/mastra-sandbox.d.ts.map +1 -1
  130. package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts +2 -3
  131. package/dist/workspace/sandbox/native-sandbox/bubblewrap.d.ts.map +1 -1
  132. package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts +2 -3
  133. package/dist/workspace/sandbox/native-sandbox/seatbelt.d.ts.map +1 -1
  134. package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts +4 -5
  135. package/dist/workspace/sandbox/native-sandbox/wrapper.d.ts.map +1 -1
  136. package/dist/workspace/sandbox/process-manager/index.d.ts +4 -0
  137. package/dist/workspace/sandbox/process-manager/index.d.ts.map +1 -0
  138. package/dist/workspace/sandbox/process-manager/process-handle.d.ts +107 -0
  139. package/dist/workspace/sandbox/process-manager/process-handle.d.ts.map +1 -0
  140. package/dist/workspace/sandbox/process-manager/process-manager.d.ts +59 -0
  141. package/dist/workspace/sandbox/process-manager/process-manager.d.ts.map +1 -0
  142. package/dist/workspace/sandbox/process-manager/types.d.ts +24 -0
  143. package/dist/workspace/sandbox/process-manager/types.d.ts.map +1 -0
  144. package/dist/workspace/sandbox/sandbox.d.ts +38 -2
  145. package/dist/workspace/sandbox/sandbox.d.ts.map +1 -1
  146. package/dist/workspace/sandbox/types.d.ts +9 -2
  147. package/dist/workspace/sandbox/types.d.ts.map +1 -1
  148. package/dist/workspace/sandbox/utils.d.ts +7 -0
  149. package/dist/workspace/sandbox/utils.d.ts.map +1 -0
  150. package/dist/workspace/tools/execute-command.d.ts +53 -2
  151. package/dist/workspace/tools/execute-command.d.ts.map +1 -1
  152. package/dist/workspace/tools/get-process-output.d.ts +6 -0
  153. package/dist/workspace/tools/get-process-output.d.ts.map +1 -0
  154. package/dist/workspace/tools/index.d.ts +4 -1
  155. package/dist/workspace/tools/index.d.ts.map +1 -1
  156. package/dist/workspace/tools/kill-process.d.ts +4 -0
  157. package/dist/workspace/tools/kill-process.d.ts.map +1 -0
  158. package/dist/workspace/tools/output-helpers.d.ts +21 -0
  159. package/dist/workspace/tools/output-helpers.d.ts.map +1 -0
  160. package/dist/workspace/tools/tools.d.ts.map +1 -1
  161. package/dist/workspace/types.d.ts +31 -0
  162. package/dist/workspace/types.d.ts.map +1 -1
  163. package/dist/workspace/utils.d.ts +11 -0
  164. package/dist/workspace/utils.d.ts.map +1 -0
  165. package/dist/workspace/workspace.d.ts +36 -0
  166. package/dist/workspace/workspace.d.ts.map +1 -1
  167. package/package.json +7 -7
  168. package/dist/chunk-3U3XFMGJ.cjs.map +0 -1
  169. package/dist/chunk-5K45E5VE.js.map +0 -1
  170. package/dist/chunk-AYHSPIT6.cjs.map +0 -1
  171. package/dist/chunk-DGS2KGDI.js.map +0 -1
  172. package/dist/chunk-IHDE4CJV.js.map +0 -1
  173. package/dist/chunk-LNKS4TJ6.cjs.map +0 -1
  174. package/dist/chunk-MWGGSA5Q.js.map +0 -1
  175. package/dist/chunk-TVPANHLE.cjs.map +0 -1
  176. package/dist/chunk-VJWRJWSC.cjs.map +0 -1
  177. package/dist/chunk-XB3DA67Q.js.map +0 -1
  178. package/dist/docs/SKILL.md +0 -301
  179. package/dist/docs/assets/SOURCE_MAP.json +0 -1413
  180. package/dist/docs/references/docs-agents-adding-voice.md +0 -353
  181. package/dist/docs/references/docs-agents-agent-approval.md +0 -377
  182. package/dist/docs/references/docs-agents-agent-memory.md +0 -212
  183. package/dist/docs/references/docs-agents-guardrails.md +0 -382
  184. package/dist/docs/references/docs-agents-network-approval.md +0 -275
  185. package/dist/docs/references/docs-agents-networks.md +0 -290
  186. package/dist/docs/references/docs-agents-overview.md +0 -309
  187. package/dist/docs/references/docs-agents-processors.md +0 -632
  188. package/dist/docs/references/docs-agents-structured-output.md +0 -271
  189. package/dist/docs/references/docs-agents-using-tools.md +0 -214
  190. package/dist/docs/references/docs-evals-custom-scorers.md +0 -519
  191. package/dist/docs/references/docs-evals-overview.md +0 -146
  192. package/dist/docs/references/docs-evals-running-in-ci.md +0 -106
  193. package/dist/docs/references/docs-mcp-overview.md +0 -370
  194. package/dist/docs/references/docs-mcp-publishing-mcp-server.md +0 -95
  195. package/dist/docs/references/docs-memory-memory-processors.md +0 -316
  196. package/dist/docs/references/docs-memory-observational-memory.md +0 -246
  197. package/dist/docs/references/docs-memory-overview.md +0 -45
  198. package/dist/docs/references/docs-memory-semantic-recall.md +0 -272
  199. package/dist/docs/references/docs-memory-storage.md +0 -261
  200. package/dist/docs/references/docs-memory-working-memory.md +0 -400
  201. package/dist/docs/references/docs-observability-datasets-overview.md +0 -188
  202. package/dist/docs/references/docs-observability-datasets-running-experiments.md +0 -266
  203. package/dist/docs/references/docs-observability-logging.md +0 -99
  204. package/dist/docs/references/docs-observability-overview.md +0 -70
  205. package/dist/docs/references/docs-observability-tracing-bridges-otel.md +0 -209
  206. package/dist/docs/references/docs-observability-tracing-exporters-arize.md +0 -274
  207. package/dist/docs/references/docs-observability-tracing-exporters-braintrust.md +0 -111
  208. package/dist/docs/references/docs-observability-tracing-exporters-cloud.md +0 -129
  209. package/dist/docs/references/docs-observability-tracing-exporters-datadog.md +0 -187
  210. package/dist/docs/references/docs-observability-tracing-exporters-default.md +0 -211
  211. package/dist/docs/references/docs-observability-tracing-exporters-laminar.md +0 -100
  212. package/dist/docs/references/docs-observability-tracing-exporters-langfuse.md +0 -217
  213. package/dist/docs/references/docs-observability-tracing-exporters-langsmith.md +0 -202
  214. package/dist/docs/references/docs-observability-tracing-exporters-otel.md +0 -479
  215. package/dist/docs/references/docs-observability-tracing-exporters-posthog.md +0 -148
  216. package/dist/docs/references/docs-observability-tracing-overview.md +0 -1114
  217. package/dist/docs/references/docs-rag-chunking-and-embedding.md +0 -183
  218. package/dist/docs/references/docs-rag-graph-rag.md +0 -215
  219. package/dist/docs/references/docs-rag-overview.md +0 -72
  220. package/dist/docs/references/docs-rag-retrieval.md +0 -521
  221. package/dist/docs/references/docs-rag-vector-databases.md +0 -648
  222. package/dist/docs/references/docs-server-auth-auth0.md +0 -222
  223. package/dist/docs/references/docs-server-auth-clerk.md +0 -132
  224. package/dist/docs/references/docs-server-auth-composite-auth.md +0 -234
  225. package/dist/docs/references/docs-server-auth-custom-auth-provider.md +0 -513
  226. package/dist/docs/references/docs-server-auth-firebase.md +0 -272
  227. package/dist/docs/references/docs-server-auth-jwt.md +0 -110
  228. package/dist/docs/references/docs-server-auth-simple-auth.md +0 -178
  229. package/dist/docs/references/docs-server-auth-supabase.md +0 -117
  230. package/dist/docs/references/docs-server-auth-workos.md +0 -190
  231. package/dist/docs/references/docs-server-custom-adapters.md +0 -374
  232. package/dist/docs/references/docs-server-custom-api-routes.md +0 -267
  233. package/dist/docs/references/docs-server-mastra-client.md +0 -243
  234. package/dist/docs/references/docs-server-mastra-server.md +0 -71
  235. package/dist/docs/references/docs-server-middleware.md +0 -228
  236. package/dist/docs/references/docs-server-request-context.md +0 -478
  237. package/dist/docs/references/docs-streaming-events.md +0 -247
  238. package/dist/docs/references/docs-streaming-tool-streaming.md +0 -178
  239. package/dist/docs/references/docs-streaming-workflow-streaming.md +0 -109
  240. package/dist/docs/references/docs-voice-overview.md +0 -979
  241. package/dist/docs/references/docs-voice-speech-to-speech.md +0 -103
  242. package/dist/docs/references/docs-voice-speech-to-text.md +0 -80
  243. package/dist/docs/references/docs-voice-text-to-speech.md +0 -84
  244. package/dist/docs/references/docs-workflows-agents-and-tools.md +0 -170
  245. package/dist/docs/references/docs-workflows-control-flow.md +0 -823
  246. package/dist/docs/references/docs-workflows-error-handling.md +0 -360
  247. package/dist/docs/references/docs-workflows-human-in-the-loop.md +0 -213
  248. package/dist/docs/references/docs-workflows-overview.md +0 -372
  249. package/dist/docs/references/docs-workflows-snapshots.md +0 -238
  250. package/dist/docs/references/docs-workflows-suspend-and-resume.md +0 -205
  251. package/dist/docs/references/docs-workflows-time-travel.md +0 -309
  252. package/dist/docs/references/docs-workflows-workflow-state.md +0 -181
  253. package/dist/docs/references/docs-workspace-filesystem.md +0 -162
  254. package/dist/docs/references/docs-workspace-overview.md +0 -239
  255. package/dist/docs/references/docs-workspace-sandbox.md +0 -63
  256. package/dist/docs/references/docs-workspace-search.md +0 -219
  257. package/dist/docs/references/docs-workspace-skills.md +0 -126
  258. package/dist/docs/references/guides-agent-frameworks-ai-sdk.md +0 -140
  259. package/dist/docs/references/reference-agents-agent.md +0 -142
  260. package/dist/docs/references/reference-agents-generate.md +0 -174
  261. package/dist/docs/references/reference-agents-generateLegacy.md +0 -176
  262. package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +0 -36
  263. package/dist/docs/references/reference-agents-getDefaultOptions.md +0 -34
  264. package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +0 -36
  265. package/dist/docs/references/reference-agents-getDescription.md +0 -21
  266. package/dist/docs/references/reference-agents-getInstructions.md +0 -34
  267. package/dist/docs/references/reference-agents-getLLM.md +0 -37
  268. package/dist/docs/references/reference-agents-getMemory.md +0 -34
  269. package/dist/docs/references/reference-agents-getModel.md +0 -34
  270. package/dist/docs/references/reference-agents-getTools.md +0 -29
  271. package/dist/docs/references/reference-agents-getVoice.md +0 -34
  272. package/dist/docs/references/reference-agents-listAgents.md +0 -35
  273. package/dist/docs/references/reference-agents-listScorers.md +0 -34
  274. package/dist/docs/references/reference-agents-listTools.md +0 -34
  275. package/dist/docs/references/reference-agents-listWorkflows.md +0 -34
  276. package/dist/docs/references/reference-agents-network.md +0 -134
  277. package/dist/docs/references/reference-ai-sdk-chat-route.md +0 -82
  278. package/dist/docs/references/reference-ai-sdk-network-route.md +0 -74
  279. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +0 -232
  280. package/dist/docs/references/reference-ai-sdk-with-mastra.md +0 -59
  281. package/dist/docs/references/reference-ai-sdk-workflow-route.md +0 -79
  282. package/dist/docs/references/reference-auth-auth0.md +0 -73
  283. package/dist/docs/references/reference-auth-clerk.md +0 -36
  284. package/dist/docs/references/reference-auth-firebase.md +0 -80
  285. package/dist/docs/references/reference-auth-jwt.md +0 -26
  286. package/dist/docs/references/reference-auth-supabase.md +0 -33
  287. package/dist/docs/references/reference-auth-workos.md +0 -84
  288. package/dist/docs/references/reference-client-js-agents.md +0 -438
  289. package/dist/docs/references/reference-configuration.md +0 -749
  290. package/dist/docs/references/reference-core-addGateway.md +0 -42
  291. package/dist/docs/references/reference-core-getAgent.md +0 -21
  292. package/dist/docs/references/reference-core-getAgentById.md +0 -21
  293. package/dist/docs/references/reference-core-getDeployer.md +0 -22
  294. package/dist/docs/references/reference-core-getGateway.md +0 -38
  295. package/dist/docs/references/reference-core-getGatewayById.md +0 -41
  296. package/dist/docs/references/reference-core-getLogger.md +0 -22
  297. package/dist/docs/references/reference-core-getMCPServer.md +0 -45
  298. package/dist/docs/references/reference-core-getMCPServerById.md +0 -53
  299. package/dist/docs/references/reference-core-getMemory.md +0 -50
  300. package/dist/docs/references/reference-core-getScorer.md +0 -54
  301. package/dist/docs/references/reference-core-getScorerById.md +0 -54
  302. package/dist/docs/references/reference-core-getServer.md +0 -22
  303. package/dist/docs/references/reference-core-getStorage.md +0 -22
  304. package/dist/docs/references/reference-core-getStoredAgentById.md +0 -89
  305. package/dist/docs/references/reference-core-getTelemetry.md +0 -22
  306. package/dist/docs/references/reference-core-getVector.md +0 -22
  307. package/dist/docs/references/reference-core-getWorkflow.md +0 -40
  308. package/dist/docs/references/reference-core-listAgents.md +0 -21
  309. package/dist/docs/references/reference-core-listGateways.md +0 -40
  310. package/dist/docs/references/reference-core-listLogs.md +0 -38
  311. package/dist/docs/references/reference-core-listLogsByRunId.md +0 -36
  312. package/dist/docs/references/reference-core-listMCPServers.md +0 -51
  313. package/dist/docs/references/reference-core-listMemory.md +0 -56
  314. package/dist/docs/references/reference-core-listScorers.md +0 -29
  315. package/dist/docs/references/reference-core-listStoredAgents.md +0 -93
  316. package/dist/docs/references/reference-core-listVectors.md +0 -22
  317. package/dist/docs/references/reference-core-listWorkflows.md +0 -21
  318. package/dist/docs/references/reference-core-mastra-class.md +0 -66
  319. package/dist/docs/references/reference-core-mastra-model-gateway.md +0 -153
  320. package/dist/docs/references/reference-core-setLogger.md +0 -26
  321. package/dist/docs/references/reference-core-setStorage.md +0 -27
  322. package/dist/docs/references/reference-datasets-addItem.md +0 -35
  323. package/dist/docs/references/reference-datasets-addItems.md +0 -33
  324. package/dist/docs/references/reference-datasets-compareExperiments.md +0 -48
  325. package/dist/docs/references/reference-datasets-create.md +0 -49
  326. package/dist/docs/references/reference-datasets-dataset.md +0 -78
  327. package/dist/docs/references/reference-datasets-datasets-manager.md +0 -84
  328. package/dist/docs/references/reference-datasets-delete.md +0 -23
  329. package/dist/docs/references/reference-datasets-deleteExperiment.md +0 -25
  330. package/dist/docs/references/reference-datasets-deleteItem.md +0 -25
  331. package/dist/docs/references/reference-datasets-deleteItems.md +0 -27
  332. package/dist/docs/references/reference-datasets-get.md +0 -29
  333. package/dist/docs/references/reference-datasets-getDetails.md +0 -45
  334. package/dist/docs/references/reference-datasets-getExperiment.md +0 -28
  335. package/dist/docs/references/reference-datasets-getItem.md +0 -31
  336. package/dist/docs/references/reference-datasets-getItemHistory.md +0 -29
  337. package/dist/docs/references/reference-datasets-list.md +0 -29
  338. package/dist/docs/references/reference-datasets-listExperimentResults.md +0 -37
  339. package/dist/docs/references/reference-datasets-listExperiments.md +0 -31
  340. package/dist/docs/references/reference-datasets-listItems.md +0 -44
  341. package/dist/docs/references/reference-datasets-listVersions.md +0 -31
  342. package/dist/docs/references/reference-datasets-startExperiment.md +0 -60
  343. package/dist/docs/references/reference-datasets-startExperimentAsync.md +0 -41
  344. package/dist/docs/references/reference-datasets-update.md +0 -46
  345. package/dist/docs/references/reference-datasets-updateItem.md +0 -36
  346. package/dist/docs/references/reference-evals-answer-relevancy.md +0 -105
  347. package/dist/docs/references/reference-evals-answer-similarity.md +0 -99
  348. package/dist/docs/references/reference-evals-bias.md +0 -120
  349. package/dist/docs/references/reference-evals-completeness.md +0 -137
  350. package/dist/docs/references/reference-evals-content-similarity.md +0 -101
  351. package/dist/docs/references/reference-evals-context-precision.md +0 -196
  352. package/dist/docs/references/reference-evals-create-scorer.md +0 -270
  353. package/dist/docs/references/reference-evals-faithfulness.md +0 -114
  354. package/dist/docs/references/reference-evals-hallucination.md +0 -220
  355. package/dist/docs/references/reference-evals-keyword-coverage.md +0 -128
  356. package/dist/docs/references/reference-evals-mastra-scorer.md +0 -123
  357. package/dist/docs/references/reference-evals-run-evals.md +0 -138
  358. package/dist/docs/references/reference-evals-scorer-utils.md +0 -330
  359. package/dist/docs/references/reference-evals-textual-difference.md +0 -113
  360. package/dist/docs/references/reference-evals-tone-consistency.md +0 -119
  361. package/dist/docs/references/reference-evals-toxicity.md +0 -123
  362. package/dist/docs/references/reference-harness-harness-class.md +0 -645
  363. package/dist/docs/references/reference-logging-pino-logger.md +0 -117
  364. package/dist/docs/references/reference-memory-deleteMessages.md +0 -40
  365. package/dist/docs/references/reference-memory-memory-class.md +0 -147
  366. package/dist/docs/references/reference-memory-observational-memory.md +0 -565
  367. package/dist/docs/references/reference-observability-tracing-bridges-otel.md +0 -131
  368. package/dist/docs/references/reference-observability-tracing-configuration.md +0 -178
  369. package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +0 -138
  370. package/dist/docs/references/reference-observability-tracing-exporters-datadog.md +0 -116
  371. package/dist/docs/references/reference-observability-tracing-instances.md +0 -109
  372. package/dist/docs/references/reference-observability-tracing-interfaces.md +0 -749
  373. package/dist/docs/references/reference-observability-tracing-processors-sensitive-data-filter.md +0 -144
  374. package/dist/docs/references/reference-observability-tracing-spans.md +0 -224
  375. package/dist/docs/references/reference-processors-batch-parts-processor.md +0 -61
  376. package/dist/docs/references/reference-processors-language-detector.md +0 -81
  377. package/dist/docs/references/reference-processors-message-history-processor.md +0 -85
  378. package/dist/docs/references/reference-processors-moderation-processor.md +0 -104
  379. package/dist/docs/references/reference-processors-pii-detector.md +0 -107
  380. package/dist/docs/references/reference-processors-processor-interface.md +0 -525
  381. package/dist/docs/references/reference-processors-prompt-injection-detector.md +0 -71
  382. package/dist/docs/references/reference-processors-semantic-recall-processor.md +0 -123
  383. package/dist/docs/references/reference-processors-system-prompt-scrubber.md +0 -80
  384. package/dist/docs/references/reference-processors-token-limiter-processor.md +0 -113
  385. package/dist/docs/references/reference-processors-tool-call-filter.md +0 -85
  386. package/dist/docs/references/reference-processors-tool-search-processor.md +0 -113
  387. package/dist/docs/references/reference-processors-unicode-normalizer.md +0 -62
  388. package/dist/docs/references/reference-processors-working-memory-processor.md +0 -154
  389. package/dist/docs/references/reference-rag-database-config.md +0 -264
  390. package/dist/docs/references/reference-rag-embeddings.md +0 -92
  391. package/dist/docs/references/reference-server-mastra-server.md +0 -298
  392. package/dist/docs/references/reference-server-register-api-route.md +0 -249
  393. package/dist/docs/references/reference-storage-cloudflare-d1.md +0 -218
  394. package/dist/docs/references/reference-storage-composite.md +0 -235
  395. package/dist/docs/references/reference-storage-lance.md +0 -131
  396. package/dist/docs/references/reference-storage-libsql.md +0 -135
  397. package/dist/docs/references/reference-storage-mongodb.md +0 -262
  398. package/dist/docs/references/reference-storage-mssql.md +0 -155
  399. package/dist/docs/references/reference-storage-overview.md +0 -121
  400. package/dist/docs/references/reference-storage-postgresql.md +0 -529
  401. package/dist/docs/references/reference-storage-upstash.md +0 -160
  402. package/dist/docs/references/reference-streaming-ChunkType.md +0 -292
  403. package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +0 -182
  404. package/dist/docs/references/reference-streaming-agents-streamLegacy.md +0 -142
  405. package/dist/docs/references/reference-streaming-workflows-observeStream.md +0 -42
  406. package/dist/docs/references/reference-streaming-workflows-resumeStream.md +0 -61
  407. package/dist/docs/references/reference-streaming-workflows-stream.md +0 -88
  408. package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +0 -142
  409. package/dist/docs/references/reference-templates-overview.md +0 -194
  410. package/dist/docs/references/reference-tools-create-tool.md +0 -237
  411. package/dist/docs/references/reference-tools-graph-rag-tool.md +0 -185
  412. package/dist/docs/references/reference-tools-mcp-client.md +0 -962
  413. package/dist/docs/references/reference-tools-mcp-server.md +0 -1275
  414. package/dist/docs/references/reference-tools-vector-query-tool.md +0 -459
  415. package/dist/docs/references/reference-vectors-libsql.md +0 -305
  416. package/dist/docs/references/reference-vectors-mongodb.md +0 -295
  417. package/dist/docs/references/reference-vectors-pg.md +0 -408
  418. package/dist/docs/references/reference-vectors-upstash.md +0 -294
  419. package/dist/docs/references/reference-voice-composite-voice.md +0 -121
  420. package/dist/docs/references/reference-voice-mastra-voice.md +0 -313
  421. package/dist/docs/references/reference-voice-voice.addInstructions.md +0 -56
  422. package/dist/docs/references/reference-voice-voice.addTools.md +0 -67
  423. package/dist/docs/references/reference-voice-voice.connect.md +0 -94
  424. package/dist/docs/references/reference-voice-voice.events.md +0 -37
  425. package/dist/docs/references/reference-voice-voice.listen.md +0 -164
  426. package/dist/docs/references/reference-voice-voice.on.md +0 -111
  427. package/dist/docs/references/reference-voice-voice.speak.md +0 -157
  428. package/dist/docs/references/reference-workflows-run-methods-cancel.md +0 -86
  429. package/dist/docs/references/reference-workflows-run-methods-restart.md +0 -33
  430. package/dist/docs/references/reference-workflows-run-methods-resume.md +0 -59
  431. package/dist/docs/references/reference-workflows-run-methods-start.md +0 -58
  432. package/dist/docs/references/reference-workflows-run-methods-startAsync.md +0 -67
  433. package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +0 -142
  434. package/dist/docs/references/reference-workflows-run.md +0 -59
  435. package/dist/docs/references/reference-workflows-step.md +0 -119
  436. package/dist/docs/references/reference-workflows-workflow-methods-branch.md +0 -25
  437. package/dist/docs/references/reference-workflows-workflow-methods-commit.md +0 -17
  438. package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +0 -63
  439. package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +0 -25
  440. package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +0 -25
  441. package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +0 -118
  442. package/dist/docs/references/reference-workflows-workflow-methods-map.md +0 -93
  443. package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +0 -21
  444. package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +0 -35
  445. package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +0 -35
  446. package/dist/docs/references/reference-workflows-workflow-methods-then.md +0 -21
  447. package/dist/docs/references/reference-workflows-workflow.md +0 -157
  448. package/dist/docs/references/reference-workspace-filesystem.md +0 -202
  449. package/dist/docs/references/reference-workspace-local-filesystem.md +0 -327
  450. package/dist/docs/references/reference-workspace-local-sandbox.md +0 -285
  451. package/dist/docs/references/reference-workspace-sandbox.md +0 -81
  452. package/dist/docs/references/reference-workspace-workspace-class.md +0 -226
  453. package/dist/docs/references/reference.md +0 -276
@@ -1,301 +0,0 @@
1
- ---
2
- name: mastra-core
3
- description: Documentation for @mastra/core. Use when working with @mastra/core APIs, configuration, or implementation.
4
- metadata:
5
- package: "@mastra/core"
6
- version: "1.6.0"
7
- ---
8
-
9
- ## When to use
10
-
11
- Use this skill whenever you are working with @mastra/core to obtain the domain-specific knowledge.
12
-
13
- ## How to use
14
-
15
- Read the individual reference documents for detailed explanations and code examples.
16
-
17
- ### Docs
18
-
19
- - [Voice](references/docs-agents-adding-voice.md)
20
- - [Agent Approval](references/docs-agents-agent-approval.md) - Learn how to require approvals, suspend tool execution, and automatically resume suspended tools while keeping humans in control of agent workflows.
21
- - [Agent Memory](references/docs-agents-agent-memory.md) - Learn how to add memory to agents to store message history and maintain context across interactions.
22
- - [Guardrails](references/docs-agents-guardrails.md) - Learn how to implement guardrails using input and output processors to secure and control AI interactions.
23
- - [Network Approval](references/docs-agents-network-approval.md) - Learn how to require approvals, suspend execution, and resume suspended networks while keeping humans in control of agent network workflows.
24
- - [Agent Networks](references/docs-agents-networks.md) - Learn how to coordinate multiple agents, workflows, and tools using agent networks for complex, non-deterministic task execution.
25
- - [Using Agents](references/docs-agents-overview.md) - Overview of agents in Mastra, detailing their capabilities and how they interact with tools, workflows, and external systems.
26
- - [Processors](references/docs-agents-processors.md) - Learn how to use input and output processors to transform, validate, and control messages in Mastra agents.
27
- - [Structured Output](references/docs-agents-structured-output.md) - Learn how to generate structured data from agents using schemas and validation.
28
- - [Using Tools](references/docs-agents-using-tools.md) - Learn how to create tools and add them to agents to extend capabilities beyond text generation.
29
- - [Custom Scorers](references/docs-evals-custom-scorers.md)
30
- - [Scorers overview](references/docs-evals-overview.md) - Overview of scorers in Mastra, detailing their capabilities for evaluating AI outputs and measuring performance.
31
- - [Running Scorers in CI](references/docs-evals-running-in-ci.md) - Learn how to run scorer experiments in your CI/CD pipeline using the runEvals function.
32
- - [MCP Overview](references/docs-mcp-overview.md) - Learn about the Model Context Protocol (MCP), how to use third-party tools via MCPClient, connect to registries, and share your own tools using MCPServer.
33
- - [Publishing an MCP Server](references/docs-mcp-publishing-mcp-server.md) - Guide to setting up and building a Mastra MCP server using the stdio transport, and publishing it to NPM.
34
- - [Memory Processors](references/docs-memory-memory-processors.md) - Learn how to use memory processors in Mastra to filter, trim, and transform messages before they're sent to the language model to manage context window limits.
35
- - [Observational Memory](references/docs-memory-observational-memory.md) - Learn how Observational Memory keeps your agent's context window small while preserving long-term memory across conversations.
36
- - [Memory overview](references/docs-memory-overview.md) - Learn how Mastra's memory system works with working memory, message history, semantic recall, and observational memory.
37
- - [Semantic Recall](references/docs-memory-semantic-recall.md) - Learn how to use semantic recall in Mastra to retrieve relevant messages from past conversations using vector search and embeddings.
38
- - [Storage](references/docs-memory-storage.md) - Configure storage for Mastra's memory system to persist conversations, workflows, and traces.
39
- - [Working Memory](references/docs-memory-working-memory.md) - Learn how to configure working memory in Mastra to store persistent user data, preferences.
40
- - [Datasets Overview](references/docs-observability-datasets-overview.md) - Manage versioned test data, run experiments against agents and workflows, and track results over time.
41
- - [Running Experiments](references/docs-observability-datasets-running-experiments.md) - Run experiments against agents or workflows, with scoring and result tracking.
42
- - [Logging](references/docs-observability-logging.md) - Learn how to use logging in Mastra to monitor execution, capture application behavior, and improve the accuracy of AI applications.
43
- - [Observability Overview](references/docs-observability-overview.md) - Monitor and debug applications with Mastra's Observability features.
44
- - [OpenTelemetry Bridge](references/docs-observability-tracing-bridges-otel.md) - Integrate Mastra tracing with existing OpenTelemetry infrastructure
45
- - [Arize Exporter](references/docs-observability-tracing-exporters-arize.md) - Send traces to Arize Phoenix or Arize AX using OpenTelemetry and OpenInference
46
- - [Braintrust Exporter](references/docs-observability-tracing-exporters-braintrust.md) - Send traces to Braintrust for evaluation and monitoring
47
- - [Cloud Exporter](references/docs-observability-tracing-exporters-cloud.md) - Send traces to Mastra Cloud for production monitoring
48
- - [Datadog Exporter](references/docs-observability-tracing-exporters-datadog.md) - Send traces to Datadog for LLM observability and analytics
49
- - [Default Exporter](references/docs-observability-tracing-exporters-default.md) - Store traces locally for development and debugging
50
- - [Laminar Exporter](references/docs-observability-tracing-exporters-laminar.md) - Send traces to Laminar for LLM observability, evaluation, and analysis
51
- - [Langfuse Exporter](references/docs-observability-tracing-exporters-langfuse.md) - Send traces to Langfuse for LLM observability and analytics
52
- - [LangSmith Exporter](references/docs-observability-tracing-exporters-langsmith.md) - Send traces to LangSmith for LLM observability and evaluation
53
- - [OpenTelemetry Exporter](references/docs-observability-tracing-exporters-otel.md) - Send traces to any OpenTelemetry-compatible observability platform
54
- - [PostHog Exporter](references/docs-observability-tracing-exporters-posthog.md) - Send traces to PostHog for AI observability and analytics
55
- - [Tracing](references/docs-observability-tracing-overview.md) - Set up Tracing for Mastra applications
56
- - [Chunking and Embedding Documents](references/docs-rag-chunking-and-embedding.md) - Guide on chunking and embedding documents in Mastra for efficient processing and retrieval.
57
- - [GraphRAG](references/docs-rag-graph-rag.md) - Guide on graph-based retrieval in Mastra's RAG systems for documents with complex relationships.
58
- - [RAG (Retrieval-Augmented Generation) in Mastra](references/docs-rag-overview.md) - Overview of Retrieval-Augmented Generation (RAG) in Mastra, detailing its capabilities for enhancing LLM outputs with relevant context.
59
- - [Retrieval, Semantic Search, Reranking](references/docs-rag-retrieval.md) - Guide on retrieval processes in Mastra's RAG systems, including semantic search, filtering, and re-ranking.
60
- - [Storing Embeddings in A Vector Database](references/docs-rag-vector-databases.md) - Guide on vector storage options in Mastra, including embedded and dedicated vector databases for similarity search.
61
- - [MastraAuthAuth0 Class](references/docs-server-auth-auth0.md) - Documentation for the MastraAuthAuth0 class, which authenticates Mastra applications using Auth0 authentication.
62
- - [MastraAuthClerk Class](references/docs-server-auth-clerk.md) - Documentation for the MastraAuthClerk class, which authenticates Mastra applications using Clerk authentication.
63
- - [CompositeAuth Class](references/docs-server-auth-composite-auth.md) - Documentation for the CompositeAuth class, which combines multiple authentication providers into a single auth handler.
64
- - [Custom Auth Provider](references/docs-server-auth-custom-auth-provider.md) - Create custom authentication providers for specialized identity systems
65
- - [MastraAuthFirebase Class](references/docs-server-auth-firebase.md) - Documentation for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication.
66
- - [MastraJwtAuth Class](references/docs-server-auth-jwt.md) - Documentation for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens.
67
- - [SimpleAuth Class](references/docs-server-auth-simple-auth.md) - Documentation for the SimpleAuth class, which provides token-to-user mapping authentication for development and simple API key scenarios.
68
- - [MastraAuthSupabase Class](references/docs-server-auth-supabase.md) - Documentation for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth.
69
- - [MastraAuthWorkos Class](references/docs-server-auth-workos.md) - Documentation for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication.
70
- - [Custom Adapters](references/docs-server-custom-adapters.md) - Create a custom server adapter for frameworks other than Hono or Express.
71
- - [Custom API Routes](references/docs-server-custom-api-routes.md) - Expose additional HTTP endpoints from your Mastra server.
72
- - [Mastra Client SDK](references/docs-server-mastra-client.md) - Learn how to set up and use the Mastra Client SDK
73
- - [Server Overview](references/docs-server-mastra-server.md) - Overview of the Mastra server, covering HTTP endpoints, middleware, authentication, and client integration.
74
- - [Middleware](references/docs-server-middleware.md) - Apply custom middleware functions to intercept requests.
75
- - [Request Context](references/docs-server-request-context.md) - Learn how to use Mastra's RequestContext to provide dynamic, request-specific configuration to agents.
76
- - [Streaming Events](references/docs-streaming-events.md) - Learn about the different types of streaming events in Mastra, including text deltas, tool calls, step events, and how to handle them in your applications.
77
- - [Tool streaming](references/docs-streaming-tool-streaming.md) - Learn how to use tool streaming in Mastra, including handling tool calls, tool results, and tool execution events during streaming.
78
- - [Workflow streaming](references/docs-streaming-workflow-streaming.md) - Learn how to use workflow streaming in Mastra, including handling workflow execution events, step streaming, and workflow integration with agents and tools.
79
- - [Voice in Mastra](references/docs-voice-overview.md) - Overview of voice capabilities in Mastra, including text-to-speech, speech-to-text, and real-time speech-to-speech interactions.
80
- - [Speech-to-Speech Capabilities in Mastra](references/docs-voice-speech-to-speech.md) - Overview of speech-to-speech capabilities in Mastra, including real-time interactions and event-driven architecture.
81
- - [Speech-to-Text (STT)](references/docs-voice-speech-to-text.md) - Overview of Speech-to-Text capabilities in Mastra, including configuration, usage, and integration with voice providers.
82
- - [Text-to-Speech (TTS)](references/docs-voice-text-to-speech.md) - Overview of Text-to-Speech capabilities in Mastra, including configuration, usage, and integration with voice providers.
83
- - [Agents and Tools](references/docs-workflows-agents-and-tools.md) - Learn how to call agents and tools from workflow steps and choose between execute functions and step composition.
84
- - [Control Flow](references/docs-workflows-control-flow.md) - Control flow in Mastra workflows allows you to manage branching, merging, and conditions to construct workflows that meet your logic requirements.
85
- - [Error Handling](references/docs-workflows-error-handling.md) - Learn how to handle errors in Mastra workflows using step retries, conditional branching, and monitoring.
86
- - [Human-in-the-loop (HITL)](references/docs-workflows-human-in-the-loop.md) - Human-in-the-loop workflows in Mastra allow you to pause execution for manual approvals, reviews, or user input before continuing.
87
- - [Workflows overview](references/docs-workflows-overview.md) - Workflows in Mastra help you orchestrate complex sequences of tasks with features like branching, parallel execution, resource suspension, and more.
88
- - [Snapshots](references/docs-workflows-snapshots.md) - Learn how to save and resume workflow execution state with snapshots in Mastra
89
- - [Suspend & Resume](references/docs-workflows-suspend-and-resume.md) - Suspend and resume in Mastra workflows allows you to pause execution while waiting for external input or resources.
90
- - [Time Travel](references/docs-workflows-time-travel.md) - Re-execute workflow steps from a specific point using time travel debugging in Mastra
91
- - [Workflow state](references/docs-workflows-workflow-state.md) - Share values across workflow steps using global state that persists through the entire workflow run.
92
- - [Filesystem](references/docs-workspace-filesystem.md) - Configure filesystem providers to give agents persistent file storage.
93
- - [Overview](references/docs-workspace-overview.md) - Give agents filesystem access and code execution through workspaces.
94
- - [Sandbox](references/docs-workspace-sandbox.md) - Configure sandbox providers to give agents command execution capabilities.
95
- - [Search and Indexing](references/docs-workspace-search.md) - Index workspace content for BM25 keyword search, vector semantic search, or hybrid mode.
96
- - [Skills](references/docs-workspace-skills.md) - Teach agents reusable capabilities with the Agent Skills specification.
97
-
98
- ### Guides
99
-
100
- - [AI SDK](references/guides-agent-frameworks-ai-sdk.md) - Use Mastra processors and memory with the Vercel AI SDK
101
-
102
- ### Reference
103
-
104
- - [Reference: Overview](references/reference.md) - Reference documentation on Mastra's APIs and tools
105
- - [Reference: Agent Class](references/reference-agents-agent.md) - Documentation for the `Agent` class in Mastra, which provides the foundation for creating AI agents with various capabilities.
106
- - [Reference: Agent.generate()](references/reference-agents-generate.md) - Documentation for the `Agent.generate()` method in Mastra agents, which enables non-streaming generation of responses with enhanced capabilities.
107
- - [Reference: Agent.generateLegacy() (Legacy)](references/reference-agents-generateLegacy.md) - Documentation for the legacy `Agent.generateLegacy()` method in Mastra agents. This method is deprecated and will be removed in a future version.
108
- - [Reference: Agent.getDefaultGenerateOptionsLegacy()](references/reference-agents-getDefaultGenerateOptions.md) - Documentation for the `Agent.getDefaultGenerateOptionsLegacy()` method in Mastra agents, which retrieves the default options used for generateLegacy calls.
109
- - [Reference: Agent.getDefaultOptions()](references/reference-agents-getDefaultOptions.md) - Documentation for the `Agent.getDefaultOptions()` method in Mastra agents, which retrieves the default options used for stream and generate calls.
110
- - [Reference: Agent.getDefaultStreamOptionsLegacy()](references/reference-agents-getDefaultStreamOptions.md) - Documentation for the `Agent.getDefaultStreamOptionsLegacy()` method in Mastra agents, which retrieves the default options used for streamLegacy calls.
111
- - [Reference: Agent.getDescription()](references/reference-agents-getDescription.md) - Documentation for the `Agent.getDescription()` method in Mastra agents, which retrieves the agent's description.
112
- - [Reference: Agent.getInstructions()](references/reference-agents-getInstructions.md) - Documentation for the `Agent.getInstructions()` method in Mastra agents, which retrieves the instructions that guide the agent's behavior.
113
- - [Reference: Agent.getLLM()](references/reference-agents-getLLM.md) - Documentation for the `Agent.getLLM()` method in Mastra agents, which retrieves the language model instance.
114
- - [Reference: Agent.getMemory()](references/reference-agents-getMemory.md) - Documentation for the `Agent.getMemory()` method in Mastra agents, which retrieves the memory system associated with the agent.
115
- - [Reference: Agent.getModel()](references/reference-agents-getModel.md) - Documentation for the `Agent.getModel()` method in Mastra agents, which retrieves the language model that powers the agent.
116
- - [Reference: Agent.getTools()](references/reference-agents-getTools.md) - Documentation for the `Agent.getTools()` method in Mastra agents, which retrieves the tools that the agent can use.
117
- - [Reference: Agent.getVoice()](references/reference-agents-getVoice.md) - Documentation for the `Agent.getVoice()` method in Mastra agents, which retrieves the voice provider for speech capabilities.
118
- - [Reference: Agent.listAgents()](references/reference-agents-listAgents.md) - Documentation for the `Agent.listAgents()` method in Mastra agents, which retrieves the subagents that the agent can access.
119
- - [Reference: Agent.listScorers()](references/reference-agents-listScorers.md) - Documentation for the `Agent.listScorers()` method in Mastra agents, which retrieves the scoring configuration.
120
- - [Reference: Agent.listTools()](references/reference-agents-listTools.md) - Documentation for the `Agent.listTools()` method in Mastra agents, which retrieves the tools that the agent can use.
121
- - [Reference: Agent.listWorkflows()](references/reference-agents-listWorkflows.md) - Documentation for the `Agent.listWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute.
122
- - [Reference: Agent.network()](references/reference-agents-network.md) - Documentation for the `Agent.network()` method in Mastra agents, which enables multi-agent collaboration and routing.
123
- - [Reference: chatRoute()](references/reference-ai-sdk-chat-route.md) - API reference for chatRoute(), a function to create chat route handlers for streaming agent conversations in AI SDK-compatible format.
124
- - [Reference: networkRoute()](references/reference-ai-sdk-network-route.md) - API reference for networkRoute(), a function to create network route handlers for streaming network execution in AI SDK-compatible format.
125
- - [Reference: toAISdkStream()](references/reference-ai-sdk-to-ai-sdk-stream.md) - API reference for toAISdkStream(), a function to convert Mastra streams to AI SDK-compatible streams.
126
- - [Reference: withMastra()](references/reference-ai-sdk-with-mastra.md) - API reference for withMastra(), a function to use Mastra functionality in AI SDK.
127
- - [Reference: workflowRoute()](references/reference-ai-sdk-workflow-route.md) - API reference for workflowRoute(), a function to create workflow route handlers for streaming workflow execution in AI SDK-compatible format.
128
- - [Reference: MastraAuthAuth0 Class](references/reference-auth-auth0.md) - API reference for the MastraAuthAuth0 class, which authenticates Mastra applications using Auth0 authentication.
129
- - [Reference: MastraAuthClerk Class](references/reference-auth-clerk.md) - API reference for the MastraAuthClerk class, which authenticates Mastra applications using Clerk authentication.
130
- - [Reference: MastraAuthFirebase Class](references/reference-auth-firebase.md) - API reference for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication.
131
- - [Reference: MastraJwtAuth Class](references/reference-auth-jwt.md) - API reference for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens.
132
- - [Reference: MastraAuthSupabase Class](references/reference-auth-supabase.md) - API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth.
133
- - [Reference: MastraAuthWorkos Class](references/reference-auth-workos.md) - API reference for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication.
134
- - [Reference: Agents API](references/reference-client-js-agents.md) - Learn how to interact with Mastra AI agents, including generating responses, streaming interactions, and managing agent tools using the client-js SDK.
135
- - [Reference: Configuration](references/reference-configuration.md) - Reference documentation on Mastra's configuration options
136
- - [Reference: Mastra.addGateway()](references/reference-core-addGateway.md) - Add a gateway to the Mastra instance
137
- - [Reference: Mastra.getAgent()](references/reference-core-getAgent.md) - Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name.
138
- - [Reference: Mastra.getAgentById()](references/reference-core-getAgentById.md) - Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID.
139
- - [Reference: Mastra.getDeployer()](references/reference-core-getDeployer.md) - Documentation for the `Mastra.getDeployer()` method in Mastra, which retrieves the configured deployer instance.
140
- - [Reference: Mastra.getGateway()](references/reference-core-getGateway.md) - Retrieve a registered gateway by its registration key
141
- - [Reference: Mastra.getGatewayById()](references/reference-core-getGatewayById.md) - Retrieve a registered gateway by its unique ID
142
- - [Reference: Mastra.getLogger()](references/reference-core-getLogger.md) - Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance.
143
- - [Reference: Mastra.getMCPServer()](references/reference-core-getMCPServer.md) - Documentation for the `Mastra.getMCPServer()` method in Mastra, which retrieves a specific MCP server instance by ID and optional version.
144
- - [Reference: Mastra.getMCPServerById()](references/reference-core-getMCPServerById.md) - Documentation for the `Mastra.getMCPServerById()` method in Mastra, which retrieves a specific MCP server instance by its intrinsic id property.
145
- - [Reference: Mastra.getMemory()](references/reference-core-getMemory.md) - Documentation for the `Mastra.getMemory()` method in Mastra, which retrieves a registered memory instance by its registry key.
146
- - [Reference: getScorer()](references/reference-core-getScorer.md) - Documentation for the `getScorer()` method in Mastra, which retrieves a specific scorer by its registration key.
147
- - [Reference: getScorerById()](references/reference-core-getScorerById.md) - Documentation for the `getScorerById()` method in Mastra, which retrieves a scorer by its id property rather than registration key.
148
- - [Reference: Mastra.getServer()](references/reference-core-getServer.md) - Documentation for the `Mastra.getServer()` method in Mastra, which retrieves the configured server configuration.
149
- - [Reference: Mastra.getStorage()](references/reference-core-getStorage.md) - Documentation for the `Mastra.getStorage()` method in Mastra, which retrieves the configured storage instance.
150
- - [Reference: Mastra.getStoredAgentById()](references/reference-core-getStoredAgentById.md) - Documentation for the `Mastra.getStoredAgentById()` method in Mastra, which retrieves an agent from storage and creates an executable Agent instance.
151
- - [Reference: Mastra.getTelemetry()](references/reference-core-getTelemetry.md) - Documentation for the `Mastra.getTelemetry()` method in Mastra, which retrieves the configured telemetry instance.
152
- - [Reference: Mastra.getVector()](references/reference-core-getVector.md) - Documentation for the `Mastra.getVector()` method in Mastra, which retrieves a vector store by name.
153
- - [Reference: Mastra.getWorkflow()](references/reference-core-getWorkflow.md) - Documentation for the `Mastra.getWorkflow()` method in Mastra, which retrieves a workflow by ID.
154
- - [Reference: Mastra.listAgents()](references/reference-core-listAgents.md) - Documentation for the `Mastra.listAgents()` method in Mastra, which retrieves all configured agents.
155
- - [Reference: Mastra.listGateways()](references/reference-core-listGateways.md) - List all registered gateways
156
- - [Reference: Mastra.listLogs()](references/reference-core-listLogs.md) - Documentation for the `Mastra.listLogs()` method in Mastra, which retrieves all logs for a specific transport ID.
157
- - [Reference: Mastra.listLogsByRunId()](references/reference-core-listLogsByRunId.md) - Documentation for the `Mastra.listLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID.
158
- - [Reference: Mastra.listMCPServers()](references/reference-core-listMCPServers.md) - Documentation for the `Mastra.listMCPServers()` method in Mastra, which retrieves all registered MCP server instances.
159
- - [Reference: Mastra.listMemory()](references/reference-core-listMemory.md) - Documentation for the `Mastra.listMemory()` method in Mastra, which returns all registered memory instances.
160
- - [Reference: listScorers()](references/reference-core-listScorers.md) - Documentation for the `listScorers()` method in Mastra, which returns all registered scorers for evaluating AI outputs.
161
- - [Reference: Mastra.listStoredAgents()](references/reference-core-listStoredAgents.md) - Documentation for the `Mastra.listStoredAgents()` method in Mastra, which retrieves a paginated list of agents from storage.
162
- - [Reference: Mastra.listVectors()](references/reference-core-listVectors.md) - Documentation for the `Mastra.listVectors()` method in Mastra, which retrieves all configured vector stores.
163
- - [Reference: Mastra.listWorkflows()](references/reference-core-listWorkflows.md) - Documentation for the `Mastra.listWorkflows()` method in Mastra, which retrieves all configured workflows.
164
- - [Reference: Mastra Class](references/reference-core-mastra-class.md) - Documentation for the `Mastra` class in Mastra, the core entry point for managing agents, workflows, MCP servers, and server endpoints.
165
- - [Reference: MastraModelGateway](references/reference-core-mastra-model-gateway.md) - Base class for creating custom model gateways
166
- - [Reference: Mastra.setLogger()](references/reference-core-setLogger.md) - Documentation for the `Mastra.setLogger()` method in Mastra, which sets the logger for all components (agents, workflows, etc.).
167
- - [Reference: Mastra.setStorage()](references/reference-core-setStorage.md) - Documentation for the `Mastra.setStorage()` method in Mastra, which sets the storage instance for the Mastra instance.
168
- - [Reference: dataset.addItem()](references/reference-datasets-addItem.md) - Documentation for the `dataset.addItem()` method, which adds a single item to a dataset.
169
- - [Reference: dataset.addItems()](references/reference-datasets-addItems.md) - Documentation for the `dataset.addItems()` method, which adds multiple items to a dataset in bulk.
170
- - [Reference: DatasetsManager.compareExperiments()](references/reference-datasets-compareExperiments.md) - Documentation for the `DatasetsManager.compareExperiments()` method, which compares two or more experiments.
171
- - [Reference: DatasetsManager.create()](references/reference-datasets-create.md) - Documentation for the `DatasetsManager.create()` method, which creates a new dataset.
172
- - [Reference: Dataset Class](references/reference-datasets-dataset.md) - Documentation for the `Dataset` class in Mastra, which provides the public API for interacting with a single dataset.
173
- - [Reference: DatasetsManager](references/reference-datasets-datasets-manager.md) - Documentation for the `DatasetsManager` class in Mastra, which provides the public API for managing datasets.
174
- - [Reference: DatasetsManager.delete()](references/reference-datasets-delete.md) - Documentation for the `DatasetsManager.delete()` method, which deletes a dataset by ID.
175
- - [Reference: dataset.deleteExperiment()](references/reference-datasets-deleteExperiment.md) - Documentation for the `dataset.deleteExperiment()` method, which deletes an experiment by ID.
176
- - [Reference: dataset.deleteItem()](references/reference-datasets-deleteItem.md) - Documentation for the `dataset.deleteItem()` method, which deletes a single item from a dataset.
177
- - [Reference: dataset.deleteItems()](references/reference-datasets-deleteItems.md) - Documentation for the `dataset.deleteItems()` method, which deletes multiple items from a dataset in bulk.
178
- - [Reference: DatasetsManager.get()](references/reference-datasets-get.md) - Documentation for the `DatasetsManager.get()` method, which retrieves an existing dataset by ID.
179
- - [Reference: dataset.getDetails()](references/reference-datasets-getDetails.md) - Documentation for the `dataset.getDetails()` method, which retrieves the full dataset record from storage.
180
- - [Reference: dataset.getExperiment()](references/reference-datasets-getExperiment.md) - Documentation for the `dataset.getExperiment()` method, which retrieves a specific experiment by ID.
181
- - [Reference: dataset.getItem()](references/reference-datasets-getItem.md) - Documentation for the `dataset.getItem()` method, which retrieves a single item by ID.
182
- - [Reference: dataset.getItemHistory()](references/reference-datasets-getItemHistory.md) - Documentation for the `dataset.getItemHistory()` method, which retrieves the full SCD-2 change history of a dataset item.
183
- - [Reference: DatasetsManager.list()](references/reference-datasets-list.md) - Documentation for the `DatasetsManager.list()` method, which lists all datasets with pagination.
184
- - [Reference: dataset.listExperimentResults()](references/reference-datasets-listExperimentResults.md) - Documentation for the `dataset.listExperimentResults()` method, which lists results for a specific experiment.
185
- - [Reference: dataset.listExperiments()](references/reference-datasets-listExperiments.md) - Documentation for the `dataset.listExperiments()` method, which lists all experiments for a dataset.
186
- - [Reference: dataset.listItems()](references/reference-datasets-listItems.md) - Documentation for the `dataset.listItems()` method, which lists items in a dataset with optional pagination and filtering.
187
- - [Reference: dataset.listVersions()](references/reference-datasets-listVersions.md) - Documentation for the `dataset.listVersions()` method, which lists all versions of a dataset.
188
- - [Reference: dataset.startExperiment()](references/reference-datasets-startExperiment.md) - Documentation for the `dataset.startExperiment()` method, which runs an experiment on a dataset and waits for completion.
189
- - [Reference: dataset.startExperimentAsync()](references/reference-datasets-startExperimentAsync.md) - Documentation for the `dataset.startExperimentAsync()` method, which starts an experiment asynchronously.
190
- - [Reference: dataset.update()](references/reference-datasets-update.md) - Documentation for the `dataset.update()` method, which updates dataset metadata and schemas.
191
- - [Reference: dataset.updateItem()](references/reference-datasets-updateItem.md) - Documentation for the `dataset.updateItem()` method, which updates an existing item in a dataset.
192
- - [Reference: Answer Relevancy Scorer](references/reference-evals-answer-relevancy.md) - Documentation for the Answer Relevancy Scorer in Mastra, which evaluates how well LLM outputs address the input query.
193
- - [Reference: Answer Similarity Scorer](references/reference-evals-answer-similarity.md) - Documentation for the Answer Similarity Scorer in Mastra, which compares agent outputs against ground truth answers for CI/CD testing.
194
- - [Reference: Bias Scorer](references/reference-evals-bias.md) - Documentation for the Bias Scorer in Mastra, which evaluates LLM outputs for various forms of bias, including gender, political, racial/ethnic, or geographical bias.
195
- - [Reference: Completeness Scorer](references/reference-evals-completeness.md) - Documentation for the Completeness Scorer in Mastra, which evaluates how thoroughly LLM outputs cover key elements present in the input.
196
- - [Reference: Content Similarity Scorer](references/reference-evals-content-similarity.md) - Documentation for the Content Similarity Scorer in Mastra, which measures textual similarity between strings and provides a matching score.
197
- - [Reference: Context Precision Scorer](references/reference-evals-context-precision.md) - Documentation for the Context Precision Scorer in Mastra. Evaluates the relevance and precision of retrieved context for generating expected outputs using Mean Average Precision.
198
- - [Reference: createScorer](references/reference-evals-create-scorer.md) - Documentation for creating custom scorers in Mastra, allowing users to define their own evaluation logic using either JavaScript functions or LLM-based prompts.
199
- - [Reference: Faithfulness Scorer](references/reference-evals-faithfulness.md) - Documentation for the Faithfulness Scorer in Mastra, which evaluates the factual accuracy of LLM outputs compared to the provided context.
200
- - [Reference: Hallucination Scorer](references/reference-evals-hallucination.md) - Documentation for the Hallucination Scorer in Mastra, which evaluates the factual correctness of LLM outputs by identifying contradictions with provided context.
201
- - [Reference: Keyword Coverage Scorer](references/reference-evals-keyword-coverage.md) - Documentation for the Keyword Coverage Scorer in Mastra, which evaluates how well LLM outputs cover important keywords from the input.
202
- - [Reference: MastraScorer](references/reference-evals-mastra-scorer.md) - Documentation for the MastraScorer base class in Mastra, which provides the foundation for all custom and built-in scorers.
203
- - [Reference: runEvals](references/reference-evals-run-evals.md) - Documentation for the runEvals function in Mastra, which enables batch evaluation of agents and workflows using multiple scorers.
204
- - [Reference: Scorer Utils](references/reference-evals-scorer-utils.md) - Utility functions for extracting data from scorer run inputs and outputs, including text content, reasoning, system messages, and tool calls.
205
- - [Reference: Textual Difference Scorer](references/reference-evals-textual-difference.md) - Documentation for the Textual Difference Scorer in Mastra, which measures textual differences between strings using sequence matching.
206
- - [Reference: Tone Consistency Scorer](references/reference-evals-tone-consistency.md) - Documentation for the Tone Consistency Scorer in Mastra, which evaluates emotional tone and sentiment consistency in text.
207
- - [Reference: Toxicity Scorer](references/reference-evals-toxicity.md) - Documentation for the Toxicity Scorer in Mastra, which evaluates LLM outputs for racist, biased, or toxic elements.
208
- - [Reference: Harness Class](references/reference-harness-harness-class.md) - Documentation for the Harness class, the core orchestrator for multi-mode agents, shared state, memory, and storage in Mastra.
209
- - [Reference: PinoLogger](references/reference-logging-pino-logger.md) - Documentation for PinoLogger, which provides methods to record events at various severity levels.
210
- - [Reference: Memory.deleteMessages()](references/reference-memory-deleteMessages.md) - Documentation for the `Memory.deleteMessages()` method in Mastra, which deletes multiple messages by their IDs.
211
- - [Reference: Memory Class](references/reference-memory-memory-class.md) - Documentation for the `Memory` class in Mastra, which provides a robust system for managing conversation history and thread-based message storage.
212
- - [Reference: Observational Memory](references/reference-memory-observational-memory.md) - API reference for Observational Memory in Mastra — a three-tier memory system that uses Observer and Reflector agents to maintain long-term memory across conversations.
213
- - [Reference: OtelBridge](references/reference-observability-tracing-bridges-otel.md) - OpenTelemetry bridge for Tracing
214
- - [Reference: Configuration](references/reference-observability-tracing-configuration.md) - Tracing configuration types and registry functions
215
- - [Reference: ConsoleExporter](references/reference-observability-tracing-exporters-console-exporter.md) - API reference for the ConsoleExporter
216
- - [Reference: DatadogExporter](references/reference-observability-tracing-exporters-datadog.md) - Datadog LLM Observability exporter for Tracing
217
- - [Reference: Tracing](references/reference-observability-tracing-instances.md) - Core Tracing classes and methods
218
- - [Reference: Interfaces](references/reference-observability-tracing-interfaces.md) - Tracing type definitions and interfaces
219
- - [Reference: SensitiveDataFilter](references/reference-observability-tracing-processors-sensitive-data-filter.md) - API reference for the SensitiveDataFilter processor
220
- - [Reference: Spans](references/reference-observability-tracing-spans.md) - Span interfaces, methods, and lifecycle events
221
- - [Reference: Batch Parts Processor](references/reference-processors-batch-parts-processor.md) - Documentation for the BatchPartsProcessor in Mastra, which batches multiple stream parts together to reduce frequency of emissions.
222
- - [Reference: Language Detector](references/reference-processors-language-detector.md) - Documentation for the LanguageDetector in Mastra, which detects language and can translate content in AI responses.
223
- - [Reference: Message History Processor](references/reference-processors-message-history-processor.md) - Documentation for the MessageHistory processor in Mastra, which handles retrieval and persistence of conversation history.
224
- - [Reference: Moderation Processor](references/reference-processors-moderation-processor.md) - Documentation for the ModerationProcessor in Mastra, which provides content moderation using LLM to detect inappropriate content across multiple categories.
225
- - [Reference: PII Detector](references/reference-processors-pii-detector.md) - Documentation for the PIIDetector in Mastra, which detects and redacts personally identifiable information (PII) from AI responses.
226
- - [Reference: Processor Interface](references/reference-processors-processor-interface.md) - API reference for the Processor interface in Mastra, which defines the contract for transforming, validating, and controlling messages in agent pipelines.
227
- - [Reference: Prompt Injection Detector](references/reference-processors-prompt-injection-detector.md) - Documentation for the PromptInjectionDetector in Mastra, which detects prompt injection attempts in user input.
228
- - [Reference: Semantic Recall Processor](references/reference-processors-semantic-recall-processor.md) - Documentation for the SemanticRecall processor in Mastra, which enables semantic search over conversation history using vector embeddings.
229
- - [Reference: System Prompt Scrubber](references/reference-processors-system-prompt-scrubber.md) - Documentation for the SystemPromptScrubber in Mastra, which detects and redacts system prompts from AI responses.
230
- - [Reference: Token Limiter Processor](references/reference-processors-token-limiter-processor.md) - Documentation for the TokenLimiterProcessor in Mastra, which limits the number of tokens in messages.
231
- - [Reference: Tool Call Filter](references/reference-processors-tool-call-filter.md) - Documentation for the ToolCallFilter processor in Mastra, which filters out tool calls and results from messages.
232
- - [Reference: ToolSearchProcessor](references/reference-processors-tool-search-processor.md) - Documentation for the ToolSearchProcessor in Mastra, which enables dynamic tool discovery and loading for agents with large tool libraries.
233
- - [Reference: Unicode Normalizer](references/reference-processors-unicode-normalizer.md) - Documentation for the UnicodeNormalizer in Mastra, which normalizes Unicode text to ensure consistent formatting and remove potentially problematic characters.
234
- - [Reference: Working Memory Processor](references/reference-processors-working-memory-processor.md) - Documentation for the WorkingMemory processor in Mastra, which injects persistent user/context data as system instructions.
235
- - [Reference: DatabaseConfig](references/reference-rag-database-config.md) - API reference for database-specific configuration types used with vector query tools in Mastra RAG systems.
236
- - [Reference: Embed](references/reference-rag-embeddings.md) - Documentation for embedding functionality in Mastra using the AI SDK.
237
- - [Reference: MastraServer](references/reference-server-mastra-server.md) - API reference for the MastraServer abstract class used to create server adapters.
238
- - [Reference: registerApiRoute()](references/reference-server-register-api-route.md) - API reference for registerApiRoute() function used to define custom HTTP routes for the Mastra server.
239
- - [Reference: Cloudflare D1 Storage](references/reference-storage-cloudflare-d1.md) - Documentation for the Cloudflare D1 SQL storage implementation in Mastra.
240
- - [Reference: Composite Storage](references/reference-storage-composite.md) - Documentation for combining multiple storage backends in Mastra.
241
- - [Reference: LanceDB Storage](references/reference-storage-lance.md) - Documentation for the LanceDB storage implementation in Mastra.
242
- - [Reference: libSQL Storage](references/reference-storage-libsql.md) - Documentation for the libSQL storage implementation in Mastra.
243
- - [Reference: MongoDB Storage](references/reference-storage-mongodb.md) - Documentation for the MongoDB storage implementation in Mastra.
244
- - [Reference: MSSQL Storage](references/reference-storage-mssql.md) - Documentation for the MSSQL storage implementation in Mastra.
245
- - [Reference: Storage Overview](references/reference-storage-overview.md) - Core data schema and table structure for Mastra's storage system.
246
- - [Reference: PostgreSQL Storage](references/reference-storage-postgresql.md) - Documentation for the PostgreSQL storage implementation in Mastra.
247
- - [Reference: Upstash Storage](references/reference-storage-upstash.md) - Documentation for the Upstash storage implementation in Mastra.
248
- - [Reference: MastraModelOutput](references/reference-streaming-agents-MastraModelOutput.md) - Complete reference for MastraModelOutput - the stream object returned by agent.stream() with streaming and promise-based access to model outputs.
249
- - [Reference: Agent.streamLegacy() (Legacy)](references/reference-streaming-agents-streamLegacy.md) - Documentation for the legacy `Agent.streamLegacy()` method in Mastra agents. This method is deprecated and will be removed in a future version.
250
- - [Reference: ChunkType](references/reference-streaming-ChunkType.md) - Documentation for the ChunkType type used in Mastra streaming responses, defining all possible chunk types and their payloads.
251
- - [Reference: Run.observeStream()](references/reference-streaming-workflows-observeStream.md) - Documentation for the `Run.observeStream()` method in workflows, which enables reopening the stream of an already active workflow run.
252
- - [Reference: Run.resumeStream()](references/reference-streaming-workflows-resumeStream.md) - Documentation for the `Run.resumeStream()` method in workflows, which enables real-time resumption and streaming of suspended workflow runs.
253
- - [Reference: Run.stream()](references/reference-streaming-workflows-stream.md) - Documentation for the `Run.stream()` method in workflows, which enables real-time streaming of responses.
254
- - [Reference: Run.timeTravelStream()](references/reference-streaming-workflows-timeTravelStream.md) - Documentation for the `Run.timeTravelStream()` method for streaming workflow time travel execution.
255
- - [Reference: LLM provider API keys (choose one or more)](references/reference-templates-overview.md) - Complete guide to creating, using, and contributing Mastra templates
256
- - [Reference: createTool()](references/reference-tools-create-tool.md) - Documentation for the `createTool()` function in Mastra, used to define custom tools for agents.
257
- - [Reference: createGraphRAGTool()](references/reference-tools-graph-rag-tool.md) - Documentation for the GraphRAG Tool in Mastra, which enhances RAG by building a graph of semantic relationships between documents.
258
- - [Reference: MCPClient](references/reference-tools-mcp-client.md) - API Reference for MCPClient - A class for managing multiple Model Context Protocol servers and their tools.
259
- - [Reference: MCPServer](references/reference-tools-mcp-server.md) - API Reference for MCPServer - A class for exposing Mastra tools and capabilities as a Model Context Protocol server.
260
- - [Reference: createVectorQueryTool()](references/reference-tools-vector-query-tool.md) - Documentation for the Vector Query Tool in Mastra, which facilitates semantic search over vector stores with filtering and reranking capabilities.
261
- - [Reference: libSQL Vector Store](references/reference-vectors-libsql.md) - Documentation for the LibSQLVector class in Mastra, which provides vector search using libSQL with vector extensions.
262
- - [Reference: MongoDB Vector Store](references/reference-vectors-mongodb.md) - Documentation for the MongoDBVector class in Mastra, which provides vector search using MongoDB Atlas and Atlas Vector Search.
263
- - [Reference: PG Vector Store](references/reference-vectors-pg.md) - Documentation for the PgVector class in Mastra, which provides vector search using PostgreSQL with pgvector extension.
264
- - [Reference: Upstash Vector Store](references/reference-vectors-upstash.md) - Documentation for the UpstashVector class in Mastra, which provides vector search using Upstash Vector.
265
- - [Reference: CompositeVoice](references/reference-voice-composite-voice.md) - Documentation for the CompositeVoice class, which enables combining multiple voice providers for flexible text-to-speech and speech-to-text operations.
266
- - [Reference: MastraVoice](references/reference-voice-mastra-voice.md) - Documentation for the MastraVoice abstract base class, which defines the core interface for all voice services in Mastra, including speech-to-speech capabilities.
267
- - [Reference: voice.addInstructions()](references/reference-voice-voice.addInstructions.md) - Documentation for the addInstructions() method available in voice providers, which adds instructions to guide the voice model's behavior.
268
- - [Reference: voice.addTools()](references/reference-voice-voice.addTools.md) - Documentation for the addTools() method available in voice providers, which equips voice models with function calling capabilities.
269
- - [Reference: voice.connect()](references/reference-voice-voice.connect.md) - Documentation for the connect() method available in real-time voice providers, which establishes a connection for speech-to-speech communication.
270
- - [Reference: Voice Events](references/reference-voice-voice.events.md) - Documentation for events emitted by voice providers, particularly for real-time voice interactions.
271
- - [Reference: voice.listen()](references/reference-voice-voice.listen.md) - Documentation for the listen() method available in all Mastra voice providers, which converts speech to text.
272
- - [Reference: voice.on()](references/reference-voice-voice.on.md) - Documentation for the on() method available in voice providers, which registers event listeners for voice events.
273
- - [Reference: voice.speak()](references/reference-voice-voice.speak.md) - Documentation for the speak() method available in all Mastra voice providers, which converts text to speech.
274
- - [Reference: Run Class](references/reference-workflows-run.md) - Documentation for the Run class in Mastra, which represents a workflow execution instance.
275
- - [Reference: Run.cancel()](references/reference-workflows-run-methods-cancel.md) - Documentation for the `Run.cancel()` method in workflows, which cancels a workflow run.
276
- - [Reference: Run.restart()](references/reference-workflows-run-methods-restart.md) - Documentation for the `Run.restart()` method in workflows, which restarts an active workflow run that lost connection to the server.
277
- - [Reference: Run.resume()](references/reference-workflows-run-methods-resume.md) - Documentation for the `Run.resume()` method in workflows, which resumes a suspended workflow run with new data.
278
- - [Reference: Run.start()](references/reference-workflows-run-methods-start.md) - Documentation for the `Run.start()` method in workflows, which starts a workflow run with input data.
279
- - [Reference: Run.startAsync()](references/reference-workflows-run-methods-startAsync.md) - Documentation for the `Run.startAsync()` method in workflows, which starts a workflow run without waiting for completion (fire-and-forget).
280
- - [Reference: Run.timeTravel()](references/reference-workflows-run-methods-timeTravel.md) - Documentation for the `Run.timeTravel()` method in workflows, which re-executes a workflow from a specific step.
281
- - [Reference: Step Class](references/reference-workflows-step.md) - Documentation for the Step class in Mastra, which defines individual units of work within a workflow.
282
- - [Reference: Workflow Class](references/reference-workflows-workflow.md) - Documentation for the `Workflow` class in Mastra, which enables you to create state machines for complex sequences of operations with conditional branching and data validation.
283
- - [Reference: Workflow.branch()](references/reference-workflows-workflow-methods-branch.md) - Documentation for the `Workflow.branch()` method in workflows, which creates conditional branches between steps.
284
- - [Reference: Workflow.commit()](references/reference-workflows-workflow-methods-commit.md) - Documentation for the `Workflow.commit()` method in workflows, which finalizes the workflow and returns the final result.
285
- - [Reference: Workflow.createRun()](references/reference-workflows-workflow-methods-create-run.md) - Documentation for the `Workflow.createRun()` method in workflows, which creates a new workflow run instance.
286
- - [Reference: Workflow.dountil()](references/reference-workflows-workflow-methods-dountil.md) - Documentation for the `Workflow.dountil()` method in workflows, which creates a loop that executes a step until a condition is met.
287
- - [Reference: Workflow.dowhile()](references/reference-workflows-workflow-methods-dowhile.md) - Documentation for the `Workflow.dowhile()` method in workflows, which creates a loop that executes a step while a condition is met.
288
- - [Reference: Workflow.foreach()](references/reference-workflows-workflow-methods-foreach.md) - Documentation for the `Workflow.foreach()` method in workflows, which creates a loop that executes a step for each item in an array.
289
- - [Reference: Workflow.map()](references/reference-workflows-workflow-methods-map.md) - Documentation for the `Workflow.map()` method in workflows, which maps output data from a previous step to the input of a subsequent step.
290
- - [Reference: Workflow.parallel()](references/reference-workflows-workflow-methods-parallel.md) - Documentation for the `Workflow.parallel()` method in workflows, which executes multiple steps in parallel.
291
- - [Reference: Workflow.sleep()](references/reference-workflows-workflow-methods-sleep.md) - Documentation for the `Workflow.sleep()` method in workflows, which pauses execution for a specified number of milliseconds.
292
- - [Reference: Workflow.sleepUntil()](references/reference-workflows-workflow-methods-sleepUntil.md) - Documentation for the `Workflow.sleepUntil()` method in workflows, which pauses execution until a specified date.
293
- - [Reference: Workflow.then()](references/reference-workflows-workflow-methods-then.md) - Documentation for the `Workflow.then()` method in workflows, which creates sequential dependencies between steps.
294
- - [Reference: WorkspaceFilesystem](references/reference-workspace-filesystem.md) - Documentation for the WorkspaceFilesystem interface that defines file storage operations.
295
- - [Reference: LocalFilesystem](references/reference-workspace-local-filesystem.md) - Documentation for the LocalFilesystem provider for local disk storage.
296
- - [Reference: LocalSandbox](references/reference-workspace-local-sandbox.md) - Documentation for the LocalSandbox provider for local command execution.
297
- - [Reference: WorkspaceSandbox](references/reference-workspace-sandbox.md) - Documentation for the WorkspaceSandbox interface that defines command execution operations.
298
- - [Reference: Workspace Class](references/reference-workspace-workspace-class.md) - Documentation for the Workspace class, the central API for filesystem access, sandbox execution, and search in Mastra.
299
-
300
-
301
- Read [assets/SOURCE_MAP.json](assets/SOURCE_MAP.json) for source code references.