@mastra/mcp-docs-server 1.2.15-alpha.19 → 1.2.15-alpha.21

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 (279) hide show
  1. package/.docs/docs/agents/code-mode.md +1 -1
  2. package/.docs/docs/agents/networks.md +2 -2
  3. package/.docs/docs/agents/overview.md +2 -2
  4. package/.docs/docs/agents/using-tools.md +1 -1
  5. package/.docs/docs/browser/overview.md +8 -8
  6. package/.docs/docs/browser/recording.md +2 -2
  7. package/.docs/docs/capabilities/{channels/overview.md → channels.md} +70 -7
  8. package/.docs/docs/capabilities/subagents.md +2 -2
  9. package/.docs/docs/deployment/cloud-providers.md +9 -9
  10. package/.docs/docs/deployment/overview.md +9 -9
  11. package/.docs/docs/deployment/sandbox.md +3 -3
  12. package/.docs/docs/deployment/web-framework.md +6 -6
  13. package/.docs/docs/deployment/workflow-runners.md +2 -2
  14. package/.docs/docs/harness/agent-controller.md +2 -2
  15. package/.docs/docs/index.md +8 -8
  16. package/.docs/docs/long-running-agents/durable-agents.md +2 -2
  17. package/.docs/docs/long-running-agents/signal-providers.md +2 -15
  18. package/.docs/docs/long-running-agents/signals.md +1 -1
  19. package/.docs/docs/mastra-platform/database.md +2 -2
  20. package/.docs/docs/mastra-platform/deploy.md +27 -0
  21. package/.docs/docs/mastra-platform/server.md +1 -1
  22. package/.docs/docs/mastra-platform/trace-intelligence.md +9 -13
  23. package/.docs/docs/mcp/overview.md +42 -0
  24. package/.docs/docs/memory/memory-processors.md +5 -5
  25. package/.docs/docs/memory/message-history.md +1 -1
  26. package/.docs/docs/memory/observational-memory.md +1 -1
  27. package/.docs/docs/observability/integrations/exporters/mastra-storage.md +16 -16
  28. package/.docs/docs/observability/integrations/overview.md +3 -3
  29. package/.docs/docs/server/auth/fga.md +1 -1
  30. package/.docs/docs/server/auth/simple-auth.md +1 -1
  31. package/.docs/docs/server/auth.md +8 -8
  32. package/.docs/docs/server/custom-api-routes.md +35 -0
  33. package/.docs/docs/storage/overview.md +14 -13
  34. package/.docs/docs/studio/observability.md +1 -1
  35. package/.docs/docs/workflows/overview.md +1 -1
  36. package/.docs/docs/workflows/snapshots.md +11 -11
  37. package/.docs/docs/workflows/time-travel.md +2 -0
  38. package/.docs/docs/workspace/filesystem.md +15 -15
  39. package/.docs/docs/workspace/sandbox.md +17 -17
  40. package/.docs/docs/workspace/search.md +1 -1
  41. package/.docs/guides/agent-frameworks/ai-sdk.md +2 -2
  42. package/.docs/guides/deployment/mastra-workers.md +1 -1
  43. package/.docs/guides/getting-started/quickstart.md +3 -3
  44. package/.docs/guides/index.md +8 -8
  45. package/.docs/guides/voice/overview.md +55 -106
  46. package/.docs/guides/voice/speech-to-text.md +7 -7
  47. package/.docs/guides/voice/text-to-speech.md +9 -10
  48. package/.docs/{guides/build-your-ui → integrations/agentic-ui}/ai-sdk-ui.md +2 -2
  49. package/.docs/{guides/build-your-ui/copilotkit/overview.md → integrations/agentic-ui/copilotkit.md} +256 -3
  50. package/.docs/{docs/browser → integrations/browsers}/agent-browser.md +2 -2
  51. package/.docs/{docs/browser → integrations/browsers}/browser-viewer.md +3 -3
  52. package/.docs/{docs/browser → integrations/browsers}/firecrawl.md +2 -2
  53. package/.docs/{docs/browser → integrations/browsers}/stagehand.md +1 -1
  54. package/.docs/{docs/capabilities → integrations}/channels/discord.md +2 -2
  55. package/.docs/integrations/channels/github.md +103 -0
  56. package/.docs/{docs/capabilities → integrations}/channels/imessage.md +7 -5
  57. package/.docs/{docs/capabilities → integrations}/channels/slack.md +4 -4
  58. package/.docs/{docs/capabilities → integrations}/channels/teams.md +2 -2
  59. package/.docs/{docs/capabilities → integrations}/channels/telegram.md +2 -2
  60. package/.docs/{docs/capabilities → integrations}/channels/whatsapp.md +2 -2
  61. package/.docs/{reference/storage/dsql.md → integrations/databases/aurora-dsql.md} +1 -1
  62. package/.docs/{reference/storage → integrations/databases}/clickhouse.md +2 -2
  63. package/.docs/{reference/storage → integrations/databases}/cloudflare-d1.md +1 -1
  64. package/.docs/{reference/storage/cloudflare.md → integrations/databases/cloudflare-kv.md} +1 -1
  65. package/.docs/{reference/storage → integrations/databases}/convex.md +1 -1
  66. package/.docs/{reference/storage → integrations/databases}/duckdb.md +5 -5
  67. package/.docs/{reference/storage → integrations/databases}/dynamodb.md +1 -1
  68. package/.docs/{reference/storage/lance.md → integrations/databases/lancedb.md} +1 -1
  69. package/.docs/{reference/storage → integrations/databases}/libsql.md +2 -2
  70. package/.docs/{reference/storage → integrations/databases}/mongodb.md +1 -1
  71. package/.docs/{reference/storage → integrations/databases}/mssql.md +1 -1
  72. package/.docs/integrations/databases/neon.md +220 -0
  73. package/.docs/{reference/storage → integrations/databases}/oracledb.md +1 -1
  74. package/.docs/{reference/storage → integrations/databases}/postgresql.md +1 -1
  75. package/.docs/{reference/storage → integrations/databases}/redis.md +1 -1
  76. package/.docs/{reference/storage → integrations/databases}/spanner.md +1 -1
  77. package/.docs/{reference/storage → integrations/databases}/upstash.md +1 -1
  78. package/.docs/{guides/deployment → integrations/deploy}/aws-bedrock-agentcore.md +1 -1
  79. package/.docs/{guides/deployment → integrations/deploy}/aws-lambda.md +1 -1
  80. package/.docs/{guides/deployment → integrations/deploy}/azure-app-services.md +1 -1
  81. package/.docs/{guides/deployment → integrations/deploy}/cloudflare.md +1 -1
  82. package/.docs/{guides/deployment → integrations/deploy}/digital-ocean.md +1 -1
  83. package/.docs/{guides/deployment → integrations/deploy}/netlify.md +1 -1
  84. package/.docs/{guides/deployment → integrations/deploy}/vercel.md +2 -2
  85. package/.docs/{reference/workspace/s3-filesystem.md → integrations/file-storage/amazon-s3.md} +5 -5
  86. package/.docs/{reference/workspace/archil-filesystem.md → integrations/file-storage/archil.md} +3 -3
  87. package/.docs/{reference/workspace/azure-blob-filesystem.md → integrations/file-storage/azure-blob.md} +2 -2
  88. package/.docs/{reference/workspace/gcs-filesystem.md → integrations/file-storage/google-cloud-storage.md} +5 -5
  89. package/.docs/{reference/workspace/mesa-filesystem.md → integrations/file-storage/mesa.md} +1 -1
  90. package/.docs/{reference/workspace/files-sdk-filesystem.md → integrations/file-storage/vercel-files.md} +5 -5
  91. package/.docs/{guides/getting-started → integrations/frameworks}/astro.md +1 -1
  92. package/.docs/{guides/getting-started → integrations/frameworks}/electron.md +1 -1
  93. package/.docs/{guides/getting-started → integrations/frameworks}/next-js.md +2 -2
  94. package/.docs/{guides/getting-started → integrations/frameworks}/nuxt.md +1 -1
  95. package/.docs/{guides/getting-started → integrations/frameworks}/sveltekit.md +1 -1
  96. package/.docs/{guides/getting-started → integrations/frameworks}/vite-react.md +1 -1
  97. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/arize.md +1 -1
  98. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/arthur.md +1 -1
  99. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/braintrust.md +1 -1
  100. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/confident-ai.md +1 -1
  101. package/.docs/integrations/observability/datadog.md +538 -0
  102. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/laminar.md +1 -1
  103. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/langfuse.md +1 -1
  104. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/langsmith.md +1 -1
  105. package/.docs/{docs/observability/integrations/exporters/otel.md → integrations/observability/opentelemetry.md} +276 -44
  106. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/posthog.md +1 -1
  107. package/.docs/{docs/observability/integrations/exporters → integrations/observability}/sentry.md +1 -1
  108. package/.docs/{reference/workspace/apple-container-sandbox.md → integrations/sandboxes/apple-container.md} +1 -1
  109. package/.docs/{reference/workspace/daytona-sandbox.md → integrations/sandboxes/daytona.md} +2 -2
  110. package/.docs/{reference/workspace/docker-sandbox.md → integrations/sandboxes/docker.md} +1 -1
  111. package/.docs/{reference/workspace/e2b-sandbox.md → integrations/sandboxes/e2b.md} +3 -3
  112. package/.docs/{reference/workspace/modal-sandbox.md → integrations/sandboxes/modal.md} +2 -2
  113. package/.docs/{reference/workspace/railway-sandbox.md → integrations/sandboxes/railway.md} +8 -0
  114. package/.docs/{reference/workspace/vercel-sandbox.md → integrations/sandboxes/vercel.md} +141 -12
  115. package/.docs/{reference → integrations}/tools/brightdata.md +1 -1
  116. package/.docs/{reference → integrations}/tools/perplexity.md +1 -1
  117. package/.docs/{reference → integrations}/tools/tavily.md +1 -1
  118. package/.docs/{reference → integrations}/voice/aws-nova-sonic.md +1 -1
  119. package/.docs/{reference → integrations}/voice/cloudflare.md +3 -3
  120. package/.docs/{reference/voice/google-gemini-live.md → integrations/voice/google.md} +305 -30
  121. package/.docs/{reference/voice/inworld-realtime.md → integrations/voice/inworld.md} +163 -25
  122. package/.docs/{reference → integrations}/voice/livekit.md +437 -34
  123. package/.docs/{reference/voice/openai-realtime.md → integrations/voice/openai.md} +117 -20
  124. package/.docs/integrations.md +147 -0
  125. package/.docs/models/embeddings.md +2 -2
  126. package/.docs/models/environment-variables.md +1 -0
  127. package/.docs/models/gateways/openrouter.md +4 -2
  128. package/.docs/models/gateways/vercel.md +2 -1
  129. package/.docs/models/index.md +1 -1
  130. package/.docs/models/providers/coralbricks.md +75 -0
  131. package/.docs/models/providers/evroc.md +2 -3
  132. package/.docs/models/providers/hyper.md +6 -6
  133. package/.docs/models/providers/kilo.md +7 -5
  134. package/.docs/models/providers/llmgateway.md +1 -2
  135. package/.docs/models/providers/nano-gpt.md +1 -3
  136. package/.docs/models/providers/opencode.md +0 -1
  137. package/.docs/models/providers/privatemode-ai.md +5 -4
  138. package/.docs/models/providers/snowflake-cortex.md +5 -1
  139. package/.docs/models/providers/wandb.md +2 -1
  140. package/.docs/models/providers/zenmux.md +0 -15
  141. package/.docs/models/providers.md +1 -0
  142. package/.docs/reference/agent-controller/agent-controller-class.md +32 -1
  143. package/.docs/reference/agents/channels.md +2 -2
  144. package/.docs/reference/agents/generateLegacy.md +2 -2
  145. package/.docs/reference/agents/getDefaultOptions.md +1 -1
  146. package/.docs/reference/agents/getDefaultStreamOptions.md +1 -1
  147. package/.docs/reference/agents/inngest-agent.md +1 -1
  148. package/.docs/reference/agents/network.md +1 -1
  149. package/.docs/reference/ai-sdk/handle-network-stream.md +1 -1
  150. package/.docs/reference/ai-sdk/network-route.md +1 -1
  151. package/.docs/reference/auth/auth0.md +1 -1
  152. package/.docs/reference/auth/better-auth.md +1 -1
  153. package/.docs/reference/auth/clerk.md +1 -1
  154. package/.docs/reference/auth/firebase.md +1 -1
  155. package/.docs/reference/auth/google.md +1 -1
  156. package/.docs/reference/auth/supabase.md +1 -1
  157. package/.docs/reference/auth/workos.md +1 -1
  158. package/.docs/reference/browser/agent-browser.md +1 -1
  159. package/.docs/reference/browser/browser-viewer.md +1 -1
  160. package/.docs/reference/browser/firecrawl-browser.md +1 -1
  161. package/.docs/reference/browser/stagehand-browser.md +1 -1
  162. package/.docs/reference/channels/channel-provider.md +1 -1
  163. package/.docs/reference/channels/slack-provider.md +2 -2
  164. package/.docs/reference/cli/mastra.md +2 -2
  165. package/.docs/reference/configuration.md +1 -26
  166. package/.docs/reference/core/getStorage.md +1 -1
  167. package/.docs/reference/core/getVector.md +2 -2
  168. package/.docs/reference/core/listVectors.md +2 -2
  169. package/.docs/reference/core/setStorage.md +1 -1
  170. package/.docs/reference/file-based-agents/storage.md +1 -1
  171. package/.docs/reference/file-based-agents/studio.md +1 -1
  172. package/.docs/reference/index.md +27 -55
  173. package/.docs/{guides → reference}/migrations/ai-sdk-v4-to-v5.md +1 -1
  174. package/.docs/{guides → reference}/migrations/mastra-cloud.md +1 -1
  175. package/.docs/{guides → reference}/migrations/upgrade-to-v1/cli.md +1 -1
  176. package/.docs/{guides → reference}/migrations/upgrade-to-v1/memory.md +1 -1
  177. package/.docs/{guides → reference}/migrations/upgrade-to-v1/overview.md +41 -41
  178. package/.docs/{guides → reference}/migrations/upgrade-to-v1/tools.md +1 -1
  179. package/.docs/{guides → reference}/migrations/upgrade-to-v1/tracing.md +10 -10
  180. package/.docs/reference/observability/tracing/bridges/datadog.md +2 -2
  181. package/.docs/reference/observability/tracing/bridges/otel.md +2 -2
  182. package/.docs/reference/observability/tracing/exporters/arize.md +1 -1
  183. package/.docs/reference/observability/tracing/exporters/arthur.md +1 -1
  184. package/.docs/reference/observability/tracing/exporters/confident-ai.md +1 -1
  185. package/.docs/reference/observability/tracing/exporters/mastra-platform-exporter.md +12 -0
  186. package/.docs/reference/observability/tracing/exporters/otel.md +2 -2
  187. package/.docs/reference/pubsub/lease-provider.md +1 -1
  188. package/.docs/{guides → reference}/rag/chunking-and-embedding.md +16 -19
  189. package/.docs/reference/rag/database-config.md +1 -1
  190. package/.docs/{guides/rag/graph-rag.md → reference/rag/graph-rag-guide.md} +1 -1
  191. package/.docs/{guides → reference}/rag/overview.md +2 -2
  192. package/.docs/{guides → reference}/rag/retrieval.md +1 -1
  193. package/.docs/{guides → reference}/rag/vector-databases.md +1 -1
  194. package/.docs/reference/server/create-route.md +27 -1
  195. package/.docs/reference/storage/composite.md +3 -3
  196. package/.docs/reference/storage/retention.md +4 -4
  197. package/.docs/reference/streaming/ChunkType.md +3 -3
  198. package/.docs/reference/streaming/agents/streamLegacy.md +3 -3
  199. package/.docs/reference/tools/mcp-server.md +1 -1
  200. package/.docs/reference/vectors/convex.md +2 -2
  201. package/.docs/reference/vectors/oracledb.md +2 -2
  202. package/.docs/reference/workers/overview.md +8 -8
  203. package/.docs/reference/workflows/run-methods/timeTravel.md +1 -0
  204. package/.docs/reference/workspace/platform-filesystem.md +2 -2
  205. package/.docs/reference/workspace/platform-sandbox.md +10 -2
  206. package/.docs/reference/workspace/process-manager.md +3 -3
  207. package/.docs/reference/workspace/sandbox.md +10 -0
  208. package/CHANGELOG.md +16 -0
  209. package/dist/index.js +1 -1
  210. package/dist/{src-BZcgzbk9.js → src-D-W-bx5t.js} +2 -2
  211. package/dist/{src-BZcgzbk9.js.map → src-D-W-bx5t.js.map} +1 -1
  212. package/dist/stdio.js +1 -1
  213. package/package.json +5 -5
  214. package/.docs/docs/capabilities/channels/other-adapters.md +0 -68
  215. package/.docs/docs/observability/integrations/bridges/datadog.md +0 -219
  216. package/.docs/docs/observability/integrations/bridges/otel.md +0 -234
  217. package/.docs/docs/observability/integrations/exporters/datadog.md +0 -321
  218. package/.docs/guides/build-your-ui/copilotkit/channels.md +0 -86
  219. package/.docs/guides/build-your-ui/copilotkit/generative-ui.md +0 -174
  220. package/.docs/guides/guide/chef-michel.md +0 -211
  221. package/.docs/guides/guide/publishing-mcp-server.md +0 -137
  222. package/.docs/guides/guide/slack-assistant.md +0 -193
  223. package/.docs/guides/guide/stock-agent.md +0 -132
  224. package/.docs/guides/guide/web-search.md +0 -322
  225. package/.docs/guides/guide/whatsapp-chat-bot.md +0 -407
  226. package/.docs/guides/voice/realtime-voice.md +0 -430
  227. package/.docs/reference/voice/google.md +0 -290
  228. package/.docs/reference/voice/inworld.md +0 -137
  229. package/.docs/reference/voice/openai.md +0 -96
  230. package/.docs/reference/voice/playai.md +0 -82
  231. package/.docs/reference/workspace/vercel-serverless.md +0 -128
  232. /package/.docs/{guides/concepts → docs/guides}/multi-agent-systems.md +0 -0
  233. /package/.docs/{guides/concepts → docs/guides}/streaming.md +0 -0
  234. /package/.docs/{guides/build-your-ui → integrations/agentic-ui}/assistant-ui.md +0 -0
  235. /package/.docs/{guides/build-your-ui → integrations/agentic-ui}/openui.md +0 -0
  236. /package/.docs/{docs/server → integrations}/auth/auth0.md +0 -0
  237. /package/.docs/{docs/server → integrations}/auth/better-auth.md +0 -0
  238. /package/.docs/{docs/server → integrations}/auth/clerk.md +0 -0
  239. /package/.docs/{docs/server → integrations}/auth/firebase.md +0 -0
  240. /package/.docs/{docs/server → integrations}/auth/google.md +0 -0
  241. /package/.docs/{docs/server → integrations}/auth/okta.md +0 -0
  242. /package/.docs/{docs/server → integrations}/auth/supabase.md +0 -0
  243. /package/.docs/{docs/server → integrations}/auth/workos.md +0 -0
  244. /package/.docs/{guides/deployment → integrations/deploy}/amazon-ec2.md +0 -0
  245. /package/.docs/{guides/deployment → integrations/deploy}/inngest.md +0 -0
  246. /package/.docs/{guides/deployment → integrations/deploy}/kubernetes.md +0 -0
  247. /package/.docs/{guides/deployment → integrations/deploy}/temporal.md +0 -0
  248. /package/.docs/{reference/workspace/agentfs-filesystem.md → integrations/file-storage/agentfs.md} +0 -0
  249. /package/.docs/{reference/workspace/google-drive-filesystem.md → integrations/file-storage/google-drive.md} +0 -0
  250. /package/.docs/{guides/getting-started → integrations/frameworks}/express.md +0 -0
  251. /package/.docs/{guides/getting-started → integrations/frameworks}/hono.md +0 -0
  252. /package/.docs/{guides/getting-started → integrations/frameworks}/nestjs.md +0 -0
  253. /package/.docs/{reference/workspace/agentcore-runtime-sandbox.md → integrations/sandboxes/agentcore.md} +0 -0
  254. /package/.docs/{reference/workspace/blaxel-sandbox.md → integrations/sandboxes/blaxel.md} +0 -0
  255. /package/.docs/{guides/guide → integrations/tools}/firecrawl.md +0 -0
  256. /package/.docs/{reference → integrations}/voice/azure.md +0 -0
  257. /package/.docs/{reference → integrations}/voice/deepgram.md +0 -0
  258. /package/.docs/{reference → integrations}/voice/elevenlabs.md +0 -0
  259. /package/.docs/{reference → integrations}/voice/mistral.md +0 -0
  260. /package/.docs/{reference → integrations}/voice/murf.md +0 -0
  261. /package/.docs/{reference → integrations}/voice/sarvam.md +0 -0
  262. /package/.docs/{reference → integrations}/voice/speechify.md +0 -0
  263. /package/.docs/{reference/voice/xai-realtime.md → integrations/voice/xai.md} +0 -0
  264. /package/.docs/{guides/getting-started → reference}/manual-install.md +0 -0
  265. /package/.docs/{guides → reference}/migrations/agentnetwork.md +0 -0
  266. /package/.docs/{guides → reference}/migrations/network-to-supervisor.md +0 -0
  267. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/agent.md +0 -0
  268. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/client.md +0 -0
  269. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/deployment.md +0 -0
  270. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/evals.md +0 -0
  271. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/mastra.md +0 -0
  272. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/mcp.md +0 -0
  273. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/processors.md +0 -0
  274. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/rag.md +0 -0
  275. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/storage.md +0 -0
  276. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/vectors.md +0 -0
  277. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/voice.md +0 -0
  278. /package/.docs/{guides → reference}/migrations/upgrade-to-v1/workflows.md +0 -0
  279. /package/.docs/{guides → reference}/migrations/vnext-to-standard-apis.md +0 -0
@@ -4,7 +4,7 @@
4
4
 
5
5
  [CopilotKit](https://www.copilotkit.ai/) provides React components to quickly integrate customizable AI copilots into your application. Combined with Mastra, you can build AI apps with bidirectional state synchronization and interactive UIs.
6
6
 
7
- CopilotKit talks to Mastra through the [AG-UI protocol](https://docs.ag-ui.com/). The `@ag-ui/mastra` package exposes your Mastra agents as an AG-UI endpoint, and CopilotKit's React hooks and components consume it. This unlocks a spectrum of experiences on top of ordinary chat: [generative UI, human-in-the-loop, and frontend tools](https://mastra.ai/guides/build-your-ui/copilotkit/generative-ui), plus deploying the same agent to [messaging channels like Slack](https://mastra.ai/guides/build-your-ui/copilotkit/channels).
7
+ CopilotKit talks to Mastra through the [AG-UI protocol](https://docs.ag-ui.com/). The `@ag-ui/mastra` package exposes your Mastra agents as an AG-UI endpoint, and CopilotKit's React hooks and components consume it. This unlocks a spectrum of experiences on top of ordinary chat: [generative UI, human-in-the-loop, and frontend tools](#generative-ui), plus deploying the same agent to [messaging channels like Slack](#channels).
8
8
 
9
9
  Visit the [CopilotKit documentation](https://docs.copilotkit.ai/) to learn more about CopilotKit concepts, components, and advanced usage patterns.
10
10
 
@@ -295,9 +295,175 @@ export default function Home() {
295
295
 
296
296
  For fully custom chat UIs (bring your own components), see [CopilotKit's headless UI guide](https://docs.copilotkit.ai/).
297
297
 
298
+ ## Generative UI
299
+
300
+ Generative UI describes interfaces that agents help create and that users can interact with. CopilotKit organizes these interfaces along a single axis, the **generative UI spectrum**, which runs from author-controlled (you decide every pixel) to agent-invented (the agent owns the rendered surface). Your position on the axis is a trade-off between predictability and breadth.
301
+
302
+ The spectrum has three tiers:
303
+
304
+ | Tier | Who controls the surface | Primitives |
305
+ | --------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- |
306
+ | **Controlled** | You wrote the component. The agent picks which one to use and what data to pass. | Tool call rendering, state rendering, reasoning, components as tools |
307
+ | **Declarative** | The agent emits a structured spec. The frontend composes it from a catalog you registered. | A2UI (fixed-schema and flexible variants) |
308
+ | **Open-ended** | The UI is invented elsewhere (an MCP server) and you sandbox it. | MCP Apps |
309
+
310
+ Each tier is a Mastra agent exposed through `registerCopilotKit()` plus the matching CopilotKit hook on the frontend. For the full concept, see CopilotKit's [generative UI spectrum](https://www.copilotkit.ai/generative-ui-spectrum) and [generative UI overview](https://docs.copilotkit.ai/concepts/generative-ui-overview).
311
+
312
+ > **Tip:** Mastra's [UI Dojo](https://ui-dojo.mastra.ai/) has working CopilotKit examples. Browse the source under `src/pages/copilot-kit`.
313
+
314
+ ### Controlled
315
+
316
+ You provide a fixed set of components. The agent chooses which component to render and supplies its data. This predictable, brand-safe approach works well for high-traffic surfaces. The Controlled primitives use CopilotKit's v2 API, imported from `@copilotkit/react-core/v2`.
317
+
318
+ #### Tool call rendering
319
+
320
+ Render an agent's tool call as a React component. Define the agent and tool on the Mastra server as usual:
321
+
322
+ ```typescript
323
+ import { Agent } from '@mastra/core/agent'
324
+ import { weatherTool } from '../tools/weather-tool'
325
+
326
+ export const weatherAgent = new Agent({
327
+ id: 'weather-agent',
328
+ name: 'Weather Agent',
329
+ instructions: 'Use the weatherTool to fetch current weather data.',
330
+ model: 'openai/gpt-5.6-sol',
331
+ tools: { weatherTool },
332
+ })
333
+ ```
334
+
335
+ On the frontend, register a renderer for the tool by name with `useRenderTool`. It's render-only (it doesn't execute the tool); the `render` function receives the tool call's `status` and, once the agent returns, its `result`:
336
+
337
+ ```tsx
338
+ import { z } from 'zod'
339
+ import { CopilotChat } from '@copilotkit/react-ui'
340
+ import { CopilotKit, useRenderTool } from '@copilotkit/react-core/v2'
341
+ import { Weather } from '@/components/weather'
342
+
343
+ function Chat() {
344
+ useRenderTool(
345
+ {
346
+ name: 'weatherTool',
347
+ parameters: z.object({ location: z.string() }),
348
+ render: ({ status, result }) => {
349
+ if (status !== 'complete') {
350
+ return <div>Retrieving weather...</div>
351
+ }
352
+ return <Weather {...result} />
353
+ },
354
+ },
355
+ [],
356
+ )
357
+
358
+ return <CopilotChat labels={{ title: 'Weather Assistant' }} />
359
+ }
360
+
361
+ export default function Page() {
362
+ return (
363
+ <CopilotKit runtimeUrl="http://localhost:4111/copilotkit" agent="weatherAgent">
364
+ <Chat />
365
+ </CopilotKit>
366
+ )
367
+ }
368
+ ```
369
+
370
+ Because Mastra streams tool-call arguments incrementally, the `render` function is called repeatedly as the arguments arrive, so the UI can paint progressively while the agent works.
371
+
372
+ #### Components as tools
373
+
374
+ Register a React component and let the agent call it as a tool. CopilotKit renders it inline with typed props (defined with a Zod schema):
375
+
376
+ ```tsx
377
+ import { z } from 'zod'
378
+ import { useComponent } from '@copilotkit/react-core/v2'
379
+
380
+ const schema = z.object({ text: z.string() })
381
+
382
+ function Callout({ text }: z.infer<typeof schema>) {
383
+ return <div className="callout">{text}</div>
384
+ }
385
+
386
+ function Chat() {
387
+ useComponent({ name: 'callout', render: Callout, parameters: schema }, [])
388
+ return <CopilotChat labels={{ title: 'Assistant' }} />
389
+ }
390
+ ```
391
+
392
+ The agent invokes `callout` like any other tool, and CopilotKit renders `Callout` with the props it passed.
393
+
394
+ #### State rendering
395
+
396
+ Render UI from the agent's state and re-render as it streams. On Mastra, agent state is the agent's working memory, streamed to the client as it changes. Read it with `useAgent`; `agent.state` is reactive, so the component updates automatically:
397
+
398
+ ```tsx
399
+ import { useAgent } from '@copilotkit/react-core/v2'
400
+
401
+ function TaskBoard() {
402
+ const { agent } = useAgent()
403
+ const tasks = (agent.state.tasks as any[]) ?? []
404
+
405
+ return (
406
+ <ul>
407
+ {tasks.map((task, i) => (
408
+ <li key={i}>
409
+ {task.title}: {task.status}
410
+ </li>
411
+ ))}
412
+ </ul>
413
+ )
414
+ }
415
+ ```
416
+
417
+ #### Reasoning
418
+
419
+ Reasoning is zero-config: when your Mastra agent runs a reasoning-capable model, `CopilotChat` renders the model's thinking inline as a dedicated message type, with no extra code. To restyle it, pass your own component to the `reasoningMessage` slot on `CopilotChat`. See CopilotKit's [generative UI guides](https://docs.copilotkit.ai/) for details.
420
+
421
+ ### Declarative
422
+
423
+ Instead of a fixed component per tool, you register a catalog of typed building blocks and the agent assembles them into a UI tree per request. CopilotKit calls this **A2UI** (Agent-to-UI), which has fixed-schema and flexible variants. It suits the long tail of secondary interactions where breadth matters more than pixel-perfection.
424
+
425
+ The path of least resistance is to pass your catalog to the `<CopilotKit>` provider. That single prop enables A2UI rendering and injects the A2UI tool into your agent, so no backend change is needed:
426
+
427
+ ```tsx
428
+ import { CopilotKit } from '@copilotkit/react-core/v2'
429
+ import { myCatalog } from './a2ui-catalog'
430
+
431
+ export default function Page() {
432
+ return (
433
+ <CopilotKit
434
+ runtimeUrl="http://localhost:4111/copilotkit"
435
+ agent="weatherAgent"
436
+ a2ui={{ catalog: myCatalog }}
437
+ >
438
+ {/* your app */}
439
+ </CopilotKit>
440
+ )
441
+ }
442
+ ```
443
+
444
+ The catalog defines the primitives (their schemas) and the renderers (how each primitive displays). In the fixed-schema variant, the components are pre-authored and the agent's tool only supplies data. The flexible variant lets the agent compose the tree more freely. See CopilotKit's [A2UI documentation](https://docs.copilotkit.ai/a2a/generative-ui/a2ui).
445
+
446
+ ### Open-ended
447
+
448
+ At the far end of the spectrum, the agent owns the entire surface: the UI is invented elsewhere and sandboxed in your app. CopilotKit supports this through **MCP Apps**, where an MCP server provides UI that renders inside your application. This tier trades determinism for novelty and is the most experimental point on the spectrum.
449
+
450
+ The path of least resistance keeps the frontend untouched: your existing `<CopilotKit>` provider is enough. On the backend, point `registerCopilotKit()` at one or more MCP servers with the `mcpApps` option (it's forwarded to the CopilotKit runtime):
451
+
452
+ ```typescript
453
+ registerCopilotKit({
454
+ path: '/copilotkit',
455
+ resourceId: 'weatherAgent',
456
+ mcpApps: {
457
+ servers: [{ type: 'http', url: 'http://localhost:3108/mcp', serverId: 'my-server' }],
458
+ },
459
+ })
460
+ ```
461
+
462
+ When the agent calls an MCP App tool, CopilotKit fetches and renders that tool's UI in the chat with no additional frontend code. See CopilotKit's [MCP Apps documentation](https://docs.copilotkit.ai/agno/generative-ui/mcp-apps).
463
+
298
464
  ## App control and interactivity
299
465
 
300
- Beyond rendering agent output as UI (see [generative UI](https://mastra.ai/guides/build-your-ui/copilotkit/generative-ui)), CopilotKit lets the agent act on your application and pause for the user. Both patterns run against the same Mastra setup.
466
+ Some capabilities sit next to the [generative UI](#generative-ui) spectrum rather than on it: they control your app or gate a run instead of rendering agent output. CopilotKit lets the agent act on your application and pause for the user. Both patterns run against the same Mastra setup.
301
467
 
302
468
  ### Frontend tools
303
469
 
@@ -333,6 +499,8 @@ export default function Page() {
333
499
 
334
500
  The matching Mastra agent is a normal agent instructed to call `colorChangeTool` with the requested color.
335
501
 
502
+ CopilotKit treats frontend tools as part of its separate [App Control](https://docs.copilotkit.ai/) concept, alongside shared state and agent context.
503
+
336
504
  ### Human-in-the-loop
337
505
 
338
506
  Pause the agent mid-run and wait for the user to approve, edit, or reject before continuing. Use `useHumanInTheLoop`: its `render` function receives a `respond` callback, and the agent's run stays suspended until you call it.
@@ -379,6 +547,91 @@ Inside `StepsFeedback`, let the user toggle steps and then call `respond({ accep
379
547
 
380
548
  The example above uses a client tool: the agent calls `generate_task_steps` and the frontend fulfills it through `respond`. Mastra can also pause on the server, suspending a tool call before it executes so a human approves or supplies input. For that path, see Mastra's [Agent approval](https://mastra.ai/docs/agents/agent-approval) guide for the backend side and CopilotKit's [`useHumanInTheLoop`](https://docs.copilotkit.ai/reference/hooks/useHumanInTheLoop) reference for the frontend.
381
549
 
550
+ ## Channels
551
+
552
+ The same Mastra agent that powers your in-app copilot can also run as a bot in messaging platforms. CopilotKit's Channels SDK connects your agent to Slack and other messaging platforms, with threads, tool calls, rich interactive messages, and human-in-the-loop approvals handled natively in the channel.
553
+
554
+ > **Note:** Full platform setup lives in the [CopilotKit Channels documentation](https://docs.copilotkit.ai/slack/mastra). This section shows how Channels fit together with a Mastra agent.
555
+
556
+ ### How it fits together
557
+
558
+ Your Mastra agent stays where it's deployed, exposed over AG-UI through `registerCopilotKit()`. A channel is a separate long-running process built with `@copilotkit/channels`: you attach one or more platform adapters and point the channel at your agent. `createChannel` takes an array of adapters, so a single process can serve several platforms at once.
559
+
560
+ Install the SDK (batteries-included, every adapter):
561
+
562
+ **npm**:
563
+
564
+ ```bash
565
+ npm install @copilotkit/channels
566
+ ```
567
+
568
+ **pnpm**:
569
+
570
+ ```bash
571
+ pnpm add @copilotkit/channels
572
+ ```
573
+
574
+ **Yarn**:
575
+
576
+ ```bash
577
+ yarn add @copilotkit/channels
578
+ ```
579
+
580
+ **Bun**:
581
+
582
+ ```bash
583
+ bun add @copilotkit/channels
584
+ ```
585
+
586
+ ```typescript
587
+ import { createChannel, Message, Section } from '@copilotkit/channels'
588
+ import { slack } from '@copilotkit/channels/slack'
589
+ import { mastraAgent } from './agent' // your AG-UI Mastra agent
590
+
591
+ const channel = createChannel({
592
+ // Point the channel at your Mastra agent (an AbstractAgent, or a per-thread factory).
593
+ agent: mastraAgent,
594
+ adapters: [
595
+ slack({
596
+ botToken: process.env.SLACK_BOT_TOKEN!,
597
+ appToken: process.env.SLACK_APP_TOKEN!,
598
+ }),
599
+ ],
600
+ })
601
+
602
+ channel.onMention(async ({ thread }) => {
603
+ await thread.runAgent()
604
+ })
605
+
606
+ await channel.start()
607
+ ```
608
+
609
+ The agent receives ordinary AG-UI input and emits ordinary AG-UI events; the platform mechanics stay behind the adapter, so the same Mastra agent runs unchanged across every channel. Rich messages are written as JSX and rendered to each platform's native format (Block Kit on Slack, for example), so an interactive card degrades gracefully where a platform has no equivalent.
610
+
611
+ ### Slack
612
+
613
+ The [Slack quickstart](https://docs.copilotkit.ai/slack/mastra) takes you from zero to a bot you can `@`-mention in a channel, then adds an interactive button card. Slack runs over Socket Mode, which opens an outbound WebSocket to Slack, so no public URL or tunnel is required during development.
614
+
615
+ Set the Slack credentials in your environment:
616
+
617
+ - `SLACK_BOT_TOKEN`: Bot User OAuth token (`xoxb-...`)
618
+ - `SLACK_APP_TOKEN`: App-level token with the `connections:write` scope (`xapp-...`)
619
+
620
+ ### Other platforms
621
+
622
+ The Channels SDK isn't limited to Slack. Other platforms like Microsoft Teams run through the same `@copilotkit/channels` API: add the matching adapter to the `adapters` array and the rest of your agent code stays the same. See the [CopilotKit Channels documentation](https://docs.copilotkit.ai/slack/mastra) for the current platform list and per-platform setup.
623
+
624
+ ### Message pipeline and architecture
625
+
626
+ Managed channels keep a deliberate credential split, which matters when your Mastra agent uses separate model keys and tools:
627
+
628
+ - **You keep** the agent logic, model credentials, tools, and the channel process.
629
+ - **CopilotKit Intelligence holds** the platform credentials, message delivery, registration, health, and reconnects.
630
+
631
+ A turn begins when a user messages the app. Intelligence receives the platform event, and the gateway delivers the turn to your running channel process. Your Mastra agent runs and renders a reply. Intelligence then returns the reply as native platform content. Platform credentials never enter the agent process, and enterprise Intelligence can be self-hosted for data residency.
632
+
633
+ > **Note:** By default, interactive actions live in memory and reset on restart. Back the channel with a durable action and state store (Redis or Postgres) so buttons and per-thread state survive restarts and span multiple instances.
634
+
382
635
  ## Configuration options
383
636
 
384
637
  Use these `registerCopilotKit()` options for the common integration points:
@@ -392,7 +645,7 @@ Use these `registerCopilotKit()` options for the common integration points:
392
645
  | `agents` | Provide pre-constructed AG-UI agents instead of the agents registered on the Mastra instance. |
393
646
  | `tracingOptions` | Forward Mastra tracing options to each agent run. |
394
647
 
395
- By default, the endpoint exposes every agent registered on the Mastra instance, and the frontend chooses one with the `agent` prop. Other CopilotKit runtime options are forwarded to the underlying runtime. For example, see [Open-ended generative UI](https://mastra.ai/guides/build-your-ui/copilotkit/generative-ui) for `mcpApps`.
648
+ By default, the endpoint exposes every agent registered on the Mastra instance, and the frontend chooses one with the `agent` prop. Other CopilotKit runtime options are forwarded to the underlying runtime. For example, see [Open-ended generative UI](#open-ended) for `mcpApps`.
396
649
 
397
650
  ## Deployment
398
651
 
@@ -104,7 +104,7 @@ This adds `browser_record` and `browser_record_caption` to the agent's toolset.
104
104
  ## Related
105
105
 
106
106
  - [Browser overview](https://mastra.ai/docs/browser/overview)
107
- - [Stagehand](https://mastra.ai/docs/browser/stagehand)
108
- - [Firecrawl](https://mastra.ai/docs/browser/firecrawl)
107
+ - [Stagehand](https://mastra.ai/integrations/browsers/stagehand)
108
+ - [Firecrawl](https://mastra.ai/integrations/browsers/firecrawl)
109
109
  - [Browser recording (alpha)](https://mastra.ai/docs/browser/recording)
110
110
  - [AgentBrowser reference](https://mastra.ai/reference/browser/agent-browser)
@@ -13,7 +13,7 @@ Use BrowserViewer when your agent drives a browser through a CLI tool rather tha
13
13
  - Live screencast streaming to Studio
14
14
  - Thread-scoped browser isolation
15
15
 
16
- For SDK-based browser automation, use [AgentBrowser](https://mastra.ai/docs/browser/agent-browser) or [Stagehand](https://mastra.ai/docs/browser/stagehand) instead.
16
+ For SDK-based browser automation, use [AgentBrowser](https://mastra.ai/integrations/browsers/agent-browser) or [Stagehand](https://mastra.ai/integrations/browsers/stagehand) instead.
17
17
 
18
18
  ## Quickstart
19
19
 
@@ -145,7 +145,7 @@ CDP flag: `--ws` See [BrowserViewer reference](https://mastra.ai/reference/brows
145
145
  ## Related
146
146
 
147
147
  - [Browser overview](https://mastra.ai/docs/browser/overview)
148
- - [AgentBrowser](https://mastra.ai/docs/browser/agent-browser)
149
- - [Stagehand](https://mastra.ai/docs/browser/stagehand)
148
+ - [AgentBrowser](https://mastra.ai/integrations/browsers/agent-browser)
149
+ - [Stagehand](https://mastra.ai/integrations/browsers/stagehand)
150
150
  - [Workspace overview](https://mastra.ai/docs/workspace/overview)
151
151
  - [Workspace skills](https://mastra.ai/docs/workspace/skills)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Firecrawl
4
4
 
5
- The `@mastra/browser-firecrawl` package provides browser automation using the [Firecrawl Browser Sandbox](https://docs.firecrawl.dev/features/browser). It provisions remote browser sessions through the Firecrawl API and drives them with the same deterministic, accessibility-first tools as [AgentBrowser](https://mastra.ai/docs/browser/agent-browser).
5
+ The `@mastra/browser-firecrawl` package provides browser automation using the [Firecrawl Browser Sandbox](https://docs.firecrawl.dev/features/browser). It provisions remote browser sessions through the Firecrawl API and drives them with the same deterministic, accessibility-first tools as [AgentBrowser](https://mastra.ai/integrations/browsers/agent-browser).
6
6
 
7
7
  `FirecrawlBrowser` extends `AgentBrowser`, so agents get the same toolset (`browser_goto`, `browser_snapshot`, `browser_click`, and so on) while the browser itself runs in Firecrawl's hosted infrastructure. No local Chromium install is needed.
8
8
 
@@ -124,6 +124,6 @@ const browser = new FirecrawlBrowser({
124
124
  ## Related
125
125
 
126
126
  - [Browser overview](https://mastra.ai/docs/browser/overview)
127
- - [AgentBrowser](https://mastra.ai/docs/browser/agent-browser)
127
+ - [AgentBrowser](https://mastra.ai/integrations/browsers/agent-browser)
128
128
  - [Browser recording (alpha)](https://mastra.ai/docs/browser/recording)
129
129
  - [FirecrawlBrowser reference](https://mastra.ai/reference/browser/firecrawl-browser)
@@ -167,6 +167,6 @@ This adds `browser_record` and `browser_record_caption` to the agent's toolset.
167
167
  ## Related
168
168
 
169
169
  - [Browser overview](https://mastra.ai/docs/browser/overview)
170
- - [AgentBrowser](https://mastra.ai/docs/browser/agent-browser)
170
+ - [AgentBrowser](https://mastra.ai/integrations/browsers/agent-browser)
171
171
  - [Browser recording (alpha)](https://mastra.ai/docs/browser/recording)
172
172
  - [StagehandBrowser reference](https://mastra.ai/reference/browser/stagehand-browser)
@@ -94,5 +94,5 @@ Use this URL anywhere the Discord adapter docs ask for the interactions endpoint
94
94
 
95
95
  ## Related
96
96
 
97
- - [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
98
- - [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
97
+ - [Channels overview](https://mastra.ai/docs/capabilities/channels)
98
+ - [More](https://mastra.ai/docs/capabilities/channels)
@@ -0,0 +1,103 @@
1
+ > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
+
3
+ # GitHub
4
+
5
+ The `@mastra/github-signals` provider lets an agent follow pull requests (PRs). It polls subscribed PRs and sends [notification signals](https://mastra.ai/docs/long-running-agents/signals) to the agent thread when relevant activity occurs.
6
+
7
+ ## Installation
8
+
9
+ Install GitHub Signals and the memory packages used in this example:
10
+
11
+ **npm**:
12
+
13
+ ```bash
14
+ npm install @mastra/github-signals @mastra/libsql @mastra/memory
15
+ ```
16
+
17
+ **pnpm**:
18
+
19
+ ```bash
20
+ pnpm add @mastra/github-signals @mastra/libsql @mastra/memory
21
+ ```
22
+
23
+ **Yarn**:
24
+
25
+ ```bash
26
+ yarn add @mastra/github-signals @mastra/libsql @mastra/memory
27
+ ```
28
+
29
+ **Bun**:
30
+
31
+ ```bash
32
+ bun add @mastra/github-signals @mastra/libsql @mastra/memory
33
+ ```
34
+
35
+ ## Prerequisites
36
+
37
+ GitHub Signals requires:
38
+
39
+ - A Mastra storage adapter with memory and notification support. The provider stores each subscription in the thread's metadata, so the thread must already exist.
40
+ - The `gitcrawl` command on `PATH`, configured to access the repositories you want to monitor. The provider runs `gitcrawl sync` and reads its SQLite database.
41
+ - The `sqlite3` command on `PATH`.
42
+ - The [GitHub CLI](https://cli.github.com/) installed and authenticated. The provider uses `gh api` to check whether comment authors have access to the repository before notifying the agent.
43
+
44
+ By default, comments from users with `admin`, `maintain`, or `write` access can trigger notifications. CodeRabbit and Devin bot comments are also allowed. Configure `authorizedPermissions`, `authorizedBots`, or `ignoredBots` when you need different rules.
45
+
46
+ ## Agent and subscription
47
+
48
+ Create one `GithubSignals` instance and register it on the agent. Register the agent and a storage adapter on the Mastra instance:
49
+
50
+ ```typescript
51
+ import { Agent } from '@mastra/core/agent'
52
+ import { Mastra } from '@mastra/core/mastra'
53
+ import { Memory } from '@mastra/memory'
54
+ import { GithubSignals } from '@mastra/github-signals'
55
+ import { LibSQLStore } from '@mastra/libsql'
56
+
57
+ export const githubSignals = new GithubSignals()
58
+
59
+ export const devAgent = new Agent({
60
+ id: 'dev-agent',
61
+ name: 'Development Agent',
62
+ instructions: 'Triage pull request activity and help resolve issues.',
63
+ model: 'openai/gpt-5.6-sol',
64
+ memory: new Memory(),
65
+ signals: [githubSignals],
66
+ })
67
+
68
+ export const mastra = new Mastra({
69
+ agents: { devAgent },
70
+ storage: new LibSQLStore({
71
+ id: 'mastra-storage',
72
+ url: 'file:./mastra.db',
73
+ }),
74
+ })
75
+ ```
76
+
77
+ After the agent has created a memory thread, subscribe that thread to a PR. Passing `owner` and `repo` works from any directory:
78
+
79
+ ```typescript
80
+ await githubSignals.subscribeThreadToPR({
81
+ threadId: 'thread-123',
82
+ resourceId: 'user-123',
83
+ pr: {
84
+ owner: 'acme',
85
+ repo: 'web-app',
86
+ number: 42,
87
+ },
88
+ })
89
+ ```
90
+
91
+ The provider syncs the PR immediately, stores the subscription, and starts polling every five minutes. Set `pollIntervalMs` in the `GithubSignals` constructor to change the interval. If the process restarts, call `startPollingForThread()` for each persisted thread subscription to resume polling.
92
+
93
+ ## Pull request notifications
94
+
95
+ GitHub Signals notifies the agent when a subscribed PR has:
96
+
97
+ - A new authorized comment, commit, or other pull request activity.
98
+ - A change in unresolved review threads.
99
+ - Continuous integration (CI) checks that start, fail, or recover.
100
+ - Merge conflicts that appear or are resolved.
101
+ - A state change to closed, reopened, or merged.
102
+
103
+ The initial sync sends a baseline notification with the current PR state. A merge automatically removes the thread's subscription to that PR.
@@ -110,6 +110,10 @@ https://your-app.example.com/api/agents/imessage-agent/channels/imessage/webhook
110
110
 
111
111
  Register this URL in the [Photon dashboard](https://app.photon.codes), then set the signing secret it returns as `IMESSAGE_WEBHOOK_SECRET`. The secret is shown once at registration. The adapter verifies the signature on every delivery and rejects requests that don't match. Webhooks are available in hosted mode only.
112
112
 
113
+ > **Note:** Photon delivers to public HTTPS endpoints only. It won't deliver to `http://`, to private addresses like `localhost`, or through a redirect. For local development, use a tunnel as described in the [Channels overview](https://mastra.ai/docs/capabilities/channels).
114
+
115
+ ## Duplicate deliveries
116
+
113
117
  Photon retries failed deliveries with backoff and delivers at least once, so the same message can arrive twice. Chat SDK drops the repeat using the channel state adapter, and Mastra's default keeps those dedup keys in memory. That covers a single long-running server.
114
118
 
115
119
  A repeat can still reach the agent after a restart, or on serverless where the retry is routed to a different instance. Pass a shared state adapter on `channels.state` so dedup keys are visible everywhere. Install one alongside the adapter:
@@ -157,8 +161,6 @@ channels: {
157
161
 
158
162
  This matters most for tools with side effects, where handling the same message twice is visible to the user.
159
163
 
160
- > **Note:** Photon delivers to public HTTPS endpoints only. It won't deliver to `http://`, to private addresses like `localhost`, or through a redirect. For local development, use a tunnel as described in the [Channels overview](https://mastra.ai/docs/capabilities/channels/overview).
161
-
162
164
  ## Gateway listener
163
165
 
164
166
  The adapter can hold an open connection and stream messages in real time instead of receiving webhooks. This works in both hosted and self-hosted modes.
@@ -173,9 +175,9 @@ imessage: {
173
175
  },
174
176
  ```
175
177
 
176
- On serverless platforms, prefer webhooks. A gateway listener needs a process that stays alive. See [Serverless deployment](https://mastra.ai/docs/capabilities/channels/overview).
178
+ On serverless platforms, prefer webhooks. A gateway listener needs a process that stays alive. See [Serverless deployment](https://mastra.ai/docs/capabilities/channels).
177
179
 
178
180
  ## Related
179
181
 
180
- - [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
181
- - [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
182
+ - [Channels overview](https://mastra.ai/docs/capabilities/channels)
183
+ - [More](https://mastra.ai/docs/capabilities/channels)
@@ -315,13 +315,13 @@ The channel context includes:
315
315
  - `platform`: The platform identifier, `slack` for this adapter.
316
316
  - `userId` and `userName`: The sender's Slack user ID and display name.
317
317
 
318
- Mastra also turns this context into a short system message. The agent learns the platform and its own identity, plus whether the conversation is a direct message or a public channel. See [thread context](https://mastra.ai/docs/capabilities/channels/overview) in the channels overview for how to change that behavior.
318
+ Mastra also turns this context into a short system message. The agent learns the platform and its own identity, plus whether the conversation is a direct message or a public channel. See [thread context](https://mastra.ai/docs/capabilities/channels) in the channels overview for how to change that behavior.
319
319
 
320
320
  ## Production deployment
321
321
 
322
322
  When you deploy the Mastra server, update both request URLs in the Slack app settings to the production webhook URL. The tunnel URL used for local development is temporary and changes when the tunnel restarts.
323
323
 
324
- Channels on serverless platforms may need `waitUntil` and shared pub/sub configuration so background responses and thread leases work across short-lived instances. See [serverless deployment](https://mastra.ai/docs/capabilities/channels/overview) in the channels overview.
324
+ Channels on serverless platforms may need `waitUntil` and shared pub/sub configuration so background responses and thread leases work across short-lived instances. See [serverless deployment](https://mastra.ai/docs/capabilities/channels) in the channels overview.
325
325
 
326
326
  ### Idle servers
327
327
 
@@ -329,7 +329,7 @@ Platform servers scale down to idle when they aren't receiving traffic, and that
329
329
 
330
330
  ## Related
331
331
 
332
- - [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
333
- - [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
332
+ - [Channels overview](https://mastra.ai/docs/capabilities/channels)
333
+ - [More](https://mastra.ai/docs/capabilities/channels)
334
334
  - [Channels reference](https://mastra.ai/reference/agents/channels)
335
335
  - [Deployment overview](https://mastra.ai/docs/deployment/overview)
@@ -96,5 +96,5 @@ Use this URL anywhere the Teams adapter docs ask for the bot endpoint or webhook
96
96
 
97
97
  ## Related
98
98
 
99
- - [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
100
- - [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
99
+ - [Channels overview](https://mastra.ai/docs/capabilities/channels)
100
+ - [More](https://mastra.ai/docs/capabilities/channels)
@@ -94,5 +94,5 @@ Use this URL anywhere the Telegram adapter docs ask for the webhook URL. Telegra
94
94
 
95
95
  ## Related
96
96
 
97
- - [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
98
- - [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
97
+ - [Channels overview](https://mastra.ai/docs/capabilities/channels)
98
+ - [More](https://mastra.ai/docs/capabilities/channels)
@@ -95,5 +95,5 @@ Use this URL for incoming WhatsApp event delivery. The generated Mastra route ha
95
95
 
96
96
  ## Related
97
97
 
98
- - [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
99
- - [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
98
+ - [Channels overview](https://mastra.ai/docs/capabilities/channels)
99
+ - [More](https://mastra.ai/docs/capabilities/channels)
@@ -1,6 +1,6 @@
1
1
  > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
2
 
3
- # Aurora DSQL Storage
3
+ # Aurora DSQL
4
4
 
5
5
  The Aurora DSQL storage implementation provides storage using Amazon Aurora DSQL with IAM authentication.
6
6
 
@@ -1,6 +1,6 @@
1
1
  > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
2
 
3
- # ClickHouse storage
3
+ # ClickHouse
4
4
 
5
5
  [ClickHouse](https://clickhouse.com/) is a columnar database designed for analytical workloads. The `@mastra/clickhouse` package provides storage adapters for several Mastra storage domains and is the recommended backend for production observability.
6
6
 
@@ -10,7 +10,7 @@ ClickHouse is most commonly used as the dedicated observability backend in a [co
10
10
 
11
11
  Production observability for traces, logs, metrics, scores, and feedback.
12
12
 
13
- For local development, use a composite store that combines [LibSQL](https://mastra.ai/reference/storage/libsql) (for memory and workflows) and `@mastra/duckdb` (for observability). Neither alone covers a development setup: LibSQL doesn't implement the observability domain, and DuckDB doesn't implement the other domains. See the [observability overview](https://mastra.ai/docs/observability/overview) for an example.
13
+ For local development, use a composite store that combines [LibSQL](https://mastra.ai/integrations/databases/libsql) (for memory and workflows) and `@mastra/duckdb` (for observability). Neither alone covers a development setup: LibSQL doesn't implement the observability domain, and DuckDB doesn't implement the other domains. See the [observability overview](https://mastra.ai/docs/observability/overview) for an example.
14
14
 
15
15
  ## Installation
16
16
 
@@ -1,6 +1,6 @@
1
1
  > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
2
 
3
- # Cloudflare D1 storage
3
+ # Cloudflare D1
4
4
 
5
5
  The Cloudflare D1 storage implementation provides a serverless SQL database solution using Cloudflare D1, supporting relational operations and transactional consistency.
6
6
 
@@ -1,6 +1,6 @@
1
1
  > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
2
 
3
- # Cloudflare storage
3
+ # Cloudflare
4
4
 
5
5
  Mastra provides two Cloudflare storage implementations:
6
6
 
@@ -1,6 +1,6 @@
1
1
  > Discover all available pages from the documentation index: https://mastra.ai/llms.txt
2
2
 
3
- # Convex storage
3
+ # Convex
4
4
 
5
5
  The Convex storage implementation provides a serverless storage solution using [Convex](https://convex.dev), a full-stack TypeScript development platform with real-time sync and automatic caching.
6
6