@mastra/mcp-docs-server 1.2.4 → 1.2.5-alpha.3
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/deploying.md +1 -1
- package/.docs/docs/agent-controller/overview.md +1 -1
- package/.docs/docs/agent-controller/session.md +1 -1
- package/.docs/docs/agents/overview.md +1 -1
- package/.docs/docs/agents/processors.md +1 -1
- package/.docs/docs/agents/supervisor-agents.md +3 -3
- package/.docs/docs/agents/using-tools.md +1 -1
- package/.docs/docs/{agents → long-running-agents}/background-tasks.md +2 -2
- package/.docs/docs/{agents → long-running-agents}/durable-agents.md +2 -2
- package/.docs/docs/{agents → long-running-agents}/goals.md +1 -1
- package/.docs/docs/{agents → long-running-agents}/heartbeats.md +5 -5
- package/.docs/docs/{agents → long-running-agents}/signal-providers.md +4 -4
- package/.docs/docs/memory/working-memory.md +1 -1
- package/.docs/docs/observability/config.md +1 -2
- package/.docs/docs/server/pubsub.md +2 -2
- package/.docs/docs/voice/overview.md +3 -3
- package/.docs/docs/voice/speech-to-speech.md +81 -1
- package/.docs/docs/voice/speech-to-text.md +19 -1
- package/.docs/docs/voice/text-to-speech.md +21 -1
- package/.docs/docs/workflows/control-flow.md +1 -1
- package/.docs/docs/workflows/error-handling.md +1 -1
- package/.docs/docs/workflows/human-in-the-loop.md +1 -1
- package/.docs/docs/workflows/overview.md +1 -1
- package/.docs/docs/workflows/snapshots.md +1 -1
- package/.docs/docs/workflows/suspend-and-resume.md +1 -1
- package/.docs/docs/workflows/time-travel.md +1 -1
- package/.docs/docs/workflows/workflow-state.md +1 -1
- package/.docs/guides/build-your-ui/copilotkit/channels.md +76 -0
- package/.docs/guides/build-your-ui/copilotkit/generative-ui.md +174 -0
- package/.docs/guides/build-your-ui/copilotkit/overview.md +411 -0
- package/.docs/guides/concepts/streaming.md +1 -1
- package/.docs/guides/deployment/vercel.md +1 -2
- package/.docs/guides/guide/signal-provider.md +5 -5
- package/.docs/models/environment-variables.md +2 -0
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/alibaba-cn.md +2 -1
- package/.docs/models/providers/friendli.md +1 -2
- package/.docs/models/providers/kenari.md +95 -0
- package/.docs/models/providers/nvidia.md +2 -3
- package/.docs/models/providers/tencent-token-plan.md +7 -7
- package/.docs/models/providers/tencent-tokenhub.md +5 -4
- package/.docs/models/providers.md +2 -0
- package/.docs/reference/acp/acp-agent.md +5 -5
- package/.docs/reference/acp/create-acp-tool.md +5 -5
- package/.docs/reference/agent-controller/agent-controller-class.md +27 -27
- package/.docs/reference/agents/agent.md +34 -34
- package/.docs/reference/agents/channels.md +19 -19
- package/.docs/reference/agents/createSkill.md +2 -2
- package/.docs/reference/agents/durable-agent.md +22 -22
- package/.docs/reference/agents/generate.md +10 -10
- package/.docs/reference/agents/generateLegacy.md +12 -12
- package/.docs/reference/agents/getMetadata.md +1 -1
- package/.docs/reference/agents/getVoice.md +1 -1
- package/.docs/reference/agents/inngest-agent.md +9 -9
- package/.docs/reference/agents/network.md +1 -1
- package/.docs/reference/ai-sdk/chat-route.md +4 -4
- package/.docs/reference/ai-sdk/handle-chat-stream.md +6 -6
- package/.docs/reference/ai-sdk/handle-network-stream.md +3 -3
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +1 -1
- package/.docs/reference/ai-sdk/network-route.md +4 -4
- package/.docs/reference/ai-sdk/to-ai-sdk-messages.md +1 -1
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +1 -1
- package/.docs/reference/ai-sdk/with-mastra.md +2 -2
- package/.docs/reference/ai-sdk/workflow-route.md +2 -2
- package/.docs/reference/ai-sdk/workflow-snapshot-to-stream.md +1 -1
- package/.docs/reference/auth/google.md +10 -10
- package/.docs/reference/auth/okta.md +11 -11
- package/.docs/reference/auth/workos.md +3 -3
- package/.docs/reference/channels/slack-provider.md +15 -15
- package/.docs/reference/cli/mastra.md +145 -0
- package/.docs/reference/client-js/agents.md +9 -9
- package/.docs/reference/client-js/mastra-client.md +5 -5
- package/.docs/reference/client-js/responses.md +3 -3
- package/.docs/reference/configuration.md +1 -1
- package/.docs/reference/core/getAgentById.md +3 -3
- package/.docs/reference/core/getWorkflow.md +1 -1
- package/.docs/reference/core/listWorkflows.md +1 -1
- package/.docs/reference/core/mastra-class.md +3 -3
- package/.docs/reference/core/removeWorkspace.md +2 -2
- package/.docs/reference/datasets/compareExperiments.md +1 -1
- package/.docs/reference/datasets/getItemHistory.md +1 -1
- package/.docs/reference/datasets/list.md +5 -5
- package/.docs/reference/datasets/listExperimentResults.md +4 -4
- package/.docs/reference/datasets/listExperiments.md +4 -4
- package/.docs/reference/datasets/listItems.md +5 -5
- package/.docs/reference/datasets/listVersions.md +3 -3
- package/.docs/reference/datasets/startExperiment.md +8 -8
- package/.docs/reference/datasets/startExperimentAsync.md +1 -1
- package/.docs/reference/editor/agent-builder/agent-builder-options.md +4 -4
- package/.docs/reference/editor/agent-builder/builder-agent-defaults.md +7 -7
- package/.docs/reference/editor/agent-builder/builder-models.md +4 -4
- package/.docs/reference/editor/blob-store-provider.md +2 -2
- package/.docs/reference/editor/browser-provider.md +2 -2
- package/.docs/reference/editor/filesystem-provider.md +2 -2
- package/.docs/reference/editor/mastra-editor.md +2 -2
- package/.docs/reference/editor/processor-provider.md +4 -4
- package/.docs/reference/editor/sandbox-provider.md +2 -2
- package/.docs/reference/editor/storage-browser-ref.md +2 -2
- package/.docs/reference/editor/storage-workspace-ref.md +7 -7
- package/.docs/reference/evals/create-scorer.md +8 -8
- package/.docs/reference/evals/rubric.md +1 -1
- package/.docs/reference/evals/run-evals.md +7 -7
- package/.docs/reference/evals/trajectory-accuracy.md +1 -1
- package/.docs/reference/index.md +2 -2
- package/.docs/reference/logging/pino-logger.md +4 -4
- package/.docs/reference/memory/cloneThread.md +35 -4
- package/.docs/reference/memory/memory-class.md +5 -5
- package/.docs/reference/memory/observational-memory.md +43 -43
- package/.docs/reference/memory/recall.md +4 -4
- package/.docs/reference/memory/serialized-memory-config.md +6 -6
- package/.docs/reference/observability/tracing/configuration.md +4 -4
- package/.docs/reference/processors/language-detector.md +1 -1
- package/.docs/reference/processors/moderation-processor.md +1 -1
- package/.docs/reference/processors/pii-detector.md +1 -1
- package/.docs/reference/processors/processor-interface.md +20 -20
- package/.docs/reference/processors/prompt-injection-detector.md +1 -1
- package/.docs/reference/processors/response-cache.md +6 -6
- package/.docs/reference/processors/unicode-normalizer.md +1 -1
- package/.docs/reference/pubsub/base.md +7 -7
- package/.docs/reference/pubsub/caching-pubsub.md +1 -1
- package/.docs/reference/pubsub/event-emitter.md +2 -2
- package/.docs/reference/pubsub/google-cloud-pubsub.md +1 -1
- package/.docs/reference/pubsub/lease-provider.md +3 -3
- package/.docs/reference/pubsub/redis-streams.md +6 -6
- package/.docs/reference/pubsub/unix-socket-pubsub.md +1 -1
- package/.docs/reference/rag/chunk.md +2 -2
- package/.docs/reference/server/create-route.md +3 -3
- package/.docs/reference/server/express-adapter.md +4 -4
- package/.docs/reference/server/fastify-adapter.md +4 -4
- package/.docs/reference/server/hono-adapter.md +4 -4
- package/.docs/reference/server/koa-adapter.md +4 -4
- package/.docs/reference/server/mastra-server.md +1 -1
- package/.docs/reference/server/nestjs-adapter.md +3 -3
- package/.docs/reference/server/register-api-route.md +3 -3
- package/.docs/reference/signals/create-notification-inbox-tool.md +3 -3
- package/.docs/reference/signals/signal-provider.md +7 -7
- package/.docs/reference/signals/webhook-signal-provider.md +2 -2
- package/.docs/reference/storage/clickhouse.md +7 -7
- package/.docs/reference/storage/composite.md +2 -2
- package/.docs/reference/storage/duckdb.md +1 -1
- package/.docs/reference/storage/dynamodb.md +1 -1
- package/.docs/reference/storage/libsql.md +1 -1
- package/.docs/reference/storage/postgresql.md +2 -2
- package/.docs/reference/storage/redis.md +2 -2
- package/.docs/reference/storage/retention.md +5 -5
- package/.docs/reference/storage/spanner.md +6 -6
- package/.docs/reference/streaming/ChunkType.md +3 -3
- package/.docs/reference/streaming/agents/stream.md +14 -14
- package/.docs/reference/streaming/agents/streamLegacy.md +10 -10
- package/.docs/reference/streaming/agents/streamUntilIdle.md +1 -1
- package/.docs/reference/streaming/workflows/resumeStream.md +1 -1
- package/.docs/reference/templates/overview.md +1 -140
- package/.docs/reference/tools/brightdata.md +4 -4
- package/.docs/reference/tools/create-code-mode.md +5 -5
- package/.docs/reference/tools/create-tool.md +15 -15
- package/.docs/reference/tools/graph-rag-tool.md +1 -1
- package/.docs/reference/tools/mcp-client.md +2 -2
- package/.docs/reference/tools/mcp-server.md +12 -12
- package/.docs/reference/tools/perplexity.md +3 -3
- package/.docs/reference/tools/tavily.md +1 -1
- package/.docs/reference/tools/vector-query-tool.md +1 -1
- package/.docs/reference/vectors/chroma.md +1 -1
- package/.docs/reference/vectors/mongodb.md +1 -1
- package/.docs/reference/vectors/pg.md +1 -1
- package/.docs/reference/vectors/s3vectors.md +4 -4
- package/.docs/reference/voice/google-gemini-live.md +3 -3
- package/.docs/reference/voice/inworld-realtime.md +12 -12
- package/.docs/reference/voice/inworld.md +2 -2
- package/.docs/reference/voice/voice.on.md +1 -1
- package/.docs/reference/workflows/run-methods/resume.md +1 -1
- package/.docs/reference/workflows/run-methods/timeTravel.md +1 -1
- package/.docs/reference/workspace/agentcore-runtime-sandbox.md +4 -4
- package/.docs/reference/workspace/agentfs-filesystem.md +1 -1
- package/.docs/reference/workspace/apple-container-sandbox.md +5 -5
- package/.docs/reference/workspace/archil-filesystem.md +5 -5
- package/.docs/reference/workspace/blaxel-sandbox.md +1 -1
- package/.docs/reference/workspace/daytona-sandbox.md +1 -1
- package/.docs/reference/workspace/docker-sandbox.md +2 -2
- package/.docs/reference/workspace/e2b-sandbox.md +2 -2
- package/.docs/reference/workspace/files-sdk-filesystem.md +1 -1
- package/.docs/reference/workspace/filesystem.md +1 -1
- package/.docs/reference/workspace/local-filesystem.md +3 -3
- package/.docs/reference/workspace/local-sandbox.md +1 -1
- package/.docs/reference/workspace/mesa-filesystem.md +3 -3
- package/.docs/reference/workspace/modal-sandbox.md +1 -1
- package/.docs/reference/workspace/railway-sandbox.md +1 -1
- package/.docs/reference/workspace/s3-filesystem.md +4 -4
- package/.docs/reference/workspace/sandbox.md +1 -1
- package/.docs/reference/workspace/{vercel-microvm-sandbox.md → vercel-sandbox.md} +21 -15
- package/.docs/reference/workspace/{vercel.md → vercel-serverless.md} +21 -14
- package/.docs/reference/workspace/workspace-class.md +15 -15
- package/CHANGELOG.md +15 -0
- package/package.json +5 -5
- package/.docs/docs/agents/adding-voice.md +0 -383
- package/.docs/docs/community/contributing-templates.md +0 -5
- package/.docs/docs/community/discord.md +0 -11
- package/.docs/guides/build-your-ui/copilotkit.md +0 -291
- package/LICENSE.md +0 -30
- /package/.docs/docs/{community/licensing.md → license.md} +0 -0
- /package/.docs/docs/{agents → long-running-agents}/signals.md +0 -0
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Alibaba (China)
|
|
4
4
|
|
|
5
|
-
Access
|
|
5
|
+
Access 84 Alibaba (China) models through Mastra's model router. Authentication is handled automatically using the `DASHSCOPE_API_KEY` environment variable.
|
|
6
6
|
|
|
7
7
|
Learn more in the [Alibaba (China) documentation](https://www.alibabacloud.com/help/en/model-studio/models).
|
|
8
8
|
|
|
@@ -51,6 +51,7 @@ for await (const chunk of stream) {
|
|
|
51
51
|
| `alibaba-cn/deepseek-v4-pro` | 1.0M | | | | | | $0.43 | $0.87 |
|
|
52
52
|
| `alibaba-cn/glm-5` | 203K | | | | | | $0.86 | $3 |
|
|
53
53
|
| `alibaba-cn/glm-5.1` | 203K | | | | | | $0.87 | $3 |
|
|
54
|
+
| `alibaba-cn/glm-5.2` | 1.0M | | | | | | $1 | $4 |
|
|
54
55
|
| `alibaba-cn/kimi-k2-thinking` | 262K | | | | | | $0.57 | $2 |
|
|
55
56
|
| `alibaba-cn/kimi-k2.5` | 262K | | | | | | $0.57 | $2 |
|
|
56
57
|
| `alibaba-cn/kimi-k2.6` | 262K | | | | | | $0.93 | $4 |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Friendli
|
|
4
4
|
|
|
5
|
-
Access
|
|
5
|
+
Access 6 Friendli models through Mastra's model router. Authentication is handled automatically using the `FRIENDLI_TOKEN` environment variable.
|
|
6
6
|
|
|
7
7
|
Learn more in the [Friendli documentation](https://friendli.ai/docs/guides/serverless_endpoints/introduction).
|
|
8
8
|
|
|
@@ -40,7 +40,6 @@ for await (const chunk of stream) {
|
|
|
40
40
|
| `friendli/google/gemma-4-31B-it` | 262K | | | | | | $0.14 | $0.40 |
|
|
41
41
|
| `friendli/MiniMaxAI/MiniMax-M2.5` | 197K | | | | | | $0.30 | $1 |
|
|
42
42
|
| `friendli/Qwen/Qwen3-235B-A22B-Instruct-2507` | 262K | | | | | | $0.20 | $0.80 |
|
|
43
|
-
| `friendli/zai-org/GLM-5` | 203K | | | | | | $1 | $3 |
|
|
44
43
|
| `friendli/zai-org/GLM-5.1` | 203K | | | | | | $1 | $4 |
|
|
45
44
|
| `friendli/zai-org/GLM-5.2` | 1.0M | | | | | | $1 | $4 |
|
|
46
45
|
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
|
|
2
|
+
|
|
3
|
+
# Kenari
|
|
4
|
+
|
|
5
|
+
Access 23 Kenari models through Mastra's model router. Authentication is handled automatically using the `KENARI_API_KEY` environment variable.
|
|
6
|
+
|
|
7
|
+
Learn more in the [Kenari documentation](https://kenari.id/docs).
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
KENARI_API_KEY=your-api-key
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { Agent } from "@mastra/core/agent";
|
|
15
|
+
|
|
16
|
+
const agent = new Agent({
|
|
17
|
+
id: "my-agent",
|
|
18
|
+
name: "My Agent",
|
|
19
|
+
instructions: "You are a helpful assistant",
|
|
20
|
+
model: "kenari/claude-opus-4-7"
|
|
21
|
+
});
|
|
22
|
+
|
|
23
|
+
// Generate a response
|
|
24
|
+
const response = await agent.generate("Hello!");
|
|
25
|
+
|
|
26
|
+
// Stream a response
|
|
27
|
+
const stream = await agent.stream("Tell me a story");
|
|
28
|
+
for await (const chunk of stream) {
|
|
29
|
+
console.log(chunk);
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
> **Info:** Mastra uses the OpenAI-compatible `/chat/completions` endpoint. Some provider-specific features may not be available. Check the [Kenari documentation](https://kenari.id/docs) for details.
|
|
34
|
+
|
|
35
|
+
## Models
|
|
36
|
+
|
|
37
|
+
| Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
|
|
38
|
+
| ------------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
|
|
39
|
+
| `kenari/claude-opus-4-7` | 1.0M | | | | | | — | — |
|
|
40
|
+
| `kenari/claude-opus-4-8` | 1.0M | | | | | | — | — |
|
|
41
|
+
| `kenari/claude-sonnet-4-6` | 1.0M | | | | | | — | — |
|
|
42
|
+
| `kenari/deepseek-v4-flash` | 1.0M | | | | | | — | — |
|
|
43
|
+
| `kenari/deepseek-v4-flash:free` | 1.0M | | | | | | — | — |
|
|
44
|
+
| `kenari/deepseek-v4-pro` | 1.0M | | | | | | — | — |
|
|
45
|
+
| `kenari/deepseek-v4-pro:free` | 1.0M | | | | | | — | — |
|
|
46
|
+
| `kenari/gemma-4-31b-it` | 262K | | | | | | — | — |
|
|
47
|
+
| `kenari/glm-5-1` | 200K | | | | | | — | — |
|
|
48
|
+
| `kenari/glm-5-2` | 1.0M | | | | | | — | — |
|
|
49
|
+
| `kenari/gpt-5-4-mini` | 400K | | | | | | — | — |
|
|
50
|
+
| `kenari/gpt-5-5` | 1.1M | | | | | | — | — |
|
|
51
|
+
| `kenari/gpt-image-2` | 272K | | | | | | — | — |
|
|
52
|
+
| `kenari/gpt-oss-120b` | 131K | | | | | | — | — |
|
|
53
|
+
| `kenari/gpt-oss-20b` | 131K | | | | | | — | — |
|
|
54
|
+
| `kenari/grok-4-3` | 1.0M | | | | | | — | — |
|
|
55
|
+
| `kenari/grok-build-0-1` | 256K | | | | | | — | — |
|
|
56
|
+
| `kenari/kimi-k2-6` | 262K | | | | | | — | — |
|
|
57
|
+
| `kenari/kimi-k2-7-code` | 262K | | | | | | — | — |
|
|
58
|
+
| `kenari/mimo-v2-5` | 1.0M | | | | | | — | — |
|
|
59
|
+
| `kenari/mimo-v2-5-pro` | 1.0M | | | | | | — | — |
|
|
60
|
+
| `kenari/minimax-m3` | 512K | | | | | | — | — |
|
|
61
|
+
| `kenari/qwen3-7-plus` | 1.0M | | | | | | — | — |
|
|
62
|
+
|
|
63
|
+
## Advanced configuration
|
|
64
|
+
|
|
65
|
+
### Custom headers
|
|
66
|
+
|
|
67
|
+
```typescript
|
|
68
|
+
const agent = new Agent({
|
|
69
|
+
id: "custom-agent",
|
|
70
|
+
name: "custom-agent",
|
|
71
|
+
model: {
|
|
72
|
+
url: "https://kenari.id/v1",
|
|
73
|
+
id: "kenari/claude-opus-4-7",
|
|
74
|
+
apiKey: process.env.KENARI_API_KEY,
|
|
75
|
+
headers: {
|
|
76
|
+
"X-Custom-Header": "value"
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
});
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Dynamic model selection
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
const agent = new Agent({
|
|
86
|
+
id: "dynamic-agent",
|
|
87
|
+
name: "Dynamic Agent",
|
|
88
|
+
model: ({ requestContext }) => {
|
|
89
|
+
const useAdvanced = requestContext.task === "complex";
|
|
90
|
+
return useAdvanced
|
|
91
|
+
? "kenari/qwen3-7-plus"
|
|
92
|
+
: "kenari/claude-opus-4-7";
|
|
93
|
+
}
|
|
94
|
+
});
|
|
95
|
+
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Nvidia
|
|
4
4
|
|
|
5
|
-
Access
|
|
5
|
+
Access 83 Nvidia models through Mastra's model router. Authentication is handled automatically using the `NVIDIA_API_KEY` environment variable.
|
|
6
6
|
|
|
7
7
|
Learn more in the [Nvidia documentation](https://docs.api.nvidia.com/nim/).
|
|
8
8
|
|
|
@@ -119,7 +119,6 @@ for await (const chunk of stream) {
|
|
|
119
119
|
| `nvidia/stepfun-ai/step-3.5-flash` | 256K | | | | | | — | — |
|
|
120
120
|
| `nvidia/stepfun-ai/step-3.7-flash` | 256K | | | | | | — | — |
|
|
121
121
|
| `nvidia/upstage/solar-10_7b-instruct` | 128K | | | | | | — | — |
|
|
122
|
-
| `nvidia/z-ai/glm-5.1` | 131K | | | | | | — | — |
|
|
123
122
|
|
|
124
123
|
## Advanced configuration
|
|
125
124
|
|
|
@@ -149,7 +148,7 @@ const agent = new Agent({
|
|
|
149
148
|
model: ({ requestContext }) => {
|
|
150
149
|
const useAdvanced = requestContext.task === "complex";
|
|
151
150
|
return useAdvanced
|
|
152
|
-
? "nvidia/
|
|
151
|
+
? "nvidia/upstage/solar-10_7b-instruct"
|
|
153
152
|
: "nvidia/abacusai/dracarys-llama-3_1-70b-instruct";
|
|
154
153
|
}
|
|
155
154
|
});
|
|
@@ -17,7 +17,7 @@ const agent = new Agent({
|
|
|
17
17
|
id: "my-agent",
|
|
18
18
|
name: "My Agent",
|
|
19
19
|
instructions: "You are a helpful assistant",
|
|
20
|
-
model: "tencent-token-plan/hy3
|
|
20
|
+
model: "tencent-token-plan/hy3"
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
// Generate a response
|
|
@@ -34,9 +34,9 @@ for await (const chunk of stream) {
|
|
|
34
34
|
|
|
35
35
|
## Models
|
|
36
36
|
|
|
37
|
-
| Model
|
|
38
|
-
|
|
|
39
|
-
| `tencent-token-plan/hy3
|
|
37
|
+
| Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
|
|
38
|
+
| ------------------------ | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
|
|
39
|
+
| `tencent-token-plan/hy3` | 256K | | | | | | — | — |
|
|
40
40
|
|
|
41
41
|
## Advanced configuration
|
|
42
42
|
|
|
@@ -48,7 +48,7 @@ const agent = new Agent({
|
|
|
48
48
|
name: "custom-agent",
|
|
49
49
|
model: {
|
|
50
50
|
url: "https://api.lkeap.cloud.tencent.com/plan/v3",
|
|
51
|
-
id: "tencent-token-plan/hy3
|
|
51
|
+
id: "tencent-token-plan/hy3",
|
|
52
52
|
apiKey: process.env.TENCENT_TOKEN_PLAN_API_KEY,
|
|
53
53
|
headers: {
|
|
54
54
|
"X-Custom-Header": "value"
|
|
@@ -66,8 +66,8 @@ const agent = new Agent({
|
|
|
66
66
|
model: ({ requestContext }) => {
|
|
67
67
|
const useAdvanced = requestContext.task === "complex";
|
|
68
68
|
return useAdvanced
|
|
69
|
-
? "tencent-token-plan/hy3
|
|
70
|
-
: "tencent-token-plan/hy3
|
|
69
|
+
? "tencent-token-plan/hy3"
|
|
70
|
+
: "tencent-token-plan/hy3";
|
|
71
71
|
}
|
|
72
72
|
});
|
|
73
73
|
```
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# Tencent TokenHub
|
|
4
4
|
|
|
5
|
-
Access
|
|
5
|
+
Access 2 Tencent TokenHub models through Mastra's model router. Authentication is handled automatically using the `TENCENT_TOKENHUB_API_KEY` environment variable.
|
|
6
6
|
|
|
7
7
|
Learn more in the [Tencent TokenHub documentation](https://cloud.tencent.com/document/product/1823/130050).
|
|
8
8
|
|
|
@@ -17,7 +17,7 @@ const agent = new Agent({
|
|
|
17
17
|
id: "my-agent",
|
|
18
18
|
name: "My Agent",
|
|
19
19
|
instructions: "You are a helpful assistant",
|
|
20
|
-
model: "tencent-tokenhub/hy3
|
|
20
|
+
model: "tencent-tokenhub/hy3"
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
// Generate a response
|
|
@@ -36,6 +36,7 @@ for await (const chunk of stream) {
|
|
|
36
36
|
|
|
37
37
|
| Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
|
|
38
38
|
| ------------------------------ | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
|
|
39
|
+
| `tencent-tokenhub/hy3` | 256K | | | | | | — | — |
|
|
39
40
|
| `tencent-tokenhub/hy3-preview` | 256K | | | | | | — | — |
|
|
40
41
|
|
|
41
42
|
## Advanced configuration
|
|
@@ -48,7 +49,7 @@ const agent = new Agent({
|
|
|
48
49
|
name: "custom-agent",
|
|
49
50
|
model: {
|
|
50
51
|
url: "https://tokenhub.tencentmaas.com/v1",
|
|
51
|
-
id: "tencent-tokenhub/hy3
|
|
52
|
+
id: "tencent-tokenhub/hy3",
|
|
52
53
|
apiKey: process.env.TENCENT_TOKENHUB_API_KEY,
|
|
53
54
|
headers: {
|
|
54
55
|
"X-Custom-Header": "value"
|
|
@@ -67,7 +68,7 @@ const agent = new Agent({
|
|
|
67
68
|
const useAdvanced = requestContext.task === "complex";
|
|
68
69
|
return useAdvanced
|
|
69
70
|
? "tencent-tokenhub/hy3-preview"
|
|
70
|
-
: "tencent-tokenhub/hy3
|
|
71
|
+
: "tencent-tokenhub/hy3";
|
|
71
72
|
}
|
|
72
73
|
});
|
|
73
74
|
```
|
|
@@ -57,6 +57,7 @@ Direct access to individual AI model providers. Each provider offers unique mode
|
|
|
57
57
|
- [Inference](https://mastra.ai/models/providers/inference)
|
|
58
58
|
- [IO.NET](https://mastra.ai/models/providers/io-net)
|
|
59
59
|
- [Jiekou.AI](https://mastra.ai/models/providers/jiekou)
|
|
60
|
+
- [Kenari](https://mastra.ai/models/providers/kenari)
|
|
60
61
|
- [Kilo Gateway](https://mastra.ai/models/providers/kilo)
|
|
61
62
|
- [Kimi For Coding](https://mastra.ai/models/providers/kimi-for-coding)
|
|
62
63
|
- [KUAE Cloud Coding Plan](https://mastra.ai/models/providers/kuae-cloud-coding-plan)
|
|
@@ -113,6 +114,7 @@ Direct access to individual AI model providers. Each provider offers unique mode
|
|
|
113
114
|
- [submodel](https://mastra.ai/models/providers/submodel)
|
|
114
115
|
- [Synthetic](https://mastra.ai/models/providers/synthetic)
|
|
115
116
|
- [Tencent Coding Plan (China)](https://mastra.ai/models/providers/tencent-coding-plan)
|
|
117
|
+
- [Tencent Token Plan](https://mastra.ai/models/providers/tencent-token-plan)
|
|
116
118
|
- [Tencent TokenHub](https://mastra.ai/models/providers/tencent-tokenhub)
|
|
117
119
|
- [The Grid AI](https://mastra.ai/models/providers/the-grid-ai)
|
|
118
120
|
- [Tinfoil](https://mastra.ai/models/providers/tinfoil)
|
|
@@ -54,7 +54,7 @@ export const claudeCodeAgent = new AcpAgent({
|
|
|
54
54
|
|
|
55
55
|
**id** (`string`): Unique identifier for the subagent.
|
|
56
56
|
|
|
57
|
-
**name** (`string`): Display name used during agent delegation. Defaults to
|
|
57
|
+
**name** (`string`): Display name used during agent delegation. Defaults to id.
|
|
58
58
|
|
|
59
59
|
**description** (`string`): Description shown to the model when it can delegate to this subagent.
|
|
60
60
|
|
|
@@ -66,19 +66,19 @@ export const claudeCodeAgent = new AcpAgent({
|
|
|
66
66
|
|
|
67
67
|
**cwd** (`string`): Working directory for the ACP process and ACP session. Also used as the default local filesystem base path. (Default: `process.cwd()`)
|
|
68
68
|
|
|
69
|
-
**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to
|
|
69
|
+
**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to cwd or process.cwd() and an empty MCP server list.
|
|
70
70
|
|
|
71
71
|
**initialize** (`Partial<InitializeRequest>`): ACP initialization options. Defaults to Mastra client information, the current ACP protocol version, and read/write filesystem capabilities.
|
|
72
72
|
|
|
73
73
|
**authMethodId** (`string`): ACP authentication method ID to invoke after initialization and before session creation.
|
|
74
74
|
|
|
75
|
-
**persistSession** (`boolean`): Whether to keep the ACP process and session alive after each prompt. Set to
|
|
75
|
+
**persistSession** (`boolean`): Whether to keep the ACP process and session alive after each prompt. Set to false to stop the process after each prompt completes. (Default: `true`)
|
|
76
76
|
|
|
77
77
|
**onPermissionRequest** (`(request: RequestPermissionRequest) => Promise<RequestPermissionResponse>`): Callback invoked when the ACP agent requests permission. Defaults to selecting the first permission option, or cancelling when no option is available.
|
|
78
78
|
|
|
79
|
-
**workspace** (`Workspace`): Workspace used for ACP file read and write requests. Defaults to a
|
|
79
|
+
**workspace** (`Workspace`): Workspace used for ACP file read and write requests. Defaults to a Workspace backed by LocalFilesystem at cwd or process.cwd().
|
|
80
80
|
|
|
81
|
-
**model** (`ModelId`): Model ID to select after ACP session creation using the ACP
|
|
81
|
+
**model** (`ModelId`): Model ID to select after ACP session creation using the ACP session/set\_model method.
|
|
82
82
|
|
|
83
83
|
## Properties
|
|
84
84
|
|
|
@@ -47,19 +47,19 @@ export const codeSupervisor = new Agent({
|
|
|
47
47
|
|
|
48
48
|
**cwd** (`string`): Working directory for the ACP process and ACP session. Also used as the default local filesystem base path. (Default: `process.cwd()`)
|
|
49
49
|
|
|
50
|
-
**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to
|
|
50
|
+
**session** (`Partial<NewSessionRequest>`): ACP session creation options. Defaults to cwd or process.cwd() and an empty MCP server list.
|
|
51
51
|
|
|
52
52
|
**initialize** (`Partial<InitializeRequest>`): ACP initialization options. Defaults to Mastra client information, the current ACP protocol version, and read/write filesystem capabilities.
|
|
53
53
|
|
|
54
54
|
**authMethodId** (`string`): ACP authentication method ID to invoke after initialization and before session creation.
|
|
55
55
|
|
|
56
|
-
**persistSession** (`boolean`): Whether the ACP connection created for a tool execution disconnects after the prompt. Set to
|
|
56
|
+
**persistSession** (`boolean`): Whether the ACP connection created for a tool execution disconnects after the prompt. Set to false to stop the process after each prompt completes. (Default: `true`)
|
|
57
57
|
|
|
58
58
|
**onPermissionRequest** (`(request: RequestPermissionRequest) => Promise<RequestPermissionResponse>`): Callback invoked when the ACP agent requests permission. Defaults to selecting the first permission option, or cancelling when no option is available.
|
|
59
59
|
|
|
60
|
-
**workspace** (`Workspace`): Workspace option from the shared ACP connection options. During tool execution,
|
|
60
|
+
**workspace** (`Workspace`): Workspace option from the shared ACP connection options. During tool execution, createACPTool() passes the current Mastra workspace from the execution context when one is available; otherwise the ACP connection falls back to a local filesystem workspace. Use AcpAgent when you need to provide an explicit workspace instance.
|
|
61
61
|
|
|
62
|
-
**model** (`ModelId`): Model ID to select after ACP session creation using the ACP
|
|
62
|
+
**model** (`ModelId`): Model ID to select after ACP session creation using the ACP session/set\_model method.
|
|
63
63
|
|
|
64
64
|
## Input schema
|
|
65
65
|
|
|
@@ -79,7 +79,7 @@ export const codeSupervisor = new Agent({
|
|
|
79
79
|
|
|
80
80
|
### Resume payload
|
|
81
81
|
|
|
82
|
-
**optionId** (`string`): Permission option ID to select when resuming with
|
|
82
|
+
**optionId** (`string`): Permission option ID to select when resuming with outcome: "selected".
|
|
83
83
|
|
|
84
84
|
**outcome** (`"selected" | "cancelled"`): Permission decision used to continue or cancel the ACP request.
|
|
85
85
|
|
|
@@ -52,7 +52,7 @@ await agentController.sendMessage({ content: 'Hello!' })
|
|
|
52
52
|
|
|
53
53
|
**id** (`string`): Unique identifier for this agentController instance.
|
|
54
54
|
|
|
55
|
-
**resourceId** (`string`): Resource ID for grouping threads (e.g., project identifier). Threads are scoped to this resource ID. Defaults to
|
|
55
|
+
**resourceId** (`string`): Resource ID for grouping threads (e.g., project identifier). Threads are scoped to this resource ID. Defaults to id.
|
|
56
56
|
|
|
57
57
|
**storage** (`MastraCompositeStore`): Storage backend for persistence (threads, messages, state).
|
|
58
58
|
|
|
@@ -62,35 +62,35 @@ await agentController.sendMessage({ content: 'Hello!' })
|
|
|
62
62
|
|
|
63
63
|
**memory** (`MastraMemory`): Memory configuration shared across all modes. Propagated to mode agents that don't have their own memory.
|
|
64
64
|
|
|
65
|
-
**modes** (`AgentControllerMode[]`): Available agent modes. At least one mode is required. When a top-level
|
|
65
|
+
**modes** (`AgentControllerMode[]`): Available agent modes. At least one mode is required. When a top-level agent is provided, each mode layers its own instructions and tool overrides on top of the shared agent.
|
|
66
66
|
|
|
67
|
-
**modes.id** (`string`): Unique identifier for this mode (e.g.,
|
|
67
|
+
**modes.id** (`string`): Unique identifier for this mode (e.g., "plan", "build").
|
|
68
68
|
|
|
69
69
|
**modes.name** (`string`): Human-readable name for display.
|
|
70
70
|
|
|
71
|
-
**modes.default** (`boolean`): Whether this is the default mode when the agentController starts. Deprecated in favor of
|
|
71
|
+
**modes.default** (`boolean`): Whether this is the default mode when the agentController starts. Deprecated in favor of metadata.default or the top-level defaultModeId.
|
|
72
72
|
|
|
73
|
-
**modes.defaultModelId** (`string`): Default model ID for this mode (e.g.,
|
|
73
|
+
**modes.defaultModelId** (`string`): Default model ID for this mode (e.g., "anthropic/claude-sonnet-4-20250514"). Used when no per-mode model has been explicitly selected.
|
|
74
74
|
|
|
75
75
|
**modes.description** (`string`): Description surfaced in mode pickers and Studio UI.
|
|
76
76
|
|
|
77
77
|
**modes.instructions** (`string`): Additional instructions layered above the backing agent's own instructions for this mode.
|
|
78
78
|
|
|
79
|
-
**modes.transitionsTo** (`string`): Target mode ID to switch to on
|
|
79
|
+
**modes.transitionsTo** (`string`): Target mode ID to switch to on submit\_plan approval. Must reference another mode's id.
|
|
80
80
|
|
|
81
|
-
**modes.metadata** (`Record<string, unknown>`): Arbitrary metadata.
|
|
81
|
+
**modes.metadata** (`Record<string, unknown>`): Arbitrary metadata. metadata.default === true marks the default mode when defaultModeId is unset.
|
|
82
82
|
|
|
83
|
-
**modes.tools** (`ToolsInput`): Replaces the backing agent's tools for this mode. Mutually exclusive with
|
|
83
|
+
**modes.tools** (`ToolsInput`): Replaces the backing agent's tools for this mode. Mutually exclusive with additionalTools.
|
|
84
84
|
|
|
85
|
-
**modes.additionalTools** (`ToolsInput`): Tools layered on top of the backing agent's tools. Mutually exclusive with
|
|
85
|
+
**modes.additionalTools** (`ToolsInput`): Tools layered on top of the backing agent's tools. Mutually exclusive with tools.
|
|
86
86
|
|
|
87
|
-
**modes.availableTools** (`string[]`): Per-mode tool visibility allowlist. When set, only tools whose final exposed names appear in this list are visible to the model and executable during this mode's runs.
|
|
87
|
+
**modes.availableTools** (`string[]`): Per-mode tool visibility allowlist. When set, only tools whose final exposed names appear in this list are visible to the model and executable during this mode's runs. undefined = all tools visible; \[] = no tools. Per-tool and per-category deny rules take precedence over this list. Workspace tools use the same list — reference them by exposed names (view, write\_file, etc.).
|
|
88
88
|
|
|
89
|
-
**modes.agent** (`Agent`): The agent for this mode. Deprecated in favor of the top-level
|
|
89
|
+
**modes.agent** (`Agent`): The agent for this mode. Deprecated in favor of the top-level agent config with mode-level overrides.
|
|
90
90
|
|
|
91
91
|
**agent** (`Agent`): Shared backing agent that each mode forks and decorates. When provided, modes layer instructions and tool overrides on top of this agent instead of providing their own.
|
|
92
92
|
|
|
93
|
-
**defaultModeId** (`string`): Default mode to enter when a thread has no persisted mode. Takes precedence over
|
|
93
|
+
**defaultModeId** (`string`): Default mode to enter when a thread has no persisted mode. Takes precedence over metadata.default on individual modes.
|
|
94
94
|
|
|
95
95
|
**instructions** (`string`): Base instructions shared across all modes. Appended to the backing agent's instructions.
|
|
96
96
|
|
|
@@ -100,9 +100,9 @@ await agentController.sendMessage({ content: 'Hello!' })
|
|
|
100
100
|
|
|
101
101
|
**browser** (`MastraBrowser | ((ctx) => MastraBrowser)`): Browser automation instance or a dynamic factory function. When omitted, each session created via createSession can provide its own browser.
|
|
102
102
|
|
|
103
|
-
**subagents** (`AgentControllerSubagent[]`): Subagent definitions. When provided, the agentController creates a built-in
|
|
103
|
+
**subagents** (`AgentControllerSubagent[]`): Subagent definitions. When provided, the agentController creates a built-in subagent tool that parent agents can call to spawn focused subagents.
|
|
104
104
|
|
|
105
|
-
**subagents.id** (`string`): Unique identifier for this subagent type (e.g.,
|
|
105
|
+
**subagents.id** (`string`): Unique identifier for this subagent type (e.g., "explore", "execute").
|
|
106
106
|
|
|
107
107
|
**subagents.name** (`string`): Human-readable name shown in tool output.
|
|
108
108
|
|
|
@@ -112,43 +112,43 @@ await agentController.sendMessage({ content: 'Hello!' })
|
|
|
112
112
|
|
|
113
113
|
**subagents.tools** (`ToolsInput`): Tools this subagent has direct access to.
|
|
114
114
|
|
|
115
|
-
**subagents.allowedAgentControllerTools** (`string[]`): Tool IDs from the agentController's shared
|
|
115
|
+
**subagents.allowedAgentControllerTools** (`string[]`): Tool IDs from the agentController's shared tools config. Merged with tools above to let subagents use a subset of agentController tools.
|
|
116
116
|
|
|
117
117
|
**subagents.allowedWorkspaceTools** (`string[]`): Workspace tool names the subagent is allowed to use. Uses the exposed names (after any renames via workspace tool config). When set, workspace tools not in this list are hidden from the model. Non-workspace tools are never affected. When omitted, all workspace tools are visible.
|
|
118
118
|
|
|
119
119
|
**subagents.defaultModelId** (`string`): Default model ID for this subagent type.
|
|
120
120
|
|
|
121
|
-
**subagents.maxSteps** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to
|
|
121
|
+
**subagents.maxSteps** (`number`): Optional maximum number of steps for the spawned subagent. Defaults to 50 when omitted.
|
|
122
122
|
|
|
123
123
|
**subagents.stopWhen** (`LoopOptions['stopWhen']`): Optional stop condition for the spawned subagent.
|
|
124
124
|
|
|
125
|
-
**subagents.forked** (`boolean`): When
|
|
125
|
+
**subagents.forked** (`boolean`): When true, calls to this subagent default to forked mode: the subagent runs on a clone of the parent thread, reusing the parent agent’s instructions, tools, and model so the prompt-cache prefix stays intact. Requires memory to be configured. The subagent definition’s own instructions, tools, allowedAgentControllerTools, allowedWorkspaceTools, defaultModelId, maxSteps, and stopWhen are ignored in forked mode. Callers can still override per-invocation via forked: false in the subagent tool input. See the Forked subagents section below for full semantics.
|
|
126
126
|
|
|
127
|
-
**resolveModel** (`(modelId: string) => MastraLanguageModel`): Converts a model ID string (e.g.,
|
|
127
|
+
**resolveModel** (`(modelId: string) => MastraLanguageModel`): Converts a model ID string (e.g., "anthropic/claude-sonnet-4") to a language model instance. Used by subagents and observational memory model resolution.
|
|
128
128
|
|
|
129
129
|
**omConfig** (`AgentControllerOMConfig`): Default configuration for observational memory (observer/reflector model IDs and thresholds).
|
|
130
130
|
|
|
131
|
-
**disableBuiltinTools** (`BuiltinToolId[]`): Built-in tool IDs to remove from the
|
|
131
|
+
**disableBuiltinTools** (`BuiltinToolId[]`): Built-in tool IDs to remove from the controllerBuiltIn toolset. Valid values are ask\_user, submit\_plan, task\_write, task\_update, task\_complete, task\_check, and subagent.
|
|
132
132
|
|
|
133
|
-
**intervalHandlers** (`IntervalHandler[]`): Periodic background tasks started during
|
|
133
|
+
**intervalHandlers** (`IntervalHandler[]`): Periodic background tasks started during init(). Use for gateway sync, cache refresh, and similar tasks.
|
|
134
134
|
|
|
135
135
|
**idGenerator** (`() => string`): Custom ID generator for AgentController-managed IDs such as threads and mode-run identifiers. (Default: `timestamp + random string`)
|
|
136
136
|
|
|
137
|
-
**modelAuthChecker** (`ModelAuthChecker`): Custom auth checker for model providers. Return
|
|
137
|
+
**modelAuthChecker** (`ModelAuthChecker`): Custom auth checker for model providers. Return true/false to override the default environment variable check, or undefined to fall back to defaults.
|
|
138
138
|
|
|
139
|
-
**modelUseCountProvider** (`ModelUseCountProvider`): Provides per-model use counts for sorting and display in
|
|
139
|
+
**modelUseCountProvider** (`ModelUseCountProvider`): Provides per-model use counts for sorting and display in listAvailableModels().
|
|
140
140
|
|
|
141
|
-
**modelUseCountTracker** (`ModelUseCountTracker`): Callback invoked when a model is selected via
|
|
141
|
+
**modelUseCountTracker** (`ModelUseCountTracker`): Callback invoked when a model is selected via session.model.switch(). Use to track and persist model usage for ranking.
|
|
142
142
|
|
|
143
|
-
**customModelCatalogProvider** (`CustomModelCatalogProvider`): Catalog hook for additional models (e.g., user-defined custom providers). Returned entries are merged into
|
|
143
|
+
**customModelCatalogProvider** (`CustomModelCatalogProvider`): Catalog hook for additional models (e.g., user-defined custom providers). Returned entries are merged into listAvailableModels().
|
|
144
144
|
|
|
145
|
-
**gateways** (`MastraModelGatewayInterface[]`): Model gateways registered on the internal Mastra instance. Apps that need gateway-backed model resolution should also provide
|
|
145
|
+
**gateways** (`MastraModelGatewayInterface[]`): Model gateways registered on the internal Mastra instance. Apps that need gateway-backed model resolution should also provide resolveModel.
|
|
146
146
|
|
|
147
|
-
**toolCategoryResolver** (`(toolName: string) => ToolCategory | null`): Maps tool names to permission categories (
|
|
147
|
+
**toolCategoryResolver** (`(toolName: string) => ToolCategory | null`): Maps tool names to permission categories ('read', 'edit', 'execute', 'mcp', 'other'). Used by the permission system to resolve category-level policies.
|
|
148
148
|
|
|
149
149
|
**pubsub** (`PubSub`): PubSub instance used by the internal Mastra instance and mode agents for event coordination.
|
|
150
150
|
|
|
151
|
-
**threadLock** (`{ acquire, release }`): Thread locking callbacks to prevent concurrent access from multiple processes.
|
|
151
|
+
**threadLock** (`{ acquire, release }`): Thread locking callbacks to prevent concurrent access from multiple processes. acquire should throw if the lock is held.
|
|
152
152
|
|
|
153
153
|
**observability** (`ObservabilityEntrypoint`): Observability entrypoint for tracing, scoring, and feedback. When provided, the internal Mastra instance produces trace spans for agent runs.
|
|
154
154
|
|