@mastra/mcp-docs-server 1.1.5 → 1.1.6-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 (556) hide show
  1. package/.docs/docs/agents/adding-voice.md +349 -0
  2. package/.docs/docs/agents/agent-approval.md +558 -0
  3. package/.docs/docs/agents/agent-memory.md +209 -0
  4. package/.docs/docs/agents/guardrails.md +374 -0
  5. package/.docs/docs/agents/network-approval.md +275 -0
  6. package/.docs/docs/agents/networks.md +299 -0
  7. package/.docs/docs/agents/overview.md +304 -0
  8. package/.docs/docs/agents/processors.md +622 -0
  9. package/.docs/docs/agents/structured-output.md +273 -0
  10. package/.docs/docs/agents/supervisor-agents.md +304 -0
  11. package/.docs/docs/agents/using-tools.md +214 -0
  12. package/.docs/docs/build-with-ai/mcp-docs-server.md +238 -0
  13. package/.docs/docs/build-with-ai/skills.md +35 -0
  14. package/.docs/docs/community/contributing-templates.md +3 -0
  15. package/.docs/docs/community/discord.md +9 -0
  16. package/.docs/docs/community/licensing.md +66 -0
  17. package/.docs/docs/deployment/cloud-providers.md +15 -0
  18. package/.docs/docs/deployment/mastra-server.md +122 -0
  19. package/.docs/docs/deployment/monorepo.md +142 -0
  20. package/.docs/docs/deployment/overview.md +62 -0
  21. package/.docs/docs/deployment/studio.md +239 -0
  22. package/.docs/docs/deployment/web-framework.md +52 -0
  23. package/.docs/docs/deployment/workflow-runners.md +9 -0
  24. package/.docs/docs/evals/built-in-scorers.md +47 -0
  25. package/.docs/docs/evals/custom-scorers.md +519 -0
  26. package/.docs/docs/evals/overview.md +141 -0
  27. package/.docs/docs/evals/running-in-ci.md +124 -0
  28. package/.docs/docs/getting-started/build-with-ai.md +68 -0
  29. package/.docs/docs/getting-started/manual-install.md +226 -0
  30. package/.docs/docs/getting-started/project-structure.md +60 -0
  31. package/.docs/docs/getting-started/start.md +28 -0
  32. package/.docs/docs/getting-started/studio.md +101 -0
  33. package/.docs/docs/index.md +43 -0
  34. package/.docs/docs/mastra-cloud/deployment.md +77 -0
  35. package/.docs/docs/mastra-cloud/observability.md +38 -0
  36. package/.docs/docs/mastra-cloud/overview.md +23 -0
  37. package/.docs/docs/mastra-cloud/setup.md +42 -0
  38. package/.docs/docs/mastra-cloud/studio.md +24 -0
  39. package/.docs/docs/mastra-code/configuration.md +299 -0
  40. package/.docs/docs/mastra-code/customization.md +228 -0
  41. package/.docs/docs/mastra-code/modes.md +104 -0
  42. package/.docs/docs/mastra-code/overview.md +135 -0
  43. package/.docs/docs/mastra-code/tools.md +229 -0
  44. package/.docs/docs/mcp/overview.md +373 -0
  45. package/.docs/docs/mcp/publishing-mcp-server.md +95 -0
  46. package/.docs/docs/memory/memory-processors.md +314 -0
  47. package/.docs/docs/memory/message-history.md +260 -0
  48. package/.docs/docs/memory/observational-memory.md +248 -0
  49. package/.docs/docs/memory/overview.md +45 -0
  50. package/.docs/docs/memory/semantic-recall.md +272 -0
  51. package/.docs/docs/memory/storage.md +261 -0
  52. package/.docs/docs/memory/working-memory.md +400 -0
  53. package/.docs/docs/observability/datasets/overview.md +198 -0
  54. package/.docs/docs/observability/datasets/running-experiments.md +274 -0
  55. package/.docs/docs/observability/logging.md +99 -0
  56. package/.docs/docs/observability/overview.md +70 -0
  57. package/.docs/docs/observability/tracing/bridges/otel.md +209 -0
  58. package/.docs/docs/observability/tracing/exporters/arize.md +272 -0
  59. package/.docs/docs/observability/tracing/exporters/braintrust.md +111 -0
  60. package/.docs/docs/observability/tracing/exporters/cloud.md +127 -0
  61. package/.docs/docs/observability/tracing/exporters/datadog.md +187 -0
  62. package/.docs/docs/observability/tracing/exporters/default.md +209 -0
  63. package/.docs/docs/observability/tracing/exporters/laminar.md +100 -0
  64. package/.docs/docs/observability/tracing/exporters/langfuse.md +213 -0
  65. package/.docs/docs/observability/tracing/exporters/langsmith.md +198 -0
  66. package/.docs/docs/observability/tracing/exporters/otel.md +476 -0
  67. package/.docs/docs/observability/tracing/exporters/posthog.md +148 -0
  68. package/.docs/docs/observability/tracing/exporters/sentry.md +208 -0
  69. package/.docs/docs/observability/tracing/overview.md +1112 -0
  70. package/.docs/docs/observability/tracing/processors/sensitive-data-filter.md +300 -0
  71. package/.docs/docs/rag/chunking-and-embedding.md +183 -0
  72. package/.docs/docs/rag/graph-rag.md +215 -0
  73. package/.docs/docs/rag/overview.md +72 -0
  74. package/.docs/docs/rag/retrieval.md +515 -0
  75. package/.docs/docs/rag/vector-databases.md +645 -0
  76. package/.docs/docs/server/auth/auth0.md +220 -0
  77. package/.docs/docs/server/auth/better-auth.md +203 -0
  78. package/.docs/docs/server/auth/clerk.md +132 -0
  79. package/.docs/docs/server/auth/composite-auth.md +234 -0
  80. package/.docs/docs/server/auth/custom-auth-provider.md +513 -0
  81. package/.docs/docs/server/auth/firebase.md +272 -0
  82. package/.docs/docs/server/auth/jwt.md +110 -0
  83. package/.docs/docs/server/auth/simple-auth.md +180 -0
  84. package/.docs/docs/server/auth/supabase.md +117 -0
  85. package/.docs/docs/server/auth/workos.md +186 -0
  86. package/.docs/docs/server/auth.md +38 -0
  87. package/.docs/docs/server/custom-adapters.md +378 -0
  88. package/.docs/docs/server/custom-api-routes.md +267 -0
  89. package/.docs/docs/server/mastra-client.md +243 -0
  90. package/.docs/docs/server/mastra-server.md +71 -0
  91. package/.docs/docs/server/middleware.md +225 -0
  92. package/.docs/docs/server/request-context.md +471 -0
  93. package/.docs/docs/server/server-adapters.md +547 -0
  94. package/.docs/docs/streaming/events.md +237 -0
  95. package/.docs/docs/streaming/overview.md +175 -0
  96. package/.docs/docs/streaming/tool-streaming.md +175 -0
  97. package/.docs/docs/streaming/workflow-streaming.md +109 -0
  98. package/.docs/docs/voice/overview.md +959 -0
  99. package/.docs/docs/voice/speech-to-speech.md +102 -0
  100. package/.docs/docs/voice/speech-to-text.md +79 -0
  101. package/.docs/docs/voice/text-to-speech.md +83 -0
  102. package/.docs/docs/workflows/agents-and-tools.md +166 -0
  103. package/.docs/docs/workflows/control-flow.md +822 -0
  104. package/.docs/docs/workflows/error-handling.md +360 -0
  105. package/.docs/docs/workflows/human-in-the-loop.md +215 -0
  106. package/.docs/docs/workflows/overview.md +370 -0
  107. package/.docs/docs/workflows/snapshots.md +238 -0
  108. package/.docs/docs/workflows/suspend-and-resume.md +205 -0
  109. package/.docs/docs/workflows/time-travel.md +309 -0
  110. package/.docs/docs/workflows/workflow-state.md +181 -0
  111. package/.docs/docs/workspace/filesystem.md +164 -0
  112. package/.docs/docs/workspace/overview.md +239 -0
  113. package/.docs/docs/workspace/sandbox.md +63 -0
  114. package/.docs/docs/workspace/search.md +243 -0
  115. package/.docs/docs/workspace/skills.md +169 -0
  116. package/.docs/guides/agent-frameworks/ai-sdk.md +140 -0
  117. package/.docs/guides/build-your-ui/ai-sdk-ui.md +1499 -0
  118. package/.docs/guides/build-your-ui/assistant-ui.md +156 -0
  119. package/.docs/guides/build-your-ui/copilotkit.md +289 -0
  120. package/.docs/guides/deployment/amazon-ec2.md +130 -0
  121. package/.docs/guides/deployment/aws-lambda.md +248 -0
  122. package/.docs/guides/deployment/azure-app-services.md +114 -0
  123. package/.docs/guides/deployment/cloudflare.md +99 -0
  124. package/.docs/guides/deployment/digital-ocean.md +168 -0
  125. package/.docs/guides/deployment/inngest.md +682 -0
  126. package/.docs/guides/deployment/netlify.md +77 -0
  127. package/.docs/guides/deployment/vercel.md +101 -0
  128. package/.docs/guides/getting-started/astro.md +398 -0
  129. package/.docs/guides/getting-started/electron.md +504 -0
  130. package/.docs/guides/getting-started/express.md +251 -0
  131. package/.docs/guides/getting-started/hono.md +190 -0
  132. package/.docs/guides/getting-started/next-js.md +347 -0
  133. package/.docs/guides/getting-started/nuxt.md +497 -0
  134. package/.docs/guides/getting-started/quickstart.md +67 -0
  135. package/.docs/guides/getting-started/sveltekit.md +296 -0
  136. package/.docs/guides/getting-started/vite-react.md +425 -0
  137. package/.docs/guides/guide/ai-recruiter.md +226 -0
  138. package/.docs/guides/guide/chef-michel.md +211 -0
  139. package/.docs/guides/guide/code-review-bot.md +226 -0
  140. package/.docs/guides/guide/dev-assistant.md +307 -0
  141. package/.docs/guides/guide/docs-manager.md +238 -0
  142. package/.docs/guides/guide/github-actions-pr-description.md +236 -0
  143. package/.docs/guides/guide/notes-mcp-server.md +416 -0
  144. package/.docs/guides/guide/research-assistant.md +348 -0
  145. package/.docs/guides/guide/research-coordinator.md +416 -0
  146. package/.docs/guides/guide/stock-agent.md +132 -0
  147. package/.docs/guides/guide/web-search.md +320 -0
  148. package/.docs/guides/guide/whatsapp-chat-bot.md +405 -0
  149. package/.docs/guides/index.md +3 -0
  150. package/.docs/guides/migrations/agentnetwork.md +97 -0
  151. package/.docs/guides/migrations/ai-sdk-v4-to-v5.md +112 -0
  152. package/.docs/guides/migrations/network-to-supervisor.md +261 -0
  153. package/.docs/guides/migrations/upgrade-to-v1/agent.md +404 -0
  154. package/.docs/guides/migrations/upgrade-to-v1/cli.md +57 -0
  155. package/.docs/guides/migrations/upgrade-to-v1/client.md +337 -0
  156. package/.docs/guides/migrations/upgrade-to-v1/deployment.md +37 -0
  157. package/.docs/guides/migrations/upgrade-to-v1/evals.md +239 -0
  158. package/.docs/guides/migrations/upgrade-to-v1/mastra.md +143 -0
  159. package/.docs/guides/migrations/upgrade-to-v1/mcp.md +97 -0
  160. package/.docs/guides/migrations/upgrade-to-v1/memory.md +285 -0
  161. package/.docs/guides/migrations/upgrade-to-v1/overview.md +119 -0
  162. package/.docs/guides/migrations/upgrade-to-v1/processors.md +68 -0
  163. package/.docs/guides/migrations/upgrade-to-v1/rag.md +42 -0
  164. package/.docs/guides/migrations/upgrade-to-v1/storage.md +553 -0
  165. package/.docs/guides/migrations/upgrade-to-v1/tools.md +180 -0
  166. package/.docs/guides/migrations/upgrade-to-v1/tracing.md +412 -0
  167. package/.docs/guides/migrations/upgrade-to-v1/vectors.md +87 -0
  168. package/.docs/guides/migrations/upgrade-to-v1/voice.md +30 -0
  169. package/.docs/guides/migrations/upgrade-to-v1/workflows.md +341 -0
  170. package/.docs/guides/migrations/vnext-to-standard-apis.md +362 -0
  171. package/.docs/models/embeddings.md +161 -0
  172. package/.docs/models/gateways/azure-openai.md +128 -0
  173. package/.docs/models/gateways/custom-gateways.md +545 -0
  174. package/.docs/models/gateways/netlify.md +88 -0
  175. package/.docs/models/gateways/openrouter.md +219 -0
  176. package/.docs/models/gateways/vercel.md +225 -0
  177. package/.docs/models/gateways.md +14 -0
  178. package/.docs/models/index.md +286 -0
  179. package/.docs/models/providers/302ai.md +134 -0
  180. package/.docs/models/providers/abacus.md +125 -0
  181. package/.docs/models/providers/agentrouter.md +90 -0
  182. package/.docs/models/providers/aihubmix.md +107 -0
  183. package/.docs/models/providers/alibaba-cn.md +135 -0
  184. package/.docs/models/providers/alibaba.md +111 -0
  185. package/.docs/models/providers/amazon-bedrock.md +33 -0
  186. package/.docs/models/providers/anthropic.md +153 -0
  187. package/.docs/models/providers/azure.md +33 -0
  188. package/.docs/models/providers/bailing.md +72 -0
  189. package/.docs/models/providers/baseten.md +77 -0
  190. package/.docs/models/providers/berget.md +78 -0
  191. package/.docs/models/providers/cerebras.md +101 -0
  192. package/.docs/models/providers/chutes.md +136 -0
  193. package/.docs/models/providers/cloudflare-ai-gateway.md +33 -0
  194. package/.docs/models/providers/cloudflare-workers-ai.md +109 -0
  195. package/.docs/models/providers/cohere.md +33 -0
  196. package/.docs/models/providers/cortecs.md +91 -0
  197. package/.docs/models/providers/deepinfra.md +112 -0
  198. package/.docs/models/providers/deepseek.md +88 -0
  199. package/.docs/models/providers/fastrouter.md +84 -0
  200. package/.docs/models/providers/fireworks-ai.md +89 -0
  201. package/.docs/models/providers/firmware.md +85 -0
  202. package/.docs/models/providers/friendli.md +78 -0
  203. package/.docs/models/providers/github-models.md +125 -0
  204. package/.docs/models/providers/google-vertex.md +33 -0
  205. package/.docs/models/providers/google.md +159 -0
  206. package/.docs/models/providers/groq.md +107 -0
  207. package/.docs/models/providers/helicone.md +161 -0
  208. package/.docs/models/providers/huggingface.md +90 -0
  209. package/.docs/models/providers/iflowcn.md +84 -0
  210. package/.docs/models/providers/inception.md +72 -0
  211. package/.docs/models/providers/inference.md +79 -0
  212. package/.docs/models/providers/io-intelligence.md +87 -0
  213. package/.docs/models/providers/io-net.md +87 -0
  214. package/.docs/models/providers/jiekou.md +131 -0
  215. package/.docs/models/providers/kilo.md +333 -0
  216. package/.docs/models/providers/kimi-for-coding.md +100 -0
  217. package/.docs/models/providers/kuae-cloud-coding-plan.md +71 -0
  218. package/.docs/models/providers/llama.md +77 -0
  219. package/.docs/models/providers/lmstudio.md +73 -0
  220. package/.docs/models/providers/lucidquery.md +72 -0
  221. package/.docs/models/providers/minimax-cn-coding-plan.md +102 -0
  222. package/.docs/models/providers/minimax-cn.md +102 -0
  223. package/.docs/models/providers/minimax-coding-plan.md +102 -0
  224. package/.docs/models/providers/minimax.md +104 -0
  225. package/.docs/models/providers/mistral.md +124 -0
  226. package/.docs/models/providers/moark.md +72 -0
  227. package/.docs/models/providers/modelscope.md +77 -0
  228. package/.docs/models/providers/moonshotai-cn.md +76 -0
  229. package/.docs/models/providers/moonshotai.md +76 -0
  230. package/.docs/models/providers/morph.md +73 -0
  231. package/.docs/models/providers/nano-gpt.md +103 -0
  232. package/.docs/models/providers/nebius.md +116 -0
  233. package/.docs/models/providers/nova.md +72 -0
  234. package/.docs/models/providers/novita-ai.md +154 -0
  235. package/.docs/models/providers/nvidia.md +141 -0
  236. package/.docs/models/providers/ollama-cloud.md +103 -0
  237. package/.docs/models/providers/ollama.md +33 -0
  238. package/.docs/models/providers/openai.md +193 -0
  239. package/.docs/models/providers/opencode.md +100 -0
  240. package/.docs/models/providers/ovhcloud.md +83 -0
  241. package/.docs/models/providers/perplexity.md +100 -0
  242. package/.docs/models/providers/poe.md +183 -0
  243. package/.docs/models/providers/privatemode-ai.md +75 -0
  244. package/.docs/models/providers/requesty.md +90 -0
  245. package/.docs/models/providers/scaleway.md +84 -0
  246. package/.docs/models/providers/siliconflow-cn.md +138 -0
  247. package/.docs/models/providers/siliconflow.md +140 -0
  248. package/.docs/models/providers/stackit.md +78 -0
  249. package/.docs/models/providers/stepfun.md +73 -0
  250. package/.docs/models/providers/submodel.md +79 -0
  251. package/.docs/models/providers/synthetic.md +96 -0
  252. package/.docs/models/providers/togetherai.md +115 -0
  253. package/.docs/models/providers/upstage.md +73 -0
  254. package/.docs/models/providers/venice.md +95 -0
  255. package/.docs/models/providers/vivgrid.md +106 -0
  256. package/.docs/models/providers/vultr.md +75 -0
  257. package/.docs/models/providers/wandb.md +80 -0
  258. package/.docs/models/providers/xai.md +141 -0
  259. package/.docs/models/providers/xiaomi.md +71 -0
  260. package/.docs/models/providers/zai-coding-plan.md +80 -0
  261. package/.docs/models/providers/zai.md +79 -0
  262. package/.docs/models/providers/zenmux.md +161 -0
  263. package/.docs/models/providers/zhipuai-coding-plan.md +79 -0
  264. package/.docs/models/providers/zhipuai.md +79 -0
  265. package/.docs/models/providers.md +81 -0
  266. package/.docs/reference/agents/agent.md +141 -0
  267. package/.docs/reference/agents/generate.md +186 -0
  268. package/.docs/reference/agents/generateLegacy.md +173 -0
  269. package/.docs/reference/agents/getDefaultGenerateOptions.md +36 -0
  270. package/.docs/reference/agents/getDefaultOptions.md +34 -0
  271. package/.docs/reference/agents/getDefaultStreamOptions.md +36 -0
  272. package/.docs/reference/agents/getDescription.md +21 -0
  273. package/.docs/reference/agents/getInstructions.md +34 -0
  274. package/.docs/reference/agents/getLLM.md +37 -0
  275. package/.docs/reference/agents/getMemory.md +34 -0
  276. package/.docs/reference/agents/getModel.md +34 -0
  277. package/.docs/reference/agents/getTools.md +29 -0
  278. package/.docs/reference/agents/getVoice.md +34 -0
  279. package/.docs/reference/agents/listAgents.md +35 -0
  280. package/.docs/reference/agents/listScorers.md +34 -0
  281. package/.docs/reference/agents/listTools.md +34 -0
  282. package/.docs/reference/agents/listWorkflows.md +34 -0
  283. package/.docs/reference/agents/network.md +133 -0
  284. package/.docs/reference/ai-sdk/chat-route.md +82 -0
  285. package/.docs/reference/ai-sdk/handle-chat-stream.md +53 -0
  286. package/.docs/reference/ai-sdk/handle-network-stream.md +37 -0
  287. package/.docs/reference/ai-sdk/handle-workflow-stream.md +55 -0
  288. package/.docs/reference/ai-sdk/network-route.md +74 -0
  289. package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +231 -0
  290. package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +79 -0
  291. package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +76 -0
  292. package/.docs/reference/ai-sdk/with-mastra.md +59 -0
  293. package/.docs/reference/ai-sdk/workflow-route.md +79 -0
  294. package/.docs/reference/auth/auth0.md +73 -0
  295. package/.docs/reference/auth/better-auth.md +71 -0
  296. package/.docs/reference/auth/clerk.md +36 -0
  297. package/.docs/reference/auth/firebase.md +80 -0
  298. package/.docs/reference/auth/jwt.md +26 -0
  299. package/.docs/reference/auth/supabase.md +33 -0
  300. package/.docs/reference/auth/workos.md +84 -0
  301. package/.docs/reference/cli/create-mastra.md +137 -0
  302. package/.docs/reference/cli/mastra.md +336 -0
  303. package/.docs/reference/client-js/agents.md +437 -0
  304. package/.docs/reference/client-js/error-handling.md +16 -0
  305. package/.docs/reference/client-js/logs.md +24 -0
  306. package/.docs/reference/client-js/mastra-client.md +63 -0
  307. package/.docs/reference/client-js/memory.md +221 -0
  308. package/.docs/reference/client-js/observability.md +72 -0
  309. package/.docs/reference/client-js/telemetry.md +20 -0
  310. package/.docs/reference/client-js/tools.md +44 -0
  311. package/.docs/reference/client-js/vectors.md +79 -0
  312. package/.docs/reference/client-js/workflows.md +199 -0
  313. package/.docs/reference/configuration.md +752 -0
  314. package/.docs/reference/core/addGateway.md +42 -0
  315. package/.docs/reference/core/getAgent.md +21 -0
  316. package/.docs/reference/core/getAgentById.md +21 -0
  317. package/.docs/reference/core/getDeployer.md +22 -0
  318. package/.docs/reference/core/getGateway.md +38 -0
  319. package/.docs/reference/core/getGatewayById.md +41 -0
  320. package/.docs/reference/core/getLogger.md +22 -0
  321. package/.docs/reference/core/getMCPServer.md +47 -0
  322. package/.docs/reference/core/getMCPServerById.md +55 -0
  323. package/.docs/reference/core/getMemory.md +50 -0
  324. package/.docs/reference/core/getScorer.md +54 -0
  325. package/.docs/reference/core/getScorerById.md +54 -0
  326. package/.docs/reference/core/getServer.md +22 -0
  327. package/.docs/reference/core/getStorage.md +22 -0
  328. package/.docs/reference/core/getStoredAgentById.md +89 -0
  329. package/.docs/reference/core/getTelemetry.md +22 -0
  330. package/.docs/reference/core/getVector.md +22 -0
  331. package/.docs/reference/core/getWorkflow.md +42 -0
  332. package/.docs/reference/core/listAgents.md +21 -0
  333. package/.docs/reference/core/listGateways.md +40 -0
  334. package/.docs/reference/core/listLogs.md +38 -0
  335. package/.docs/reference/core/listLogsByRunId.md +36 -0
  336. package/.docs/reference/core/listMCPServers.md +55 -0
  337. package/.docs/reference/core/listMemory.md +56 -0
  338. package/.docs/reference/core/listScorers.md +29 -0
  339. package/.docs/reference/core/listStoredAgents.md +93 -0
  340. package/.docs/reference/core/listVectors.md +22 -0
  341. package/.docs/reference/core/listWorkflows.md +21 -0
  342. package/.docs/reference/core/mastra-class.md +66 -0
  343. package/.docs/reference/core/mastra-model-gateway.md +153 -0
  344. package/.docs/reference/core/setLogger.md +26 -0
  345. package/.docs/reference/core/setStorage.md +27 -0
  346. package/.docs/reference/datasets/addItem.md +37 -0
  347. package/.docs/reference/datasets/addItems.md +35 -0
  348. package/.docs/reference/datasets/compareExperiments.md +52 -0
  349. package/.docs/reference/datasets/create.md +51 -0
  350. package/.docs/reference/datasets/dataset.md +82 -0
  351. package/.docs/reference/datasets/datasets-manager.md +94 -0
  352. package/.docs/reference/datasets/delete.md +25 -0
  353. package/.docs/reference/datasets/deleteExperiment.md +27 -0
  354. package/.docs/reference/datasets/deleteItem.md +27 -0
  355. package/.docs/reference/datasets/deleteItems.md +29 -0
  356. package/.docs/reference/datasets/get.md +31 -0
  357. package/.docs/reference/datasets/getDetails.md +47 -0
  358. package/.docs/reference/datasets/getExperiment.md +30 -0
  359. package/.docs/reference/datasets/getItem.md +33 -0
  360. package/.docs/reference/datasets/getItemHistory.md +31 -0
  361. package/.docs/reference/datasets/list.md +31 -0
  362. package/.docs/reference/datasets/listExperimentResults.md +39 -0
  363. package/.docs/reference/datasets/listExperiments.md +33 -0
  364. package/.docs/reference/datasets/listItems.md +46 -0
  365. package/.docs/reference/datasets/listVersions.md +33 -0
  366. package/.docs/reference/datasets/startExperiment.md +62 -0
  367. package/.docs/reference/datasets/startExperimentAsync.md +43 -0
  368. package/.docs/reference/datasets/update.md +48 -0
  369. package/.docs/reference/datasets/updateItem.md +38 -0
  370. package/.docs/reference/deployer/cloudflare.md +79 -0
  371. package/.docs/reference/deployer/netlify.md +80 -0
  372. package/.docs/reference/deployer/vercel.md +91 -0
  373. package/.docs/reference/deployer.md +100 -0
  374. package/.docs/reference/evals/answer-relevancy.md +105 -0
  375. package/.docs/reference/evals/answer-similarity.md +99 -0
  376. package/.docs/reference/evals/bias.md +120 -0
  377. package/.docs/reference/evals/completeness.md +136 -0
  378. package/.docs/reference/evals/content-similarity.md +101 -0
  379. package/.docs/reference/evals/context-precision.md +196 -0
  380. package/.docs/reference/evals/context-relevance.md +531 -0
  381. package/.docs/reference/evals/create-scorer.md +270 -0
  382. package/.docs/reference/evals/faithfulness.md +114 -0
  383. package/.docs/reference/evals/hallucination.md +213 -0
  384. package/.docs/reference/evals/keyword-coverage.md +128 -0
  385. package/.docs/reference/evals/mastra-scorer.md +123 -0
  386. package/.docs/reference/evals/noise-sensitivity.md +675 -0
  387. package/.docs/reference/evals/prompt-alignment.md +614 -0
  388. package/.docs/reference/evals/run-evals.md +179 -0
  389. package/.docs/reference/evals/scorer-utils.md +326 -0
  390. package/.docs/reference/evals/textual-difference.md +113 -0
  391. package/.docs/reference/evals/tone-consistency.md +119 -0
  392. package/.docs/reference/evals/tool-call-accuracy.md +533 -0
  393. package/.docs/reference/evals/toxicity.md +123 -0
  394. package/.docs/reference/harness/harness-class.md +708 -0
  395. package/.docs/reference/index.md +277 -0
  396. package/.docs/reference/logging/pino-logger.md +117 -0
  397. package/.docs/reference/mastra-code/createMastraCode.md +108 -0
  398. package/.docs/reference/memory/clone-utilities.md +199 -0
  399. package/.docs/reference/memory/cloneThread.md +130 -0
  400. package/.docs/reference/memory/createThread.md +68 -0
  401. package/.docs/reference/memory/deleteMessages.md +38 -0
  402. package/.docs/reference/memory/getThreadById.md +24 -0
  403. package/.docs/reference/memory/listThreads.md +145 -0
  404. package/.docs/reference/memory/memory-class.md +147 -0
  405. package/.docs/reference/memory/observational-memory.md +565 -0
  406. package/.docs/reference/memory/recall.md +91 -0
  407. package/.docs/reference/observability/tracing/bridges/otel.md +131 -0
  408. package/.docs/reference/observability/tracing/configuration.md +178 -0
  409. package/.docs/reference/observability/tracing/exporters/arize.md +141 -0
  410. package/.docs/reference/observability/tracing/exporters/braintrust.md +93 -0
  411. package/.docs/reference/observability/tracing/exporters/cloud-exporter.md +163 -0
  412. package/.docs/reference/observability/tracing/exporters/console-exporter.md +138 -0
  413. package/.docs/reference/observability/tracing/exporters/datadog.md +116 -0
  414. package/.docs/reference/observability/tracing/exporters/default-exporter.md +174 -0
  415. package/.docs/reference/observability/tracing/exporters/laminar.md +78 -0
  416. package/.docs/reference/observability/tracing/exporters/langfuse.md +134 -0
  417. package/.docs/reference/observability/tracing/exporters/langsmith.md +108 -0
  418. package/.docs/reference/observability/tracing/exporters/otel.md +199 -0
  419. package/.docs/reference/observability/tracing/exporters/posthog.md +92 -0
  420. package/.docs/reference/observability/tracing/exporters/sentry.md +184 -0
  421. package/.docs/reference/observability/tracing/instances.md +107 -0
  422. package/.docs/reference/observability/tracing/interfaces.md +743 -0
  423. package/.docs/reference/observability/tracing/processors/sensitive-data-filter.md +144 -0
  424. package/.docs/reference/observability/tracing/spans.md +224 -0
  425. package/.docs/reference/processors/batch-parts-processor.md +61 -0
  426. package/.docs/reference/processors/language-detector.md +82 -0
  427. package/.docs/reference/processors/message-history-processor.md +85 -0
  428. package/.docs/reference/processors/moderation-processor.md +104 -0
  429. package/.docs/reference/processors/pii-detector.md +108 -0
  430. package/.docs/reference/processors/processor-interface.md +521 -0
  431. package/.docs/reference/processors/prompt-injection-detector.md +72 -0
  432. package/.docs/reference/processors/semantic-recall-processor.md +117 -0
  433. package/.docs/reference/processors/system-prompt-scrubber.md +80 -0
  434. package/.docs/reference/processors/token-limiter-processor.md +115 -0
  435. package/.docs/reference/processors/tool-call-filter.md +85 -0
  436. package/.docs/reference/processors/tool-search-processor.md +111 -0
  437. package/.docs/reference/processors/unicode-normalizer.md +62 -0
  438. package/.docs/reference/processors/working-memory-processor.md +152 -0
  439. package/.docs/reference/rag/chunk.md +221 -0
  440. package/.docs/reference/rag/database-config.md +261 -0
  441. package/.docs/reference/rag/document.md +114 -0
  442. package/.docs/reference/rag/embeddings.md +92 -0
  443. package/.docs/reference/rag/extract-params.md +168 -0
  444. package/.docs/reference/rag/graph-rag.md +111 -0
  445. package/.docs/reference/rag/metadata-filters.md +216 -0
  446. package/.docs/reference/rag/rerank.md +75 -0
  447. package/.docs/reference/rag/rerankWithScorer.md +80 -0
  448. package/.docs/reference/server/create-route.md +262 -0
  449. package/.docs/reference/server/express-adapter.md +176 -0
  450. package/.docs/reference/server/fastify-adapter.md +90 -0
  451. package/.docs/reference/server/hono-adapter.md +162 -0
  452. package/.docs/reference/server/koa-adapter.md +127 -0
  453. package/.docs/reference/server/mastra-server.md +298 -0
  454. package/.docs/reference/server/register-api-route.md +249 -0
  455. package/.docs/reference/server/routes.md +306 -0
  456. package/.docs/reference/storage/cloudflare-d1.md +218 -0
  457. package/.docs/reference/storage/cloudflare.md +88 -0
  458. package/.docs/reference/storage/composite.md +235 -0
  459. package/.docs/reference/storage/convex.md +161 -0
  460. package/.docs/reference/storage/dynamodb.md +282 -0
  461. package/.docs/reference/storage/lance.md +131 -0
  462. package/.docs/reference/storage/libsql.md +135 -0
  463. package/.docs/reference/storage/mongodb.md +262 -0
  464. package/.docs/reference/storage/mssql.md +157 -0
  465. package/.docs/reference/storage/overview.md +121 -0
  466. package/.docs/reference/storage/postgresql.md +526 -0
  467. package/.docs/reference/storage/upstash.md +160 -0
  468. package/.docs/reference/streaming/ChunkType.md +292 -0
  469. package/.docs/reference/streaming/agents/MastraModelOutput.md +182 -0
  470. package/.docs/reference/streaming/agents/stream.md +221 -0
  471. package/.docs/reference/streaming/agents/streamLegacy.md +142 -0
  472. package/.docs/reference/streaming/workflows/observeStream.md +42 -0
  473. package/.docs/reference/streaming/workflows/resumeStream.md +61 -0
  474. package/.docs/reference/streaming/workflows/stream.md +88 -0
  475. package/.docs/reference/streaming/workflows/timeTravelStream.md +142 -0
  476. package/.docs/reference/templates/overview.md +194 -0
  477. package/.docs/reference/tools/create-tool.md +237 -0
  478. package/.docs/reference/tools/document-chunker-tool.md +89 -0
  479. package/.docs/reference/tools/graph-rag-tool.md +182 -0
  480. package/.docs/reference/tools/mcp-client.md +954 -0
  481. package/.docs/reference/tools/mcp-server.md +1271 -0
  482. package/.docs/reference/tools/vector-query-tool.md +459 -0
  483. package/.docs/reference/vectors/astra.md +121 -0
  484. package/.docs/reference/vectors/chroma.md +264 -0
  485. package/.docs/reference/vectors/convex.md +300 -0
  486. package/.docs/reference/vectors/couchbase.md +226 -0
  487. package/.docs/reference/vectors/duckdb.md +318 -0
  488. package/.docs/reference/vectors/elasticsearch.md +189 -0
  489. package/.docs/reference/vectors/lance.md +220 -0
  490. package/.docs/reference/vectors/libsql.md +305 -0
  491. package/.docs/reference/vectors/mongodb.md +295 -0
  492. package/.docs/reference/vectors/opensearch.md +99 -0
  493. package/.docs/reference/vectors/pg.md +408 -0
  494. package/.docs/reference/vectors/pinecone.md +168 -0
  495. package/.docs/reference/vectors/qdrant.md +222 -0
  496. package/.docs/reference/vectors/s3vectors.md +277 -0
  497. package/.docs/reference/vectors/turbopuffer.md +157 -0
  498. package/.docs/reference/vectors/upstash.md +294 -0
  499. package/.docs/reference/vectors/vectorize.md +147 -0
  500. package/.docs/reference/voice/azure.md +148 -0
  501. package/.docs/reference/voice/cloudflare.md +83 -0
  502. package/.docs/reference/voice/composite-voice.md +121 -0
  503. package/.docs/reference/voice/deepgram.md +79 -0
  504. package/.docs/reference/voice/elevenlabs.md +98 -0
  505. package/.docs/reference/voice/google-gemini-live.md +378 -0
  506. package/.docs/reference/voice/google.md +228 -0
  507. package/.docs/reference/voice/mastra-voice.md +311 -0
  508. package/.docs/reference/voice/murf.md +122 -0
  509. package/.docs/reference/voice/openai-realtime.md +203 -0
  510. package/.docs/reference/voice/openai.md +88 -0
  511. package/.docs/reference/voice/playai.md +80 -0
  512. package/.docs/reference/voice/sarvam.md +126 -0
  513. package/.docs/reference/voice/speechify.md +75 -0
  514. package/.docs/reference/voice/voice.addInstructions.md +55 -0
  515. package/.docs/reference/voice/voice.addTools.md +67 -0
  516. package/.docs/reference/voice/voice.answer.md +54 -0
  517. package/.docs/reference/voice/voice.close.md +51 -0
  518. package/.docs/reference/voice/voice.connect.md +94 -0
  519. package/.docs/reference/voice/voice.events.md +37 -0
  520. package/.docs/reference/voice/voice.getSpeakers.md +129 -0
  521. package/.docs/reference/voice/voice.listen.md +164 -0
  522. package/.docs/reference/voice/voice.off.md +54 -0
  523. package/.docs/reference/voice/voice.on.md +111 -0
  524. package/.docs/reference/voice/voice.send.md +65 -0
  525. package/.docs/reference/voice/voice.speak.md +157 -0
  526. package/.docs/reference/voice/voice.updateConfig.md +60 -0
  527. package/.docs/reference/workflows/run-methods/cancel.md +86 -0
  528. package/.docs/reference/workflows/run-methods/restart.md +33 -0
  529. package/.docs/reference/workflows/run-methods/resume.md +59 -0
  530. package/.docs/reference/workflows/run-methods/start.md +58 -0
  531. package/.docs/reference/workflows/run-methods/startAsync.md +67 -0
  532. package/.docs/reference/workflows/run-methods/timeTravel.md +142 -0
  533. package/.docs/reference/workflows/run.md +59 -0
  534. package/.docs/reference/workflows/step.md +119 -0
  535. package/.docs/reference/workflows/workflow-methods/branch.md +25 -0
  536. package/.docs/reference/workflows/workflow-methods/commit.md +17 -0
  537. package/.docs/reference/workflows/workflow-methods/create-run.md +63 -0
  538. package/.docs/reference/workflows/workflow-methods/dountil.md +25 -0
  539. package/.docs/reference/workflows/workflow-methods/dowhile.md +25 -0
  540. package/.docs/reference/workflows/workflow-methods/foreach.md +118 -0
  541. package/.docs/reference/workflows/workflow-methods/map.md +93 -0
  542. package/.docs/reference/workflows/workflow-methods/parallel.md +21 -0
  543. package/.docs/reference/workflows/workflow-methods/sleep.md +35 -0
  544. package/.docs/reference/workflows/workflow-methods/sleepUntil.md +35 -0
  545. package/.docs/reference/workflows/workflow-methods/then.md +21 -0
  546. package/.docs/reference/workflows/workflow.md +157 -0
  547. package/.docs/reference/workspace/e2b-sandbox.md +289 -0
  548. package/.docs/reference/workspace/filesystem.md +255 -0
  549. package/.docs/reference/workspace/gcs-filesystem.md +174 -0
  550. package/.docs/reference/workspace/local-filesystem.md +343 -0
  551. package/.docs/reference/workspace/local-sandbox.md +301 -0
  552. package/.docs/reference/workspace/s3-filesystem.md +175 -0
  553. package/.docs/reference/workspace/sandbox.md +87 -0
  554. package/.docs/reference/workspace/workspace-class.md +244 -0
  555. package/CHANGELOG.md +8 -0
  556. package/package.json +5 -5
@@ -0,0 +1,286 @@
1
+ # Model Providers
2
+
3
+ Mastra provides a unified interface for working with LLMs across multiple providers, giving you access to 2436 models from 81 providers through a single API.
4
+
5
+ ## Features
6
+
7
+ - **One API for any model** - Access any model without having to install and manage additional provider dependencies.
8
+
9
+ - **Access the newest AI** - Use new models the moment they're released, no matter which provider they come from. Avoid vendor lock-in with Mastra's provider-agnostic interface.
10
+
11
+ - [**Mix and match models**](#mix-and-match-models) - Use different models for different tasks. For example, run GPT-4o-mini for large-context processing, then switch to Claude Opus 4.1 for reasoning tasks.
12
+
13
+ - [**Model fallbacks**](#model-fallbacks) - If a provider experiences an outage, Mastra can automatically switch to another provider at the application level, minimizing latency compared to API gateways.
14
+
15
+ ## Basic usage
16
+
17
+ Whether you're using OpenAI, Anthropic, Google, or a gateway like OpenRouter, specify the model as `"provider/model-name"` and Mastra handles the rest.
18
+
19
+ Mastra reads the relevant environment variable (e.g. `ANTHROPIC_API_KEY`) and routes requests to the provider. If an API key is missing, you'll get a clear runtime error showing exactly which variable to set.
20
+
21
+ **OpenAI**:
22
+
23
+ ```typescript
24
+ import { Agent } from "@mastra/core/agent";
25
+
26
+ const agent = new Agent({
27
+ id: "my-agent",
28
+ name: "My Agent",
29
+ instructions: "You are a helpful assistant",
30
+ model: "openai/gpt-5"
31
+ })
32
+ ```
33
+
34
+ **Anthropic**:
35
+
36
+ ```typescript
37
+ import { Agent } from "@mastra/core/agent";
38
+
39
+ const agent = new Agent({
40
+ id: "my-agent",
41
+ name: "My Agent",
42
+ instructions: "You are a helpful assistant",
43
+ model: "anthropic/claude-4-5-sonnet"
44
+ })
45
+ ```
46
+
47
+ **Google Gemini**:
48
+
49
+ ```typescript
50
+ import { Agent } from "@mastra/core/agent";
51
+
52
+ const agent = new Agent({
53
+ id: "my-agent",
54
+ name: "My Agent",
55
+ instructions: "You are a helpful assistant",
56
+ model: "google/gemini-2.5-flash"
57
+ })
58
+ ```
59
+
60
+ **xAI**:
61
+
62
+ ```typescript
63
+ import { Agent } from "@mastra/core/agent";
64
+
65
+ const agent = new Agent({
66
+ id: "my-agent",
67
+ name: "My Agent",
68
+ instructions: "You are a helpful assistant",
69
+ model: "xai/grok-4"
70
+ })
71
+ ```
72
+
73
+ **OpenRouter**:
74
+
75
+ ```typescript
76
+ import { Agent } from "@mastra/core/agent";
77
+
78
+ const agent = new Agent({
79
+ id: "my-agent",
80
+ name: "My Agent",
81
+ instructions: "You are a helpful assistant",
82
+ model: "openrouter/anthropic/claude-haiku-4-5"
83
+ })
84
+ ```
85
+
86
+ ## Model directory
87
+
88
+ Browse the directory of available models using the navigation on the left, or explore below.
89
+
90
+ - [Gateways](https://mastra.ai/models/gateways)
91
+ - [Providers](https://mastra.ai/models/providers)
92
+
93
+ You can also discover models directly in your editor. Mastra provides full autocomplete for the `model` field - just start typing, and your IDE will show available options.
94
+
95
+ Alternatively, browse and test models in [Studio](https://mastra.ai/docs/getting-started/studio) UI.
96
+
97
+ > **Info:** In development, we auto-refresh your local model list every hour, ensuring your TypeScript autocomplete and Studio stay up-to-date with the latest models. To disable, set `MASTRA_AUTO_REFRESH_PROVIDERS=false`. Auto-refresh is disabled by default in production.
98
+
99
+ ## Mix and match models
100
+
101
+ Some models are faster but less capable, while others offer larger context windows or stronger reasoning skills. Use different models from the same provider, or mix and match across providers to fit each task.
102
+
103
+ ```typescript
104
+ import { Agent } from "@mastra/core/agent";
105
+
106
+ // Use a cost-effective model for document processing
107
+ const documentProcessor = new Agent({
108
+ id: "document-processor",
109
+ name: "Document Processor",
110
+ instructions: "Extract and summarize key information from documents",
111
+ model: "openai/gpt-4o-mini"
112
+ })
113
+
114
+ // Use a powerful reasoning model for complex analysis
115
+ const reasoningAgent = new Agent({
116
+ id: "reasoning-agent",
117
+ name: "Reasoning Agent",
118
+ instructions: "Analyze data and provide strategic recommendations",
119
+ model: "anthropic/claude-opus-4-1"
120
+ })
121
+ ```
122
+
123
+ ## Dynamic model selection
124
+
125
+ Since models are just strings, you can select them dynamically based on [request context](https://mastra.ai/docs/server/request-context), variables, or any other logic.
126
+
127
+ ```typescript
128
+ const agent = new Agent({
129
+ id: "dynamic-assistant",
130
+ name: "Dynamic Assistant",
131
+ model: ({ requestContext }) => {
132
+ const provider = requestContext.get("provider-id");
133
+ const model = requestContext.get("model-id");
134
+ return `${provider}/${model}`;
135
+ },
136
+ });
137
+ ```
138
+
139
+ This enables powerful patterns:
140
+
141
+ - A/B testing - Compare model performance in production.
142
+ - User-selectable models - Let users choose their preferred model in your app.
143
+ - Multi-tenant applications - Each customer can bring their own API keys and model preferences.
144
+
145
+ ## Provider-specific options
146
+
147
+ Different model providers expose their own configuration options. With OpenAI, you might adjust the `reasoningEffort`. With Anthropic, you might tune `cacheControl`. Mastra lets you set these specific `providerOptions` either at the agent level or per message.
148
+
149
+ ```typescript
150
+ // Agent level (apply to all future messages)
151
+ const planner = new Agent({
152
+ id: "planner",
153
+ name: "Planner",
154
+ instructions: {
155
+ role: "system",
156
+ content: "You are a helpful assistant.",
157
+ providerOptions: {
158
+ openai: { reasoningEffort: "low" }
159
+ }
160
+ },
161
+ model: "openai/o3-pro",
162
+ });
163
+
164
+ const lowEffort =
165
+ await planner.generate("Plan a simple 3 item dinner menu");
166
+
167
+ // Message level (apply only to this message)
168
+ const highEffort = await planner.generate([
169
+ {
170
+ role: "user",
171
+ content: "Plan a simple 3 item dinner menu for a celiac",
172
+ providerOptions: {
173
+ openai: { reasoningEffort: "high" }
174
+ }
175
+ }
176
+ ]);
177
+ ```
178
+
179
+ ## Custom headers
180
+
181
+ If you need to specify custom headers, such as an organization ID or other provider-specific fields, use this syntax.
182
+
183
+ ```typescript
184
+ const agent = new Agent({
185
+ id: "custom-agent",
186
+ name: "Custom Agent",
187
+ model: {
188
+ id: "openai/gpt-4-turbo",
189
+ apiKey: process.env.OPENAI_API_KEY,
190
+ headers: {
191
+ "OpenAI-Organization": "org-abc123"
192
+ }
193
+ }
194
+ });
195
+ ```
196
+
197
+ > **Info:** Configuration differs by provider. See the provider pages in the left navigation for details on custom headers.
198
+
199
+ ## Model fallbacks
200
+
201
+ Relying on a single model creates a single point of failure for your application. Model fallbacks provide automatic failover between models and providers. If the primary model becomes unavailable, requests are retried against the next configured fallback until one succeeds.
202
+
203
+ ```typescript
204
+ import { Agent } from '@mastra/core/agent';
205
+
206
+ const agent = new Agent({
207
+ id: 'resilient-assistant',
208
+ name: 'Resilient Assistant',
209
+ instructions: 'You are a helpful assistant.',
210
+ model: [
211
+ {
212
+ model: "openai/gpt-5",
213
+ maxRetries: 3,
214
+ },
215
+ {
216
+ model: "anthropic/claude-4-5-sonnet",
217
+ maxRetries: 2,
218
+ },
219
+ {
220
+ model: "google/gemini-2.5-pro",
221
+ maxRetries: 2,
222
+ },
223
+ ],
224
+ });
225
+ ```
226
+
227
+ Mastra tries your primary model first. If it encounters a 500 error, rate limit, or timeout, it automatically switches to your first fallback. If that fails too, it moves to the next. Each model gets its own retry count before moving on.
228
+
229
+ Your users never experience the disruption - the response comes back with the same format, just from a different model. The error context is preserved as the system moves through your fallback chain, ensuring clean error propagation while maintaining streaming compatibility.
230
+
231
+ ## Use local models with Mastra
232
+
233
+ Mastra also supports local models like `gpt-oss`, `Qwen3`, `DeepSeek` and many more that you run on your own hardware. The application running your local model needs to provide an OpenAI-compatible API server for Mastra to connect to. We recommend using [LMStudio](https://lmstudio.ai/) (see [Running the LMStudio server](https://lmstudio.ai/docs/developer/core/server)).
234
+
235
+ For a custom provider the `id` (`${providerId}/${modelId}`) is required but it will only be used for display purposes. The `modelId` needs to be the actual model you want to use. An example would be: `custom/my-qwen3-model`.
236
+
237
+ For the `url` it's **important** that you use the base URL of the OpenAI-compatible endpoint with Mastra's `model` setting and not the individual chat endpoints.
238
+
239
+ ```typescript
240
+ import { Agent } from "@mastra/core/agent";
241
+
242
+ const agent = new Agent({
243
+ id: "my-agent",
244
+ name: "My Agent",
245
+ instructions: "You are a helpful assistant",
246
+ model: {
247
+ id: "custom/my-qwen3-model",
248
+ url: "http://your-custom-openai-compatible-endpoint.com/v1"
249
+ }
250
+ })
251
+ ```
252
+
253
+ ### Example: LMStudio
254
+
255
+ After starting the LMStudio server, the local server is available at `http://localhost:1234` and it provides endpoints like `/v1/models`, `/v1/chat/completions`, etc. The `url` will be `http://localhost:1234/v1`. For the `id` you can use (`lmstudio/${modelId}`) which will be displayed in the LMStudio interface.
256
+
257
+ ```typescript
258
+ import { Agent } from "@mastra/core/agent";
259
+
260
+ const agent = new Agent({
261
+ id: "my-agent",
262
+ name: "My Agent",
263
+ instructions: "You are a helpful assistant",
264
+ model: {
265
+ id: "lmstudio/qwen/qwen3-30b-a3b-2507",
266
+ url: "http://localhost:1234/v1"
267
+ }
268
+ })
269
+ ```
270
+
271
+ ## Use AI SDK with Mastra
272
+
273
+ Mastra supports AI SDK provider modules, should you need to use them directly.
274
+
275
+ ```typescript
276
+ import { groq } from '@ai-sdk/groq';
277
+ import { Agent } from "@mastra/core/agent";
278
+
279
+ const agent = new Agent({
280
+ id: "my-agent",
281
+ name: "My Agent",
282
+ model: groq('gemma2-9b-it')
283
+ })
284
+ ```
285
+
286
+ You can use an AI SDK model (e.g. `groq('gemma2-9b-it')`) anywhere that accepts a `"provider/model"` string, including within model router fallbacks and [scorers](https://mastra.ai/docs/evals/overview).
@@ -0,0 +1,134 @@
1
+ # ![302.AI logo](https://models.dev/logos/302ai.svg)302.AI
2
+
3
+ Access 64 302.AI models through Mastra's model router. Authentication is handled automatically using the `302AI_API_KEY` environment variable.
4
+
5
+ Learn more in the [302.AI documentation](https://doc.302.ai).
6
+
7
+ ```bash
8
+ 302AI_API_KEY=your-api-key
9
+ ```
10
+
11
+ ```typescript
12
+ import { Agent } from "@mastra/core/agent";
13
+
14
+ const agent = new Agent({
15
+ id: "my-agent",
16
+ name: "My Agent",
17
+ instructions: "You are a helpful assistant",
18
+ model: "302ai/MiniMax-M1"
19
+ });
20
+
21
+ // Generate a response
22
+ const response = await agent.generate("Hello!");
23
+
24
+ // Stream a response
25
+ const stream = await agent.stream("Tell me a story");
26
+ for await (const chunk of stream) {
27
+ console.log(chunk);
28
+ }
29
+ ```
30
+
31
+ > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [302.AI documentation](https://doc.302.ai) for details.
32
+
33
+ ## Models
34
+
35
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
36
+ | --------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
37
+ | `302ai/chatgpt-4o-latest` | 128K | | | | | | $5 | $15 |
38
+ | `302ai/claude-haiku-4-5-20251001` | 200K | | | | | | $1 | $5 |
39
+ | `302ai/claude-opus-4-1-20250805` | 200K | | | | | | $15 | $75 |
40
+ | `302ai/claude-opus-4-1-20250805-thinking` | 200K | | | | | | $15 | $75 |
41
+ | `302ai/claude-opus-4-5-20251101` | 200K | | | | | | $5 | $25 |
42
+ | `302ai/claude-opus-4-5-20251101-thinking` | 200K | | | | | | $5 | $25 |
43
+ | `302ai/claude-sonnet-4-5-20250929` | 200K | | | | | | $3 | $15 |
44
+ | `302ai/claude-sonnet-4-5-20250929-thinking` | 200K | | | | | | $3 | $15 |
45
+ | `302ai/deepseek-chat` | 128K | | | | | | $0.29 | $0.43 |
46
+ | `302ai/deepseek-reasoner` | 128K | | | | | | $0.29 | $0.43 |
47
+ | `302ai/deepseek-v3.2` | 128K | | | | | | $0.29 | $0.43 |
48
+ | `302ai/deepseek-v3.2-thinking` | 128K | | | | | | $0.29 | $0.43 |
49
+ | `302ai/doubao-seed-1-6-thinking-250715` | 256K | | | | | | $0.12 | $1 |
50
+ | `302ai/doubao-seed-1-6-vision-250815` | 256K | | | | | | $0.11 | $1 |
51
+ | `302ai/doubao-seed-1-8-251215` | 224K | | | | | | $0.11 | $0.29 |
52
+ | `302ai/doubao-seed-code-preview-251028` | 256K | | | | | | $0.17 | $1 |
53
+ | `302ai/gemini-2.0-flash-lite` | 2.0M | | | | | | $0.07 | $0.30 |
54
+ | `302ai/gemini-2.5-flash` | 1.0M | | | | | | $0.30 | $3 |
55
+ | `302ai/gemini-2.5-flash-image` | 33K | | | | | | $0.30 | $30 |
56
+ | `302ai/gemini-2.5-flash-lite-preview-09-2025` | 1.0M | | | | | | $0.10 | $0.40 |
57
+ | `302ai/gemini-2.5-flash-nothink` | 1.0M | | | | | | $0.30 | $3 |
58
+ | `302ai/gemini-2.5-flash-preview-09-2025` | 1.0M | | | | | | $0.30 | $3 |
59
+ | `302ai/gemini-2.5-pro` | 1.0M | | | | | | $1 | $10 |
60
+ | `302ai/gemini-3-flash-preview` | 1.0M | | | | | | $0.50 | $3 |
61
+ | `302ai/gemini-3-pro-image-preview` | 33K | | | | | | $2 | $120 |
62
+ | `302ai/gemini-3-pro-preview` | 1.0M | | | | | | $2 | $12 |
63
+ | `302ai/glm-4.5` | 128K | | | | | | $0.29 | $1 |
64
+ | `302ai/glm-4.5v` | 64K | | | | | | $0.29 | $0.86 |
65
+ | `302ai/glm-4.6` | 200K | | | | | | $0.29 | $1 |
66
+ | `302ai/glm-4.6v` | 128K | | | | | | $0.14 | $0.43 |
67
+ | `302ai/glm-4.7` | 200K | | | | | | $0.29 | $1 |
68
+ | `302ai/gpt-4.1` | 1.0M | | | | | | $2 | $8 |
69
+ | `302ai/gpt-4.1-mini` | 1.0M | | | | | | $0.40 | $2 |
70
+ | `302ai/gpt-4.1-nano` | 1.0M | | | | | | $0.10 | $0.40 |
71
+ | `302ai/gpt-4o` | 128K | | | | | | $3 | $10 |
72
+ | `302ai/gpt-5` | 400K | | | | | | $1 | $10 |
73
+ | `302ai/gpt-5-mini` | 400K | | | | | | $0.25 | $2 |
74
+ | `302ai/gpt-5-pro` | 400K | | | | | | $15 | $120 |
75
+ | `302ai/gpt-5-thinking` | 400K | | | | | | $1 | $10 |
76
+ | `302ai/gpt-5.1` | 400K | | | | | | $1 | $10 |
77
+ | `302ai/gpt-5.1-chat-latest` | 128K | | | | | | $1 | $10 |
78
+ | `302ai/gpt-5.2` | 400K | | | | | | $2 | $14 |
79
+ | `302ai/gpt-5.2-chat-latest` | 128K | | | | | | $2 | $14 |
80
+ | `302ai/grok-4-1-fast-non-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
81
+ | `302ai/grok-4-1-fast-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
82
+ | `302ai/grok-4-fast-non-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
83
+ | `302ai/grok-4-fast-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
84
+ | `302ai/grok-4.1` | 200K | | | | | | $2 | $10 |
85
+ | `302ai/kimi-k2-0905-preview` | 262K | | | | | | $0.63 | $3 |
86
+ | `302ai/kimi-k2-thinking` | 262K | | | | | | $0.57 | $2 |
87
+ | `302ai/kimi-k2-thinking-turbo` | 262K | | | | | | $1 | $9 |
88
+ | `302ai/MiniMax-M1` | 1.0M | | | | | | $0.13 | $1 |
89
+ | `302ai/MiniMax-M2` | 1.0M | | | | | | $0.33 | $1 |
90
+ | `302ai/MiniMax-M2.1` | 1.0M | | | | | | $0.30 | $1 |
91
+ | `302ai/ministral-14b-2512` | 128K | | | | | | $0.33 | $0.33 |
92
+ | `302ai/mistral-large-2512` | 128K | | | | | | $1 | $3 |
93
+ | `302ai/qwen-flash` | 1.0M | | | | | | $0.02 | $0.22 |
94
+ | `302ai/qwen-max-latest` | 131K | | | | | | $0.34 | $1 |
95
+ | `302ai/qwen-plus` | 1.0M | | | | | | $0.12 | $1 |
96
+ | `302ai/qwen3-235b-a22b` | 128K | | | | | | $0.29 | $3 |
97
+ | `302ai/qwen3-235b-a22b-instruct-2507` | 128K | | | | | | $0.29 | $1 |
98
+ | `302ai/qwen3-30b-a3b` | 128K | | | | | | $0.11 | $1 |
99
+ | `302ai/qwen3-coder-480b-a35b-instruct` | 262K | | | | | | $0.86 | $3 |
100
+ | `302ai/qwen3-max-2025-09-23` | 258K | | | | | | $0.86 | $3 |
101
+
102
+ ## Advanced Configuration
103
+
104
+ ### Custom Headers
105
+
106
+ ```typescript
107
+ const agent = new Agent({
108
+ id: "custom-agent",
109
+ name: "custom-agent",
110
+ model: {
111
+ url: "https://api.302.ai/v1",
112
+ id: "302ai/MiniMax-M1",
113
+ apiKey: process.env.302AI_API_KEY,
114
+ headers: {
115
+ "X-Custom-Header": "value"
116
+ }
117
+ }
118
+ });
119
+ ```
120
+
121
+ ### Dynamic Model Selection
122
+
123
+ ```typescript
124
+ const agent = new Agent({
125
+ id: "dynamic-agent",
126
+ name: "Dynamic Agent",
127
+ model: ({ requestContext }) => {
128
+ const useAdvanced = requestContext.task === "complex";
129
+ return useAdvanced
130
+ ? "302ai/qwen3-max-2025-09-23"
131
+ : "302ai/MiniMax-M1";
132
+ }
133
+ });
134
+ ```
@@ -0,0 +1,125 @@
1
+ # ![Abacus logo](https://models.dev/logos/abacus.svg)Abacus
2
+
3
+ Access 55 Abacus models through Mastra's model router. Authentication is handled automatically using the `ABACUS_API_KEY` environment variable.
4
+
5
+ Learn more in the [Abacus documentation](https://abacus.ai).
6
+
7
+ ```bash
8
+ ABACUS_API_KEY=your-api-key
9
+ ```
10
+
11
+ ```typescript
12
+ import { Agent } from "@mastra/core/agent";
13
+
14
+ const agent = new Agent({
15
+ id: "my-agent",
16
+ name: "My Agent",
17
+ instructions: "You are a helpful assistant",
18
+ model: "abacus/Qwen/QwQ-32B"
19
+ });
20
+
21
+ // Generate a response
22
+ const response = await agent.generate("Hello!");
23
+
24
+ // Stream a response
25
+ const stream = await agent.stream("Tell me a story");
26
+ for await (const chunk of stream) {
27
+ console.log(chunk);
28
+ }
29
+ ```
30
+
31
+ > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Abacus documentation](https://abacus.ai) for details.
32
+
33
+ ## Models
34
+
35
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
36
+ | ---------------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
37
+ | `abacus/claude-3-7-sonnet-20250219` | 200K | | | | | | $3 | $15 |
38
+ | `abacus/claude-haiku-4-5-20251001` | 200K | | | | | | $1 | $5 |
39
+ | `abacus/claude-opus-4-1-20250805` | 200K | | | | | | $15 | $75 |
40
+ | `abacus/claude-opus-4-20250514` | 200K | | | | | | $15 | $75 |
41
+ | `abacus/claude-opus-4-5-20251101` | 200K | | | | | | $5 | $25 |
42
+ | `abacus/claude-sonnet-4-20250514` | 200K | | | | | | $3 | $15 |
43
+ | `abacus/claude-sonnet-4-5-20250929` | 200K | | | | | | $3 | $15 |
44
+ | `abacus/deepseek-ai/DeepSeek-R1` | 128K | | | | | | $3 | $7 |
45
+ | `abacus/deepseek-ai/DeepSeek-V3.1-Terminus` | 128K | | | | | | $0.27 | $1 |
46
+ | `abacus/deepseek-ai/DeepSeek-V3.2` | 128K | | | | | | $0.27 | $0.40 |
47
+ | `abacus/deepseek/deepseek-v3.1` | 128K | | | | | | $0.14 | $0.28 |
48
+ | `abacus/gemini-2.0-flash-001` | 1.0M | | | | | | $0.10 | $0.40 |
49
+ | `abacus/gemini-2.0-pro-exp-02-05` | 2.0M | | | | | | — | — |
50
+ | `abacus/gemini-2.5-flash` | 1.0M | | | | | | $0.30 | $3 |
51
+ | `abacus/gemini-2.5-pro` | 1.0M | | | | | | $1 | $10 |
52
+ | `abacus/gemini-3-flash-preview` | 1.0M | | | | | | $0.50 | $3 |
53
+ | `abacus/gemini-3-pro-preview` | 1.0M | | | | | | $2 | $12 |
54
+ | `abacus/gpt-4.1` | 1.0M | | | | | | $2 | $8 |
55
+ | `abacus/gpt-4.1-mini` | 1.0M | | | | | | $0.40 | $2 |
56
+ | `abacus/gpt-4.1-nano` | 1.0M | | | | | | $0.10 | $0.40 |
57
+ | `abacus/gpt-4o-2024-11-20` | 128K | | | | | | $3 | $10 |
58
+ | `abacus/gpt-4o-mini` | 128K | | | | | | $0.15 | $0.60 |
59
+ | `abacus/gpt-5` | 400K | | | | | | $1 | $10 |
60
+ | `abacus/gpt-5-mini` | 400K | | | | | | $0.25 | $2 |
61
+ | `abacus/gpt-5-nano` | 400K | | | | | | $0.05 | $0.40 |
62
+ | `abacus/gpt-5.1` | 400K | | | | | | $1 | $10 |
63
+ | `abacus/gpt-5.1-chat-latest` | 400K | | | | | | $1 | $10 |
64
+ | `abacus/gpt-5.2` | 400K | | | | | | $2 | $14 |
65
+ | `abacus/gpt-5.2-chat-latest` | 400K | | | | | | $2 | $12 |
66
+ | `abacus/grok-4-0709` | 256K | | | | | | $3 | $15 |
67
+ | `abacus/grok-4-1-fast-non-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
68
+ | `abacus/grok-4-fast-non-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
69
+ | `abacus/grok-code-fast-1` | 256K | | | | | | $0.20 | $2 |
70
+ | `abacus/kimi-k2-turbo-preview` | 256K | | | | | | $0.15 | $8 |
71
+ | `abacus/llama-3.3-70b-versatile` | 128K | | | | | | $0.59 | $0.79 |
72
+ | `abacus/meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8` | 1.0M | | | | | | $0.14 | $0.59 |
73
+ | `abacus/meta-llama/Meta-Llama-3.1-405B-Instruct-Turbo` | 128K | | | | | | $4 | $4 |
74
+ | `abacus/meta-llama/Meta-Llama-3.1-70B-Instruct` | 128K | | | | | | $0.40 | $0.40 |
75
+ | `abacus/meta-llama/Meta-Llama-3.1-8B-Instruct` | 128K | | | | | | $0.02 | $0.05 |
76
+ | `abacus/o3` | 200K | | | | | | $2 | $8 |
77
+ | `abacus/o3-mini` | 200K | | | | | | $1 | $4 |
78
+ | `abacus/o3-pro` | 200K | | | | | | $20 | $80 |
79
+ | `abacus/o4-mini` | 200K | | | | | | $1 | $4 |
80
+ | `abacus/openai/gpt-oss-120b` | 128K | | | | | | $0.08 | $0.44 |
81
+ | `abacus/qwen-2.5-coder-32b` | 128K | | | | | | $0.79 | $0.79 |
82
+ | `abacus/Qwen/Qwen2.5-72B-Instruct` | 128K | | | | | | $0.11 | $0.38 |
83
+ | `abacus/Qwen/Qwen3-235B-A22B-Instruct-2507` | 262K | | | | | | $0.13 | $0.60 |
84
+ | `abacus/Qwen/Qwen3-32B` | 128K | | | | | | $0.09 | $0.29 |
85
+ | `abacus/Qwen/qwen3-coder-480b-a35b-instruct` | 262K | | | | | | $0.29 | $1 |
86
+ | `abacus/Qwen/QwQ-32B` | 33K | | | | | | $0.40 | $0.40 |
87
+ | `abacus/qwen3-max` | 131K | | | | | | $1 | $6 |
88
+ | `abacus/route-llm` | 128K | | | | | | $0.50 | $2 |
89
+ | `abacus/zai-org/glm-4.5` | 128K | | | | | | $0.60 | $2 |
90
+ | `abacus/zai-org/glm-4.6` | 128K | | | | | | $0.60 | $2 |
91
+ | `abacus/zai-org/glm-4.7` | 128K | | | | | | $0.70 | $3 |
92
+
93
+ ## Advanced Configuration
94
+
95
+ ### Custom Headers
96
+
97
+ ```typescript
98
+ const agent = new Agent({
99
+ id: "custom-agent",
100
+ name: "custom-agent",
101
+ model: {
102
+ url: "https://routellm.abacus.ai/v1",
103
+ id: "abacus/Qwen/QwQ-32B",
104
+ apiKey: process.env.ABACUS_API_KEY,
105
+ headers: {
106
+ "X-Custom-Header": "value"
107
+ }
108
+ }
109
+ });
110
+ ```
111
+
112
+ ### Dynamic Model Selection
113
+
114
+ ```typescript
115
+ const agent = new Agent({
116
+ id: "dynamic-agent",
117
+ name: "Dynamic Agent",
118
+ model: ({ requestContext }) => {
119
+ const useAdvanced = requestContext.task === "complex";
120
+ return useAdvanced
121
+ ? "abacus/zai-org/glm-4.7"
122
+ : "abacus/Qwen/QwQ-32B";
123
+ }
124
+ });
125
+ ```
@@ -0,0 +1,90 @@
1
+ # ![AgentRouter logo](https://models.dev/logos/agentrouter.svg)AgentRouter
2
+
3
+ Access 20 AgentRouter models through Mastra's model router. Authentication is handled automatically using the `AGENTROUTER_API_KEY` environment variable.
4
+
5
+ Learn more in the [AgentRouter documentation](https://docs.agentrouter.org).
6
+
7
+ ```bash
8
+ AGENTROUTER_API_KEY=your-api-key
9
+ ```
10
+
11
+ ```typescript
12
+ import { Agent } from "@mastra/core/agent";
13
+
14
+ const agent = new Agent({
15
+ id: "my-agent",
16
+ name: "My Agent",
17
+ instructions: "You are a helpful assistant",
18
+ model: "agentrouter/claude-3-5-haiku-20241022"
19
+ });
20
+
21
+ // Generate a response
22
+ const response = await agent.generate("Hello!");
23
+
24
+ // Stream a response
25
+ const stream = await agent.stream("Tell me a story");
26
+ for await (const chunk of stream) {
27
+ console.log(chunk);
28
+ }
29
+ ```
30
+
31
+ > **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [AgentRouter documentation](https://docs.agentrouter.org) for details.
32
+
33
+ ## Models
34
+
35
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
36
+ | ------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
37
+ | `agentrouter/claude-3-5-haiku-20241022` | 200K | | | | | | $1 | $5 |
38
+ | `agentrouter/claude-3-5-sonnet-20240620` | 200K | | | | | | $3 | $15 |
39
+ | `agentrouter/claude-3-5-sonnet-20241022` | 200K | | | | | | $3 | $15 |
40
+ | `agentrouter/claude-3-7-sonnet-20250219` | 200K | | | | | | $3 | $15 |
41
+ | `agentrouter/claude-3-7-sonnet-20250219-thinking` | 200K | | | | | | $3 | $15 |
42
+ | `agentrouter/claude-haiku-4-5-20251001` | 200K | | | | | | $2 | $4 |
43
+ | `agentrouter/claude-opus-4-20250514` | 200K | | | | | | $21 | $105 |
44
+ | `agentrouter/claude-opus-4-20250514-thinking` | 200K | | | | | | $2 | $10 |
45
+ | `agentrouter/claude-sonnet-4-20250514` | 200K | | | | | | $3 | $15 |
46
+ | `agentrouter/claude-sonnet-4-20250514-thinking` | 200K | | | | | | $2 | $10 |
47
+ | `agentrouter/claude-sonnet-4-5-20250929` | 1.0M | | | | | | $6 | $30 |
48
+ | `agentrouter/deepseek-r1-0528` | 128K | | | | | | $0.30 | $0.04 |
49
+ | `agentrouter/deepseek-v3.1` | 128K | | | | | | $0.30 | $0.04 |
50
+ | `agentrouter/deepseek-v3.2` | 128K | | | | | | $0.30 | $0.04 |
51
+ | `agentrouter/gemini-3-pro-preview` | 1.0M | | | | | | $2 | $8 |
52
+ | `agentrouter/glm-4.5` | 131K | | | | | | $0.00 | — |
53
+ | `agentrouter/glm-4.6` | 205K | | | | | | $0.00 | — |
54
+ | `agentrouter/gpt-5` | 1.3M | | | | | | — | — |
55
+ | `agentrouter/gpt-5.1` | 400K | | | | | | $2 | $2 |
56
+ | `agentrouter/kimi-k2-thinking` | 262K | | | | | | $0.00 | — |
57
+
58
+ ## Advanced Configuration
59
+
60
+ ### Custom Headers
61
+
62
+ ```typescript
63
+ const agent = new Agent({
64
+ id: "custom-agent",
65
+ name: "custom-agent",
66
+ model: {
67
+ url: "https://agentrouter.org/v1",
68
+ id: "agentrouter/claude-3-5-haiku-20241022",
69
+ apiKey: process.env.AGENTROUTER_API_KEY,
70
+ headers: {
71
+ "X-Custom-Header": "value"
72
+ }
73
+ }
74
+ });
75
+ ```
76
+
77
+ ### Dynamic Model Selection
78
+
79
+ ```typescript
80
+ const agent = new Agent({
81
+ id: "dynamic-agent",
82
+ name: "Dynamic Agent",
83
+ model: ({ requestContext }) => {
84
+ const useAdvanced = requestContext.task === "complex";
85
+ return useAdvanced
86
+ ? "agentrouter/kimi-k2-thinking"
87
+ : "agentrouter/claude-3-5-haiku-20241022";
88
+ }
89
+ });
90
+ ```