@mastra/mcp-docs-server 1.1.5 → 1.1.6

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 +16 -0
  556. package/package.json +6 -6
@@ -0,0 +1,33 @@
1
+ # ![Vertex logo](https://models.dev/logos/google-vertex.svg)Vertex
2
+
3
+ Vertex is available through the AI SDK. Install the provider package to use their models with Mastra.
4
+
5
+ For detailed provider-specific documentation, see the [AI SDK Vertex provider docs](https://ai-sdk.dev/providers/ai-sdk-providers/google-vertex).
6
+
7
+ To use this provider with Mastra agents, see the [Agent Overview documentation](https://mastra.ai/docs/agents/overview).
8
+
9
+ ## Installation
10
+
11
+ **npm**:
12
+
13
+ ```bash
14
+ npm install @ai-sdk/google-vertex
15
+ ```
16
+
17
+ **pnpm**:
18
+
19
+ ```bash
20
+ pnpm add @ai-sdk/google-vertex
21
+ ```
22
+
23
+ **Yarn**:
24
+
25
+ ```bash
26
+ yarn add @ai-sdk/google-vertex
27
+ ```
28
+
29
+ **Bun**:
30
+
31
+ ```bash
32
+ bun add @ai-sdk/google-vertex
33
+ ```
@@ -0,0 +1,159 @@
1
+ # ![Google logo](https://models.dev/logos/google.svg)Google
2
+
3
+ Access 26 Google models through Mastra's model router. Authentication is handled automatically using the `GOOGLE_GENERATIVE_AI_API_KEY` environment variable.
4
+
5
+ Learn more in the [Google documentation](https://ai.google.dev/gemini-api/docs/pricing).
6
+
7
+ ```bash
8
+ GOOGLE_GENERATIVE_AI_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: "google/gemini-1.5-flash"
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
+ ## Models
32
+
33
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
34
+ | --------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
35
+ | `google/gemini-1.5-flash` | 1.0M | | | | | | $0.07 | $0.30 |
36
+ | `google/gemini-1.5-flash-8b` | 1.0M | | | | | | $0.04 | $0.15 |
37
+ | `google/gemini-1.5-pro` | 1.0M | | | | | | $1 | $5 |
38
+ | `google/gemini-2.0-flash` | 1.0M | | | | | | $0.10 | $0.40 |
39
+ | `google/gemini-2.0-flash-lite` | 1.0M | | | | | | $0.07 | $0.30 |
40
+ | `google/gemini-2.5-flash` | 1.0M | | | | | | $0.30 | $3 |
41
+ | `google/gemini-2.5-flash-image` | 33K | | | | | | $0.30 | $30 |
42
+ | `google/gemini-2.5-flash-image-preview` | 33K | | | | | | $0.30 | $30 |
43
+ | `google/gemini-2.5-flash-lite` | 1.0M | | | | | | $0.10 | $0.40 |
44
+ | `google/gemini-2.5-flash-lite-preview-06-17` | 1.0M | | | | | | $0.10 | $0.40 |
45
+ | `google/gemini-2.5-flash-lite-preview-09-2025` | 1.0M | | | | | | $0.10 | $0.40 |
46
+ | `google/gemini-2.5-flash-preview-04-17` | 1.0M | | | | | | $0.15 | $0.60 |
47
+ | `google/gemini-2.5-flash-preview-05-20` | 1.0M | | | | | | $0.15 | $0.60 |
48
+ | `google/gemini-2.5-flash-preview-09-2025` | 1.0M | | | | | | $0.30 | $3 |
49
+ | `google/gemini-2.5-flash-preview-tts` | 8K | | | | | | $0.50 | $10 |
50
+ | `google/gemini-2.5-pro` | 1.0M | | | | | | $1 | $10 |
51
+ | `google/gemini-2.5-pro-preview-05-06` | 1.0M | | | | | | $1 | $10 |
52
+ | `google/gemini-2.5-pro-preview-06-05` | 1.0M | | | | | | $1 | $10 |
53
+ | `google/gemini-2.5-pro-preview-tts` | 8K | | | | | | $1 | $20 |
54
+ | `google/gemini-3-flash-preview` | 1.0M | | | | | | $0.50 | $3 |
55
+ | `google/gemini-3-pro-preview` | 1.0M | | | | | | $2 | $12 |
56
+ | `google/gemini-embedding-001` | 2K | | | | | | $0.15 | — |
57
+ | `google/gemini-flash-latest` | 1.0M | | | | | | $0.30 | $3 |
58
+ | `google/gemini-flash-lite-latest` | 1.0M | | | | | | $0.10 | $0.40 |
59
+ | `google/gemini-live-2.5-flash` | 128K | | | | | | $0.50 | $2 |
60
+ | `google/gemini-live-2.5-flash-preview-native-audio` | 131K | | | | | | $0.50 | $2 |
61
+
62
+ ## Advanced Configuration
63
+
64
+ ### Custom Headers
65
+
66
+ ```typescript
67
+ const agent = new Agent({
68
+ id: "custom-agent",
69
+ name: "custom-agent",
70
+ model: {
71
+ id: "google/gemini-1.5-flash",
72
+ apiKey: process.env.GOOGLE_GENERATIVE_AI_API_KEY,
73
+ headers: {
74
+ "X-Custom-Header": "value"
75
+ }
76
+ }
77
+ });
78
+ ```
79
+
80
+ ### Dynamic Model Selection
81
+
82
+ ```typescript
83
+ const agent = new Agent({
84
+ id: "dynamic-agent",
85
+ name: "Dynamic Agent",
86
+ model: ({ requestContext }) => {
87
+ const useAdvanced = requestContext.task === "complex";
88
+ return useAdvanced
89
+ ? "google/gemini-live-2.5-flash-preview-native-audio"
90
+ : "google/gemini-1.5-flash";
91
+ }
92
+ });
93
+ ```
94
+
95
+ ## Provider Options
96
+
97
+ Google supports the following provider-specific options via the `providerOptions` parameter:
98
+
99
+ ```typescript
100
+ const response = await agent.generate("Hello!", {
101
+ providerOptions: {
102
+ google: {
103
+ // See available options in the table below
104
+ }
105
+ }
106
+ });
107
+ ```
108
+
109
+ ### Available Options
110
+
111
+ **responseModalities?:** (`("TEXT" | "IMAGE")[] | undefined`)
112
+
113
+ **thinkingConfig?:** (`{ thinkingBudget?: number | undefined; includeThoughts?: boolean | undefined; thinkingLevel?: "minimal" | "low" | "medium" | "high" | undefined; } | undefined`)
114
+
115
+ **cachedContent?:** (`string | undefined`)
116
+
117
+ **structuredOutputs?:** (`boolean | undefined`)
118
+
119
+ **safetySettings?:** (`{ category: "HARM_CATEGORY_UNSPECIFIED" | "HARM_CATEGORY_HATE_SPEECH" | "HARM_CATEGORY_DANGEROUS_CONTENT" | "HARM_CATEGORY_HARASSMENT" | "HARM_CATEGORY_SEXUALLY_EXPLICIT" | "HARM_CATEGORY_CIVIC_INTEGRITY"; threshold: "HARM_BLOCK_THRESHOLD_UNSPECIFIED" | ... 4 more ... | "OFF"; }[] | undefined`)
120
+
121
+ **threshold?:** (`"HARM_BLOCK_THRESHOLD_UNSPECIFIED" | "BLOCK_LOW_AND_ABOVE" | "BLOCK_MEDIUM_AND_ABOVE" | "BLOCK_ONLY_HIGH" | "BLOCK_NONE" | "OFF" | undefined`)
122
+
123
+ **audioTimestamp?:** (`boolean | undefined`)
124
+
125
+ **labels?:** (`Record<string, string> | undefined`)
126
+
127
+ **mediaResolution?:** (`"MEDIA_RESOLUTION_UNSPECIFIED" | "MEDIA_RESOLUTION_LOW" | "MEDIA_RESOLUTION_MEDIUM" | "MEDIA_RESOLUTION_HIGH" | undefined`)
128
+
129
+ **imageConfig?:** (`{ aspectRatio?: "1:1" | "2:3" | "3:2" | "3:4" | "4:3" | "4:5" | "5:4" | "9:16" | "16:9" | "21:9" | undefined; imageSize?: "1K" | "2K" | "4K" | undefined; } | undefined`)
130
+
131
+ **retrievalConfig?:** (`{ latLng?: { latitude: number; longitude: number; } | undefined; } | undefined`)
132
+
133
+ ## Direct Provider Installation
134
+
135
+ This provider can also be installed directly as a standalone package, which can be used instead of the Mastra model router string. View the [package documentation](https://www.npmjs.com/package/@ai-sdk/google) for more details.
136
+
137
+ **npm**:
138
+
139
+ ```bash
140
+ npm install @ai-sdk/google
141
+ ```
142
+
143
+ **pnpm**:
144
+
145
+ ```bash
146
+ pnpm add @ai-sdk/google
147
+ ```
148
+
149
+ **Yarn**:
150
+
151
+ ```bash
152
+ yarn add @ai-sdk/google
153
+ ```
154
+
155
+ **Bun**:
156
+
157
+ ```bash
158
+ bun add @ai-sdk/google
159
+ ```
@@ -0,0 +1,107 @@
1
+ # ![Groq logo](https://models.dev/logos/groq.svg)Groq
2
+
3
+ Access 9 Groq models through Mastra's model router. Authentication is handled automatically using the `GROQ_API_KEY` environment variable.
4
+
5
+ Learn more in the [Groq documentation](https://console.groq.com/docs/models).
6
+
7
+ ```bash
8
+ GROQ_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: "groq/llama-3.1-8b-instant"
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
+ ## Models
32
+
33
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
34
+ | ---------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
35
+ | `groq/llama-3.1-8b-instant` | 131K | | | | | | $0.05 | $0.08 |
36
+ | `groq/llama-3.3-70b-versatile` | 131K | | | | | | $0.59 | $0.79 |
37
+ | `groq/meta-llama/llama-4-maverick-17b-128e-instruct` | 131K | | | | | | $0.20 | $0.60 |
38
+ | `groq/meta-llama/llama-4-scout-17b-16e-instruct` | 131K | | | | | | $0.11 | $0.34 |
39
+ | `groq/meta-llama/llama-guard-4-12b` | 131K | | | | | | $0.20 | $0.20 |
40
+ | `groq/moonshotai/kimi-k2-instruct-0905` | 262K | | | | | | $1 | $3 |
41
+ | `groq/openai/gpt-oss-120b` | 131K | | | | | | $0.15 | $0.60 |
42
+ | `groq/openai/gpt-oss-20b` | 131K | | | | | | $0.07 | $0.30 |
43
+ | `groq/qwen/qwen3-32b` | 131K | | | | | | $0.29 | $0.59 |
44
+
45
+ ## Advanced Configuration
46
+
47
+ ### Custom Headers
48
+
49
+ ```typescript
50
+ const agent = new Agent({
51
+ id: "custom-agent",
52
+ name: "custom-agent",
53
+ model: {
54
+ url: "https://api.groq.com/openai/v1",
55
+ id: "groq/llama-3.1-8b-instant",
56
+ apiKey: process.env.GROQ_API_KEY,
57
+ headers: {
58
+ "X-Custom-Header": "value"
59
+ }
60
+ }
61
+ });
62
+ ```
63
+
64
+ ### Dynamic Model Selection
65
+
66
+ ```typescript
67
+ const agent = new Agent({
68
+ id: "dynamic-agent",
69
+ name: "Dynamic Agent",
70
+ model: ({ requestContext }) => {
71
+ const useAdvanced = requestContext.task === "complex";
72
+ return useAdvanced
73
+ ? "groq/qwen/qwen3-32b"
74
+ : "groq/llama-3.1-8b-instant";
75
+ }
76
+ });
77
+ ```
78
+
79
+ ## Direct Provider Installation
80
+
81
+ This provider can also be installed directly as a standalone package, which can be used instead of the Mastra model router string. View the [package documentation](https://www.npmjs.com/package/@ai-sdk/groq) for more details.
82
+
83
+ **npm**:
84
+
85
+ ```bash
86
+ npm install @ai-sdk/groq
87
+ ```
88
+
89
+ **pnpm**:
90
+
91
+ ```bash
92
+ pnpm add @ai-sdk/groq
93
+ ```
94
+
95
+ **Yarn**:
96
+
97
+ ```bash
98
+ yarn add @ai-sdk/groq
99
+ ```
100
+
101
+ **Bun**:
102
+
103
+ ```bash
104
+ bun add @ai-sdk/groq
105
+ ```
106
+
107
+ For detailed provider-specific documentation, see the [AI SDK Groq provider docs](https://ai-sdk.dev/providers/ai-sdk-providers/groq).
@@ -0,0 +1,161 @@
1
+ # ![Helicone logo](https://models.dev/logos/helicone.svg)Helicone
2
+
3
+ Access 91 Helicone models through Mastra's model router. Authentication is handled automatically using the `HELICONE_API_KEY` environment variable.
4
+
5
+ Learn more in the [Helicone documentation](https://helicone.ai/models).
6
+
7
+ ```bash
8
+ HELICONE_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: "helicone/chatgpt-4o-latest"
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 [Helicone documentation](https://helicone.ai/models) for details.
32
+
33
+ ## Models
34
+
35
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
36
+ | ---------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
37
+ | `helicone/chatgpt-4o-latest` | 128K | | | | | | $5 | $20 |
38
+ | `helicone/claude-3-haiku-20240307` | 200K | | | | | | $0.25 | $1 |
39
+ | `helicone/claude-3.5-haiku` | 200K | | | | | | $0.80 | $4 |
40
+ | `helicone/claude-3.5-sonnet-v2` | 200K | | | | | | $3 | $15 |
41
+ | `helicone/claude-3.7-sonnet` | 200K | | | | | | $3 | $15 |
42
+ | `helicone/claude-4.5-haiku` | 200K | | | | | | $1 | $5 |
43
+ | `helicone/claude-4.5-opus` | 200K | | | | | | $5 | $25 |
44
+ | `helicone/claude-4.5-sonnet` | 200K | | | | | | $3 | $15 |
45
+ | `helicone/claude-haiku-4-5-20251001` | 200K | | | | | | $1 | $5 |
46
+ | `helicone/claude-opus-4` | 200K | | | | | | $15 | $75 |
47
+ | `helicone/claude-opus-4-1` | 200K | | | | | | $15 | $75 |
48
+ | `helicone/claude-opus-4-1-20250805` | 200K | | | | | | $15 | $75 |
49
+ | `helicone/claude-sonnet-4` | 200K | | | | | | $3 | $15 |
50
+ | `helicone/claude-sonnet-4-5-20250929` | 200K | | | | | | $3 | $15 |
51
+ | `helicone/codex-mini-latest` | 200K | | | | | | $2 | $6 |
52
+ | `helicone/deepseek-r1-distill-llama-70b` | 128K | | | | | | $0.03 | $0.13 |
53
+ | `helicone/deepseek-reasoner` | 128K | | | | | | $0.56 | $2 |
54
+ | `helicone/deepseek-tng-r1t2-chimera` | 130K | | | | | | $0.30 | $1 |
55
+ | `helicone/deepseek-v3` | 128K | | | | | | $0.56 | $2 |
56
+ | `helicone/deepseek-v3.1-terminus` | 128K | | | | | | $0.27 | $1 |
57
+ | `helicone/deepseek-v3.2` | 164K | | | | | | $0.27 | $0.41 |
58
+ | `helicone/ernie-4.5-21b-a3b-thinking` | 128K | | | | | | $0.07 | $0.28 |
59
+ | `helicone/gemini-2.5-flash` | 1.0M | | | | | | $0.30 | $3 |
60
+ | `helicone/gemini-2.5-flash-lite` | 1.0M | | | | | | $0.10 | $0.40 |
61
+ | `helicone/gemini-2.5-pro` | 1.0M | | | | | | $1 | $10 |
62
+ | `helicone/gemini-3-pro-preview` | 1.0M | | | | | | $2 | $12 |
63
+ | `helicone/gemma-3-12b-it` | 131K | | | | | | $0.05 | $0.10 |
64
+ | `helicone/gemma2-9b-it` | 8K | | | | | | $0.01 | $0.03 |
65
+ | `helicone/glm-4.6` | 205K | | | | | | $0.45 | $2 |
66
+ | `helicone/gpt-4.1` | 1.0M | | | | | | $2 | $8 |
67
+ | `helicone/gpt-4.1-mini` | 1.0M | | | | | | $0.40 | $2 |
68
+ | `helicone/gpt-4.1-mini-2025-04-14` | 1.0M | | | | | | $0.40 | $2 |
69
+ | `helicone/gpt-4.1-nano` | 1.0M | | | | | | $0.10 | $0.40 |
70
+ | `helicone/gpt-4o` | 128K | | | | | | $3 | $10 |
71
+ | `helicone/gpt-4o-mini` | 128K | | | | | | $0.15 | $0.60 |
72
+ | `helicone/gpt-5` | 400K | | | | | | $1 | $10 |
73
+ | `helicone/gpt-5-chat-latest` | 128K | | | | | | $1 | $10 |
74
+ | `helicone/gpt-5-codex` | 400K | | | | | | $1 | $10 |
75
+ | `helicone/gpt-5-mini` | 400K | | | | | | $0.25 | $2 |
76
+ | `helicone/gpt-5-nano` | 400K | | | | | | $0.05 | $0.40 |
77
+ | `helicone/gpt-5-pro` | 128K | | | | | | $15 | $120 |
78
+ | `helicone/gpt-5.1` | 400K | | | | | | $1 | $10 |
79
+ | `helicone/gpt-5.1-chat-latest` | 128K | | | | | | $1 | $10 |
80
+ | `helicone/gpt-5.1-codex` | 400K | | | | | | $1 | $10 |
81
+ | `helicone/gpt-5.1-codex-mini` | 400K | | | | | | $0.25 | $2 |
82
+ | `helicone/gpt-oss-120b` | 131K | | | | | | $0.04 | $0.16 |
83
+ | `helicone/gpt-oss-20b` | 131K | | | | | | $0.05 | $0.20 |
84
+ | `helicone/grok-3` | 131K | | | | | | $3 | $15 |
85
+ | `helicone/grok-3-mini` | 131K | | | | | | $0.30 | $0.50 |
86
+ | `helicone/grok-4` | 256K | | | | | | $3 | $15 |
87
+ | `helicone/grok-4-1-fast-non-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
88
+ | `helicone/grok-4-1-fast-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
89
+ | `helicone/grok-4-fast-non-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
90
+ | `helicone/grok-4-fast-reasoning` | 2.0M | | | | | | $0.20 | $0.50 |
91
+ | `helicone/grok-code-fast-1` | 256K | | | | | | $0.20 | $2 |
92
+ | `helicone/hermes-2-pro-llama-3-8b` | 131K | | | | | | $0.14 | $0.14 |
93
+ | `helicone/kimi-k2-0711` | 131K | | | | | | $0.57 | $2 |
94
+ | `helicone/kimi-k2-0905` | 262K | | | | | | $0.50 | $2 |
95
+ | `helicone/kimi-k2-thinking` | 256K | | | | | | $0.48 | $2 |
96
+ | `helicone/llama-3.1-8b-instant` | 131K | | | | | | $0.05 | $0.08 |
97
+ | `helicone/llama-3.1-8b-instruct` | 16K | | | | | | $0.02 | $0.05 |
98
+ | `helicone/llama-3.1-8b-instruct-turbo` | 128K | | | | | | $0.02 | $0.03 |
99
+ | `helicone/llama-3.3-70b-instruct` | 128K | | | | | | $0.13 | $0.39 |
100
+ | `helicone/llama-3.3-70b-versatile` | 131K | | | | | | $0.59 | $0.79 |
101
+ | `helicone/llama-4-maverick` | 131K | | | | | | $0.15 | $0.60 |
102
+ | `helicone/llama-4-scout` | 131K | | | | | | $0.08 | $0.30 |
103
+ | `helicone/llama-guard-4` | 131K | | | | | | $0.21 | $0.21 |
104
+ | `helicone/llama-prompt-guard-2-22m` | 512 | | | | | | $0.01 | $0.01 |
105
+ | `helicone/llama-prompt-guard-2-86m` | 512 | | | | | | $0.01 | $0.01 |
106
+ | `helicone/mistral-large-2411` | 128K | | | | | | $2 | $6 |
107
+ | `helicone/mistral-nemo` | 128K | | | | | | $20 | $40 |
108
+ | `helicone/mistral-small` | 128K | | | | | | $75 | $200 |
109
+ | `helicone/o1` | 200K | | | | | | $15 | $60 |
110
+ | `helicone/o1-mini` | 128K | | | | | | $1 | $4 |
111
+ | `helicone/o3` | 200K | | | | | | $2 | $8 |
112
+ | `helicone/o3-mini` | 200K | | | | | | $1 | $4 |
113
+ | `helicone/o3-pro` | 200K | | | | | | $20 | $80 |
114
+ | `helicone/o4-mini` | 200K | | | | | | $1 | $4 |
115
+ | `helicone/qwen2.5-coder-7b-fast` | 32K | | | | | | $0.03 | $0.09 |
116
+ | `helicone/qwen3-235b-a22b-thinking` | 262K | | | | | | $0.30 | $3 |
117
+ | `helicone/qwen3-30b-a3b` | 41K | | | | | | $0.08 | $0.29 |
118
+ | `helicone/qwen3-32b` | 131K | | | | | | $0.29 | $0.59 |
119
+ | `helicone/qwen3-coder` | 262K | | | | | | $0.22 | $0.95 |
120
+ | `helicone/qwen3-coder-30b-a3b-instruct` | 262K | | | | | | $0.10 | $0.30 |
121
+ | `helicone/qwen3-next-80b-a3b-instruct` | 262K | | | | | | $0.14 | $1 |
122
+ | `helicone/qwen3-vl-235b-a22b-instruct` | 256K | | | | | | $0.30 | $2 |
123
+ | `helicone/sonar` | 127K | | | | | | $1 | $1 |
124
+ | `helicone/sonar-deep-research` | 127K | | | | | | $2 | $8 |
125
+ | `helicone/sonar-pro` | 200K | | | | | | $3 | $15 |
126
+ | `helicone/sonar-reasoning` | 127K | | | | | | $1 | $5 |
127
+ | `helicone/sonar-reasoning-pro` | 127K | | | | | | $2 | $8 |
128
+
129
+ ## Advanced Configuration
130
+
131
+ ### Custom Headers
132
+
133
+ ```typescript
134
+ const agent = new Agent({
135
+ id: "custom-agent",
136
+ name: "custom-agent",
137
+ model: {
138
+ url: "https://ai-gateway.helicone.ai/v1",
139
+ id: "helicone/chatgpt-4o-latest",
140
+ apiKey: process.env.HELICONE_API_KEY,
141
+ headers: {
142
+ "X-Custom-Header": "value"
143
+ }
144
+ }
145
+ });
146
+ ```
147
+
148
+ ### Dynamic Model Selection
149
+
150
+ ```typescript
151
+ const agent = new Agent({
152
+ id: "dynamic-agent",
153
+ name: "Dynamic Agent",
154
+ model: ({ requestContext }) => {
155
+ const useAdvanced = requestContext.task === "complex";
156
+ return useAdvanced
157
+ ? "helicone/sonar-reasoning-pro"
158
+ : "helicone/chatgpt-4o-latest";
159
+ }
160
+ });
161
+ ```
@@ -0,0 +1,90 @@
1
+ # ![Hugging Face logo](https://models.dev/logos/huggingface.svg)Hugging Face
2
+
3
+ Access 20 Hugging Face models through Mastra's model router. Authentication is handled automatically using the `HF_TOKEN` environment variable.
4
+
5
+ Learn more in the [Hugging Face documentation](https://huggingface.co).
6
+
7
+ ```bash
8
+ HF_TOKEN=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: "huggingface/MiniMaxAI/MiniMax-M2.1"
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 [Hugging Face documentation](https://huggingface.co) for details.
32
+
33
+ ## Models
34
+
35
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
36
+ | ------------------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
37
+ | `huggingface/deepseek-ai/DeepSeek-R1-0528` | 164K | | | | | | $3 | $5 |
38
+ | `huggingface/deepseek-ai/DeepSeek-V3.2` | 164K | | | | | | $0.28 | $0.40 |
39
+ | `huggingface/MiniMaxAI/MiniMax-M2.1` | 205K | | | | | | $0.30 | $1 |
40
+ | `huggingface/MiniMaxAI/MiniMax-M2.5` | 205K | | | | | | $0.30 | $1 |
41
+ | `huggingface/moonshotai/Kimi-K2-Instruct` | 131K | | | | | | $1 | $3 |
42
+ | `huggingface/moonshotai/Kimi-K2-Instruct-0905` | 262K | | | | | | $1 | $3 |
43
+ | `huggingface/moonshotai/Kimi-K2-Thinking` | 262K | | | | | | $0.60 | $3 |
44
+ | `huggingface/moonshotai/Kimi-K2.5` | 262K | | | | | | $0.60 | $3 |
45
+ | `huggingface/Qwen/Qwen3-235B-A22B-Thinking-2507` | 262K | | | | | | $0.30 | $3 |
46
+ | `huggingface/Qwen/Qwen3-Coder-480B-A35B-Instruct` | 262K | | | | | | $2 | $2 |
47
+ | `huggingface/Qwen/Qwen3-Coder-Next` | 262K | | | | | | $0.20 | $2 |
48
+ | `huggingface/Qwen/Qwen3-Embedding-4B` | 32K | | | | | | $0.01 | — |
49
+ | `huggingface/Qwen/Qwen3-Embedding-8B` | 32K | | | | | | $0.01 | — |
50
+ | `huggingface/Qwen/Qwen3-Next-80B-A3B-Instruct` | 262K | | | | | | $0.25 | $1 |
51
+ | `huggingface/Qwen/Qwen3-Next-80B-A3B-Thinking` | 262K | | | | | | $0.30 | $2 |
52
+ | `huggingface/Qwen/Qwen3.5-397B-A17B` | 262K | | | | | | $0.60 | $4 |
53
+ | `huggingface/XiaomiMiMo/MiMo-V2-Flash` | 262K | | | | | | $0.10 | $0.30 |
54
+ | `huggingface/zai-org/GLM-4.7` | 205K | | | | | | $0.60 | $2 |
55
+ | `huggingface/zai-org/GLM-4.7-Flash` | 200K | | | | | | — | — |
56
+ | `huggingface/zai-org/GLM-5` | 203K | | | | | | $1 | $3 |
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://router.huggingface.co/v1",
68
+ id: "huggingface/MiniMaxAI/MiniMax-M2.1",
69
+ apiKey: process.env.HF_TOKEN,
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
+ ? "huggingface/zai-org/GLM-5"
87
+ : "huggingface/MiniMaxAI/MiniMax-M2.1";
88
+ }
89
+ });
90
+ ```
@@ -0,0 +1,84 @@
1
+ # ![iFlow logo](https://models.dev/logos/iflowcn.svg)iFlow
2
+
3
+ Access 14 iFlow models through Mastra's model router. Authentication is handled automatically using the `IFLOW_API_KEY` environment variable.
4
+
5
+ Learn more in the [iFlow documentation](https://platform.iflow.cn/en/docs).
6
+
7
+ ```bash
8
+ IFLOW_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: "iflowcn/deepseek-r1"
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 [iFlow documentation](https://platform.iflow.cn/en/docs) for details.
32
+
33
+ ## Models
34
+
35
+ | Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
36
+ | --------------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
37
+ | `iflowcn/deepseek-r1` | 128K | | | | | | — | — |
38
+ | `iflowcn/deepseek-v3` | 128K | | | | | | — | — |
39
+ | `iflowcn/deepseek-v3.2` | 128K | | | | | | — | — |
40
+ | `iflowcn/glm-4.6` | 200K | | | | | | — | — |
41
+ | `iflowcn/kimi-k2` | 128K | | | | | | — | — |
42
+ | `iflowcn/kimi-k2-0905` | 256K | | | | | | — | — |
43
+ | `iflowcn/qwen3-235b` | 128K | | | | | | — | — |
44
+ | `iflowcn/qwen3-235b-a22b-instruct` | 256K | | | | | | — | — |
45
+ | `iflowcn/qwen3-235b-a22b-thinking-2507` | 256K | | | | | | — | — |
46
+ | `iflowcn/qwen3-32b` | 128K | | | | | | — | — |
47
+ | `iflowcn/qwen3-coder-plus` | 256K | | | | | | — | — |
48
+ | `iflowcn/qwen3-max` | 256K | | | | | | — | — |
49
+ | `iflowcn/qwen3-max-preview` | 256K | | | | | | — | — |
50
+ | `iflowcn/qwen3-vl-plus` | 256K | | | | | | — | — |
51
+
52
+ ## Advanced Configuration
53
+
54
+ ### Custom Headers
55
+
56
+ ```typescript
57
+ const agent = new Agent({
58
+ id: "custom-agent",
59
+ name: "custom-agent",
60
+ model: {
61
+ url: "https://apis.iflow.cn/v1",
62
+ id: "iflowcn/deepseek-r1",
63
+ apiKey: process.env.IFLOW_API_KEY,
64
+ headers: {
65
+ "X-Custom-Header": "value"
66
+ }
67
+ }
68
+ });
69
+ ```
70
+
71
+ ### Dynamic Model Selection
72
+
73
+ ```typescript
74
+ const agent = new Agent({
75
+ id: "dynamic-agent",
76
+ name: "Dynamic Agent",
77
+ model: ({ requestContext }) => {
78
+ const useAdvanced = requestContext.task === "complex";
79
+ return useAdvanced
80
+ ? "iflowcn/qwen3-vl-plus"
81
+ : "iflowcn/deepseek-r1";
82
+ }
83
+ });
84
+ ```