@mastra/mcp-docs-server 1.2.6 → 1.2.7-alpha.10
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.
- package/.docs/docs/agent-builder/integrations.md +1 -1
- package/.docs/docs/agent-builder/overview.md +4 -3
- package/.docs/docs/agent-builder/skill-registries.md +1 -3
- package/.docs/docs/agent-controller/modes.md +1 -1
- package/.docs/docs/agent-controller/overview.md +4 -3
- package/.docs/docs/agent-controller/session.md +3 -5
- package/.docs/docs/agents/a2a.md +2 -1
- package/.docs/docs/agents/agent-approval.md +2 -2
- package/.docs/docs/agents/code-mode.md +1 -1
- package/.docs/docs/agents/guardrails.md +10 -9
- package/.docs/docs/agents/networks.md +1 -1
- package/.docs/docs/agents/overview.md +5 -5
- package/.docs/docs/agents/skills.md +3 -5
- package/.docs/docs/agents/structured-output.md +1 -1
- package/.docs/docs/agents/supervisor-agents.md +3 -4
- package/.docs/docs/agents/using-tools.md +2 -4
- package/.docs/docs/browser/agent-browser.md +1 -3
- package/.docs/docs/browser/browser-viewer.md +1 -3
- package/.docs/docs/browser/overview.md +2 -1
- package/.docs/docs/browser/recording.md +1 -1
- package/.docs/docs/browser/stagehand.md +1 -1
- package/.docs/docs/capabilities/channels/discord.md +98 -0
- package/.docs/docs/capabilities/channels/other-adapters.md +68 -0
- package/.docs/docs/capabilities/channels/overview.md +255 -0
- package/.docs/docs/capabilities/channels/slack.md +225 -0
- package/.docs/docs/capabilities/channels/teams.md +100 -0
- package/.docs/docs/capabilities/channels/telegram.md +98 -0
- package/.docs/docs/capabilities/channels/whatsapp.md +99 -0
- package/.docs/docs/deployment/mastra-server.md +2 -4
- package/.docs/docs/editor/overview.md +2 -6
- package/.docs/docs/editor/prompts.md +1 -1
- package/.docs/docs/editor/tools.md +1 -3
- package/.docs/docs/evals/built-in-scorers.md +2 -2
- package/.docs/docs/evals/custom-scorers.md +1 -3
- package/.docs/docs/evals/datasets/overview.md +4 -5
- package/.docs/docs/evals/datasets/running-experiments.md +10 -8
- package/.docs/docs/evals/evals-with-memory.md +1 -3
- package/.docs/docs/evals/gates-and-verdicts.md +2 -4
- package/.docs/docs/evals/overview.md +4 -1
- package/.docs/docs/evals/quick-checks.md +3 -5
- package/.docs/docs/getting-started/file-based-agents.md +114 -0
- package/.docs/docs/getting-started/manual-install.md +17 -4
- package/.docs/docs/index.md +1 -1
- package/.docs/docs/long-running-agents/background-tasks.md +3 -3
- package/.docs/docs/long-running-agents/durable-agents.md +5 -7
- package/.docs/docs/long-running-agents/goals.md +5 -7
- package/.docs/docs/long-running-agents/schedules.md +1 -1
- package/.docs/docs/long-running-agents/signal-providers.md +1 -3
- package/.docs/docs/long-running-agents/signals.md +12 -23
- package/.docs/docs/mastra-platform/database.md +2 -2
- package/.docs/docs/mastra-platform/github.md +1 -1
- package/.docs/docs/mastra-platform/observability.md +5 -1
- package/.docs/docs/mcp/mcp-apps.md +3 -3
- package/.docs/docs/mcp/overview.md +6 -10
- package/.docs/docs/memory/memory-processors.md +67 -0
- package/.docs/docs/memory/message-history.md +56 -2
- package/.docs/docs/memory/observational-memory.md +5 -4
- package/.docs/docs/memory/overview.md +8 -6
- package/.docs/docs/memory/semantic-recall.md +36 -2
- package/.docs/docs/memory/working-memory.md +3 -3
- package/.docs/docs/observability/integrations/exporters/mastra-platform.md +1 -3
- package/.docs/docs/observability/integrations/exporters/mastra-storage.md +1 -1
- package/.docs/docs/observability/logging.md +1 -1
- package/.docs/docs/observability/tracing/overview.md +1 -1
- package/.docs/docs/rag/vector-databases.md +7 -2
- package/.docs/docs/server/auth/auth0.md +1 -1
- package/.docs/docs/server/auth/better-auth.md +2 -2
- package/.docs/docs/server/auth/clerk.md +1 -1
- package/.docs/docs/server/auth/firebase.md +1 -1
- package/.docs/docs/server/auth/google.md +3 -3
- package/.docs/docs/server/auth/jwt.md +2 -2
- package/.docs/docs/server/auth/okta.md +2 -2
- package/.docs/docs/server/auth/workos.md +1 -1
- package/.docs/docs/server/mastra-client.md +1 -1
- package/.docs/docs/server/mastra-server.md +1 -1
- package/.docs/docs/server/pubsub.md +1 -1
- package/.docs/docs/server/request-context.md +4 -4
- package/.docs/docs/server/server-adapters.md +8 -8
- package/.docs/docs/storage/overview.md +214 -0
- package/.docs/docs/studio/auth.md +1 -3
- package/.docs/docs/studio/overview.md +1 -1
- package/.docs/docs/voice/livekit.md +101 -4
- package/.docs/docs/workflows/agents-and-tools.md +3 -5
- package/.docs/docs/workflows/control-flow.md +1 -3
- package/.docs/docs/workflows/overview.md +6 -7
- package/.docs/docs/workflows/snapshots.md +1 -1
- package/.docs/docs/workspace/overview.md +2 -1
- package/.docs/docs/workspace/sandbox.md +2 -0
- package/.docs/guides/build-your-ui/assistant-ui.md +1 -1
- package/.docs/guides/build-your-ui/copilotkit/channels.md +1 -1
- package/.docs/guides/build-your-ui/copilotkit/generative-ui.md +2 -2
- package/.docs/guides/build-your-ui/copilotkit/overview.md +1 -1
- package/.docs/guides/concepts/streaming.md +3 -3
- package/.docs/guides/getting-started/quickstart.md +4 -2
- package/.docs/guides/guide/chef-michel.md +0 -2
- package/.docs/guides/guide/slack-assistant.md +2 -2
- package/.docs/guides/guide/stock-agent.md +0 -2
- package/.docs/models/embeddings.md +119 -0
- package/.docs/models/environment-variables.md +3 -0
- package/.docs/models/gateways/netlify.md +4 -1
- package/.docs/models/gateways/openrouter.md +12 -6
- package/.docs/models/gateways/vercel.md +7 -1
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/crossmodel.md +109 -0
- package/.docs/models/providers/google.md +2 -1
- package/.docs/models/providers/llmgateway.md +184 -181
- package/.docs/models/providers/meta.md +101 -0
- package/.docs/models/providers/nano-gpt.md +2 -2
- package/.docs/models/providers/neon.md +40 -29
- package/.docs/models/providers/openai.md +5 -1
- package/.docs/models/providers/opencode.md +2 -1
- package/.docs/models/providers/poolside.md +6 -5
- package/.docs/models/providers/routing-run.md +20 -34
- package/.docs/models/providers/the-grid-ai.md +3 -3
- package/.docs/models/providers/wandb.md +21 -14
- package/.docs/models/providers/xai.md +2 -1
- package/.docs/models/providers/zenifra.md +73 -0
- package/.docs/models/providers.md +3 -0
- package/.docs/reference/agent-controller/agent-controller-class.md +3 -3
- package/.docs/reference/agent-controller/session.md +4 -4
- package/.docs/reference/agents/agent.md +1 -1
- package/.docs/reference/agents/channels.md +2 -2
- package/.docs/reference/agents/inngest-agent.md +1 -1
- package/.docs/reference/agents/listSkills.md +1 -1
- package/.docs/reference/agents/listSuspendedRuns.md +3 -3
- package/.docs/reference/auth/google.md +5 -5
- package/.docs/reference/channels/channel-provider.md +1 -1
- package/.docs/reference/channels/slack-provider.md +3 -3
- package/.docs/reference/cli/mastra.md +119 -12
- package/.docs/reference/code-sdk/mount-agent-controller.md +76 -0
- package/.docs/reference/coding-agent/create-coding-agent.md +1 -1
- package/.docs/reference/configuration.md +1 -1
- package/.docs/reference/evals/checks.md +4 -4
- package/.docs/reference/evals/create-scorer.md +8 -0
- package/.docs/reference/file-based-agents/config.md +97 -0
- package/.docs/reference/file-based-agents/instructions.md +54 -0
- package/.docs/reference/file-based-agents/memory.md +58 -0
- package/.docs/reference/file-based-agents/observability.md +32 -0
- package/.docs/reference/file-based-agents/processors.md +56 -0
- package/.docs/reference/file-based-agents/server.md +37 -0
- package/.docs/reference/file-based-agents/skills.md +56 -0
- package/.docs/reference/file-based-agents/storage.md +30 -0
- package/.docs/reference/file-based-agents/studio.md +56 -0
- package/.docs/reference/file-based-agents/subagents.md +123 -0
- package/.docs/reference/file-based-agents/tools.md +63 -0
- package/.docs/reference/file-based-agents/workflows.md +52 -0
- package/.docs/reference/file-based-agents/workspace.md +74 -0
- package/.docs/reference/index.md +16 -0
- package/.docs/reference/memory/memory-class.md +1 -1
- package/.docs/reference/memory/observational-memory.md +1 -1
- package/.docs/reference/memory/serialized-memory-config.md +1 -1
- package/.docs/reference/memory/summarizeConversation.md +99 -0
- package/.docs/reference/memory/summarizeThread.md +93 -0
- package/.docs/{docs/getting-started → reference}/project-structure.md +3 -10
- package/.docs/reference/pubsub/lease-provider.md +5 -5
- package/.docs/reference/server/express-adapter.md +1 -3
- package/.docs/reference/server/fastify-adapter.md +1 -3
- package/.docs/reference/server/hono-adapter.md +1 -3
- package/.docs/reference/server/koa-adapter.md +1 -3
- package/.docs/reference/server/nestjs-adapter.md +1 -3
- package/.docs/reference/signals/task-signal-provider.md +1 -1
- package/.docs/reference/storage/clickhouse.md +34 -2
- package/.docs/reference/storage/cloudflare-d1.md +1 -1
- package/.docs/reference/storage/composite.md +64 -6
- package/.docs/reference/storage/convex.md +1 -1
- package/.docs/reference/storage/dynamodb.md +1 -1
- package/.docs/reference/storage/mongodb.md +46 -46
- package/.docs/reference/storage/retention.md +74 -6
- package/.docs/reference/tools/create-tool.md +2 -2
- package/.docs/reference/tools/mcp-client.md +22 -0
- package/.docs/reference/tools/mcp-server.md +161 -4
- package/.docs/reference/vectors/mongodb.md +93 -4
- package/.docs/reference/voice/livekit.md +272 -8
- package/.docs/reference/workspace/agentcore-runtime-sandbox.md +1 -3
- package/.docs/reference/workspace/agentfs-filesystem.md +1 -3
- package/.docs/reference/workspace/apple-container-sandbox.md +6 -8
- package/.docs/reference/workspace/archil-filesystem.md +1 -3
- package/.docs/reference/workspace/azure-blob-filesystem.md +1 -3
- package/.docs/reference/workspace/blaxel-sandbox.md +1 -3
- package/.docs/reference/workspace/daytona-sandbox.md +1 -3
- package/.docs/reference/workspace/docker-sandbox.md +1 -3
- package/.docs/reference/workspace/e2b-sandbox.md +1 -3
- package/.docs/reference/workspace/files-sdk-filesystem.md +1 -3
- package/.docs/reference/workspace/gcs-filesystem.md +1 -3
- package/.docs/reference/workspace/google-drive-filesystem.md +1 -3
- package/.docs/reference/workspace/local-filesystem.md +1 -3
- package/.docs/reference/workspace/local-sandbox.md +1 -3
- package/.docs/reference/workspace/mesa-filesystem.md +4 -4
- package/.docs/reference/workspace/modal-sandbox.md +1 -3
- package/.docs/reference/workspace/railway-sandbox.md +2 -4
- package/.docs/reference/workspace/s3-filesystem.md +1 -3
- package/.docs/reference/workspace/vercel-sandbox.md +5 -7
- package/.docs/reference/workspace/vercel-serverless.md +2 -4
- package/CHANGELOG.md +36 -0
- package/package.json +5 -5
- package/.docs/docs/agents/channels.md +0 -225
- package/.docs/docs/agents/file-based-agents.md +0 -297
- package/.docs/docs/memory/storage.md +0 -267
|
@@ -40,7 +40,7 @@ export const mastra = new Mastra({
|
|
|
40
40
|
})
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Each provider's toolkits become available in the Builder once it
|
|
43
|
+
Each provider's toolkits become available in the Builder once it's registered. Use `allowedToolkits` to restrict which toolkits the provider exposes — by slug, such as `gmail` or `googlecalendar`. Omit it to expose every toolkit the provider offers. To add another provider, import it and add another entry to `toolProviders`. For the full list of providers and their options, see [Tools — Integration providers](https://mastra.ai/docs/editor/tools).
|
|
44
44
|
|
|
45
45
|
## Set up a Composio auth config
|
|
46
46
|
|
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
> **Note:** The Agent Builder is part of the Mastra Enterprise Edition. Production deployments require a valid EE license. [Contact sales](https://mastra.ai/contact) for more information.
|
|
6
6
|
|
|
7
|
-
[YouTube video player](https://www.youtube-nocookie.com/embed/AbdgIu4Z07I)
|
|
8
|
-
|
|
9
7
|
The Agent Builder lets you build, configure, and operate Mastra agents all within the UI. It runs inside your Mastra server, persists everything to `Mastra.storage`, and supports multi-tenant agent workflows with RBAC and channel integrations.
|
|
10
8
|
|
|
9
|
+
> **📹 Watch:** Watch [Mastra Agent Builder overview](https://www.youtube.com/watch?v=AbdgIu4Z07I) to see how teams create and configure agents from the UI.
|
|
10
|
+
|
|
11
11
|
- [**Configuration**](https://mastra.ai/docs/agent-builder/configuration): Toggle UI sections and pin admin-controlled defaults for every new agent.
|
|
12
12
|
- [**Model policy**](https://mastra.ai/docs/agent-builder/model-policy): Restrict which providers and models the Builder exposes, and pin a default.
|
|
13
13
|
- [**Memory**](https://mastra.ai/docs/agent-builder/memory): Configure the default memory shape for every Builder-created agent.
|
|
@@ -108,4 +108,5 @@ Omitting the `builder` field has the same effect.
|
|
|
108
108
|
|
|
109
109
|
- [Configuration](https://mastra.ai/docs/agent-builder/configuration): Toggle Builder surfaces and pin defaults for new agents.
|
|
110
110
|
- [Access control](https://mastra.ai/docs/agent-builder/access-control): Gate the Builder with authentication and role-based access control.
|
|
111
|
-
- [Deploying](https://mastra.ai/docs/agent-builder/deploying): Replace local development primitives with production-ready storage, filesystems, and sandboxes.
|
|
111
|
+
- [Deploying](https://mastra.ai/docs/agent-builder/deploying): Replace local development primitives with production-ready storage, filesystems, and sandboxes.
|
|
112
|
+
- 📹 [Mastra Agent Builder workshop](https://www.youtube.com/watch?v=p2p_wb-rUPg\&t=666s)
|
|
@@ -23,9 +23,7 @@ new MastraEditor({
|
|
|
23
23
|
})
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
The Builder library tab now exposes a **Browse** view backed by skills.sh. End users can preview a skill, then install it into an agent.
|
|
27
|
-
|
|
28
|
-
> **Note:** See the [AgentBuilderOptions reference](https://mastra.ai/reference/editor/agent-builder/agent-builder-options) for the full `registries` schema.
|
|
26
|
+
The Builder library tab now exposes a **Browse** view backed by skills.sh. End users can preview a skill, then install it into an agent. See the [AgentBuilderOptions reference](https://mastra.ai/reference/editor/agent-builder/agent-builder-options) for the full `registries` schema.
|
|
29
27
|
|
|
30
28
|
## Related
|
|
31
29
|
|
|
@@ -98,7 +98,7 @@ const reviewMode = {
|
|
|
98
98
|
|
|
99
99
|
- **`undefined`** (default): no mode-level restriction — every tool is visible.
|
|
100
100
|
- **`[]`**: no tools are available for this mode.
|
|
101
|
-
- A denied tool stays hidden even
|
|
101
|
+
- A denied tool stays hidden even when the list includes it. Per-tool and per-category `deny` rules in your permission config always take precedence.
|
|
102
102
|
|
|
103
103
|
Workspace tools use the same list as every other tool — reference them by their exposed names (`view`, `write_file`, `find_files`, etc.). Visibility is enforced at LLM-call time, so the model never sees — and can't attempt to call — a tool outside the allowlist.
|
|
104
104
|
|
|
@@ -32,7 +32,7 @@ Use the AgentController when your application needs:
|
|
|
32
32
|
- Subagent orchestration to delegate focused subtasks with constrained tools
|
|
33
33
|
- Session continuity with persistent threads, state, and observational memory across restarts
|
|
34
34
|
|
|
35
|
-
You could assemble all of this yourself on top of the [Agent class](https://mastra.ai/docs/agents/overview), which exposes the full agent loop, tools, and memory. The AgentController is an opinionated set of defaults that wires those pieces into one application style: an ongoing session where the agent acts as a collaborator rather than a one-shot endpoint. Reach for the Agent class directly when you want full control or a
|
|
35
|
+
You could assemble all of this yourself on top of the [Agent class](https://mastra.ai/docs/agents/overview), which exposes the full agent loop, tools, and memory. The AgentController is an opinionated set of defaults that wires those pieces into one application style: an ongoing session where the agent acts as a collaborator rather than a one-shot endpoint. Reach for the Agent class directly when you want full control or a request-response call; reach for the AgentController when you want the collaborative-session model without building the runtime around it.
|
|
36
36
|
|
|
37
37
|
## Key capabilities
|
|
38
38
|
|
|
@@ -88,7 +88,7 @@ await agentController.selectOrCreateThread()
|
|
|
88
88
|
await agentController.sendMessage({ content: 'Hello!' })
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
Visit the [AgentController reference](https://mastra.ai/reference/agent-controller/agent-controller-class) for the full constructor parameters and method signatures.
|
|
92
92
|
|
|
93
93
|
## Architecture
|
|
94
94
|
|
|
@@ -128,4 +128,5 @@ Your app sends commands — send a message, switch mode, approve a tool call —
|
|
|
128
128
|
- [Threads and state](https://mastra.ai/docs/agent-controller/threads-and-state): Manage persistent conversations
|
|
129
129
|
- [Subagents](https://mastra.ai/docs/agent-controller/subagents): Delegate focused subtasks
|
|
130
130
|
- [Tool approvals and permissions](https://mastra.ai/docs/agent-controller/tool-approvals): Human-in-the-loop gating
|
|
131
|
-
- [API reference](https://mastra.ai/reference/agent-controller/agent-controller-class): Full constructor and method docs
|
|
131
|
+
- [API reference](https://mastra.ai/reference/agent-controller/agent-controller-class): Full constructor and method docs
|
|
132
|
+
- 📹 [Mastra AgentController harness workshop](https://www.youtube.com/watch?v=tV1pSleP-LM)
|
|
@@ -6,9 +6,9 @@ A [`Session`](https://mastra.ai/reference/agent-controller/session) holds the li
|
|
|
6
6
|
|
|
7
7
|
## What the Session tracks
|
|
8
8
|
|
|
9
|
-
The Session is the live state of a single user's interaction with the AgentController. It answers "what
|
|
9
|
+
The Session is the live state of a single user's interaction with the AgentController. It answers "what's true right now": who the session belongs to, which thread is currently bound, which mode and model are selected, what the user has approved, what's queued or running, the application state, and the snapshot to render. A session has one active thread at a time but can list, switch between, and clone many threads over its lifetime. Anything that describes the current state lives here; the AgentController owns the shared infrastructure every session runs on.
|
|
10
10
|
|
|
11
|
-
Because each session has its own identity and state, one AgentController can serve many users at once — each backed by its own Session — without one session's mode, grants, or active thread leaking into another.
|
|
11
|
+
Because each session has its own identity and state, one AgentController can serve many users at once — each with a different `resourceId` backed by its own Session — without one session's mode, grants, or active thread leaking into another. Calling `createSession` with the same `resourceId` returns the existing session (get-or-create), so a resource always resumes its own session.
|
|
12
12
|
|
|
13
13
|
The rest of this page walks through the Session's state. Each part is a focused sub-object on `agentController.session`:
|
|
14
14
|
|
|
@@ -133,9 +133,7 @@ agentController.subscribe(event => {
|
|
|
133
133
|
})
|
|
134
134
|
```
|
|
135
135
|
|
|
136
|
-
This is the recommended pattern for most UIs. Subscribe to individual typed events only when you need to react to a specific transition rather than re-render the whole view.
|
|
137
|
-
|
|
138
|
-
> **Note:** Visit the [Session reference](https://mastra.ai/reference/agent-controller/session) for the full list of sub-objects and method signatures.
|
|
136
|
+
This is the recommended pattern for most UIs. Subscribe to individual typed events only when you need to react to a specific transition rather than re-render the whole view. Visit the [Session reference](https://mastra.ai/reference/agent-controller/session) for the full list of sub-objects and method signatures.
|
|
139
137
|
|
|
140
138
|
## Related
|
|
141
139
|
|
package/.docs/docs/agents/a2a.md
CHANGED
|
@@ -261,4 +261,5 @@ Use this hook to enforce expected providers, expected endpoints, certificate-bou
|
|
|
261
261
|
- [Agent reference](https://mastra.ai/reference/agents/agent)
|
|
262
262
|
- [JavaScript client agents reference](https://mastra.ai/reference/client-js/agents)
|
|
263
263
|
- [A2A core concepts](https://a2a-protocol.org/latest/topics/key-concepts/)
|
|
264
|
-
- [A2A discovery guide](https://a2a-protocol.org/latest/topics/agent-discovery/)
|
|
264
|
+
- [A2A discovery guide](https://a2a-protocol.org/latest/topics/agent-discovery/)
|
|
265
|
+
- 📹 [Agent-to-agent with Mastra workshop](https://www.youtube.com/watch?v=LQDzyNGm-aw)
|
|
@@ -48,7 +48,7 @@ for await (const chunk of stream.fullStream) {
|
|
|
48
48
|
}
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
> **Note:** Agent approval uses snapshots to capture request state. Configure a [storage provider](https://mastra.ai/docs/
|
|
51
|
+
> **Note:** Agent approval uses snapshots to capture request state. Configure a [storage provider](https://mastra.ai/docs/storage/overview) on your Mastra instance or you'll see a "snapshot not found" error.
|
|
52
52
|
>
|
|
53
53
|
> Snapshots for agent runs are minimal resume artifacts: they hold only what's needed to resume the suspended run and are deleted once the run finishes. Use [tracing](https://mastra.ai/docs/observability/overview) for the execution record and [memory](https://mastra.ai/docs/memory/overview) for the conversation history.
|
|
54
54
|
|
|
@@ -420,7 +420,7 @@ Each returned run includes the suspended tool calls (`toolCallId`, `toolName`, `
|
|
|
420
420
|
|
|
421
421
|
The same discovery is available over HTTP as `GET /agents/:agentId/suspended-runs` and in the client SDK as [`agent.listSuspendedRuns()`](https://mastra.ai/reference/client-js/agents), so browser-based approval UIs can rediscover pending runs directly.
|
|
422
422
|
|
|
423
|
-
> **Note:** Suspended runs only survive restarts when your Mastra instance is configured with a persistent [storage provider](https://mastra.ai/docs/
|
|
423
|
+
> **Note:** Suspended runs only survive restarts when your Mastra instance is configured with a persistent [storage provider](https://mastra.ai/docs/storage/overview). The default in-memory store loses snapshots when the process exits.
|
|
424
424
|
|
|
425
425
|
## Tool approval: Supervisor agents
|
|
426
426
|
|
|
@@ -94,7 +94,7 @@ For `createCodeMode()` to work well, keep these tips in mind:
|
|
|
94
94
|
- Keep tools focused, so each does one thing well and the model composes them in code.
|
|
95
95
|
- Code mode helps most when calls can be parallelized with `Promise.all`.
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
Visit the [`createCodeMode()` reference](https://mastra.ai/reference/tools/create-code-mode) for configuration options, return values, result shape, and instructions inspection.
|
|
98
98
|
|
|
99
99
|
## Scoping tools across multiple code tools
|
|
100
100
|
|
|
@@ -29,7 +29,7 @@ export const normalizedAgent = new Agent({
|
|
|
29
29
|
})
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Visit [`UnicodeNormalizer()`](https://mastra.ai/reference/processors/unicode-normalizer) reference for a full list of configuration options.
|
|
33
33
|
|
|
34
34
|
### Prevent prompt injection
|
|
35
35
|
|
|
@@ -52,7 +52,7 @@ export const secureAgent = new Agent({
|
|
|
52
52
|
})
|
|
53
53
|
```
|
|
54
54
|
|
|
55
|
-
|
|
55
|
+
Visit [`PromptInjectionDetector()`](https://mastra.ai/reference/processors/prompt-injection-detector) reference for a full list of configuration options.
|
|
56
56
|
|
|
57
57
|
### Detect and translate language
|
|
58
58
|
|
|
@@ -75,7 +75,7 @@ export const multilingualAgent = new Agent({
|
|
|
75
75
|
})
|
|
76
76
|
```
|
|
77
77
|
|
|
78
|
-
|
|
78
|
+
Visit [`LanguageDetector()`](https://mastra.ai/reference/processors/language-detector) reference for a full list of configuration options.
|
|
79
79
|
|
|
80
80
|
## Output processors
|
|
81
81
|
|
|
@@ -101,7 +101,7 @@ export const batchedAgent = new Agent({
|
|
|
101
101
|
})
|
|
102
102
|
```
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
Visit [`BatchPartsProcessor()`](https://mastra.ai/reference/processors/batch-parts-processor) reference for a full list of configuration options.
|
|
105
105
|
|
|
106
106
|
### Scrub system prompts
|
|
107
107
|
|
|
@@ -128,7 +128,7 @@ const scrubbedAgent = new Agent({
|
|
|
128
128
|
})
|
|
129
129
|
```
|
|
130
130
|
|
|
131
|
-
|
|
131
|
+
Visit [`SystemPromptScrubber()`](https://mastra.ai/reference/processors/system-prompt-scrubber) reference for a full list of configuration options.
|
|
132
132
|
|
|
133
133
|
> **Note:** When streaming responses over HTTP, Mastra redacts sensitive request data (system prompts, tool definitions, API keys) from stream chunks at the server level by default. See [Stream data redaction](https://mastra.ai/docs/server/mastra-server) for details.
|
|
134
134
|
|
|
@@ -158,7 +158,7 @@ export const moderatedAgent = new Agent({
|
|
|
158
158
|
})
|
|
159
159
|
```
|
|
160
160
|
|
|
161
|
-
|
|
161
|
+
Visit [`ModerationProcessor()`](https://mastra.ai/reference/processors/moderation-processor) reference for a full list of configuration options.
|
|
162
162
|
|
|
163
163
|
### Detect and redact PII
|
|
164
164
|
|
|
@@ -184,7 +184,7 @@ export const privateAgent = new Agent({
|
|
|
184
184
|
})
|
|
185
185
|
```
|
|
186
186
|
|
|
187
|
-
|
|
187
|
+
Visit [`PIIDetector()`](https://mastra.ai/reference/processors/pii-detector) reference for a full list of configuration options.
|
|
188
188
|
|
|
189
189
|
### Enforce cost limits
|
|
190
190
|
|
|
@@ -206,7 +206,7 @@ export const budgetedAgent = new Agent({
|
|
|
206
206
|
})
|
|
207
207
|
```
|
|
208
208
|
|
|
209
|
-
|
|
209
|
+
Visit [`CostGuardProcessor()`](https://mastra.ai/reference/processors/cost-guard-processor) reference for scoping modes, time windows, metric persistence delays, and the `onViolation` callback. Requires observability storage with `getMetricAggregate` support.
|
|
210
210
|
|
|
211
211
|
## Processor strategies
|
|
212
212
|
|
|
@@ -386,4 +386,5 @@ outputProcessors: [
|
|
|
386
386
|
|
|
387
387
|
- [Processors](https://mastra.ai/docs/agents/processors): How processors work, execution order, custom processors, and retry mechanism
|
|
388
388
|
- [`Processor` Interface](https://mastra.ai/reference/processors/processor-interface): API reference for the `Processor` interface
|
|
389
|
-
- [Memory Processors](https://mastra.ai/docs/memory/memory-processors): Processors for message history, semantic recall, and working memory
|
|
389
|
+
- [Memory Processors](https://mastra.ai/docs/memory/memory-processors): Processors for message history, semantic recall, and working memory
|
|
390
|
+
- 📹 [Mastra processors and guardrails workshop](https://www.youtube.com/watch?v=4Vpp7xQYvl0)
|
|
@@ -95,7 +95,7 @@ console.log(final?.summary)
|
|
|
95
95
|
|
|
96
96
|
When a primitive requires approval, the stream emits an `agent-execution-approval` or `tool-execution-approval` chunk. Use `approveNetworkToolCall()` or `declineNetworkToolCall()` to respond.
|
|
97
97
|
|
|
98
|
-
Network approval uses snapshots to capture execution state. Ensure a [storage provider](https://mastra.ai/docs/
|
|
98
|
+
Network approval uses snapshots to capture execution state. Ensure a [storage provider](https://mastra.ai/docs/storage/overview) is enabled in your Mastra instance.
|
|
99
99
|
|
|
100
100
|
```typescript
|
|
101
101
|
const stream = await routingAgent.network('Perform some sensitive action', {
|
|
@@ -54,7 +54,7 @@ export const weatherTool = createTool({
|
|
|
54
54
|
})
|
|
55
55
|
```
|
|
56
56
|
|
|
57
|
-
If you need to create an agent, create a new file and use `import { Agent } from "@mastra/core/agent"`. The constructor takes `{ id, name, instructions, model }`. The `model` property is a string in Mastra's model router format: `provider/model`, for example `openai/gpt-5.5`. For OpenAI models, use `openai/<model>`, not `openai:<model>`, and don't pass a provider object. No provider import is needed for this format.
|
|
57
|
+
If you need to create an agent, create a new file and use `import { Agent } from "@mastra/core/agent"`. The constructor takes `{ id, name, instructions, model }`. The `model` property is a string in Mastra's model router format: `provider/model`, for example `openai/gpt-5.5`. For OpenAI models, use `openai/<model>`, not `openai:<model>`, and don't pass a provider object. No provider import is needed for this format. Don't install any AI SDK package unless Mastra's documentation says otherwise.
|
|
58
58
|
|
|
59
59
|
Add a tool an agent by importing the tool and passing it to the agent constructor as a tools object.
|
|
60
60
|
|
|
@@ -119,7 +119,7 @@ console.log(response.text)
|
|
|
119
119
|
|
|
120
120
|
Use agents when the task is open-ended and the steps aren't known in advance. An agent decides which tools to call, how many times to loop, and when to stop. You provide the goal and constraints instead of defining each step. For predetermined, multi-step processes with explicit control flow, use [workflows](https://mastra.ai/docs/workflows/overview) instead.
|
|
121
121
|
|
|
122
|
-
>
|
|
122
|
+
> **📹 Watch:** Watch [Mastra agent quickstart](https://www.youtube.com/watch?v=G8tXjcseNjg) for a short walkthrough of creating and testing a Mastra agent.
|
|
123
123
|
|
|
124
124
|
## Quickstart
|
|
125
125
|
|
|
@@ -151,9 +151,9 @@ export const mastra = new Mastra({
|
|
|
151
151
|
|
|
152
152
|
Once registered, it can be called from workflows, tools, or other agents, and has access to shared resources such as memory, logging, and observability features.
|
|
153
153
|
|
|
154
|
-
|
|
154
|
+
Visit the [agent reference](https://mastra.ai/reference/agents/agent) for more information on available properties and configurations.
|
|
155
155
|
|
|
156
|
-
> **
|
|
156
|
+
> **Tip:** Use [Studio](https://mastra.ai/docs/studio/overview) to test your agent with different messages, inspect tool calls and responses, and debug agent behavior.
|
|
157
157
|
|
|
158
158
|
## Use your agent
|
|
159
159
|
|
|
@@ -205,7 +205,7 @@ Once your agent is running, use this table to find the right page for what you w
|
|
|
205
205
|
| Build agents that correct their work | [Rubric scorer](https://mastra.ai/docs/agents/supervisor-agents) |
|
|
206
206
|
| Swap instructions or models based on request context | [Dynamic configuration](https://mastra.ai/docs/server/request-context) |
|
|
207
207
|
| Add speech-to-text or text-to-speech | [Voice](https://mastra.ai/docs/voice/overview) |
|
|
208
|
-
| Connect to Slack, Discord, or Telegram | [Channels](https://mastra.ai/docs/
|
|
208
|
+
| Connect to Slack, Discord, or Telegram | [Channels](https://mastra.ai/docs/capabilities/channels/overview) |
|
|
209
209
|
|
|
210
210
|
## Multi-agent systems
|
|
211
211
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
Skills are reusable instructions that teach agents how to perform specific tasks. They follow the [Agent Skills specification](https://agentskills.io).
|
|
6
6
|
|
|
7
|
-
You can attach skills directly to an agent
|
|
7
|
+
You can attach skills directly to an agent through its `skills` config, or configure them on a [workspace](https://mastra.ai/docs/workspace/overview). Attach them to the agent when the skills belong to that specific agent and you want to define them in code with no workspace required; use a workspace when you want skills discovered from the filesystem and shared across every agent that uses it. This page covers the agent-level approach — defining skills in code, loading them from files, and resolving them per request.
|
|
8
8
|
|
|
9
9
|
## When to use agent-level skills
|
|
10
10
|
|
|
@@ -69,9 +69,7 @@ export const releaseChecklist = createSkill({
|
|
|
69
69
|
})
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
The `references` field bundles supporting documents that the agent can read with the `skill_read` tool,
|
|
73
|
-
|
|
74
|
-
> **Note:** Visit [`createSkill()` reference](https://mastra.ai/reference/agents/createSkill) for the full API.
|
|
72
|
+
The `references` field bundles supporting documents that the agent can read with the `skill_read` tool, like `references/` files in a filesystem skill. Visit [`createSkill()` reference](https://mastra.ai/reference/agents/createSkill) for the full API.
|
|
75
73
|
|
|
76
74
|
## Filesystem path skills
|
|
77
75
|
|
|
@@ -179,7 +177,7 @@ for (const meta of allSkills) {
|
|
|
179
177
|
}
|
|
180
178
|
```
|
|
181
179
|
|
|
182
|
-
|
|
180
|
+
Visit [`.getSkill()` reference](https://mastra.ai/reference/agents/getSkill) and [`.listSkills()` reference](https://mastra.ai/reference/agents/listSkills) for the full API.
|
|
183
181
|
|
|
184
182
|
## Related
|
|
185
183
|
|
|
@@ -103,7 +103,7 @@ const response = await testAgent.generate('Help me plan my day.', {
|
|
|
103
103
|
console.log(response.object)
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
-
|
|
106
|
+
Visit [`.generate()`](https://mastra.ai/reference/agents/generate) for a full list of configuration options.
|
|
107
107
|
|
|
108
108
|
**Example output:** The `response.object` will contain the structured data as defined by the schema.
|
|
109
109
|
|
|
@@ -226,9 +226,7 @@ How it works:
|
|
|
226
226
|
2. **Scoped memory saves**: Only the delegation prompt and the subagent's response are saved to the subagent's memory
|
|
227
227
|
3. **Fresh thread per invocation**: Each delegation uses a unique thread ID, ensuring clean separation
|
|
228
228
|
|
|
229
|
-
This ensures subagents have the context they need without cluttering their memory with the entire supervisor conversation.
|
|
230
|
-
|
|
231
|
-
> **Note:** Visit [memory in multi-agent systems](https://mastra.ai/docs/memory/overview) for more details.
|
|
229
|
+
This ensures subagents have the context they need without cluttering their memory with the entire supervisor conversation. Visit [memory in multi-agent systems](https://mastra.ai/docs/memory/overview) for more details.
|
|
232
230
|
|
|
233
231
|
## Tool approval propagation
|
|
234
232
|
|
|
@@ -428,4 +426,5 @@ Version overrides propagate automatically through delegation. See [Subagent vers
|
|
|
428
426
|
- [Agent.generate() reference](https://mastra.ai/reference/agents/generate)
|
|
429
427
|
- [Agent approval](https://mastra.ai/docs/agents/agent-approval)
|
|
430
428
|
- [Memory in multi-agent systems](https://mastra.ai/docs/memory/overview)
|
|
431
|
-
- [Concept: Multi-agent systems](https://mastra.ai/guides/concepts/multi-agent-systems)
|
|
429
|
+
- [Concept: Multi-agent systems](https://mastra.ai/guides/concepts/multi-agent-systems)
|
|
430
|
+
- 📹 [Mastra supervisor agents workshop](https://www.youtube.com/watch?v=FNb2fL9WhQg\&t=1872s)
|
|
@@ -38,9 +38,7 @@ export const weatherTool = createTool({
|
|
|
38
38
|
})
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
When creating tools, keep descriptions concise and focused on what the tool does, emphasizing its primary use case. Descriptive schema names can also help guide the agent on how to use the tool.
|
|
42
|
-
|
|
43
|
-
> **Note:** Visit the [`createTool`](https://mastra.ai/reference/tools/create-tool) reference for more information on available properties, configurations, and examples.
|
|
41
|
+
When creating tools, keep descriptions concise and focused on what the tool does, emphasizing its primary use case. Descriptive schema names can also help guide the agent on how to use the tool. Visit the [`createTool`](https://mastra.ai/reference/tools/create-tool) reference for more information on available properties, configurations, and examples.
|
|
44
42
|
|
|
45
43
|
To make a tool available to an agent, add it to the `tools` property on the `Agent` class. Mentioning available tools and their general purpose in the agent's system prompt helps the agent decide when to call a tool and when not to.
|
|
46
44
|
|
|
@@ -359,7 +357,7 @@ await agent.generate('Check the forecast', {
|
|
|
359
357
|
})
|
|
360
358
|
```
|
|
361
359
|
|
|
362
|
-
|
|
360
|
+
See the [`Agent.generate()` reference](https://mastra.ai/reference/agents/generate) for all runtime options including `toolsets`, `clientTools`, and `prepareStep`.
|
|
363
361
|
|
|
364
362
|
## Control `toolName` in stream responses
|
|
365
363
|
|
|
@@ -99,9 +99,7 @@ const browser = new AgentBrowser({
|
|
|
99
99
|
})
|
|
100
100
|
```
|
|
101
101
|
|
|
102
|
-
This adds `browser_record` and `browser_record_caption` to the agent's toolset. See [Browser recording (alpha)](https://mastra.ai/docs/browser/recording) for details.
|
|
103
|
-
|
|
104
|
-
> **Note:** See [AgentBrowser reference](https://mastra.ai/reference/browser/agent-browser) for all configuration options and tool details.
|
|
102
|
+
This adds `browser_record` and `browser_record_caption` to the agent's toolset. See [Browser recording (alpha)](https://mastra.ai/docs/browser/recording) for details. See [AgentBrowser reference](https://mastra.ai/reference/browser/agent-browser) for all configuration options and tool details.
|
|
105
103
|
|
|
106
104
|
## Related
|
|
107
105
|
|
|
@@ -140,9 +140,7 @@ npm install -g browse
|
|
|
140
140
|
browse skills install
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
CDP flag: `--ws`
|
|
144
|
-
|
|
145
|
-
> **Note:** See [BrowserViewer reference](https://mastra.ai/reference/browser/browser-viewer) for all configuration options, advanced connection modes, and method details.
|
|
143
|
+
CDP flag: `--ws` See [BrowserViewer reference](https://mastra.ai/reference/browser/browser-viewer) for all configuration options, advanced connection modes, and method details.
|
|
146
144
|
|
|
147
145
|
## Related
|
|
148
146
|
|
|
@@ -169,4 +169,5 @@ const browser = new AgentBrowser({
|
|
|
169
169
|
- [Stagehand](https://mastra.ai/docs/browser/stagehand)
|
|
170
170
|
- [Browser recording (alpha)](https://mastra.ai/docs/browser/recording)
|
|
171
171
|
- [BrowserViewer](https://mastra.ai/docs/browser/browser-viewer)
|
|
172
|
-
- [MastraBrowser reference](https://mastra.ai/reference/browser/mastra-browser)
|
|
172
|
+
- [MastraBrowser reference](https://mastra.ai/reference/browser/mastra-browser)
|
|
173
|
+
- 📹 [Mastra browser capabilities workshop](https://www.youtube.com/watch?v=E9KFsZEnQO8\&t=5s)
|
|
@@ -101,7 +101,7 @@ When the user asks for a recording:
|
|
|
101
101
|
|
|
102
102
|
## Output format and limits
|
|
103
103
|
|
|
104
|
-
Recordings are saved as Motion-JPEG AVI files. This format is encoded in JavaScript and
|
|
104
|
+
Recordings are saved as Motion-JPEG AVI files. This format is encoded in JavaScript and doesn't require `ffmpeg` or native dependencies.
|
|
105
105
|
|
|
106
106
|
Default limits:
|
|
107
107
|
|
|
@@ -146,7 +146,7 @@ const browser = new StagehandBrowser({
|
|
|
146
146
|
})
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
|
|
149
|
+
See [StagehandBrowser reference](https://mastra.ai/reference/browser/stagehand-browser) for all configuration options.
|
|
150
150
|
|
|
151
151
|
## Recording
|
|
152
152
|
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
3
|
+
# Discord
|
|
4
|
+
|
|
5
|
+
Discord channels let a Mastra agent receive Discord interactions and bot messages. Mastra handles the agent wiring and webhook route; the Chat SDK Discord adapter docs cover Discord application setup, bot permissions, and Gateway behavior.
|
|
6
|
+
|
|
7
|
+
## Install the adapter
|
|
8
|
+
|
|
9
|
+
Install the Discord adapter from the Chat SDK:
|
|
10
|
+
|
|
11
|
+
**npm**:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @chat-adapter/discord
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**pnpm**:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
pnpm add @chat-adapter/discord
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Yarn**:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
yarn add @chat-adapter/discord
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Bun**:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
bun add @chat-adapter/discord
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Agent configuration
|
|
36
|
+
|
|
37
|
+
Add `createDiscordAdapter()` to the agent's `channels.adapters` object:
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
import { Agent } from '@mastra/core/agent'
|
|
41
|
+
import { createDiscordAdapter } from '@chat-adapter/discord'
|
|
42
|
+
|
|
43
|
+
export const discordAgent = new Agent({
|
|
44
|
+
id: 'discord-agent',
|
|
45
|
+
name: 'Discord Agent',
|
|
46
|
+
instructions: 'Answer questions and help with tasks in Discord.',
|
|
47
|
+
model: 'openai/gpt-5.5',
|
|
48
|
+
channels: {
|
|
49
|
+
adapters: {
|
|
50
|
+
discord: createDiscordAdapter(),
|
|
51
|
+
},
|
|
52
|
+
},
|
|
53
|
+
})
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
Register the agent on the Mastra instance:
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { Mastra } from '@mastra/core'
|
|
60
|
+
import { discordAgent } from './agents/discord-agent'
|
|
61
|
+
|
|
62
|
+
export const mastra = new Mastra({
|
|
63
|
+
agents: { discordAgent },
|
|
64
|
+
})
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Adapter setup
|
|
68
|
+
|
|
69
|
+
Follow the [Chat SDK Discord adapter docs](https://chat-sdk.dev/adapters/official/discord) for Discord-specific setup, including application creation, bot tokens, interaction endpoints, permissions, and Gateway behavior.
|
|
70
|
+
|
|
71
|
+
The adapter reads Discord credentials from environment variables such as:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
DISCORD_BOT_TOKEN=your-discord-bot-token
|
|
75
|
+
DISCORD_PUBLIC_KEY=your-discord-application-public-key
|
|
76
|
+
DISCORD_APPLICATION_ID=your-discord-application-id
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Webhook URL
|
|
80
|
+
|
|
81
|
+
Mastra generates the Discord webhook route from the agent ID and adapter key:
|
|
82
|
+
|
|
83
|
+
```text
|
|
84
|
+
/api/agents/discord-agent/channels/discord/webhook
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Use your public Mastra server URL as the base URL:
|
|
88
|
+
|
|
89
|
+
```text
|
|
90
|
+
https://your-app.example.com/api/agents/discord-agent/channels/discord/webhook
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Use this URL anywhere the Discord adapter docs ask for the interactions endpoint or webhook URL. Discord regular message events may require Gateway setup outside the generated webhook route; follow the Chat SDK adapter docs for that path.
|
|
94
|
+
|
|
95
|
+
## Related
|
|
96
|
+
|
|
97
|
+
- [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
|
|
98
|
+
- [More](https://mastra.ai/docs/capabilities/channels/other-adapters)
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
3
|
+
# More
|
|
4
|
+
|
|
5
|
+
Mastra channels use Chat SDK adapters, so the pages in this section are not the full list of supported platforms. Use any Chat SDK platform adapter that exports an adapter factory compatible with `channels.adapters`.
|
|
6
|
+
|
|
7
|
+
## Adapter catalog
|
|
8
|
+
|
|
9
|
+
The [Chat SDK adapter catalog](https://chat-sdk.dev/adapters) is the canonical source for available adapters. The list below is only a snapshot and may not always be up to date.
|
|
10
|
+
|
|
11
|
+
At the time of writing, Chat SDK lists adapters for:
|
|
12
|
+
|
|
13
|
+
- AgentPhone
|
|
14
|
+
- Baileys WhatsApp
|
|
15
|
+
- Discord
|
|
16
|
+
- Google Chat
|
|
17
|
+
- GitHub
|
|
18
|
+
- iMessage
|
|
19
|
+
- Kapso
|
|
20
|
+
- Lark / Feishu
|
|
21
|
+
- Linear
|
|
22
|
+
- Liveblocks
|
|
23
|
+
- Matrix
|
|
24
|
+
- Messenger
|
|
25
|
+
- Mattermost
|
|
26
|
+
- Novu
|
|
27
|
+
- Resend
|
|
28
|
+
- Sendblue
|
|
29
|
+
- Telegram
|
|
30
|
+
- Twilio
|
|
31
|
+
- Velt
|
|
32
|
+
- Web
|
|
33
|
+
- Webex
|
|
34
|
+
- WeChat
|
|
35
|
+
- WhatsApp Business Cloud
|
|
36
|
+
- X
|
|
37
|
+
- Zalo
|
|
38
|
+
- Zernio
|
|
39
|
+
|
|
40
|
+
Check the adapter's docs for its package name, credential variables, webhook requirements, and platform-specific behavior.
|
|
41
|
+
|
|
42
|
+
## Use the same Mastra wiring
|
|
43
|
+
|
|
44
|
+
The Mastra side of each Chat SDK adapter is similar: install the adapter package, add its adapter factory to `channels.adapters`, configure platform credentials, and point the platform webhook to the generated Mastra route.
|
|
45
|
+
|
|
46
|
+
Use one of the platform pages in this section as a reference for the Mastra wiring:
|
|
47
|
+
|
|
48
|
+
- [Slack](https://mastra.ai/docs/capabilities/channels/slack)
|
|
49
|
+
- [Microsoft Teams](https://mastra.ai/docs/capabilities/channels/teams)
|
|
50
|
+
- [Discord](https://mastra.ai/docs/capabilities/channels/discord)
|
|
51
|
+
- [Telegram](https://mastra.ai/docs/capabilities/channels/telegram)
|
|
52
|
+
- [WhatsApp](https://mastra.ai/docs/capabilities/channels/whatsapp)
|
|
53
|
+
|
|
54
|
+
## What to check in adapter docs
|
|
55
|
+
|
|
56
|
+
Before wiring a new adapter into Mastra, check the adapter docs for:
|
|
57
|
+
|
|
58
|
+
- Credential environment variables.
|
|
59
|
+
- Required platform permissions or scopes.
|
|
60
|
+
- Webhook verification behavior.
|
|
61
|
+
- Whether the platform needs separate routes for setup, events, or interactions.
|
|
62
|
+
- Whether regular messages require long-running listeners or polling.
|
|
63
|
+
- Attachment, card, and rich message support.
|
|
64
|
+
|
|
65
|
+
## Related
|
|
66
|
+
|
|
67
|
+
- [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
|
|
68
|
+
- [Channels reference](https://mastra.ai/reference/agents/channels)
|