@mastra/core 1.7.0 → 1.8.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 (498) hide show
  1. package/CHANGELOG.md +218 -0
  2. package/dist/agent/agent-legacy.d.ts +15 -0
  3. package/dist/agent/agent-legacy.d.ts.map +1 -1
  4. package/dist/agent/agent.d.ts +7 -0
  5. package/dist/agent/agent.d.ts.map +1 -1
  6. package/dist/agent/agent.types.d.ts +311 -2
  7. package/dist/agent/agent.types.d.ts.map +1 -1
  8. package/dist/agent/index.cjs +13 -13
  9. package/dist/agent/index.d.ts +3 -1
  10. package/dist/agent/index.d.ts.map +1 -1
  11. package/dist/agent/index.js +2 -2
  12. package/dist/agent/message-list/index.cjs +18 -18
  13. package/dist/agent/message-list/index.js +1 -1
  14. package/dist/agent/message-list/merge/MessageMerger.d.ts.map +1 -1
  15. package/dist/agent/message-list/message-list.d.ts.map +1 -1
  16. package/dist/agent/workflows/prepare-stream/map-results-step.d.ts.map +1 -1
  17. package/dist/agent/workflows/prepare-stream/prepare-tools-step.d.ts.map +1 -1
  18. package/dist/{chunk-A72NTLFT.cjs → chunk-2IO5Q7OZ.cjs} +7 -7
  19. package/dist/{chunk-A72NTLFT.cjs.map → chunk-2IO5Q7OZ.cjs.map} +1 -1
  20. package/dist/{chunk-DFCRXDVK.js → chunk-2KHPZJNU.js} +10 -8
  21. package/dist/chunk-2KHPZJNU.js.map +1 -0
  22. package/dist/{chunk-R4N65TLG.js → chunk-2R5MQMSA.js} +35 -16
  23. package/dist/chunk-2R5MQMSA.js.map +1 -0
  24. package/dist/{chunk-ZSBM2SVU.js → chunk-4H5F6AFP.js} +1064 -226
  25. package/dist/chunk-4H5F6AFP.js.map +1 -0
  26. package/dist/{chunk-BQHWJLXU.js → chunk-63G75DJE.js} +9 -3
  27. package/dist/chunk-63G75DJE.js.map +1 -0
  28. package/dist/{chunk-SBOHDNIZ.cjs → chunk-6GSWC5ZA.cjs} +2 -2
  29. package/dist/{chunk-SBOHDNIZ.cjs.map → chunk-6GSWC5ZA.cjs.map} +1 -1
  30. package/dist/{chunk-QTAS3HND.cjs → chunk-6Q2UD3XF.cjs} +21 -14
  31. package/dist/chunk-6Q2UD3XF.cjs.map +1 -0
  32. package/dist/{chunk-GPJGPARM.js → chunk-DTPR3JAM.js} +2 -2
  33. package/dist/{chunk-GPJGPARM.js.map → chunk-DTPR3JAM.js.map} +1 -1
  34. package/dist/{chunk-NN26FSKL.js → chunk-FHJ2KIU5.js} +3 -3
  35. package/dist/{chunk-NN26FSKL.js.map → chunk-FHJ2KIU5.js.map} +1 -1
  36. package/dist/{chunk-RABITNTG.cjs → chunk-HWG7NPJA.cjs} +55 -55
  37. package/dist/{chunk-RABITNTG.cjs.map → chunk-HWG7NPJA.cjs.map} +1 -1
  38. package/dist/{chunk-HB6T4554.cjs → chunk-KH3G65IS.cjs} +10 -8
  39. package/dist/chunk-KH3G65IS.cjs.map +1 -0
  40. package/dist/{chunk-YQG7NBPR.cjs → chunk-KZ4IKNPN.cjs} +25 -23
  41. package/dist/chunk-KZ4IKNPN.cjs.map +1 -0
  42. package/dist/{chunk-6DUTLERJ.js → chunk-MRV5NCPC.js} +3 -3
  43. package/dist/{chunk-6DUTLERJ.js.map → chunk-MRV5NCPC.js.map} +1 -1
  44. package/dist/{chunk-O7PZ4VOO.cjs → chunk-N3ROEJG4.cjs} +12 -10
  45. package/dist/chunk-N3ROEJG4.cjs.map +1 -0
  46. package/dist/{chunk-7EXW4AAG.js → chunk-NXKI2L4X.js} +6 -4
  47. package/dist/chunk-NXKI2L4X.js.map +1 -0
  48. package/dist/{chunk-QWTB53GS.js → chunk-OSEPGSLN.js} +6 -6
  49. package/dist/{chunk-QWTB53GS.js.map → chunk-OSEPGSLN.js.map} +1 -1
  50. package/dist/{chunk-6OXW5E2O.js → chunk-PI7ONENO.js} +4 -4
  51. package/dist/{chunk-6OXW5E2O.js.map → chunk-PI7ONENO.js.map} +1 -1
  52. package/dist/{chunk-KUXNBWN7.js → chunk-Q4MV4XKX.js} +8 -6
  53. package/dist/chunk-Q4MV4XKX.js.map +1 -0
  54. package/dist/{chunk-7UAJ6LMR.cjs → chunk-QKQGKEN7.cjs} +1078 -241
  55. package/dist/chunk-QKQGKEN7.cjs.map +1 -0
  56. package/dist/{chunk-IC5OUWKJ.js → chunk-SP7P6Z4L.js} +19 -2
  57. package/dist/chunk-SP7P6Z4L.js.map +1 -0
  58. package/dist/{chunk-QDH6MVJ7.cjs → chunk-TGUDI64A.cjs} +14 -14
  59. package/dist/{chunk-QDH6MVJ7.cjs.map → chunk-TGUDI64A.cjs.map} +1 -1
  60. package/dist/{chunk-EAZ6YDCQ.cjs → chunk-U3HBG2GU.cjs} +9 -2
  61. package/dist/chunk-U3HBG2GU.cjs.map +1 -0
  62. package/dist/{chunk-6QBN6MZY.cjs → chunk-VAKB5EXJ.cjs} +42 -23
  63. package/dist/chunk-VAKB5EXJ.cjs.map +1 -0
  64. package/dist/{chunk-QSHV7GPT.js → chunk-VBPU6CLZ.js} +3808 -3026
  65. package/dist/chunk-VBPU6CLZ.js.map +1 -0
  66. package/dist/{chunk-2X66GWF5.cjs → chunk-VTVCMIAI.cjs} +3905 -3121
  67. package/dist/chunk-VTVCMIAI.cjs.map +1 -0
  68. package/dist/{chunk-PHHJLGZU.cjs → chunk-XNWF6CYR.cjs} +6 -6
  69. package/dist/{chunk-PHHJLGZU.cjs.map → chunk-XNWF6CYR.cjs.map} +1 -1
  70. package/dist/{chunk-T6GAM3SQ.js → chunk-ZRPTWYWJ.js} +18 -11
  71. package/dist/chunk-ZRPTWYWJ.js.map +1 -0
  72. package/dist/{chunk-DB7U2C5B.cjs → chunk-ZXOWG32X.cjs} +19 -2
  73. package/dist/chunk-ZXOWG32X.cjs.map +1 -0
  74. package/dist/datasets/experiment/index.d.ts.map +1 -1
  75. package/dist/datasets/experiment/scorer.d.ts +1 -1
  76. package/dist/datasets/experiment/scorer.d.ts.map +1 -1
  77. package/dist/datasets/index.cjs +17 -17
  78. package/dist/datasets/index.js +2 -2
  79. package/dist/docs/SKILL.md +300 -0
  80. package/dist/docs/assets/SOURCE_MAP.json +1423 -0
  81. package/dist/docs/references/docs-agents-adding-voice.md +349 -0
  82. package/dist/docs/references/docs-agents-agent-approval.md +558 -0
  83. package/dist/docs/references/docs-agents-agent-memory.md +209 -0
  84. package/dist/docs/references/docs-agents-guardrails.md +374 -0
  85. package/dist/docs/references/docs-agents-network-approval.md +275 -0
  86. package/dist/docs/references/docs-agents-networks.md +299 -0
  87. package/dist/docs/references/docs-agents-overview.md +304 -0
  88. package/dist/docs/references/docs-agents-processors.md +622 -0
  89. package/dist/docs/references/docs-agents-structured-output.md +273 -0
  90. package/dist/docs/references/docs-agents-supervisor-agents.md +304 -0
  91. package/dist/docs/references/docs-agents-using-tools.md +214 -0
  92. package/dist/docs/references/docs-evals-custom-scorers.md +519 -0
  93. package/dist/docs/references/docs-evals-overview.md +141 -0
  94. package/dist/docs/references/docs-evals-running-in-ci.md +124 -0
  95. package/dist/docs/references/docs-memory-memory-processors.md +314 -0
  96. package/dist/docs/references/docs-memory-observational-memory.md +248 -0
  97. package/dist/docs/references/docs-memory-overview.md +45 -0
  98. package/dist/docs/references/docs-memory-semantic-recall.md +272 -0
  99. package/dist/docs/references/docs-memory-storage.md +261 -0
  100. package/dist/docs/references/docs-memory-working-memory.md +400 -0
  101. package/dist/docs/references/docs-observability-datasets-overview.md +198 -0
  102. package/dist/docs/references/docs-observability-datasets-running-experiments.md +274 -0
  103. package/dist/docs/references/docs-observability-logging.md +99 -0
  104. package/dist/docs/references/docs-observability-overview.md +70 -0
  105. package/dist/docs/references/docs-observability-tracing-bridges-otel.md +209 -0
  106. package/dist/docs/references/docs-observability-tracing-exporters-arize.md +272 -0
  107. package/dist/docs/references/docs-observability-tracing-exporters-braintrust.md +111 -0
  108. package/dist/docs/references/docs-observability-tracing-exporters-cloud.md +127 -0
  109. package/dist/docs/references/docs-observability-tracing-exporters-datadog.md +187 -0
  110. package/dist/docs/references/docs-observability-tracing-exporters-default.md +209 -0
  111. package/dist/docs/references/docs-observability-tracing-exporters-laminar.md +100 -0
  112. package/dist/docs/references/docs-observability-tracing-exporters-langfuse.md +213 -0
  113. package/dist/docs/references/docs-observability-tracing-exporters-langsmith.md +198 -0
  114. package/dist/docs/references/docs-observability-tracing-exporters-otel.md +476 -0
  115. package/dist/docs/references/docs-observability-tracing-exporters-posthog.md +148 -0
  116. package/dist/docs/references/docs-observability-tracing-overview.md +1112 -0
  117. package/dist/docs/references/docs-rag-chunking-and-embedding.md +183 -0
  118. package/dist/docs/references/docs-rag-graph-rag.md +215 -0
  119. package/dist/docs/references/docs-rag-overview.md +72 -0
  120. package/dist/docs/references/docs-rag-retrieval.md +515 -0
  121. package/dist/docs/references/docs-rag-vector-databases.md +645 -0
  122. package/dist/docs/references/docs-server-auth-auth0.md +220 -0
  123. package/dist/docs/references/docs-server-auth-clerk.md +132 -0
  124. package/dist/docs/references/docs-server-auth-composite-auth.md +234 -0
  125. package/dist/docs/references/docs-server-auth-custom-auth-provider.md +513 -0
  126. package/dist/docs/references/docs-server-auth-firebase.md +272 -0
  127. package/dist/docs/references/docs-server-auth-jwt.md +110 -0
  128. package/dist/docs/references/docs-server-auth-simple-auth.md +180 -0
  129. package/dist/docs/references/docs-server-auth-supabase.md +117 -0
  130. package/dist/docs/references/docs-server-auth-workos.md +186 -0
  131. package/dist/docs/references/docs-server-custom-adapters.md +378 -0
  132. package/dist/docs/references/docs-server-custom-api-routes.md +267 -0
  133. package/dist/docs/references/docs-server-mastra-client.md +243 -0
  134. package/dist/docs/references/docs-server-mastra-server.md +71 -0
  135. package/dist/docs/references/docs-server-middleware.md +225 -0
  136. package/dist/docs/references/docs-server-request-context.md +471 -0
  137. package/dist/docs/references/docs-streaming-events.md +237 -0
  138. package/dist/docs/references/docs-streaming-tool-streaming.md +175 -0
  139. package/dist/docs/references/docs-streaming-workflow-streaming.md +109 -0
  140. package/dist/docs/references/docs-voice-overview.md +959 -0
  141. package/dist/docs/references/docs-voice-speech-to-speech.md +102 -0
  142. package/dist/docs/references/docs-voice-speech-to-text.md +79 -0
  143. package/dist/docs/references/docs-voice-text-to-speech.md +83 -0
  144. package/dist/docs/references/docs-workflows-agents-and-tools.md +166 -0
  145. package/dist/docs/references/docs-workflows-control-flow.md +822 -0
  146. package/dist/docs/references/docs-workflows-error-handling.md +360 -0
  147. package/dist/docs/references/docs-workflows-human-in-the-loop.md +215 -0
  148. package/dist/docs/references/docs-workflows-overview.md +370 -0
  149. package/dist/docs/references/docs-workflows-snapshots.md +238 -0
  150. package/dist/docs/references/docs-workflows-suspend-and-resume.md +205 -0
  151. package/dist/docs/references/docs-workflows-time-travel.md +309 -0
  152. package/dist/docs/references/docs-workflows-workflow-state.md +181 -0
  153. package/dist/docs/references/docs-workspace-filesystem.md +164 -0
  154. package/dist/docs/references/docs-workspace-overview.md +239 -0
  155. package/dist/docs/references/docs-workspace-sandbox.md +63 -0
  156. package/dist/docs/references/docs-workspace-search.md +243 -0
  157. package/dist/docs/references/docs-workspace-skills.md +169 -0
  158. package/dist/docs/references/guides-agent-frameworks-ai-sdk.md +140 -0
  159. package/dist/docs/references/reference-agents-agent.md +141 -0
  160. package/dist/docs/references/reference-agents-generate.md +186 -0
  161. package/dist/docs/references/reference-agents-generateLegacy.md +173 -0
  162. package/dist/docs/references/reference-agents-getDefaultGenerateOptions.md +36 -0
  163. package/dist/docs/references/reference-agents-getDefaultOptions.md +34 -0
  164. package/dist/docs/references/reference-agents-getDefaultStreamOptions.md +36 -0
  165. package/dist/docs/references/reference-agents-getDescription.md +21 -0
  166. package/dist/docs/references/reference-agents-getInstructions.md +34 -0
  167. package/dist/docs/references/reference-agents-getLLM.md +37 -0
  168. package/dist/docs/references/reference-agents-getMemory.md +34 -0
  169. package/dist/docs/references/reference-agents-getModel.md +34 -0
  170. package/dist/docs/references/reference-agents-getTools.md +29 -0
  171. package/dist/docs/references/reference-agents-getVoice.md +34 -0
  172. package/dist/docs/references/reference-agents-listAgents.md +35 -0
  173. package/dist/docs/references/reference-agents-listScorers.md +34 -0
  174. package/dist/docs/references/reference-agents-listTools.md +34 -0
  175. package/dist/docs/references/reference-agents-listWorkflows.md +34 -0
  176. package/dist/docs/references/reference-agents-network.md +133 -0
  177. package/dist/docs/references/reference-ai-sdk-chat-route.md +82 -0
  178. package/dist/docs/references/reference-ai-sdk-network-route.md +74 -0
  179. package/dist/docs/references/reference-ai-sdk-to-ai-sdk-stream.md +231 -0
  180. package/dist/docs/references/reference-ai-sdk-with-mastra.md +59 -0
  181. package/dist/docs/references/reference-ai-sdk-workflow-route.md +79 -0
  182. package/dist/docs/references/reference-auth-auth0.md +73 -0
  183. package/dist/docs/references/reference-auth-clerk.md +36 -0
  184. package/dist/docs/references/reference-auth-firebase.md +80 -0
  185. package/dist/docs/references/reference-auth-jwt.md +26 -0
  186. package/dist/docs/references/reference-auth-supabase.md +33 -0
  187. package/dist/docs/references/reference-auth-workos.md +84 -0
  188. package/dist/docs/references/reference-client-js-agents.md +437 -0
  189. package/dist/docs/references/reference-configuration.md +752 -0
  190. package/dist/docs/references/reference-core-addGateway.md +42 -0
  191. package/dist/docs/references/reference-core-getAgent.md +21 -0
  192. package/dist/docs/references/reference-core-getAgentById.md +21 -0
  193. package/dist/docs/references/reference-core-getDeployer.md +22 -0
  194. package/dist/docs/references/reference-core-getGateway.md +38 -0
  195. package/dist/docs/references/reference-core-getGatewayById.md +41 -0
  196. package/dist/docs/references/reference-core-getLogger.md +22 -0
  197. package/dist/docs/references/reference-core-getMCPServer.md +47 -0
  198. package/dist/docs/references/reference-core-getMCPServerById.md +55 -0
  199. package/dist/docs/references/reference-core-getMemory.md +50 -0
  200. package/dist/docs/references/reference-core-getScorer.md +54 -0
  201. package/dist/docs/references/reference-core-getScorerById.md +54 -0
  202. package/dist/docs/references/reference-core-getServer.md +22 -0
  203. package/dist/docs/references/reference-core-getStorage.md +22 -0
  204. package/dist/docs/references/reference-core-getStoredAgentById.md +89 -0
  205. package/dist/docs/references/reference-core-getTelemetry.md +22 -0
  206. package/dist/docs/references/reference-core-getVector.md +22 -0
  207. package/dist/docs/references/reference-core-getWorkflow.md +42 -0
  208. package/dist/docs/references/reference-core-listAgents.md +21 -0
  209. package/dist/docs/references/reference-core-listGateways.md +40 -0
  210. package/dist/docs/references/reference-core-listLogs.md +38 -0
  211. package/dist/docs/references/reference-core-listLogsByRunId.md +36 -0
  212. package/dist/docs/references/reference-core-listMCPServers.md +55 -0
  213. package/dist/docs/references/reference-core-listMemory.md +56 -0
  214. package/dist/docs/references/reference-core-listScorers.md +29 -0
  215. package/dist/docs/references/reference-core-listStoredAgents.md +93 -0
  216. package/dist/docs/references/reference-core-listVectors.md +22 -0
  217. package/dist/docs/references/reference-core-listWorkflows.md +21 -0
  218. package/dist/docs/references/reference-core-mastra-class.md +66 -0
  219. package/dist/docs/references/reference-core-mastra-model-gateway.md +153 -0
  220. package/dist/docs/references/reference-core-setLogger.md +26 -0
  221. package/dist/docs/references/reference-core-setStorage.md +27 -0
  222. package/dist/docs/references/reference-datasets-addItem.md +37 -0
  223. package/dist/docs/references/reference-datasets-addItems.md +35 -0
  224. package/dist/docs/references/reference-datasets-compareExperiments.md +52 -0
  225. package/dist/docs/references/reference-datasets-create.md +51 -0
  226. package/dist/docs/references/reference-datasets-dataset.md +82 -0
  227. package/dist/docs/references/reference-datasets-datasets-manager.md +94 -0
  228. package/dist/docs/references/reference-datasets-delete.md +25 -0
  229. package/dist/docs/references/reference-datasets-deleteExperiment.md +27 -0
  230. package/dist/docs/references/reference-datasets-deleteItem.md +27 -0
  231. package/dist/docs/references/reference-datasets-deleteItems.md +29 -0
  232. package/dist/docs/references/reference-datasets-get.md +31 -0
  233. package/dist/docs/references/reference-datasets-getDetails.md +47 -0
  234. package/dist/docs/references/reference-datasets-getExperiment.md +30 -0
  235. package/dist/docs/references/reference-datasets-getItem.md +33 -0
  236. package/dist/docs/references/reference-datasets-getItemHistory.md +31 -0
  237. package/dist/docs/references/reference-datasets-list.md +31 -0
  238. package/dist/docs/references/reference-datasets-listExperimentResults.md +39 -0
  239. package/dist/docs/references/reference-datasets-listExperiments.md +33 -0
  240. package/dist/docs/references/reference-datasets-listItems.md +46 -0
  241. package/dist/docs/references/reference-datasets-listVersions.md +33 -0
  242. package/dist/docs/references/reference-datasets-startExperiment.md +62 -0
  243. package/dist/docs/references/reference-datasets-startExperimentAsync.md +43 -0
  244. package/dist/docs/references/reference-datasets-update.md +48 -0
  245. package/dist/docs/references/reference-datasets-updateItem.md +38 -0
  246. package/dist/docs/references/reference-evals-answer-relevancy.md +105 -0
  247. package/dist/docs/references/reference-evals-answer-similarity.md +99 -0
  248. package/dist/docs/references/reference-evals-bias.md +120 -0
  249. package/dist/docs/references/reference-evals-completeness.md +136 -0
  250. package/dist/docs/references/reference-evals-content-similarity.md +101 -0
  251. package/dist/docs/references/reference-evals-context-precision.md +196 -0
  252. package/dist/docs/references/reference-evals-create-scorer.md +270 -0
  253. package/dist/docs/references/reference-evals-faithfulness.md +114 -0
  254. package/dist/docs/references/reference-evals-hallucination.md +213 -0
  255. package/dist/docs/references/reference-evals-keyword-coverage.md +128 -0
  256. package/dist/docs/references/reference-evals-mastra-scorer.md +123 -0
  257. package/dist/docs/references/reference-evals-run-evals.md +179 -0
  258. package/dist/docs/references/reference-evals-scorer-utils.md +326 -0
  259. package/dist/docs/references/reference-evals-textual-difference.md +113 -0
  260. package/dist/docs/references/reference-evals-tone-consistency.md +119 -0
  261. package/dist/docs/references/reference-evals-toxicity.md +123 -0
  262. package/dist/docs/references/reference-harness-harness-class.md +708 -0
  263. package/dist/docs/references/reference-logging-pino-logger.md +117 -0
  264. package/dist/docs/references/reference-memory-deleteMessages.md +38 -0
  265. package/dist/docs/references/reference-memory-memory-class.md +147 -0
  266. package/dist/docs/references/reference-memory-observational-memory.md +565 -0
  267. package/dist/docs/references/reference-observability-tracing-bridges-otel.md +131 -0
  268. package/dist/docs/references/reference-observability-tracing-configuration.md +178 -0
  269. package/dist/docs/references/reference-observability-tracing-exporters-console-exporter.md +138 -0
  270. package/dist/docs/references/reference-observability-tracing-exporters-datadog.md +116 -0
  271. package/dist/docs/references/reference-observability-tracing-instances.md +107 -0
  272. package/dist/docs/references/reference-observability-tracing-interfaces.md +743 -0
  273. package/dist/docs/references/reference-observability-tracing-processors-sensitive-data-filter.md +144 -0
  274. package/dist/docs/references/reference-observability-tracing-spans.md +224 -0
  275. package/dist/docs/references/reference-processors-batch-parts-processor.md +61 -0
  276. package/dist/docs/references/reference-processors-language-detector.md +82 -0
  277. package/dist/docs/references/reference-processors-message-history-processor.md +85 -0
  278. package/dist/docs/references/reference-processors-moderation-processor.md +104 -0
  279. package/dist/docs/references/reference-processors-pii-detector.md +108 -0
  280. package/dist/docs/references/reference-processors-processor-interface.md +521 -0
  281. package/dist/docs/references/reference-processors-prompt-injection-detector.md +72 -0
  282. package/dist/docs/references/reference-processors-semantic-recall-processor.md +117 -0
  283. package/dist/docs/references/reference-processors-system-prompt-scrubber.md +80 -0
  284. package/dist/docs/references/reference-processors-token-limiter-processor.md +115 -0
  285. package/dist/docs/references/reference-processors-tool-call-filter.md +85 -0
  286. package/dist/docs/references/reference-processors-tool-search-processor.md +111 -0
  287. package/dist/docs/references/reference-processors-unicode-normalizer.md +62 -0
  288. package/dist/docs/references/reference-processors-working-memory-processor.md +152 -0
  289. package/dist/docs/references/reference-rag-database-config.md +261 -0
  290. package/dist/docs/references/reference-rag-embeddings.md +92 -0
  291. package/dist/docs/references/reference-server-mastra-server.md +298 -0
  292. package/dist/docs/references/reference-server-register-api-route.md +249 -0
  293. package/dist/docs/references/reference-storage-cloudflare-d1.md +218 -0
  294. package/dist/docs/references/reference-storage-composite.md +235 -0
  295. package/dist/docs/references/reference-storage-lance.md +131 -0
  296. package/dist/docs/references/reference-storage-libsql.md +135 -0
  297. package/dist/docs/references/reference-storage-mongodb.md +262 -0
  298. package/dist/docs/references/reference-storage-mssql.md +157 -0
  299. package/dist/docs/references/reference-storage-overview.md +121 -0
  300. package/dist/docs/references/reference-storage-postgresql.md +526 -0
  301. package/dist/docs/references/reference-storage-upstash.md +160 -0
  302. package/dist/docs/references/reference-streaming-ChunkType.md +292 -0
  303. package/dist/docs/references/reference-streaming-agents-MastraModelOutput.md +182 -0
  304. package/dist/docs/references/reference-streaming-agents-streamLegacy.md +142 -0
  305. package/dist/docs/references/reference-streaming-workflows-observeStream.md +42 -0
  306. package/dist/docs/references/reference-streaming-workflows-resumeStream.md +61 -0
  307. package/dist/docs/references/reference-streaming-workflows-stream.md +88 -0
  308. package/dist/docs/references/reference-streaming-workflows-timeTravelStream.md +142 -0
  309. package/dist/docs/references/reference-templates-overview.md +194 -0
  310. package/dist/docs/references/reference-tools-create-tool.md +237 -0
  311. package/dist/docs/references/reference-tools-graph-rag-tool.md +182 -0
  312. package/dist/docs/references/reference-tools-mcp-client.md +954 -0
  313. package/dist/docs/references/reference-tools-mcp-server.md +1271 -0
  314. package/dist/docs/references/reference-tools-vector-query-tool.md +459 -0
  315. package/dist/docs/references/reference-vectors-libsql.md +305 -0
  316. package/dist/docs/references/reference-vectors-mongodb.md +295 -0
  317. package/dist/docs/references/reference-vectors-pg.md +408 -0
  318. package/dist/docs/references/reference-vectors-upstash.md +294 -0
  319. package/dist/docs/references/reference-voice-composite-voice.md +121 -0
  320. package/dist/docs/references/reference-voice-mastra-voice.md +311 -0
  321. package/dist/docs/references/reference-voice-voice.addInstructions.md +55 -0
  322. package/dist/docs/references/reference-voice-voice.addTools.md +67 -0
  323. package/dist/docs/references/reference-voice-voice.connect.md +94 -0
  324. package/dist/docs/references/reference-voice-voice.events.md +37 -0
  325. package/dist/docs/references/reference-voice-voice.listen.md +164 -0
  326. package/dist/docs/references/reference-voice-voice.on.md +111 -0
  327. package/dist/docs/references/reference-voice-voice.speak.md +157 -0
  328. package/dist/docs/references/reference-workflows-run-methods-cancel.md +86 -0
  329. package/dist/docs/references/reference-workflows-run-methods-restart.md +33 -0
  330. package/dist/docs/references/reference-workflows-run-methods-resume.md +59 -0
  331. package/dist/docs/references/reference-workflows-run-methods-start.md +58 -0
  332. package/dist/docs/references/reference-workflows-run-methods-startAsync.md +67 -0
  333. package/dist/docs/references/reference-workflows-run-methods-timeTravel.md +142 -0
  334. package/dist/docs/references/reference-workflows-run.md +59 -0
  335. package/dist/docs/references/reference-workflows-step.md +119 -0
  336. package/dist/docs/references/reference-workflows-workflow-methods-branch.md +25 -0
  337. package/dist/docs/references/reference-workflows-workflow-methods-commit.md +17 -0
  338. package/dist/docs/references/reference-workflows-workflow-methods-create-run.md +63 -0
  339. package/dist/docs/references/reference-workflows-workflow-methods-dountil.md +25 -0
  340. package/dist/docs/references/reference-workflows-workflow-methods-dowhile.md +25 -0
  341. package/dist/docs/references/reference-workflows-workflow-methods-foreach.md +118 -0
  342. package/dist/docs/references/reference-workflows-workflow-methods-map.md +93 -0
  343. package/dist/docs/references/reference-workflows-workflow-methods-parallel.md +21 -0
  344. package/dist/docs/references/reference-workflows-workflow-methods-sleep.md +35 -0
  345. package/dist/docs/references/reference-workflows-workflow-methods-sleepUntil.md +35 -0
  346. package/dist/docs/references/reference-workflows-workflow-methods-then.md +21 -0
  347. package/dist/docs/references/reference-workflows-workflow.md +157 -0
  348. package/dist/docs/references/reference-workspace-filesystem.md +255 -0
  349. package/dist/docs/references/reference-workspace-local-filesystem.md +343 -0
  350. package/dist/docs/references/reference-workspace-local-sandbox.md +301 -0
  351. package/dist/docs/references/reference-workspace-sandbox.md +87 -0
  352. package/dist/docs/references/reference-workspace-workspace-class.md +244 -0
  353. package/dist/docs/references/reference.md +277 -0
  354. package/dist/evals/index.cjs +20 -20
  355. package/dist/evals/index.js +3 -3
  356. package/dist/evals/run/index.d.ts +9 -2
  357. package/dist/evals/run/index.d.ts.map +1 -1
  358. package/dist/evals/scoreTraces/index.cjs +5 -5
  359. package/dist/evals/scoreTraces/index.js +2 -2
  360. package/dist/harness/harness.d.ts +6 -0
  361. package/dist/harness/harness.d.ts.map +1 -1
  362. package/dist/harness/index.cjs +28 -13
  363. package/dist/harness/index.cjs.map +1 -1
  364. package/dist/harness/index.js +20 -5
  365. package/dist/harness/index.js.map +1 -1
  366. package/dist/index.cjs +2 -2
  367. package/dist/index.js +1 -1
  368. package/dist/integration/index.cjs +2 -2
  369. package/dist/integration/index.js +1 -1
  370. package/dist/llm/index.cjs +6 -6
  371. package/dist/llm/index.js +1 -1
  372. package/dist/llm/model/embedding-router.d.ts.map +1 -1
  373. package/dist/llm/model/model.loop.d.ts +1 -1
  374. package/dist/llm/model/model.loop.d.ts.map +1 -1
  375. package/dist/loop/index.cjs +20 -12
  376. package/dist/loop/index.js +1 -1
  377. package/dist/loop/network/index.d.ts.map +1 -1
  378. package/dist/loop/network/validation.d.ts +51 -0
  379. package/dist/loop/network/validation.d.ts.map +1 -1
  380. package/dist/loop/test-utils/generateText.d.ts.map +1 -1
  381. package/dist/loop/test-utils/options.d.ts.map +1 -1
  382. package/dist/loop/test-utils/streamObject.d.ts.map +1 -1
  383. package/dist/loop/types.d.ts +15 -0
  384. package/dist/loop/types.d.ts.map +1 -1
  385. package/dist/loop/workflows/agentic-execution/index.d.ts +3 -0
  386. package/dist/loop/workflows/agentic-execution/index.d.ts.map +1 -1
  387. package/dist/loop/workflows/agentic-execution/is-task-complete-step.d.ts +126 -0
  388. package/dist/loop/workflows/agentic-execution/is-task-complete-step.d.ts.map +1 -0
  389. package/dist/loop/workflows/agentic-execution/llm-execution-step.d.ts +3 -1
  390. package/dist/loop/workflows/agentic-execution/llm-execution-step.d.ts.map +1 -1
  391. package/dist/loop/workflows/agentic-execution/llm-mapping-step.d.ts +1 -0
  392. package/dist/loop/workflows/agentic-execution/llm-mapping-step.d.ts.map +1 -1
  393. package/dist/loop/workflows/agentic-execution/tool-call-step.d.ts.map +1 -1
  394. package/dist/loop/workflows/agentic-loop/index.d.ts +3 -0
  395. package/dist/loop/workflows/agentic-loop/index.d.ts.map +1 -1
  396. package/dist/loop/workflows/schema.d.ts +3 -0
  397. package/dist/loop/workflows/schema.d.ts.map +1 -1
  398. package/dist/mastra/index.cjs +2 -2
  399. package/dist/mastra/index.d.ts +9 -5
  400. package/dist/mastra/index.d.ts.map +1 -1
  401. package/dist/mastra/index.js +1 -1
  402. package/dist/memory/index.cjs +14 -14
  403. package/dist/memory/index.js +1 -1
  404. package/dist/processor-provider/index.cjs +10 -10
  405. package/dist/processor-provider/index.js +1 -1
  406. package/dist/processors/index.cjs +42 -42
  407. package/dist/processors/index.js +1 -1
  408. package/dist/processors/processors/skills.d.ts.map +1 -1
  409. package/dist/relevance/index.cjs +3 -3
  410. package/dist/relevance/index.js +1 -1
  411. package/dist/storage/constants.cjs +56 -56
  412. package/dist/storage/constants.js +1 -1
  413. package/dist/storage/domains/memory/inmemory.d.ts.map +1 -1
  414. package/dist/storage/index.cjs +160 -160
  415. package/dist/storage/index.js +2 -2
  416. package/dist/storage/types.d.ts +2 -3
  417. package/dist/storage/types.d.ts.map +1 -1
  418. package/dist/stream/aisdk/v5/compat/prepare-tools.d.ts.map +1 -1
  419. package/dist/stream/base/output.d.ts +1 -0
  420. package/dist/stream/base/output.d.ts.map +1 -1
  421. package/dist/stream/index.cjs +11 -11
  422. package/dist/stream/index.js +2 -2
  423. package/dist/stream/types.d.ts +27 -1
  424. package/dist/stream/types.d.ts.map +1 -1
  425. package/dist/test-utils/llm-mock.cjs +4 -4
  426. package/dist/test-utils/llm-mock.js +1 -1
  427. package/dist/tool-loop-agent/index.cjs +4 -4
  428. package/dist/tool-loop-agent/index.js +1 -1
  429. package/dist/tools/index.cjs +9 -5
  430. package/dist/tools/index.d.ts +1 -1
  431. package/dist/tools/index.d.ts.map +1 -1
  432. package/dist/tools/index.js +1 -1
  433. package/dist/tools/is-vercel-tool.cjs +2 -2
  434. package/dist/tools/is-vercel-tool.js +1 -1
  435. package/dist/tools/toolchecks.d.ts +10 -0
  436. package/dist/tools/toolchecks.d.ts.map +1 -1
  437. package/dist/utils.cjs +23 -23
  438. package/dist/utils.js +1 -1
  439. package/dist/vector/index.cjs +7 -7
  440. package/dist/vector/index.js +1 -1
  441. package/dist/vector/types.d.ts +9 -1
  442. package/dist/vector/types.d.ts.map +1 -1
  443. package/dist/workflows/evented/index.cjs +10 -10
  444. package/dist/workflows/evented/index.js +1 -1
  445. package/dist/workflows/index.cjs +25 -25
  446. package/dist/workflows/index.js +1 -1
  447. package/dist/workflows/types.d.ts +14 -1
  448. package/dist/workflows/types.d.ts.map +1 -1
  449. package/dist/workflows/workflow.d.ts +3 -17
  450. package/dist/workflows/workflow.d.ts.map +1 -1
  451. package/dist/workspace/filesystem/composite-filesystem.d.ts +5 -0
  452. package/dist/workspace/filesystem/composite-filesystem.d.ts.map +1 -1
  453. package/dist/workspace/filesystem/filesystem.d.ts +12 -0
  454. package/dist/workspace/filesystem/filesystem.d.ts.map +1 -1
  455. package/dist/workspace/filesystem/fs-utils.d.ts +12 -0
  456. package/dist/workspace/filesystem/fs-utils.d.ts.map +1 -1
  457. package/dist/workspace/filesystem/local-filesystem.d.ts +6 -0
  458. package/dist/workspace/filesystem/local-filesystem.d.ts.map +1 -1
  459. package/dist/workspace/index.cjs +66 -66
  460. package/dist/workspace/index.js +1 -1
  461. package/dist/workspace/lsp/client.d.ts +76 -0
  462. package/dist/workspace/lsp/client.d.ts.map +1 -0
  463. package/dist/workspace/lsp/index.d.ts +6 -0
  464. package/dist/workspace/lsp/index.d.ts.map +1 -0
  465. package/dist/workspace/lsp/language.d.ts +16 -0
  466. package/dist/workspace/lsp/language.d.ts.map +1 -0
  467. package/dist/workspace/lsp/manager.d.ts +72 -0
  468. package/dist/workspace/lsp/manager.d.ts.map +1 -0
  469. package/dist/workspace/lsp/servers.d.ts +43 -0
  470. package/dist/workspace/lsp/servers.d.ts.map +1 -0
  471. package/dist/workspace/lsp/types.d.ts +45 -0
  472. package/dist/workspace/lsp/types.d.ts.map +1 -0
  473. package/dist/workspace/tools/ast-edit.d.ts.map +1 -1
  474. package/dist/workspace/tools/edit-file.d.ts.map +1 -1
  475. package/dist/workspace/tools/helpers.d.ts +13 -0
  476. package/dist/workspace/tools/helpers.d.ts.map +1 -1
  477. package/dist/workspace/tools/write-file.d.ts.map +1 -1
  478. package/dist/workspace/workspace.d.ts +33 -0
  479. package/dist/workspace/workspace.d.ts.map +1 -1
  480. package/package.json +10 -8
  481. package/dist/chunk-2X66GWF5.cjs.map +0 -1
  482. package/dist/chunk-6QBN6MZY.cjs.map +0 -1
  483. package/dist/chunk-7EXW4AAG.js.map +0 -1
  484. package/dist/chunk-7UAJ6LMR.cjs.map +0 -1
  485. package/dist/chunk-BQHWJLXU.js.map +0 -1
  486. package/dist/chunk-DB7U2C5B.cjs.map +0 -1
  487. package/dist/chunk-DFCRXDVK.js.map +0 -1
  488. package/dist/chunk-EAZ6YDCQ.cjs.map +0 -1
  489. package/dist/chunk-HB6T4554.cjs.map +0 -1
  490. package/dist/chunk-IC5OUWKJ.js.map +0 -1
  491. package/dist/chunk-KUXNBWN7.js.map +0 -1
  492. package/dist/chunk-O7PZ4VOO.cjs.map +0 -1
  493. package/dist/chunk-QSHV7GPT.js.map +0 -1
  494. package/dist/chunk-QTAS3HND.cjs.map +0 -1
  495. package/dist/chunk-R4N65TLG.js.map +0 -1
  496. package/dist/chunk-T6GAM3SQ.js.map +0 -1
  497. package/dist/chunk-YQG7NBPR.cjs.map +0 -1
  498. package/dist/chunk-ZSBM2SVU.js.map +0 -1
@@ -0,0 +1,954 @@
1
+ # MCPClient
2
+
3
+ The `MCPClient` class provides a way to manage multiple MCP server connections and their tools in a Mastra application. It handles connection lifecycle, tool namespacing, and provides access to tools across all configured servers.
4
+
5
+ ## Constructor
6
+
7
+ Creates a new instance of the MCPClient class.
8
+
9
+ ```typescript
10
+ constructor({
11
+ id?: string;
12
+ servers: Record<string, MastraMCPServerDefinition>;
13
+ timeout?: number;
14
+ }: MCPClientOptions)
15
+ ```
16
+
17
+ ### MCPClientOptions
18
+
19
+ **id?:** (`string`): Optional unique identifier for the configuration instance. Use this to prevent memory leaks when creating multiple instances with identical configurations.
20
+
21
+ **servers:** (`Record<string, MastraMCPServerDefinition>`): A map of server configurations, where each key is a unique server identifier and the value is the server configuration.
22
+
23
+ **timeout?:** (`number`): Global timeout value in milliseconds for all servers unless overridden in individual server configs. (Default: `60000`)
24
+
25
+ ### MastraMCPServerDefinition
26
+
27
+ Each server in the `servers` map is configured using the `MastraMCPServerDefinition` type. The transport type is detected based on the provided parameters:
28
+
29
+ - If `command` is provided, it uses the Stdio transport.
30
+ - If `url` is provided, it first attempts to use the Streamable HTTP transport and falls back to the legacy SSE transport if the initial connection fails.
31
+
32
+ **command?:** (`string`): For Stdio servers: The command to execute.
33
+
34
+ **args?:** (`string[]`): For Stdio servers: Arguments to pass to the command.
35
+
36
+ **env?:** (`Record<string, string>`): For Stdio servers: Environment variables to set for the command.
37
+
38
+ **url?:** (`URL`): For HTTP servers (Streamable HTTP or SSE): The URL of the server.
39
+
40
+ **requestInit?:** (`RequestInit`): For HTTP servers: Request configuration for the fetch API.
41
+
42
+ **eventSourceInit?:** (`EventSourceInit`): For SSE fallback: Custom fetch configuration for SSE connections. Required when using custom headers with SSE.
43
+
44
+ **fetch?:** (`FetchLike`): For HTTP servers: Custom fetch implementation used for all network requests. When provided, this function will be used for all HTTP requests, allowing you to add dynamic authentication headers (e.g., refreshing bearer tokens), customize request behavior per-request, or intercept and modify requests/responses. When \`fetch\` is provided, \`requestInit\`, \`eventSourceInit\`, and \`authProvider\` become optional, as you can handle these concerns within your custom fetch function.
45
+
46
+ **logger?:** (`LogHandler`): Optional additional handler for logging.
47
+
48
+ **timeout?:** (`number`): Server-specific timeout in milliseconds.
49
+
50
+ **capabilities?:** (`ClientCapabilities`): Server-specific capabilities configuration.
51
+
52
+ **authProvider?:** (`OAuthClientProvider`): For HTTP servers: OAuth authentication provider for automatic token refresh and OAuth flow management. Use MCPOAuthClientProvider for a ready-to-use implementation.
53
+
54
+ **enableServerLogs?:** (`boolean`): Whether to enable logging for this server. (Default: `true`)
55
+
56
+ ## Methods
57
+
58
+ ### listTools()
59
+
60
+ Retrieves all tools from all configured servers, with tool names namespaced by their server name (in the format `serverName_toolName`) to prevent conflicts. Intended to be passed onto an Agent definition.
61
+
62
+ ```ts
63
+ new Agent({ id: 'agent', tools: await mcp.listTools() })
64
+ ```
65
+
66
+ ### listToolsets()
67
+
68
+ Returns an object mapping namespaced tool names (in the format `serverName.toolName`) to their tool implementations. Intended to be passed dynamically into the generate or stream method.
69
+
70
+ ```typescript
71
+ const res = await agent.stream(prompt, {
72
+ toolsets: await mcp.listToolsets(),
73
+ })
74
+ ```
75
+
76
+ ### disconnect()
77
+
78
+ Disconnects from all MCP servers and cleans up resources.
79
+
80
+ ```typescript
81
+ async disconnect(): Promise<void>
82
+ ```
83
+
84
+ ### `resources` Property
85
+
86
+ The `MCPClient` instance has a `resources` property that provides access to resource-related operations.
87
+
88
+ ```typescript
89
+ const mcpClient = new MCPClient({
90
+ /* ...servers configuration... */
91
+ })
92
+
93
+ // Access resource methods via mcpClient.resources
94
+ const allResourcesByServer = await mcpClient.resources.list()
95
+ const templatesByServer = await mcpClient.resources.templates()
96
+ // ... and so on for other resource methods.
97
+ ```
98
+
99
+ #### `resources.list()`
100
+
101
+ Retrieves all available resources from all connected MCP servers, grouped by server name.
102
+
103
+ ```typescript
104
+ async list(): Promise<Record<string, Resource[]>>
105
+ ```
106
+
107
+ Example:
108
+
109
+ ```typescript
110
+ const resourcesByServer = await mcpClient.resources.list()
111
+ for (const serverName in resourcesByServer) {
112
+ console.log(`Resources from ${serverName}:`, resourcesByServer[serverName])
113
+ }
114
+ ```
115
+
116
+ #### `resources.templates()`
117
+
118
+ Retrieves all available resource templates from all connected MCP servers, grouped by server name.
119
+
120
+ ```typescript
121
+ async templates(): Promise<Record<string, ResourceTemplate[]>>
122
+ ```
123
+
124
+ Example:
125
+
126
+ ```typescript
127
+ const templatesByServer = await mcpClient.resources.templates()
128
+ for (const serverName in templatesByServer) {
129
+ console.log(`Templates from ${serverName}:`, templatesByServer[serverName])
130
+ }
131
+ ```
132
+
133
+ #### `resources.read(serverName: string, uri: string)`
134
+
135
+ Reads the content of a specific resource from a named server.
136
+
137
+ ```typescript
138
+ async read(serverName: string, uri: string): Promise<ReadResourceResult>
139
+ ```
140
+
141
+ - `serverName`: The identifier of the server (key used in the `servers` constructor option).
142
+ - `uri`: The URI of the resource to read.
143
+
144
+ Example:
145
+
146
+ ```typescript
147
+ const content = await mcpClient.resources.read('myWeatherServer', 'weather://current')
148
+ console.log('Current weather:', content.contents[0].text)
149
+ ```
150
+
151
+ #### `resources.subscribe(serverName: string, uri: string)`
152
+
153
+ Subscribes to updates for a specific resource on a named server.
154
+
155
+ ```typescript
156
+ async subscribe(serverName: string, uri: string): Promise<object>
157
+ ```
158
+
159
+ Example:
160
+
161
+ ```typescript
162
+ await mcpClient.resources.subscribe('myWeatherServer', 'weather://current')
163
+ ```
164
+
165
+ #### `resources.unsubscribe(serverName: string, uri: string)`
166
+
167
+ Unsubscribes from updates for a specific resource on a named server.
168
+
169
+ ```typescript
170
+ async unsubscribe(serverName: string, uri: string): Promise<object>
171
+ ```
172
+
173
+ Example:
174
+
175
+ ```typescript
176
+ await mcpClient.resources.unsubscribe('myWeatherServer', 'weather://current')
177
+ ```
178
+
179
+ #### `resources.onUpdated(serverName: string, handler: (params: { uri: string }) => void)`
180
+
181
+ Sets a notification handler that will be called when a subscribed resource on a specific server is updated.
182
+
183
+ ```typescript
184
+ async onUpdated(serverName: string, handler: (params: { uri: string }) => void): Promise<void>
185
+ ```
186
+
187
+ Example:
188
+
189
+ ```typescript
190
+ mcpClient.resources.onUpdated('myWeatherServer', params => {
191
+ console.log(`Resource updated on myWeatherServer: ${params.uri}`)
192
+ // You might want to re-fetch the resource content here
193
+ // await mcpClient.resources.read("myWeatherServer", params.uri);
194
+ })
195
+ ```
196
+
197
+ #### `resources.onListChanged(serverName: string, handler: () => void)`
198
+
199
+ Sets a notification handler that will be called when the overall list of available resources changes on a specific server.
200
+
201
+ ```typescript
202
+ async onListChanged(serverName: string, handler: () => void): Promise<void>
203
+ ```
204
+
205
+ Example:
206
+
207
+ ```typescript
208
+ mcpClient.resources.onListChanged('myWeatherServer', () => {
209
+ console.log('Resource list changed on myWeatherServer.')
210
+ // You should re-fetch the list of resources
211
+ // await mcpClient.resources.list();
212
+ })
213
+ ```
214
+
215
+ ### `elicitation` Property
216
+
217
+ The `MCPClient` instance has an `elicitation` property that provides access to elicitation-related operations. Elicitation allows MCP servers to request structured information from users.
218
+
219
+ ```typescript
220
+ const mcpClient = new MCPClient({
221
+ /* ...servers configuration... */
222
+ })
223
+
224
+ // Set up elicitation handler
225
+ mcpClient.elicitation.onRequest('serverName', async request => {
226
+ // Handle elicitation request from server
227
+ console.log('Server requests:', request.message)
228
+ console.log('Schema:', request.requestedSchema)
229
+
230
+ // Return user response
231
+ return {
232
+ action: 'accept',
233
+ content: { name: 'John Doe', email: 'john@example.com' },
234
+ }
235
+ })
236
+ ```
237
+
238
+ #### `elicitation.onRequest(serverName: string, handler: ElicitationHandler)`
239
+
240
+ Sets up a handler function that will be called when any connected MCP server sends an elicitation request. The handler receives the request and must return a response.
241
+
242
+ ##### ElicitationHandler Function
243
+
244
+ The handler function receives a request object with:
245
+
246
+ - `message`: A human-readable message describing what information is needed
247
+ - `requestedSchema`: A JSON schema defining the structure of the expected response
248
+
249
+ The handler must return an `ElicitResult` with:
250
+
251
+ - `action`: One of `'accept'`, `'decline'`, or `'cancel'`
252
+ - `content`: The user's data (only when action is `'accept'`)
253
+
254
+ **Example:**
255
+
256
+ ```typescript
257
+ mcpClient.elicitation.onRequest('serverName', async request => {
258
+ console.log(`Server requests: ${request.message}`)
259
+
260
+ // Example: Simple user input collection
261
+ if (request.requestedSchema.properties.name) {
262
+ // Simulate user accepting and providing data
263
+ return {
264
+ action: 'accept',
265
+ content: {
266
+ name: 'Alice Smith',
267
+ email: 'alice@example.com',
268
+ },
269
+ }
270
+ }
271
+
272
+ // Simulate user declining the request
273
+ return { action: 'decline' }
274
+ })
275
+ ```
276
+
277
+ **Complete Interactive Example:**
278
+
279
+ ```typescript
280
+ import { MCPClient } from '@mastra/mcp'
281
+ import { createInterface } from 'readline'
282
+
283
+ const readline = createInterface({
284
+ input: process.stdin,
285
+ output: process.stdout,
286
+ })
287
+
288
+ function askQuestion(question: string): Promise<string> {
289
+ return new Promise(resolve => {
290
+ readline.question(question, answer => resolve(answer.trim()))
291
+ })
292
+ }
293
+
294
+ const mcpClient = new MCPClient({
295
+ servers: {
296
+ interactiveServer: {
297
+ url: new URL('http://localhost:3000/mcp'),
298
+ },
299
+ },
300
+ })
301
+
302
+ // Set up interactive elicitation handler
303
+ await mcpClient.elicitation.onRequest('interactiveServer', async request => {
304
+ console.log(`\n📋 Server Request: ${request.message}`)
305
+ console.log('Required information:')
306
+
307
+ const schema = request.requestedSchema
308
+ const properties = schema.properties || {}
309
+ const required = schema.required || []
310
+ const content: Record<string, any> = {}
311
+
312
+ // Collect input for each field
313
+ for (const [fieldName, fieldSchema] of Object.entries(properties)) {
314
+ const field = fieldSchema as any
315
+ const isRequired = required.includes(fieldName)
316
+
317
+ let prompt = `${field.title || fieldName}`
318
+ if (field.description) prompt += ` (${field.description})`
319
+ if (isRequired) prompt += ' *required*'
320
+ prompt += ': '
321
+
322
+ const answer = await askQuestion(prompt)
323
+
324
+ // Handle cancellation
325
+ if (answer.toLowerCase() === 'cancel') {
326
+ return { action: 'cancel' }
327
+ }
328
+
329
+ // Validate required fields
330
+ if (answer === '' && isRequired) {
331
+ console.log(`❌ ${fieldName} is required`)
332
+ return { action: 'decline' }
333
+ }
334
+
335
+ if (answer !== '') {
336
+ content[fieldName] = answer
337
+ }
338
+ }
339
+
340
+ // Confirm submission
341
+ console.log('\n📝 You provided:')
342
+ console.log(JSON.stringify(content, null, 2))
343
+
344
+ const confirm = await askQuestion('\nSubmit this information? (yes/no/cancel): ')
345
+
346
+ if (confirm.toLowerCase() === 'yes' || confirm.toLowerCase() === 'y') {
347
+ return { action: 'accept', content }
348
+ } else if (confirm.toLowerCase() === 'cancel') {
349
+ return { action: 'cancel' }
350
+ } else {
351
+ return { action: 'decline' }
352
+ }
353
+ })
354
+ ```
355
+
356
+ ### `prompts` Property
357
+
358
+ The `MCPClient` instance has a `prompts` property that provides access to prompt-related operations.
359
+
360
+ ```typescript
361
+ const mcpClient = new MCPClient({
362
+ /* ...servers configuration... */
363
+ })
364
+
365
+ // Access prompt methods via mcpClient.prompts
366
+ const allPromptsByServer = await mcpClient.prompts.list()
367
+ const { prompt, messages } = await mcpClient.prompts.get({
368
+ serverName: 'myWeatherServer',
369
+ name: 'current',
370
+ })
371
+ ```
372
+
373
+ #### `prompts.list()`
374
+
375
+ Retrieves all available prompts from all connected MCP servers, grouped by server name.
376
+
377
+ ```typescript
378
+ async list(): Promise<Record<string, Prompt[]>>
379
+ ```
380
+
381
+ Example:
382
+
383
+ ```typescript
384
+ const promptsByServer = await mcpClient.prompts.list()
385
+ for (const serverName in promptsByServer) {
386
+ console.log(`Prompts from ${serverName}:`, promptsByServer[serverName])
387
+ }
388
+ ```
389
+
390
+ #### `prompts.get({ serverName, name, args?, version? })`
391
+
392
+ Retrieves a specific prompt and its messages from a server.
393
+
394
+ ```typescript
395
+ async get({
396
+ serverName,
397
+ name,
398
+ args?,
399
+ version?,
400
+ }: {
401
+ serverName: string;
402
+ name: string;
403
+ args?: Record<string, any>;
404
+ version?: string;
405
+ }): Promise<{ prompt: Prompt; messages: PromptMessage[] }>
406
+ ```
407
+
408
+ Example:
409
+
410
+ ```typescript
411
+ const { prompt, messages } = await mcpClient.prompts.get({
412
+ serverName: 'myWeatherServer',
413
+ name: 'current',
414
+ args: { location: 'London' },
415
+ })
416
+ console.log(prompt)
417
+ console.log(messages)
418
+ ```
419
+
420
+ #### `prompts.onListChanged(serverName: string, handler: () => void)`
421
+
422
+ Sets a notification handler that will be called when the list of available prompts changes on a specific server.
423
+
424
+ ```typescript
425
+ async onListChanged(serverName: string, handler: () => void): Promise<void>
426
+ ```
427
+
428
+ Example:
429
+
430
+ ```typescript
431
+ mcpClient.prompts.onListChanged('myWeatherServer', () => {
432
+ console.log('Prompt list changed on myWeatherServer.')
433
+ // You should re-fetch the list of prompts
434
+ // await mcpClient.prompts.list();
435
+ })
436
+ ```
437
+
438
+ ### `progress` Property
439
+
440
+ The `MCPClient` instance has a `progress` property for subscribing to progress notifications emitted by MCP servers while tools execute.
441
+
442
+ ```typescript
443
+ const mcpClient = new MCPClient({
444
+ servers: {
445
+ myServer: {
446
+ url: new URL('http://localhost:4111/api/mcp/myServer/mcp'),
447
+ // Enabled by default; set to false to disable
448
+ enableProgressTracking: true,
449
+ },
450
+ },
451
+ })
452
+
453
+ // Subscribe to progress updates for a specific server
454
+ await mcpClient.progress.onUpdate('myServer', params => {
455
+ console.log('📊 Progress:', params.progress, '/', params.total)
456
+ if (params.message) console.log('Message:', params.message)
457
+ if (params.progressToken) console.log('Token:', params.progressToken)
458
+ })
459
+ ```
460
+
461
+ #### `progress.onUpdate(serverName: string, handler)`
462
+
463
+ Registers a handler function to receive progress updates from the specified server.
464
+
465
+ ```typescript
466
+ async onUpdate(
467
+ serverName: string,
468
+ handler: (params: {
469
+ progressToken: string;
470
+ progress: number;
471
+ total?: number;
472
+ message?: string;
473
+ }) => void,
474
+ ): Promise<void>
475
+ ```
476
+
477
+ Notes:
478
+
479
+ - When `enableProgressTracking` is true (default), tool calls include a `progressToken` so you can correlate updates to a specific run.
480
+ - If you pass a `runId` when executing a tool, it will be used as the `progressToken`.
481
+
482
+ To disable progress tracking for a server:
483
+
484
+ ```typescript
485
+ const mcpClient = new MCPClient({
486
+ servers: {
487
+ myServer: {
488
+ url: new URL('http://localhost:4111/api/mcp/myServer/mcp'),
489
+ enableProgressTracking: false,
490
+ },
491
+ },
492
+ })
493
+ ```
494
+
495
+ ## Elicitation
496
+
497
+ Elicitation is a feature that allows MCP servers to request structured information from users. When a server needs additional data, it can send an elicitation request that the client handles by prompting the user. A common example is during a tool call.
498
+
499
+ ### How Elicitation Works
500
+
501
+ 1. **Server Request**: An MCP server tool calls `server.elicitation.sendRequest()` with a message and schema
502
+ 2. **Client Handler**: Your elicitation handler function is called with the request
503
+ 3. **User Interaction**: Your handler collects user input (via UI, CLI, etc.)
504
+ 4. **Response**: Your handler returns the user's response (accept/decline/cancel)
505
+ 5. **Tool Continuation**: The server tool receives the response and continues execution
506
+
507
+ ### Setting Up Elicitation
508
+
509
+ You must set up an elicitation handler before tools that use elicitation are called:
510
+
511
+ ```typescript
512
+ import { MCPClient } from '@mastra/mcp'
513
+
514
+ const mcpClient = new MCPClient({
515
+ servers: {
516
+ interactiveServer: {
517
+ url: new URL('http://localhost:3000/mcp'),
518
+ },
519
+ },
520
+ })
521
+
522
+ // Set up elicitation handler
523
+ mcpClient.elicitation.onRequest('interactiveServer', async request => {
524
+ // Handle the server's request for user input
525
+ console.log(`Server needs: ${request.message}`)
526
+
527
+ // Your logic to collect user input
528
+ const userData = await collectUserInput(request.requestedSchema)
529
+
530
+ return {
531
+ action: 'accept',
532
+ content: userData,
533
+ }
534
+ })
535
+ ```
536
+
537
+ ### Response Types
538
+
539
+ Your elicitation handler must return one of three response types:
540
+
541
+ - **Accept**: User provided data and confirmed submission
542
+
543
+ ```typescript
544
+ return {
545
+ action: 'accept',
546
+ content: { name: 'John Doe', email: 'john@example.com' },
547
+ }
548
+ ```
549
+
550
+ - **Decline**: User explicitly declined to provide the information
551
+
552
+ ```typescript
553
+ return { action: 'decline' }
554
+ ```
555
+
556
+ - **Cancel**: User dismissed or cancelled the request
557
+
558
+ ```typescript
559
+ return { action: 'cancel' }
560
+ ```
561
+
562
+ ### Schema-Based Input Collection
563
+
564
+ The `requestedSchema` provides structure for the data the server needs:
565
+
566
+ ```typescript
567
+ await mcpClient.elicitation.onRequest('interactiveServer', async request => {
568
+ const { properties, required = [] } = request.requestedSchema
569
+ const content: Record<string, any> = {}
570
+
571
+ for (const [fieldName, fieldSchema] of Object.entries(properties || {})) {
572
+ const field = fieldSchema as any
573
+ const isRequired = required.includes(fieldName)
574
+
575
+ // Collect input based on field type and requirements
576
+ const value = await promptUser({
577
+ name: fieldName,
578
+ title: field.title,
579
+ description: field.description,
580
+ type: field.type,
581
+ required: isRequired,
582
+ format: field.format,
583
+ enum: field.enum,
584
+ })
585
+
586
+ if (value !== null) {
587
+ content[fieldName] = value
588
+ }
589
+ }
590
+
591
+ return { action: 'accept', content }
592
+ })
593
+ ```
594
+
595
+ ### Best Practices
596
+
597
+ - **Always handle elicitation**: Set up your handler before calling tools that might use elicitation
598
+ - **Validate input**: Check that required fields are provided
599
+ - **Respect user choice**: Handle decline and cancel responses gracefully
600
+ - **Clear UI**: Make it obvious what information is being requested and why
601
+ - **Security**: Never auto-accept requests for sensitive information
602
+
603
+ ## OAuth Authentication
604
+
605
+ For connecting to MCP servers that require OAuth authentication per the [MCP Auth Specification](https://modelcontextprotocol.io/specification/2025-06-18/basic/authorization), use the `MCPOAuthClientProvider`:
606
+
607
+ ```typescript
608
+ import { MCPClient, MCPOAuthClientProvider } from '@mastra/mcp'
609
+
610
+ // Create an OAuth provider
611
+ const oauthProvider = new MCPOAuthClientProvider({
612
+ redirectUrl: 'http://localhost:3000/oauth/callback',
613
+ clientMetadata: {
614
+ redirect_uris: ['http://localhost:3000/oauth/callback'],
615
+ client_name: 'My MCP Client',
616
+ grant_types: ['authorization_code', 'refresh_token'],
617
+ response_types: ['code'],
618
+ },
619
+ onRedirectToAuthorization: url => {
620
+ // Handle authorization redirect (open browser, redirect response, etc.)
621
+ console.log(`Please visit: ${url}`)
622
+ },
623
+ })
624
+
625
+ // Use the provider with MCPClient
626
+ const client = new MCPClient({
627
+ servers: {
628
+ protectedServer: {
629
+ url: new URL('https://mcp.example.com/mcp'),
630
+ authProvider: oauthProvider,
631
+ },
632
+ },
633
+ })
634
+ ```
635
+
636
+ ### Quick Token Provider
637
+
638
+ For testing or when you already have a valid access token:
639
+
640
+ ```typescript
641
+ import { MCPClient, createSimpleTokenProvider } from '@mastra/mcp'
642
+
643
+ const provider = createSimpleTokenProvider('your-access-token', {
644
+ redirectUrl: 'http://localhost:3000/callback',
645
+ clientMetadata: {
646
+ redirect_uris: ['http://localhost:3000/callback'],
647
+ client_name: 'Test Client',
648
+ },
649
+ })
650
+
651
+ const client = new MCPClient({
652
+ servers: {
653
+ testServer: {
654
+ url: new URL('https://mcp.example.com/mcp'),
655
+ authProvider: provider,
656
+ },
657
+ },
658
+ })
659
+ ```
660
+
661
+ ### Custom Token Storage
662
+
663
+ For persistent token storage across sessions, implement the `OAuthStorage` interface:
664
+
665
+ ```typescript
666
+ import { MCPOAuthClientProvider, OAuthStorage } from '@mastra/mcp'
667
+
668
+ class DatabaseOAuthStorage implements OAuthStorage {
669
+ constructor(
670
+ private db: Database,
671
+ private userId: string,
672
+ ) {}
673
+
674
+ async set(key: string, value: string): Promise<void> {
675
+ await this.db.query(
676
+ 'INSERT INTO oauth_tokens (user_id, key, value) VALUES (?, ?, ?) ON CONFLICT DO UPDATE SET value = ?',
677
+ [this.userId, key, value, value],
678
+ )
679
+ }
680
+
681
+ async get(key: string): Promise<string | undefined> {
682
+ const result = await this.db.query(
683
+ 'SELECT value FROM oauth_tokens WHERE user_id = ? AND key = ?',
684
+ [this.userId, key],
685
+ )
686
+ return result?.[0]?.value
687
+ }
688
+
689
+ async delete(key: string): Promise<void> {
690
+ await this.db.query('DELETE FROM oauth_tokens WHERE user_id = ? AND key = ?', [
691
+ this.userId,
692
+ key,
693
+ ])
694
+ }
695
+ }
696
+
697
+ const provider = new MCPOAuthClientProvider({
698
+ redirectUrl: 'http://localhost:3000/callback',
699
+ clientMetadata: {
700
+ /* ... */
701
+ },
702
+ storage: new DatabaseOAuthStorage(db, 'user-123'),
703
+ })
704
+ ```
705
+
706
+ ## Examples
707
+
708
+ ### Static Tool Configuration
709
+
710
+ For tools where you have a single connection to the MCP server for you entire app, use `listTools()` and pass the tools to your agent:
711
+
712
+ ```typescript
713
+ import { MCPClient } from '@mastra/mcp'
714
+ import { Agent } from '@mastra/core/agent'
715
+
716
+ const mcp = new MCPClient({
717
+ servers: {
718
+ stockPrice: {
719
+ command: 'npx',
720
+ args: ['tsx', 'stock-price.ts'],
721
+ env: {
722
+ API_KEY: 'your-api-key',
723
+ },
724
+ log: logMessage => {
725
+ console.log(`[${logMessage.level}] ${logMessage.message}`)
726
+ },
727
+ },
728
+ weather: {
729
+ url: new URL('http://localhost:8080/sse'),
730
+ },
731
+ },
732
+ timeout: 30000, // Global 30s timeout
733
+ })
734
+
735
+ // Create an agent with access to all tools
736
+ const agent = new Agent({
737
+ id: 'multi-tool-agent',
738
+ name: 'Multi-tool Agent',
739
+ instructions: 'You have access to multiple tool servers.',
740
+ model: 'openai/gpt-5.1',
741
+ tools: await mcp.listTools(),
742
+ })
743
+
744
+ // Example of using resource methods
745
+ async function checkWeatherResource() {
746
+ try {
747
+ const weatherResources = await mcp.resources.list()
748
+ if (weatherResources.weather && weatherResources.weather.length > 0) {
749
+ const currentWeatherURI = weatherResources.weather[0].uri
750
+ const weatherData = await mcp.resources.read('weather', currentWeatherURI)
751
+ console.log('Weather data:', weatherData.contents[0].text)
752
+ }
753
+ } catch (error) {
754
+ console.error('Error fetching weather resource:', error)
755
+ }
756
+ }
757
+ checkWeatherResource()
758
+
759
+ // Example of using prompt methods
760
+ async function checkWeatherPrompt() {
761
+ try {
762
+ const weatherPrompts = await mcp.prompts.list()
763
+ if (weatherPrompts.weather && weatherPrompts.weather.length > 0) {
764
+ const currentWeatherPrompt = weatherPrompts.weather.find(p => p.name === 'current')
765
+ if (currentWeatherPrompt) {
766
+ console.log('Weather prompt:', currentWeatherPrompt)
767
+ } else {
768
+ console.log('Current weather prompt not found')
769
+ }
770
+ }
771
+ } catch (error) {
772
+ console.error('Error fetching weather prompt:', error)
773
+ }
774
+ }
775
+ checkWeatherPrompt()
776
+ ```
777
+
778
+ ### Dynamic toolsets
779
+
780
+ When you need a new MCP connection for each user, use `listToolsets()` and add the tools when calling stream or generate:
781
+
782
+ ```typescript
783
+ import { Agent } from '@mastra/core/agent'
784
+ import { MCPClient } from '@mastra/mcp'
785
+
786
+ // Create the agent first, without any tools
787
+ const agent = new Agent({
788
+ id: 'multi-tool-agent',
789
+ name: 'Multi-tool Agent',
790
+ instructions: 'You help users check stocks and weather.',
791
+ model: 'openai/gpt-5.1',
792
+ })
793
+
794
+ // Later, configure MCP with user-specific settings
795
+ const mcp = new MCPClient({
796
+ servers: {
797
+ stockPrice: {
798
+ command: 'npx',
799
+ args: ['tsx', 'stock-price.ts'],
800
+ env: {
801
+ API_KEY: 'user-123-api-key',
802
+ },
803
+ timeout: 20000, // Server-specific timeout
804
+ },
805
+ weather: {
806
+ url: new URL('http://localhost:8080/sse'),
807
+ requestInit: {
808
+ headers: {
809
+ Authorization: `Bearer user-123-token`,
810
+ },
811
+ },
812
+ },
813
+ },
814
+ })
815
+
816
+ // Pass all toolsets to stream() or generate()
817
+ const response = await agent.stream('How is AAPL doing and what is the weather?', {
818
+ toolsets: await mcp.listToolsets(),
819
+ })
820
+ ```
821
+
822
+ ## Instance Management
823
+
824
+ The `MCPClient` class includes built-in memory leak prevention for managing multiple instances:
825
+
826
+ 1. Creating multiple instances with identical configurations without an `id` will throw an error to prevent memory leaks
827
+ 2. If you need multiple instances with identical configurations, provide a unique `id` for each instance
828
+ 3. Call `await configuration.disconnect()` before recreating an instance with the same configuration
829
+ 4. If you only need one instance, consider moving the configuration to a higher scope to avoid recreation
830
+
831
+ For example, if you try to create multiple instances with the same configuration without an `id`:
832
+
833
+ ```typescript
834
+ // First instance - OK
835
+ const mcp1 = new MCPClient({
836
+ servers: {
837
+ /* ... */
838
+ },
839
+ })
840
+
841
+ // Second instance with same config - Will throw an error
842
+ const mcp2 = new MCPClient({
843
+ servers: {
844
+ /* ... */
845
+ },
846
+ })
847
+
848
+ // To fix, either:
849
+ // 1. Add unique IDs
850
+ const mcp3 = new MCPClient({
851
+ id: 'instance-1',
852
+ servers: {
853
+ /* ... */
854
+ },
855
+ })
856
+
857
+ // 2. Or disconnect before recreating
858
+ await mcp1.disconnect()
859
+ const mcp4 = new MCPClient({
860
+ servers: {
861
+ /* ... */
862
+ },
863
+ })
864
+ ```
865
+
866
+ ## Server Lifecycle
867
+
868
+ MCPClient handles server connections gracefully:
869
+
870
+ 1. Automatic connection management for multiple servers
871
+ 2. Graceful server shutdown to prevent error messages during development
872
+ 3. Proper cleanup of resources when disconnecting
873
+
874
+ ## Using Custom Fetch for Dynamic Authentication
875
+
876
+ For HTTP servers, you can provide a custom `fetch` function to handle dynamic authentication, request interception, or other custom behavior. This is particularly useful when you need to refresh tokens on each request or customize request behavior.
877
+
878
+ When `fetch` is provided, `requestInit`, `eventSourceInit`, and `authProvider` become optional, as you can handle these concerns within your custom fetch function.
879
+
880
+ ```typescript
881
+ const mcpClient = new MCPClient({
882
+ servers: {
883
+ apiServer: {
884
+ url: new URL('https://api.example.com/mcp'),
885
+ fetch: async (url, init) => {
886
+ // Refresh token on each request
887
+ const token = await getAuthToken() // Your token refresh logic
888
+
889
+ return fetch(url, {
890
+ ...init,
891
+ headers: {
892
+ ...init?.headers,
893
+ Authorization: `Bearer ${token}`,
894
+ },
895
+ })
896
+ },
897
+ },
898
+ },
899
+ })
900
+ ```
901
+
902
+ ## Using SSE Request Headers
903
+
904
+ When using the legacy SSE MCP transport, you must configure both `requestInit` and `eventSourceInit` due to a bug in the MCP SDK. Alternatively, you can use a custom `fetch` function which will be automatically used for both POST requests and SSE connections:
905
+
906
+ ```ts
907
+ // Option 1: Using requestInit and eventSourceInit (required for SSE)
908
+ const sseClient = new MCPClient({
909
+ servers: {
910
+ exampleServer: {
911
+ url: new URL('https://your-mcp-server.com/sse'),
912
+ // Note: requestInit alone isn't enough for SSE
913
+ requestInit: {
914
+ headers: {
915
+ Authorization: 'Bearer your-token',
916
+ },
917
+ },
918
+ // This is also required for SSE connections with custom headers
919
+ eventSourceInit: {
920
+ fetch(input: Request | URL | string, init?: RequestInit) {
921
+ const headers = new Headers(init?.headers || {})
922
+ headers.set('Authorization', 'Bearer your-token')
923
+ return fetch(input, {
924
+ ...init,
925
+ headers,
926
+ })
927
+ },
928
+ },
929
+ },
930
+ },
931
+ })
932
+
933
+ // Option 2: Using custom fetch (simpler, works for both Streamable HTTP and SSE)
934
+ const sseClientWithFetch = new MCPClient({
935
+ servers: {
936
+ exampleServer: {
937
+ url: new URL('https://your-mcp-server.com/sse'),
938
+ fetch: async (url, init) => {
939
+ const headers = new Headers(init?.headers || {})
940
+ headers.set('Authorization', 'Bearer your-token')
941
+ return fetch(url, {
942
+ ...init,
943
+ headers,
944
+ })
945
+ },
946
+ },
947
+ },
948
+ })
949
+ ```
950
+
951
+ ## Related Information
952
+
953
+ - For creating MCP servers, see the [MCPServer documentation](https://mastra.ai/reference/tools/mcp-server).
954
+ - For more about the Model Context Protocol, see the [@modelcontextprotocol/sdk documentation](https://github.com/modelcontextprotocol/typescript-sdk).