@mastra/mcp-docs-server 1.1.4 → 1.1.5-alpha.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 (547) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/package.json +3 -3
  3. package/.docs/docs/agents/adding-voice.md +0 -353
  4. package/.docs/docs/agents/agent-approval.md +0 -377
  5. package/.docs/docs/agents/agent-memory.md +0 -212
  6. package/.docs/docs/agents/guardrails.md +0 -382
  7. package/.docs/docs/agents/network-approval.md +0 -275
  8. package/.docs/docs/agents/networks.md +0 -290
  9. package/.docs/docs/agents/overview.md +0 -309
  10. package/.docs/docs/agents/processors.md +0 -632
  11. package/.docs/docs/agents/structured-output.md +0 -271
  12. package/.docs/docs/agents/using-tools.md +0 -214
  13. package/.docs/docs/build-with-ai/mcp-docs-server.md +0 -241
  14. package/.docs/docs/build-with-ai/skills.md +0 -35
  15. package/.docs/docs/community/contributing-templates.md +0 -3
  16. package/.docs/docs/community/discord.md +0 -9
  17. package/.docs/docs/community/licensing.md +0 -66
  18. package/.docs/docs/deployment/cloud-providers.md +0 -15
  19. package/.docs/docs/deployment/mastra-server.md +0 -122
  20. package/.docs/docs/deployment/monorepo.md +0 -142
  21. package/.docs/docs/deployment/overview.md +0 -62
  22. package/.docs/docs/deployment/studio.md +0 -234
  23. package/.docs/docs/deployment/web-framework.md +0 -52
  24. package/.docs/docs/deployment/workflow-runners.md +0 -9
  25. package/.docs/docs/evals/built-in-scorers.md +0 -47
  26. package/.docs/docs/evals/custom-scorers.md +0 -519
  27. package/.docs/docs/evals/overview.md +0 -146
  28. package/.docs/docs/evals/running-in-ci.md +0 -106
  29. package/.docs/docs/getting-started/build-with-ai.md +0 -68
  30. package/.docs/docs/getting-started/manual-install.md +0 -226
  31. package/.docs/docs/getting-started/project-structure.md +0 -60
  32. package/.docs/docs/getting-started/start.md +0 -28
  33. package/.docs/docs/getting-started/studio.md +0 -101
  34. package/.docs/docs/index.md +0 -43
  35. package/.docs/docs/mastra-cloud/deployment.md +0 -77
  36. package/.docs/docs/mastra-cloud/observability.md +0 -38
  37. package/.docs/docs/mastra-cloud/overview.md +0 -23
  38. package/.docs/docs/mastra-cloud/setup.md +0 -42
  39. package/.docs/docs/mastra-cloud/studio.md +0 -24
  40. package/.docs/docs/mcp/overview.md +0 -370
  41. package/.docs/docs/mcp/publishing-mcp-server.md +0 -95
  42. package/.docs/docs/memory/memory-processors.md +0 -316
  43. package/.docs/docs/memory/message-history.md +0 -260
  44. package/.docs/docs/memory/observational-memory.md +0 -246
  45. package/.docs/docs/memory/overview.md +0 -45
  46. package/.docs/docs/memory/semantic-recall.md +0 -272
  47. package/.docs/docs/memory/storage.md +0 -261
  48. package/.docs/docs/memory/working-memory.md +0 -400
  49. package/.docs/docs/observability/datasets/overview.md +0 -188
  50. package/.docs/docs/observability/datasets/running-experiments.md +0 -266
  51. package/.docs/docs/observability/logging.md +0 -99
  52. package/.docs/docs/observability/overview.md +0 -70
  53. package/.docs/docs/observability/tracing/bridges/otel.md +0 -209
  54. package/.docs/docs/observability/tracing/exporters/arize.md +0 -274
  55. package/.docs/docs/observability/tracing/exporters/braintrust.md +0 -111
  56. package/.docs/docs/observability/tracing/exporters/cloud.md +0 -129
  57. package/.docs/docs/observability/tracing/exporters/datadog.md +0 -187
  58. package/.docs/docs/observability/tracing/exporters/default.md +0 -211
  59. package/.docs/docs/observability/tracing/exporters/laminar.md +0 -100
  60. package/.docs/docs/observability/tracing/exporters/langfuse.md +0 -217
  61. package/.docs/docs/observability/tracing/exporters/langsmith.md +0 -202
  62. package/.docs/docs/observability/tracing/exporters/otel.md +0 -479
  63. package/.docs/docs/observability/tracing/exporters/posthog.md +0 -148
  64. package/.docs/docs/observability/tracing/exporters/sentry.md +0 -208
  65. package/.docs/docs/observability/tracing/overview.md +0 -1114
  66. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +0 -303
  67. package/.docs/docs/rag/chunking-and-embedding.md +0 -183
  68. package/.docs/docs/rag/graph-rag.md +0 -215
  69. package/.docs/docs/rag/overview.md +0 -72
  70. package/.docs/docs/rag/retrieval.md +0 -521
  71. package/.docs/docs/rag/vector-databases.md +0 -648
  72. package/.docs/docs/server/auth/auth0.md +0 -222
  73. package/.docs/docs/server/auth/better-auth.md +0 -203
  74. package/.docs/docs/server/auth/clerk.md +0 -132
  75. package/.docs/docs/server/auth/composite-auth.md +0 -234
  76. package/.docs/docs/server/auth/custom-auth-provider.md +0 -513
  77. package/.docs/docs/server/auth/firebase.md +0 -272
  78. package/.docs/docs/server/auth/jwt.md +0 -110
  79. package/.docs/docs/server/auth/simple-auth.md +0 -178
  80. package/.docs/docs/server/auth/supabase.md +0 -117
  81. package/.docs/docs/server/auth/workos.md +0 -190
  82. package/.docs/docs/server/auth.md +0 -38
  83. package/.docs/docs/server/custom-adapters.md +0 -374
  84. package/.docs/docs/server/custom-api-routes.md +0 -267
  85. package/.docs/docs/server/mastra-client.md +0 -243
  86. package/.docs/docs/server/mastra-server.md +0 -71
  87. package/.docs/docs/server/middleware.md +0 -228
  88. package/.docs/docs/server/request-context.md +0 -478
  89. package/.docs/docs/server/server-adapters.md +0 -547
  90. package/.docs/docs/streaming/events.md +0 -247
  91. package/.docs/docs/streaming/overview.md +0 -181
  92. package/.docs/docs/streaming/tool-streaming.md +0 -178
  93. package/.docs/docs/streaming/workflow-streaming.md +0 -109
  94. package/.docs/docs/voice/overview.md +0 -979
  95. package/.docs/docs/voice/speech-to-speech.md +0 -103
  96. package/.docs/docs/voice/speech-to-text.md +0 -80
  97. package/.docs/docs/voice/text-to-speech.md +0 -84
  98. package/.docs/docs/workflows/agents-and-tools.md +0 -170
  99. package/.docs/docs/workflows/control-flow.md +0 -823
  100. package/.docs/docs/workflows/error-handling.md +0 -360
  101. package/.docs/docs/workflows/human-in-the-loop.md +0 -213
  102. package/.docs/docs/workflows/overview.md +0 -372
  103. package/.docs/docs/workflows/snapshots.md +0 -238
  104. package/.docs/docs/workflows/suspend-and-resume.md +0 -205
  105. package/.docs/docs/workflows/time-travel.md +0 -309
  106. package/.docs/docs/workflows/workflow-state.md +0 -181
  107. package/.docs/docs/workspace/filesystem.md +0 -162
  108. package/.docs/docs/workspace/overview.md +0 -239
  109. package/.docs/docs/workspace/sandbox.md +0 -63
  110. package/.docs/docs/workspace/search.md +0 -219
  111. package/.docs/docs/workspace/skills.md +0 -126
  112. package/.docs/guides/agent-frameworks/ai-sdk.md +0 -140
  113. package/.docs/guides/build-your-ui/ai-sdk-ui.md +0 -1463
  114. package/.docs/guides/build-your-ui/assistant-ui.md +0 -156
  115. package/.docs/guides/build-your-ui/copilotkit.md +0 -292
  116. package/.docs/guides/deployment/amazon-ec2.md +0 -130
  117. package/.docs/guides/deployment/aws-lambda.md +0 -248
  118. package/.docs/guides/deployment/azure-app-services.md +0 -114
  119. package/.docs/guides/deployment/cloudflare.md +0 -99
  120. package/.docs/guides/deployment/digital-ocean.md +0 -168
  121. package/.docs/guides/deployment/inngest.md +0 -685
  122. package/.docs/guides/deployment/netlify.md +0 -77
  123. package/.docs/guides/deployment/vercel.md +0 -101
  124. package/.docs/guides/getting-started/astro.md +0 -408
  125. package/.docs/guides/getting-started/electron.md +0 -504
  126. package/.docs/guides/getting-started/express.md +0 -251
  127. package/.docs/guides/getting-started/hono.md +0 -191
  128. package/.docs/guides/getting-started/next-js.md +0 -355
  129. package/.docs/guides/getting-started/nuxt.md +0 -476
  130. package/.docs/guides/getting-started/quickstart.md +0 -67
  131. package/.docs/guides/getting-started/sveltekit.md +0 -300
  132. package/.docs/guides/getting-started/vite-react.md +0 -439
  133. package/.docs/guides/guide/ai-recruiter.md +0 -227
  134. package/.docs/guides/guide/chef-michel.md +0 -215
  135. package/.docs/guides/guide/code-review-bot.md +0 -221
  136. package/.docs/guides/guide/dev-assistant.md +0 -304
  137. package/.docs/guides/guide/docs-manager.md +0 -238
  138. package/.docs/guides/guide/github-actions-pr-description.md +0 -236
  139. package/.docs/guides/guide/notes-mcp-server.md +0 -425
  140. package/.docs/guides/guide/research-assistant.md +0 -349
  141. package/.docs/guides/guide/stock-agent.md +0 -134
  142. package/.docs/guides/guide/web-search.md +0 -326
  143. package/.docs/guides/guide/whatsapp-chat-bot.md +0 -416
  144. package/.docs/guides/index.md +0 -3
  145. package/.docs/guides/migrations/agentnetwork.md +0 -101
  146. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +0 -112
  147. package/.docs/guides/migrations/upgrade-to-v1/agent.md +0 -404
  148. package/.docs/guides/migrations/upgrade-to-v1/cli.md +0 -57
  149. package/.docs/guides/migrations/upgrade-to-v1/client.md +0 -337
  150. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +0 -37
  151. package/.docs/guides/migrations/upgrade-to-v1/evals.md +0 -239
  152. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +0 -143
  153. package/.docs/guides/migrations/upgrade-to-v1/mcp.md +0 -97
  154. package/.docs/guides/migrations/upgrade-to-v1/memory.md +0 -285
  155. package/.docs/guides/migrations/upgrade-to-v1/overview.md +0 -119
  156. package/.docs/guides/migrations/upgrade-to-v1/processors.md +0 -68
  157. package/.docs/guides/migrations/upgrade-to-v1/rag.md +0 -42
  158. package/.docs/guides/migrations/upgrade-to-v1/storage.md +0 -553
  159. package/.docs/guides/migrations/upgrade-to-v1/tools.md +0 -180
  160. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +0 -417
  161. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +0 -87
  162. package/.docs/guides/migrations/upgrade-to-v1/voice.md +0 -30
  163. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +0 -341
  164. package/.docs/guides/migrations/vnext-to-standard-apis.md +0 -364
  165. package/.docs/models/embeddings.md +0 -161
  166. package/.docs/models/gateways/azure-openai.md +0 -128
  167. package/.docs/models/gateways/custom-gateways.md +0 -545
  168. package/.docs/models/gateways/netlify.md +0 -88
  169. package/.docs/models/gateways/openrouter.md +0 -219
  170. package/.docs/models/gateways/vercel.md +0 -225
  171. package/.docs/models/gateways.md +0 -14
  172. package/.docs/models/index.md +0 -286
  173. package/.docs/models/providers/302ai.md +0 -134
  174. package/.docs/models/providers/abacus.md +0 -125
  175. package/.docs/models/providers/agentrouter.md +0 -90
  176. package/.docs/models/providers/aihubmix.md +0 -107
  177. package/.docs/models/providers/alibaba-cn.md +0 -135
  178. package/.docs/models/providers/alibaba.md +0 -111
  179. package/.docs/models/providers/amazon-bedrock.md +0 -33
  180. package/.docs/models/providers/anthropic.md +0 -153
  181. package/.docs/models/providers/azure.md +0 -33
  182. package/.docs/models/providers/bailing.md +0 -72
  183. package/.docs/models/providers/baseten.md +0 -77
  184. package/.docs/models/providers/berget.md +0 -78
  185. package/.docs/models/providers/cerebras.md +0 -101
  186. package/.docs/models/providers/chutes.md +0 -136
  187. package/.docs/models/providers/cloudflare-ai-gateway.md +0 -33
  188. package/.docs/models/providers/cloudflare-workers-ai.md +0 -109
  189. package/.docs/models/providers/cohere.md +0 -33
  190. package/.docs/models/providers/cortecs.md +0 -91
  191. package/.docs/models/providers/deepinfra.md +0 -112
  192. package/.docs/models/providers/deepseek.md +0 -88
  193. package/.docs/models/providers/fastrouter.md +0 -84
  194. package/.docs/models/providers/fireworks-ai.md +0 -89
  195. package/.docs/models/providers/firmware.md +0 -85
  196. package/.docs/models/providers/friendli.md +0 -78
  197. package/.docs/models/providers/github-models.md +0 -125
  198. package/.docs/models/providers/google-vertex.md +0 -33
  199. package/.docs/models/providers/google.md +0 -159
  200. package/.docs/models/providers/groq.md +0 -107
  201. package/.docs/models/providers/helicone.md +0 -161
  202. package/.docs/models/providers/huggingface.md +0 -90
  203. package/.docs/models/providers/iflowcn.md +0 -84
  204. package/.docs/models/providers/inception.md +0 -72
  205. package/.docs/models/providers/inference.md +0 -79
  206. package/.docs/models/providers/io-intelligence.md +0 -87
  207. package/.docs/models/providers/io-net.md +0 -87
  208. package/.docs/models/providers/jiekou.md +0 -131
  209. package/.docs/models/providers/kilo.md +0 -333
  210. package/.docs/models/providers/kimi-for-coding.md +0 -100
  211. package/.docs/models/providers/kuae-cloud-coding-plan.md +0 -71
  212. package/.docs/models/providers/llama.md +0 -77
  213. package/.docs/models/providers/lmstudio.md +0 -73
  214. package/.docs/models/providers/lucidquery.md +0 -72
  215. package/.docs/models/providers/minimax-cn-coding-plan.md +0 -102
  216. package/.docs/models/providers/minimax-cn.md +0 -102
  217. package/.docs/models/providers/minimax-coding-plan.md +0 -102
  218. package/.docs/models/providers/minimax.md +0 -104
  219. package/.docs/models/providers/mistral.md +0 -124
  220. package/.docs/models/providers/moark.md +0 -72
  221. package/.docs/models/providers/modelscope.md +0 -77
  222. package/.docs/models/providers/moonshotai-cn.md +0 -76
  223. package/.docs/models/providers/moonshotai.md +0 -76
  224. package/.docs/models/providers/morph.md +0 -73
  225. package/.docs/models/providers/nano-gpt.md +0 -103
  226. package/.docs/models/providers/nebius.md +0 -116
  227. package/.docs/models/providers/nova.md +0 -72
  228. package/.docs/models/providers/novita-ai.md +0 -154
  229. package/.docs/models/providers/nvidia.md +0 -141
  230. package/.docs/models/providers/ollama-cloud.md +0 -103
  231. package/.docs/models/providers/ollama.md +0 -33
  232. package/.docs/models/providers/openai.md +0 -193
  233. package/.docs/models/providers/opencode.md +0 -100
  234. package/.docs/models/providers/ovhcloud.md +0 -83
  235. package/.docs/models/providers/perplexity.md +0 -100
  236. package/.docs/models/providers/poe.md +0 -183
  237. package/.docs/models/providers/privatemode-ai.md +0 -75
  238. package/.docs/models/providers/requesty.md +0 -90
  239. package/.docs/models/providers/scaleway.md +0 -84
  240. package/.docs/models/providers/siliconflow-cn.md +0 -138
  241. package/.docs/models/providers/siliconflow.md +0 -140
  242. package/.docs/models/providers/stackit.md +0 -78
  243. package/.docs/models/providers/stepfun.md +0 -73
  244. package/.docs/models/providers/submodel.md +0 -79
  245. package/.docs/models/providers/synthetic.md +0 -96
  246. package/.docs/models/providers/togetherai.md +0 -115
  247. package/.docs/models/providers/upstage.md +0 -73
  248. package/.docs/models/providers/venice.md +0 -95
  249. package/.docs/models/providers/vivgrid.md +0 -106
  250. package/.docs/models/providers/vultr.md +0 -75
  251. package/.docs/models/providers/wandb.md +0 -80
  252. package/.docs/models/providers/xai.md +0 -141
  253. package/.docs/models/providers/xiaomi.md +0 -71
  254. package/.docs/models/providers/zai-coding-plan.md +0 -80
  255. package/.docs/models/providers/zai.md +0 -79
  256. package/.docs/models/providers/zenmux.md +0 -161
  257. package/.docs/models/providers/zhipuai-coding-plan.md +0 -79
  258. package/.docs/models/providers/zhipuai.md +0 -79
  259. package/.docs/models/providers.md +0 -81
  260. package/.docs/reference/agents/agent.md +0 -142
  261. package/.docs/reference/agents/generate.md +0 -174
  262. package/.docs/reference/agents/generateLegacy.md +0 -176
  263. package/.docs/reference/agents/getDefaultGenerateOptions.md +0 -36
  264. package/.docs/reference/agents/getDefaultOptions.md +0 -34
  265. package/.docs/reference/agents/getDefaultStreamOptions.md +0 -36
  266. package/.docs/reference/agents/getDescription.md +0 -21
  267. package/.docs/reference/agents/getInstructions.md +0 -34
  268. package/.docs/reference/agents/getLLM.md +0 -37
  269. package/.docs/reference/agents/getMemory.md +0 -34
  270. package/.docs/reference/agents/getModel.md +0 -34
  271. package/.docs/reference/agents/getTools.md +0 -29
  272. package/.docs/reference/agents/getVoice.md +0 -34
  273. package/.docs/reference/agents/listAgents.md +0 -35
  274. package/.docs/reference/agents/listScorers.md +0 -34
  275. package/.docs/reference/agents/listTools.md +0 -34
  276. package/.docs/reference/agents/listWorkflows.md +0 -34
  277. package/.docs/reference/agents/network.md +0 -134
  278. package/.docs/reference/ai-sdk/chat-route.md +0 -82
  279. package/.docs/reference/ai-sdk/handle-chat-stream.md +0 -53
  280. package/.docs/reference/ai-sdk/handle-network-stream.md +0 -37
  281. package/.docs/reference/ai-sdk/handle-workflow-stream.md +0 -55
  282. package/.docs/reference/ai-sdk/network-route.md +0 -74
  283. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +0 -232
  284. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +0 -79
  285. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +0 -73
  286. package/.docs/reference/ai-sdk/with-mastra.md +0 -59
  287. package/.docs/reference/ai-sdk/workflow-route.md +0 -79
  288. package/.docs/reference/auth/auth0.md +0 -73
  289. package/.docs/reference/auth/better-auth.md +0 -71
  290. package/.docs/reference/auth/clerk.md +0 -36
  291. package/.docs/reference/auth/firebase.md +0 -80
  292. package/.docs/reference/auth/jwt.md +0 -26
  293. package/.docs/reference/auth/supabase.md +0 -33
  294. package/.docs/reference/auth/workos.md +0 -84
  295. package/.docs/reference/cli/create-mastra.md +0 -137
  296. package/.docs/reference/cli/mastra.md +0 -336
  297. package/.docs/reference/client-js/agents.md +0 -438
  298. package/.docs/reference/client-js/error-handling.md +0 -16
  299. package/.docs/reference/client-js/logs.md +0 -24
  300. package/.docs/reference/client-js/mastra-client.md +0 -63
  301. package/.docs/reference/client-js/memory.md +0 -225
  302. package/.docs/reference/client-js/observability.md +0 -72
  303. package/.docs/reference/client-js/telemetry.md +0 -20
  304. package/.docs/reference/client-js/tools.md +0 -44
  305. package/.docs/reference/client-js/vectors.md +0 -79
  306. package/.docs/reference/client-js/workflows.md +0 -199
  307. package/.docs/reference/configuration.md +0 -749
  308. package/.docs/reference/core/addGateway.md +0 -42
  309. package/.docs/reference/core/getAgent.md +0 -21
  310. package/.docs/reference/core/getAgentById.md +0 -21
  311. package/.docs/reference/core/getDeployer.md +0 -22
  312. package/.docs/reference/core/getGateway.md +0 -38
  313. package/.docs/reference/core/getGatewayById.md +0 -41
  314. package/.docs/reference/core/getLogger.md +0 -22
  315. package/.docs/reference/core/getMCPServer.md +0 -45
  316. package/.docs/reference/core/getMCPServerById.md +0 -53
  317. package/.docs/reference/core/getMemory.md +0 -50
  318. package/.docs/reference/core/getScorer.md +0 -54
  319. package/.docs/reference/core/getScorerById.md +0 -54
  320. package/.docs/reference/core/getServer.md +0 -22
  321. package/.docs/reference/core/getStorage.md +0 -22
  322. package/.docs/reference/core/getStoredAgentById.md +0 -89
  323. package/.docs/reference/core/getTelemetry.md +0 -22
  324. package/.docs/reference/core/getVector.md +0 -22
  325. package/.docs/reference/core/getWorkflow.md +0 -40
  326. package/.docs/reference/core/listAgents.md +0 -21
  327. package/.docs/reference/core/listGateways.md +0 -40
  328. package/.docs/reference/core/listLogs.md +0 -38
  329. package/.docs/reference/core/listLogsByRunId.md +0 -36
  330. package/.docs/reference/core/listMCPServers.md +0 -51
  331. package/.docs/reference/core/listMemory.md +0 -56
  332. package/.docs/reference/core/listScorers.md +0 -29
  333. package/.docs/reference/core/listStoredAgents.md +0 -93
  334. package/.docs/reference/core/listVectors.md +0 -22
  335. package/.docs/reference/core/listWorkflows.md +0 -21
  336. package/.docs/reference/core/mastra-class.md +0 -66
  337. package/.docs/reference/core/mastra-model-gateway.md +0 -153
  338. package/.docs/reference/core/setLogger.md +0 -26
  339. package/.docs/reference/core/setStorage.md +0 -27
  340. package/.docs/reference/datasets/addItem.md +0 -35
  341. package/.docs/reference/datasets/addItems.md +0 -33
  342. package/.docs/reference/datasets/compareExperiments.md +0 -48
  343. package/.docs/reference/datasets/create.md +0 -49
  344. package/.docs/reference/datasets/dataset.md +0 -78
  345. package/.docs/reference/datasets/datasets-manager.md +0 -84
  346. package/.docs/reference/datasets/delete.md +0 -23
  347. package/.docs/reference/datasets/deleteExperiment.md +0 -25
  348. package/.docs/reference/datasets/deleteItem.md +0 -25
  349. package/.docs/reference/datasets/deleteItems.md +0 -27
  350. package/.docs/reference/datasets/get.md +0 -29
  351. package/.docs/reference/datasets/getDetails.md +0 -45
  352. package/.docs/reference/datasets/getExperiment.md +0 -28
  353. package/.docs/reference/datasets/getItem.md +0 -31
  354. package/.docs/reference/datasets/getItemHistory.md +0 -29
  355. package/.docs/reference/datasets/list.md +0 -29
  356. package/.docs/reference/datasets/listExperimentResults.md +0 -37
  357. package/.docs/reference/datasets/listExperiments.md +0 -31
  358. package/.docs/reference/datasets/listItems.md +0 -44
  359. package/.docs/reference/datasets/listVersions.md +0 -31
  360. package/.docs/reference/datasets/startExperiment.md +0 -60
  361. package/.docs/reference/datasets/startExperimentAsync.md +0 -41
  362. package/.docs/reference/datasets/update.md +0 -46
  363. package/.docs/reference/datasets/updateItem.md +0 -36
  364. package/.docs/reference/deployer/cloudflare.md +0 -79
  365. package/.docs/reference/deployer/netlify.md +0 -82
  366. package/.docs/reference/deployer/vercel.md +0 -91
  367. package/.docs/reference/deployer.md +0 -100
  368. package/.docs/reference/evals/answer-relevancy.md +0 -105
  369. package/.docs/reference/evals/answer-similarity.md +0 -99
  370. package/.docs/reference/evals/bias.md +0 -120
  371. package/.docs/reference/evals/completeness.md +0 -137
  372. package/.docs/reference/evals/content-similarity.md +0 -101
  373. package/.docs/reference/evals/context-precision.md +0 -196
  374. package/.docs/reference/evals/context-relevance.md +0 -536
  375. package/.docs/reference/evals/create-scorer.md +0 -270
  376. package/.docs/reference/evals/faithfulness.md +0 -114
  377. package/.docs/reference/evals/hallucination.md +0 -220
  378. package/.docs/reference/evals/keyword-coverage.md +0 -128
  379. package/.docs/reference/evals/mastra-scorer.md +0 -123
  380. package/.docs/reference/evals/noise-sensitivity.md +0 -685
  381. package/.docs/reference/evals/prompt-alignment.md +0 -619
  382. package/.docs/reference/evals/run-evals.md +0 -138
  383. package/.docs/reference/evals/scorer-utils.md +0 -330
  384. package/.docs/reference/evals/textual-difference.md +0 -113
  385. package/.docs/reference/evals/tone-consistency.md +0 -119
  386. package/.docs/reference/evals/tool-call-accuracy.md +0 -533
  387. package/.docs/reference/evals/toxicity.md +0 -123
  388. package/.docs/reference/harness/harness-class.md +0 -645
  389. package/.docs/reference/index.md +0 -276
  390. package/.docs/reference/logging/pino-logger.md +0 -117
  391. package/.docs/reference/memory/clone-utilities.md +0 -199
  392. package/.docs/reference/memory/cloneThread.md +0 -130
  393. package/.docs/reference/memory/createThread.md +0 -68
  394. package/.docs/reference/memory/deleteMessages.md +0 -40
  395. package/.docs/reference/memory/getThreadById.md +0 -24
  396. package/.docs/reference/memory/listThreads.md +0 -145
  397. package/.docs/reference/memory/memory-class.md +0 -147
  398. package/.docs/reference/memory/observational-memory.md +0 -565
  399. package/.docs/reference/memory/recall.md +0 -91
  400. package/.docs/reference/observability/tracing/bridges/otel.md +0 -131
  401. package/.docs/reference/observability/tracing/configuration.md +0 -178
  402. package/.docs/reference/observability/tracing/exporters/arize.md +0 -141
  403. package/.docs/reference/observability/tracing/exporters/braintrust.md +0 -93
  404. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +0 -163
  405. package/.docs/reference/observability/tracing/exporters/console-exporter.md +0 -138
  406. package/.docs/reference/observability/tracing/exporters/datadog.md +0 -116
  407. package/.docs/reference/observability/tracing/exporters/default-exporter.md +0 -174
  408. package/.docs/reference/observability/tracing/exporters/laminar.md +0 -78
  409. package/.docs/reference/observability/tracing/exporters/langfuse.md +0 -134
  410. package/.docs/reference/observability/tracing/exporters/langsmith.md +0 -110
  411. package/.docs/reference/observability/tracing/exporters/otel.md +0 -199
  412. package/.docs/reference/observability/tracing/exporters/posthog.md +0 -92
  413. package/.docs/reference/observability/tracing/exporters/sentry.md +0 -184
  414. package/.docs/reference/observability/tracing/instances.md +0 -109
  415. package/.docs/reference/observability/tracing/interfaces.md +0 -749
  416. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +0 -144
  417. package/.docs/reference/observability/tracing/spans.md +0 -224
  418. package/.docs/reference/processors/batch-parts-processor.md +0 -61
  419. package/.docs/reference/processors/language-detector.md +0 -81
  420. package/.docs/reference/processors/message-history-processor.md +0 -85
  421. package/.docs/reference/processors/moderation-processor.md +0 -104
  422. package/.docs/reference/processors/pii-detector.md +0 -107
  423. package/.docs/reference/processors/processor-interface.md +0 -525
  424. package/.docs/reference/processors/prompt-injection-detector.md +0 -71
  425. package/.docs/reference/processors/semantic-recall-processor.md +0 -123
  426. package/.docs/reference/processors/system-prompt-scrubber.md +0 -80
  427. package/.docs/reference/processors/token-limiter-processor.md +0 -113
  428. package/.docs/reference/processors/tool-call-filter.md +0 -85
  429. package/.docs/reference/processors/tool-search-processor.md +0 -113
  430. package/.docs/reference/processors/unicode-normalizer.md +0 -62
  431. package/.docs/reference/processors/working-memory-processor.md +0 -154
  432. package/.docs/reference/rag/chunk.md +0 -221
  433. package/.docs/reference/rag/database-config.md +0 -264
  434. package/.docs/reference/rag/document.md +0 -114
  435. package/.docs/reference/rag/embeddings.md +0 -92
  436. package/.docs/reference/rag/extract-params.md +0 -168
  437. package/.docs/reference/rag/graph-rag.md +0 -111
  438. package/.docs/reference/rag/metadata-filters.md +0 -216
  439. package/.docs/reference/rag/rerank.md +0 -80
  440. package/.docs/reference/rag/rerankWithScorer.md +0 -80
  441. package/.docs/reference/server/create-route.md +0 -260
  442. package/.docs/reference/server/express-adapter.md +0 -176
  443. package/.docs/reference/server/fastify-adapter.md +0 -90
  444. package/.docs/reference/server/hono-adapter.md +0 -162
  445. package/.docs/reference/server/koa-adapter.md +0 -127
  446. package/.docs/reference/server/mastra-server.md +0 -298
  447. package/.docs/reference/server/register-api-route.md +0 -249
  448. package/.docs/reference/server/routes.md +0 -306
  449. package/.docs/reference/storage/cloudflare-d1.md +0 -218
  450. package/.docs/reference/storage/cloudflare.md +0 -88
  451. package/.docs/reference/storage/composite.md +0 -235
  452. package/.docs/reference/storage/convex.md +0 -161
  453. package/.docs/reference/storage/dynamodb.md +0 -282
  454. package/.docs/reference/storage/lance.md +0 -131
  455. package/.docs/reference/storage/libsql.md +0 -135
  456. package/.docs/reference/storage/mongodb.md +0 -262
  457. package/.docs/reference/storage/mssql.md +0 -155
  458. package/.docs/reference/storage/overview.md +0 -121
  459. package/.docs/reference/storage/postgresql.md +0 -529
  460. package/.docs/reference/storage/upstash.md +0 -160
  461. package/.docs/reference/streaming/ChunkType.md +0 -292
  462. package/.docs/reference/streaming/agents/MastraModelOutput.md +0 -182
  463. package/.docs/reference/streaming/agents/stream.md +0 -212
  464. package/.docs/reference/streaming/agents/streamLegacy.md +0 -142
  465. package/.docs/reference/streaming/workflows/observeStream.md +0 -42
  466. package/.docs/reference/streaming/workflows/resumeStream.md +0 -61
  467. package/.docs/reference/streaming/workflows/stream.md +0 -88
  468. package/.docs/reference/streaming/workflows/timeTravelStream.md +0 -142
  469. package/.docs/reference/templates/overview.md +0 -194
  470. package/.docs/reference/tools/create-tool.md +0 -237
  471. package/.docs/reference/tools/document-chunker-tool.md +0 -89
  472. package/.docs/reference/tools/graph-rag-tool.md +0 -185
  473. package/.docs/reference/tools/mcp-client.md +0 -962
  474. package/.docs/reference/tools/mcp-server.md +0 -1275
  475. package/.docs/reference/tools/vector-query-tool.md +0 -459
  476. package/.docs/reference/vectors/astra.md +0 -121
  477. package/.docs/reference/vectors/chroma.md +0 -267
  478. package/.docs/reference/vectors/convex.md +0 -303
  479. package/.docs/reference/vectors/couchbase.md +0 -226
  480. package/.docs/reference/vectors/duckdb.md +0 -318
  481. package/.docs/reference/vectors/elasticsearch.md +0 -189
  482. package/.docs/reference/vectors/lance.md +0 -220
  483. package/.docs/reference/vectors/libsql.md +0 -305
  484. package/.docs/reference/vectors/mongodb.md +0 -295
  485. package/.docs/reference/vectors/opensearch.md +0 -99
  486. package/.docs/reference/vectors/pg.md +0 -408
  487. package/.docs/reference/vectors/pinecone.md +0 -168
  488. package/.docs/reference/vectors/qdrant.md +0 -222
  489. package/.docs/reference/vectors/s3vectors.md +0 -277
  490. package/.docs/reference/vectors/turbopuffer.md +0 -157
  491. package/.docs/reference/vectors/upstash.md +0 -294
  492. package/.docs/reference/vectors/vectorize.md +0 -147
  493. package/.docs/reference/voice/azure.md +0 -148
  494. package/.docs/reference/voice/cloudflare.md +0 -83
  495. package/.docs/reference/voice/composite-voice.md +0 -121
  496. package/.docs/reference/voice/deepgram.md +0 -79
  497. package/.docs/reference/voice/elevenlabs.md +0 -98
  498. package/.docs/reference/voice/google-gemini-live.md +0 -378
  499. package/.docs/reference/voice/google.md +0 -228
  500. package/.docs/reference/voice/mastra-voice.md +0 -313
  501. package/.docs/reference/voice/murf.md +0 -122
  502. package/.docs/reference/voice/openai-realtime.md +0 -203
  503. package/.docs/reference/voice/openai.md +0 -88
  504. package/.docs/reference/voice/playai.md +0 -80
  505. package/.docs/reference/voice/sarvam.md +0 -126
  506. package/.docs/reference/voice/speechify.md +0 -75
  507. package/.docs/reference/voice/voice.addInstructions.md +0 -56
  508. package/.docs/reference/voice/voice.addTools.md +0 -67
  509. package/.docs/reference/voice/voice.answer.md +0 -54
  510. package/.docs/reference/voice/voice.close.md +0 -51
  511. package/.docs/reference/voice/voice.connect.md +0 -94
  512. package/.docs/reference/voice/voice.events.md +0 -37
  513. package/.docs/reference/voice/voice.getSpeakers.md +0 -129
  514. package/.docs/reference/voice/voice.listen.md +0 -164
  515. package/.docs/reference/voice/voice.off.md +0 -54
  516. package/.docs/reference/voice/voice.on.md +0 -111
  517. package/.docs/reference/voice/voice.send.md +0 -65
  518. package/.docs/reference/voice/voice.speak.md +0 -157
  519. package/.docs/reference/voice/voice.updateConfig.md +0 -60
  520. package/.docs/reference/workflows/run-methods/cancel.md +0 -86
  521. package/.docs/reference/workflows/run-methods/restart.md +0 -33
  522. package/.docs/reference/workflows/run-methods/resume.md +0 -59
  523. package/.docs/reference/workflows/run-methods/start.md +0 -58
  524. package/.docs/reference/workflows/run-methods/startAsync.md +0 -67
  525. package/.docs/reference/workflows/run-methods/timeTravel.md +0 -142
  526. package/.docs/reference/workflows/run.md +0 -59
  527. package/.docs/reference/workflows/step.md +0 -119
  528. package/.docs/reference/workflows/workflow-methods/branch.md +0 -25
  529. package/.docs/reference/workflows/workflow-methods/commit.md +0 -17
  530. package/.docs/reference/workflows/workflow-methods/create-run.md +0 -63
  531. package/.docs/reference/workflows/workflow-methods/dountil.md +0 -25
  532. package/.docs/reference/workflows/workflow-methods/dowhile.md +0 -25
  533. package/.docs/reference/workflows/workflow-methods/foreach.md +0 -118
  534. package/.docs/reference/workflows/workflow-methods/map.md +0 -93
  535. package/.docs/reference/workflows/workflow-methods/parallel.md +0 -21
  536. package/.docs/reference/workflows/workflow-methods/sleep.md +0 -35
  537. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +0 -35
  538. package/.docs/reference/workflows/workflow-methods/then.md +0 -21
  539. package/.docs/reference/workflows/workflow.md +0 -157
  540. package/.docs/reference/workspace/e2b-sandbox.md +0 -288
  541. package/.docs/reference/workspace/filesystem.md +0 -202
  542. package/.docs/reference/workspace/gcs-filesystem.md +0 -170
  543. package/.docs/reference/workspace/local-filesystem.md +0 -327
  544. package/.docs/reference/workspace/local-sandbox.md +0 -285
  545. package/.docs/reference/workspace/s3-filesystem.md +0 -169
  546. package/.docs/reference/workspace/sandbox.md +0 -81
  547. package/.docs/reference/workspace/workspace-class.md +0 -226
@@ -1,162 +0,0 @@
1
- # Filesystem
2
-
3
- **Added in:** `@mastra/core@1.1.0`
4
-
5
- Filesystem providers give agents the ability to read, write, and manage files. When you configure a filesystem on a workspace, agents receive tools for file operations.
6
-
7
- A filesystem provider handles all file operations for a workspace:
8
-
9
- - **Read** - Read file contents
10
- - **Write** - Create and update files
11
- - **List** - Browse directories
12
- - **Delete** - Remove files and directories
13
- - **Stat** - Get file metadata
14
-
15
- ## Supported providers
16
-
17
- Available providers:
18
-
19
- - [`LocalFilesystem`](https://mastra.ai/reference/workspace/local-filesystem) - Stores files in a directory on disk
20
- - [`S3Filesystem`](https://mastra.ai/reference/workspace/s3-filesystem) - Stores files in Amazon S3 or S3-compatible storage (R2, MinIO)
21
- - [`GCSFilesystem`](https://mastra.ai/reference/workspace/gcs-filesystem) - Stores files in Google Cloud Storage
22
-
23
- > **Tip:** `LocalFilesystem` is the simplest way to get started as it requires no external services. For cloud storage, use `S3Filesystem` or `GCSFilesystem`.
24
-
25
- ## Basic usage
26
-
27
- Create a workspace with a filesystem and assign it to an agent. The agent can then read, write, and manage files as part of its tasks:
28
-
29
- ```typescript
30
- import { Agent } from '@mastra/core/agent';
31
- import { Workspace, LocalFilesystem } from '@mastra/core/workspace';
32
-
33
- const workspace = new Workspace({
34
- filesystem: new LocalFilesystem({
35
- basePath: './workspace',
36
- }),
37
- });
38
-
39
- const agent = new Agent({
40
- id: 'file-agent',
41
- model: 'openai/gpt-4o',
42
- instructions: 'You are a helpful file management assistant.',
43
- workspace,
44
- });
45
-
46
- // The agent now has filesystem tools available
47
- const response = await agent.generate('List all files in the workspace');
48
- ```
49
-
50
- ## Containment
51
-
52
- By default, `LocalFilesystem` runs in **contained mode** — all file operations are restricted to stay within `basePath`. This prevents path traversal attacks and symlink escapes.
53
-
54
- In contained mode, absolute paths that fall within `basePath` are used as-is, while other absolute paths are treated as virtual paths relative to `basePath` (e.g. `/file.txt` resolves to `basePath/file.txt`). Any resolved path that escapes `basePath` throws a `PermissionError`.
55
-
56
- If your agent needs to access specific paths outside `basePath`, use `allowedPaths` to grant access without disabling containment entirely:
57
-
58
- ```typescript
59
- const workspace = new Workspace({
60
- filesystem: new LocalFilesystem({
61
- basePath: './workspace',
62
- allowedPaths: ['/home/user/.config', '/home/user/documents'],
63
- }),
64
- });
65
- ```
66
-
67
- Allowed paths can be updated at runtime using the `setAllowedPaths()` method:
68
-
69
- ```typescript
70
- // Add a path dynamically
71
- workspace.filesystem.setAllowedPaths(prev => [...prev, '/home/user/documents']);
72
- ```
73
-
74
- This is the recommended approach for least-privilege access — the agent can only reach the specific directories you allow.
75
-
76
- If your agent needs unrestricted access to the entire filesystem, disable containment:
77
-
78
- ```typescript
79
- const workspace = new Workspace({
80
- filesystem: new LocalFilesystem({
81
- basePath: './workspace',
82
- contained: false,
83
- }),
84
- });
85
- ```
86
-
87
- When `contained` is `false`, absolute paths are treated as real filesystem paths with no restriction.
88
-
89
- ## Read-only mode
90
-
91
- To prevent agents from modifying files, enable read-only mode:
92
-
93
- ```typescript
94
- const workspace = new Workspace({
95
- filesystem: new LocalFilesystem({
96
- basePath: './workspace',
97
- readOnly: true,
98
- }),
99
- });
100
- ```
101
-
102
- When read-only, write tools (`write_file`, `edit_file`, `delete`, `mkdir`) are not added to the agent's toolset. The agent can still read and list files.
103
-
104
- ## Mounts and CompositeFilesystem
105
-
106
- When you use the `mounts` option on a workspace, Mastra creates a `CompositeFilesystem` that routes file operations to the correct provider based on path prefix.
107
-
108
- ```typescript
109
- import { Workspace } from '@mastra/core/workspace';
110
- import { S3Filesystem } from '@mastra/s3';
111
- import { GCSFilesystem } from '@mastra/gcs';
112
- import { E2BSandbox } from '@mastra/e2b';
113
-
114
- const workspace = new Workspace({
115
- mounts: {
116
- '/data': new S3Filesystem({
117
- bucket: 'my-bucket',
118
- region: 'us-east-1',
119
- accessKeyId: process.env.AWS_ACCESS_KEY_ID,
120
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
121
- }),
122
- '/skills': new GCSFilesystem({
123
- bucket: 'agent-skills',
124
- }),
125
- },
126
- sandbox: new E2BSandbox({ id: 'dev-sandbox' }),
127
- });
128
- ```
129
-
130
- With this configuration:
131
-
132
- - `read_file('/data/input.csv')` reads from the S3 bucket
133
- - `write_file('/skills/guide.md', content)` writes to the GCS bucket
134
- - `list_directory('/')` returns virtual entries for `/data` and `/skills`
135
- - Commands in the sandbox can access files at `/data` and `/skills` via FUSE mounts
136
-
137
- ### Path routing
138
-
139
- All file paths must start with a mount prefix. Operations on paths that don't match any mount will fail. Listing the root directory (`/`) returns virtual directory entries for each mount point.
140
-
141
- Mount paths cannot be nested — for example, you cannot mount at both `/data` and `/data/sub`.
142
-
143
- ### `filesystem` vs `mounts`
144
-
145
- `filesystem` and `mounts` are mutually exclusive options on a workspace:
146
-
147
- - Use **`filesystem`** when you have a single storage provider and don't need to mount it into a sandbox. The agent gets file tools that operate directly against the provider.
148
- - Use **`mounts`** when you need cloud storage accessible inside a sandbox, or when you want to combine multiple providers. The workspace creates a CompositeFilesystem for file tools and FUSE-mounts the storage into the sandbox.
149
-
150
- For local development, you typically don't need `mounts` — a `LocalFilesystem` and `LocalSandbox` pointed at the same directory gives you both file tools and command execution on the same files. See [configuration patterns](https://mastra.ai/docs/workspace/overview) for more detail.
151
-
152
- ## Agent tools
153
-
154
- When you configure a filesystem on a workspace, agents receive tools for reading, writing, listing, and deleting files. See [workspace class reference](https://mastra.ai/reference/workspace/workspace-class) for details.
155
-
156
- ## Related
157
-
158
- - [LocalFilesystem reference](https://mastra.ai/reference/workspace/local-filesystem)
159
- - [S3Filesystem reference](https://mastra.ai/reference/workspace/s3-filesystem)
160
- - [GCSFilesystem reference](https://mastra.ai/reference/workspace/gcs-filesystem)
161
- - [Workspace overview](https://mastra.ai/docs/workspace/overview)
162
- - [Sandbox](https://mastra.ai/docs/workspace/sandbox)
@@ -1,239 +0,0 @@
1
- # Workspaces
2
-
3
- **Added in:** `@mastra/core@1.1.0`
4
-
5
- A Mastra workspace gives agents a persistent environment for storing files and executing commands. Agents use workspace tools to read and write files, run shell commands, and search indexed content.
6
-
7
- A workspace supports the following features:
8
-
9
- - **[Filesystem](https://mastra.ai/docs/workspace/filesystem)**: File storage (read, write, list, delete)
10
- - **[Sandbox](https://mastra.ai/docs/workspace/sandbox)**: Command execution (shell commands)
11
- - **[Search](https://mastra.ai/docs/workspace/search)**: BM25, vector, or hybrid search over indexed content
12
- - **[Skills](https://mastra.ai/docs/workspace/skills)**: Reusable instructions for agents
13
-
14
- ## How it works
15
-
16
- When you assign a workspace to an agent, Mastra includes the corresponding tools in the agent's toolset. The agent can then use these tools to interact with files and execute commands.
17
-
18
- You can create a workspace with any combination of the supported features. The agent receives only the tools relevant to what's configured.
19
-
20
- ## Usage
21
-
22
- ### Creating a workspace
23
-
24
- Create a workspace by instantiating the `Workspace` class with your desired features:
25
-
26
- ```typescript
27
- import { Workspace, LocalFilesystem, LocalSandbox } from '@mastra/core/workspace';
28
-
29
- const workspace = new Workspace({
30
- filesystem: new LocalFilesystem({
31
- basePath: './workspace',
32
- }),
33
- sandbox: new LocalSandbox({
34
- workingDirectory: './workspace',
35
- }),
36
- skills: ['/skills'],
37
- });
38
- ```
39
-
40
- The `skills` array specifies paths to directories containing skill definitions, see [Skills](https://mastra.ai/docs/workspace/skills).
41
-
42
- ### Global workspace
43
-
44
- Set a workspace on the Mastra instance. All agents inherit this workspace unless they define their own:
45
-
46
- ```typescript
47
- import { Mastra } from '@mastra/core';
48
- import { Workspace, LocalFilesystem } from '@mastra/core/workspace';
49
-
50
- const workspace = new Workspace({
51
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
52
- });
53
-
54
- const mastra = new Mastra({
55
- workspace,
56
- });
57
- ```
58
-
59
- ### Agent-scoped workspace
60
-
61
- Assign a workspace directly to an agent to override the global workspace:
62
-
63
- ```typescript
64
- import { Agent } from '@mastra/core/agent';
65
- import { Workspace, LocalFilesystem } from '@mastra/core/workspace';
66
-
67
- const workspace = new Workspace({
68
- filesystem: new LocalFilesystem({ basePath: './agent-workspace' }),
69
- });
70
-
71
- export const myAgent = new Agent({
72
- id: 'my-agent',
73
- model: 'openai/gpt-4o',
74
- workspace,
75
- });
76
- ```
77
-
78
- ## Configuration patterns
79
-
80
- Workspaces support several configuration patterns depending on what capabilities your agent needs. The two main building blocks are `filesystem` (file tools) and `sandbox` (command execution), with `mounts` as the way to bridge cloud storage into sandboxes.
81
-
82
- ### Filesystem + sandbox (local)
83
-
84
- For local development, pair a `LocalFilesystem` and `LocalSandbox` pointed at the same directory. Since both operate on the local machine, files written through the filesystem are immediately available to commands in the sandbox:
85
-
86
- ```typescript
87
- const workspace = new Workspace({
88
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
89
- sandbox: new LocalSandbox({ workingDirectory: './workspace' }),
90
- });
91
- ```
92
-
93
- The agent receives both file tools and `execute_command`. This is the simplest full-featured setup.
94
-
95
- ### Mounts + sandbox (cloud storage)
96
-
97
- When you need cloud storage accessible inside a sandbox, use `mounts`. This FUSE-mounts the cloud filesystem into the sandbox so commands can read and write files at the mount path:
98
-
99
- ```typescript
100
- const workspace = new Workspace({
101
- mounts: {
102
- '/data': new S3Filesystem({
103
- bucket: 'my-bucket',
104
- region: 'us-east-1',
105
- accessKeyId: process.env.AWS_ACCESS_KEY_ID,
106
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
107
- }),
108
- '/skills': new GCSFilesystem({
109
- bucket: 'agent-skills',
110
- }),
111
- },
112
- sandbox: new E2BSandbox({ id: 'dev-sandbox' }),
113
- });
114
- ```
115
-
116
- Under the hood, `mounts` creates a [CompositeFilesystem](https://mastra.ai/docs/workspace/filesystem) that routes file tool operations to the correct provider based on path prefix. Commands in the sandbox access the mounted paths directly (e.g., `ls /data`).
117
-
118
- You can mount multiple providers at different paths. Each mount path must be unique and non-overlapping.
119
-
120
- > **Note:** `filesystem` and `mounts` are mutually exclusive — you cannot use both in the same workspace. Use `filesystem` for a single provider without a sandbox, or `mounts` when you need to combine cloud storage with a sandbox.
121
-
122
- ### Filesystem only
123
-
124
- Use a single `filesystem` when agents only need to read and write files. No command execution is available.
125
-
126
- ```typescript
127
- const workspace = new Workspace({
128
- filesystem: new S3Filesystem({
129
- bucket: 'my-bucket',
130
- region: 'us-east-1',
131
- accessKeyId: process.env.AWS_ACCESS_KEY_ID,
132
- secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY,
133
- }),
134
- });
135
- ```
136
-
137
- The agent receives file tools (`read_file`, `write_file`, `list_directory`, etc.) that operate directly against the storage provider.
138
-
139
- ### Sandbox only
140
-
141
- Use a single `sandbox` when agents only need to execute commands. No file tools are added.
142
-
143
- ```typescript
144
- const workspace = new Workspace({
145
- sandbox: new E2BSandbox({ id: 'dev-sandbox' }),
146
- });
147
- ```
148
-
149
- The agent receives the `execute_command` tool.
150
-
151
- ### Which pattern should I use?
152
-
153
- | Scenario | Pattern |
154
- | ----------------------------------------------------- | ----------------------------------------------------- |
155
- | Local development with files and commands | `filesystem` + `sandbox` (both local, same directory) |
156
- | Cloud storage accessible inside a cloud sandbox | `mounts` + `sandbox` |
157
- | Multiple cloud providers in one sandbox | `mounts` + `sandbox` (one mount per provider) |
158
- | Agent reads/writes files, no command execution needed | `filesystem` only |
159
- | Agent runs commands, no file tools needed | `sandbox` only |
160
-
161
- ## Tool configuration
162
-
163
- Configure tool behavior through the `tools` option on the workspace. This controls which tools are enabled and how they behave.
164
-
165
- ```typescript
166
- import { Workspace, LocalFilesystem, LocalSandbox, WORKSPACE_TOOLS } from '@mastra/core/workspace';
167
-
168
- const workspace = new Workspace({
169
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
170
- sandbox: new LocalSandbox({ workingDirectory: './workspace' }),
171
- tools: {
172
- // Global defaults
173
- enabled: true,
174
- requireApproval: false,
175
-
176
- // Per-tool overrides
177
- [WORKSPACE_TOOLS.FILESYSTEM.WRITE_FILE]: {
178
- requireApproval: true,
179
- requireReadBeforeWrite: true,
180
- },
181
- [WORKSPACE_TOOLS.FILESYSTEM.DELETE]: {
182
- enabled: false,
183
- },
184
- [WORKSPACE_TOOLS.SANDBOX.EXECUTE_COMMAND]: {
185
- requireApproval: true,
186
- },
187
- },
188
- });
189
- ```
190
-
191
- ### Tool options
192
-
193
- | Option | Type | Description |
194
- | ------------------------ | --------- | --------------------------------------------------------------------------- |
195
- | `enabled` | `boolean` | Whether the tool is available (default: `true`) |
196
- | `requireApproval` | `boolean` | Whether the tool requires user approval before execution (default: `false`) |
197
- | `requireReadBeforeWrite` | `boolean` | For write tools: require reading the file first (default: `false`) |
198
-
199
- ### Read-before-write
200
-
201
- When `requireReadBeforeWrite` is enabled on write tools, agents must read a file before writing to it. This prevents overwriting files the agent hasn't seen:
202
-
203
- - **New files**: Can be written without reading (they don't exist yet)
204
- - **Existing files**: Must be read first
205
- - **Externally modified files**: If a file changed since the agent read it, the write fails
206
-
207
- ## Initialization
208
-
209
- Calling `init()` is optional in most cases—some providers initialize on first operation. Call `init()` manually when using a workspace outside of Mastra (standalone scripts, tests) or when you need to pre-provision resources before the first agent interaction.
210
-
211
- ```typescript
212
- import { Workspace, LocalFilesystem, LocalSandbox } from '@mastra/core/workspace';
213
-
214
- const workspace = new Workspace({
215
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
216
- sandbox: new LocalSandbox({ workingDirectory: './workspace' }),
217
- });
218
-
219
- // Optional: pre-create directories and sandbox before first use
220
- await workspace.init();
221
- ```
222
-
223
- ### What init() does
224
-
225
- Initialization runs setup logic for each configured provider:
226
-
227
- - `LocalFilesystem`: Creates the base directory if it doesn't exist
228
- - `LocalSandbox`: Creates the working directory
229
- - `Search` (if configured): Indexes files from `autoIndexPaths`, see [Search and Indexing](https://mastra.ai/docs/workspace/search)
230
-
231
- External providers may perform additional setup like establishing connections or authenticating.
232
-
233
- ## Related
234
-
235
- - [Filesystem](https://mastra.ai/docs/workspace/filesystem)
236
- - [Sandbox](https://mastra.ai/docs/workspace/sandbox)
237
- - [Skills](https://mastra.ai/docs/workspace/skills)
238
- - [Search and indexing](https://mastra.ai/docs/workspace/search)
239
- - [Workspace class reference](https://mastra.ai/reference/workspace/workspace-class)
@@ -1,63 +0,0 @@
1
- # Sandbox
2
-
3
- **Added in:** `@mastra/core@1.1.0`
4
-
5
- Sandbox providers give agents the ability to execute shell commands. When you configure a sandbox on a workspace, agents can run commands as part of their tasks.
6
-
7
- A sandbox provider executes commands in a controlled environment:
8
-
9
- - **Command execution** - Run shell commands with arguments
10
- - **Working directory** - Commands run from a specific directory
11
- - **Environment variables** - Control what variables are available
12
- - **Timeouts** - Prevent long-running commands from hanging
13
- - **Isolation** - Optional OS-level sandboxing for security
14
-
15
- When you assign a workspace with a sandbox to an agent, Mastra automatically includes the `execute_command` tool in the agent's toolset.
16
-
17
- ## Supported providers
18
-
19
- Available providers:
20
-
21
- - [`LocalSandbox`](https://mastra.ai/reference/workspace/local-sandbox) - Executes commands on the local machine
22
- - [`E2BSandbox`](https://mastra.ai/reference/workspace/e2b-sandbox) - Executes commands in isolated E2B cloud sandboxes
23
-
24
- ## Basic usage
25
-
26
- Create a workspace with a sandbox and assign it to an agent. The agent can then execute shell commands:
27
-
28
- ```typescript
29
- import { Agent } from '@mastra/core/agent';
30
- import { Workspace, LocalFilesystem, LocalSandbox } from '@mastra/core/workspace';
31
-
32
- const workspace = new Workspace({
33
- filesystem: new LocalFilesystem({
34
- basePath: './workspace',
35
- }),
36
- sandbox: new LocalSandbox({
37
- workingDirectory: './workspace',
38
- }),
39
- });
40
-
41
- const agent = new Agent({
42
- id: 'dev-agent',
43
- model: 'openai/gpt-4o',
44
- instructions: 'You are a helpful development assistant.',
45
- workspace,
46
- });
47
-
48
- // The agent now has the execute_command tool available
49
- const response = await agent.generate('Run `ls -la` in the workspace directory');
50
- ```
51
-
52
- See [`LocalSandbox` reference](https://mastra.ai/reference/workspace/local-sandbox) for configuration options including environment isolation and native OS sandboxing.
53
-
54
- ## Agent tools
55
-
56
- When you configure a sandbox on a workspace, agents receive the `execute_command` tool for running shell commands. See [workspace class reference](https://mastra.ai/reference/workspace/workspace-class) for details.
57
-
58
- ## Related
59
-
60
- - [`LocalSandbox` reference](https://mastra.ai/reference/workspace/local-sandbox)
61
- - [`E2BSandbox` reference](https://mastra.ai/reference/workspace/e2b-sandbox)
62
- - [Workspace overview](https://mastra.ai/docs/workspace/overview)
63
- - [Filesystem](https://mastra.ai/docs/workspace/filesystem)
@@ -1,219 +0,0 @@
1
- # Search and Indexing
2
-
3
- **Added in:** `@mastra/core@1.1.0`
4
-
5
- Search lets agents find relevant content in indexed workspace files. When an agent needs to answer a question or find information, it can search the indexed content instead of reading every file.
6
-
7
- ## How it works
8
-
9
- Workspace search has two phases: indexing and querying.
10
-
11
- ### Indexing
12
-
13
- Content must be indexed before it can be searched. When you index a document:
14
-
15
- - The content is tokenized (split into searchable terms)
16
- - For BM25: term frequencies and document statistics are computed
17
- - For vector: the content is embedded using your embedder function and stored in the vector store
18
-
19
- Each indexed document has:
20
-
21
- - **id** - A unique identifier (typically the file path)
22
- - **content** - The text content
23
- - **metadata** - Optional key-value data stored with the document
24
-
25
- ### Querying
26
-
27
- When you search:
28
-
29
- 1. The query is processed using the same tokenization/embedding as indexing
30
- 2. Documents are scored based on relevance to the query
31
- 3. Results are ranked by score and returned with the matching content
32
-
33
- Workspaces support three search modes: BM25 keyword search, vector semantic search, and hybrid search that combines both.
34
-
35
- ## BM25 keyword search
36
-
37
- BM25 scores documents based on term frequency and document length. It works well for exact matches and specific terminology.
38
-
39
- ```typescript
40
- import { Workspace, LocalFilesystem } from '@mastra/core/workspace';
41
-
42
- const workspace = new Workspace({
43
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
44
- bm25: true,
45
- });
46
- ```
47
-
48
- For custom BM25 parameters (`k1` is term frequency saturation, `b` is document length normalization):
49
-
50
- ```typescript
51
- const workspace = new Workspace({
52
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
53
- bm25: {
54
- k1: 1.5,
55
- b: 0.75,
56
- },
57
- });
58
- ```
59
-
60
- ## Vector search
61
-
62
- Vector search uses embeddings to find semantically similar content. It requires a vector store and embedder function.
63
-
64
- ```typescript
65
- import { Workspace, LocalFilesystem } from '@mastra/core/workspace';
66
- import { PineconeVector } from '@mastra/pinecone';
67
- import { embed } from 'ai';
68
- import { openai } from '@ai-sdk/openai';
69
-
70
- const workspace = new Workspace({
71
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
72
- vectorStore: new PineconeVector({
73
- apiKey: process.env.PINECONE_API_KEY,
74
- index: 'workspace-index',
75
- }),
76
- embedder: async (text: string) => {
77
- const { embedding } = await embed({
78
- model: openai.embedding('text-embedding-3-small'),
79
- value: text,
80
- });
81
- return embedding;
82
- },
83
- });
84
- ```
85
-
86
- ## Hybrid search
87
-
88
- Configure both BM25 and vector search to enable hybrid mode, which combines keyword matching with semantic understanding.
89
-
90
- ```typescript
91
- const workspace = new Workspace({
92
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
93
- bm25: true,
94
- vectorStore: pineconeVector,
95
- embedder: embedderFn,
96
- });
97
- ```
98
-
99
- ## Indexing content
100
-
101
- ### Manual indexing
102
-
103
- Use `workspace.index()` to add content to the search index programmatically. The file paths become document IDs. You can also pass metadata for each document.
104
-
105
- ```typescript
106
- // Basic indexing
107
- await workspace.index('/docs/guide.md', 'Content of the guide...');
108
-
109
- // Index with metadata for filtering or context
110
- await workspace.index('/docs/api.md', apiDocContent, {
111
- metadata: {
112
- category: 'api',
113
- version: '2.0',
114
- },
115
- });
116
- ```
117
-
118
- Manual indexing is useful when:
119
-
120
- - You're indexing content that doesn't come from files (e.g., database records, API responses)
121
- - You want to pre-process or chunk content before indexing
122
- - You need to add custom metadata to documents
123
-
124
- ### Auto-indexing
125
-
126
- Configure `autoIndexPaths` to automatically index files when the workspace initializes. Each path specifies a directory to index recursively.
127
-
128
- ```typescript
129
- const workspace = new Workspace({
130
- filesystem: new LocalFilesystem({ basePath: './workspace' }),
131
- bm25: true,
132
- autoIndexPaths: ['/docs', '/support/faq'],
133
- });
134
-
135
- await workspace.init();
136
- ```
137
-
138
- When `init()` is called, all files in the specified directories are read and indexed for search. The file path becomes the document ID.
139
-
140
- > **Note:** Paths must be directories, not glob patterns. Use `/docs` to index all files in the docs directory recursively. Glob patterns like `**/*.md` are not supported.
141
-
142
- ## Searching
143
-
144
- Use `workspace.search()` to find relevant content. Results are ranked by relevance score.
145
-
146
- ```typescript
147
- const results = await workspace.search('password reset');
148
-
149
- for (const result of results) {
150
- console.log(`${result.id}: ${result.score}`);
151
- console.log(result.content);
152
- }
153
- ```
154
-
155
- ### Search options
156
-
157
- You can customize the search behavior with options:
158
-
159
- ```typescript
160
- const results = await workspace.search('authentication flow', {
161
- topK: 10,
162
- mode: 'hybrid',
163
- minScore: 0.5,
164
- vectorWeight: 0.5,
165
- });
166
- ```
167
-
168
- | Option | Description |
169
- | -------------- | ------------------------------------------------------------------------------------------------------------- |
170
- | `topK` | Maximum number of results to return. Default: 5 |
171
- | `mode` | Search mode: `'bm25'`, `'vector'`, or `'hybrid'`. Defaults to the best available mode based on configuration. |
172
- | `minScore` | Filter out results below this score threshold (0-1). |
173
- | `vectorWeight` | In hybrid mode, how much to weight vector scores vs BM25. 0 = all BM25, 1 = all vector, 0.5 = equal. |
174
-
175
- ### Search results
176
-
177
- Each result contains:
178
-
179
- ```typescript
180
- interface SearchResult {
181
- id: string; // Document ID (typically file path)
182
- content: string; // The matching content
183
- score: number; // Relevance score (0-1)
184
- lineRange?: { // Lines where the match was found
185
- start: number;
186
- end: number;
187
- };
188
- metadata?: Record<string, unknown>; // Metadata stored with the document
189
- scoreDetails?: { // Score breakdown (hybrid mode only)
190
- vector?: number;
191
- bm25?: number;
192
- };
193
- }
194
- ```
195
-
196
- **Understanding scores:**
197
-
198
- - Scores range from 0 to 1, where 1 is a perfect match
199
- - BM25 scores are normalized based on the best match in the result set
200
- - Vector scores represent cosine similarity between query and document embeddings
201
- - In hybrid mode, scores are combined using the `vectorWeight` parameter
202
-
203
- ### When to use each mode
204
-
205
- | Mode | Best for | Example queries |
206
- | -------- | ------------------------------------ | ------------------------------------------------------------------------ |
207
- | `bm25` | Exact terms, technical queries, code | "useState hook", "404 error", "config.yaml" |
208
- | `vector` | Conceptual queries, natural language | "how to handle user authentication", "best practices for error handling" |
209
- | `hybrid` | General search, unknown query types | Most agent use cases |
210
-
211
- ## Agent tools
212
-
213
- When you configure search on a workspace, agents receive tools for searching and indexing content. See [workspace class reference](https://mastra.ai/reference/workspace/workspace-class) for details.
214
-
215
- ## Related
216
-
217
- - [Workspace overview](https://mastra.ai/docs/workspace/overview)
218
- - [RAG overview](https://mastra.ai/docs/rag/overview)
219
- - [Workspace class reference](https://mastra.ai/reference/workspace/workspace-class)