@mastra/mcp-docs-server 1.1.7 → 1.1.8
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/agents/agent-approval.md +61 -31
- package/.docs/docs/agents/supervisor-agents.md +1 -1
- package/.docs/docs/getting-started/manual-install.md +1 -1
- package/.docs/docs/index.md +68 -24
- package/.docs/docs/mastra-cloud/setup.md +1 -1
- package/.docs/docs/memory/observational-memory.md +9 -0
- package/.docs/docs/memory/semantic-recall.md +17 -1
- package/.docs/docs/workspace/skills.md +7 -5
- package/.docs/guides/deployment/aws-lambda.md +76 -165
- package/.docs/guides/deployment/azure-app-services.md +38 -61
- package/.docs/guides/deployment/cloudflare.md +1 -1
- package/.docs/guides/deployment/netlify.md +1 -1
- package/.docs/guides/deployment/vercel.md +1 -1
- package/.docs/models/gateways/netlify.md +5 -1
- package/.docs/models/index.md +1 -1
- package/.docs/models/providers/anthropic.md +9 -9
- package/.docs/models/providers/deepseek.md +1 -1
- package/.docs/models/providers/google.md +11 -11
- package/.docs/models/providers/openai.md +19 -19
- package/.docs/models/providers/opencode.md +33 -33
- package/.docs/models/providers/xai.md +3 -3
- package/.docs/reference/agents/agent.md +20 -20
- package/.docs/reference/agents/generate.md +200 -66
- package/.docs/reference/agents/generateLegacy.md +77 -35
- package/.docs/reference/agents/getDefaultGenerateOptions.md +4 -6
- package/.docs/reference/agents/getDefaultOptions.md +4 -6
- package/.docs/reference/agents/getDefaultStreamOptions.md +4 -6
- package/.docs/reference/agents/getDescription.md +1 -1
- package/.docs/reference/agents/getInstructions.md +4 -6
- package/.docs/reference/agents/getLLM.md +6 -8
- package/.docs/reference/agents/getMemory.md +4 -6
- package/.docs/reference/agents/getModel.md +4 -6
- package/.docs/reference/agents/getTools.md +5 -7
- package/.docs/reference/agents/getVoice.md +4 -6
- package/.docs/reference/agents/listAgents.md +4 -6
- package/.docs/reference/agents/listScorers.md +4 -6
- package/.docs/reference/agents/listTools.md +4 -6
- package/.docs/reference/agents/listWorkflows.md +4 -6
- package/.docs/reference/agents/network.md +69 -23
- package/.docs/reference/ai-sdk/chat-route.md +7 -7
- package/.docs/reference/ai-sdk/handle-chat-stream.md +12 -12
- package/.docs/reference/ai-sdk/handle-network-stream.md +4 -4
- package/.docs/reference/ai-sdk/handle-workflow-stream.md +11 -11
- package/.docs/reference/ai-sdk/network-route.md +3 -3
- package/.docs/reference/ai-sdk/to-ai-sdk-stream.md +9 -9
- package/.docs/reference/ai-sdk/to-ai-sdk-v4-messages.md +9 -9
- package/.docs/reference/ai-sdk/to-ai-sdk-v5-messages.md +5 -5
- package/.docs/reference/ai-sdk/with-mastra.md +12 -12
- package/.docs/reference/ai-sdk/workflow-route.md +3 -3
- package/.docs/reference/auth/auth0.md +6 -6
- package/.docs/reference/auth/better-auth.md +5 -5
- package/.docs/reference/auth/clerk.md +5 -5
- package/.docs/reference/auth/firebase.md +7 -7
- package/.docs/reference/auth/jwt.md +1 -1
- package/.docs/reference/auth/supabase.md +4 -4
- package/.docs/reference/auth/workos.md +6 -6
- package/.docs/reference/cli/create-mastra.md +14 -14
- package/.docs/reference/client-js/mastra-client.md +23 -23
- package/.docs/reference/client-js/workflows.md +3 -3
- package/.docs/reference/core/addGateway.md +2 -2
- package/.docs/reference/core/getAgent.md +2 -2
- package/.docs/reference/core/getAgentById.md +2 -2
- package/.docs/reference/core/getDeployer.md +1 -1
- package/.docs/reference/core/getGateway.md +2 -2
- package/.docs/reference/core/getGatewayById.md +2 -2
- package/.docs/reference/core/getLogger.md +1 -1
- package/.docs/reference/core/getMCPServer.md +2 -2
- package/.docs/reference/core/getMCPServerById.md +3 -3
- package/.docs/reference/core/getMemory.md +2 -2
- package/.docs/reference/core/getScorer.md +2 -2
- package/.docs/reference/core/getScorerById.md +2 -2
- package/.docs/reference/core/getServer.md +1 -1
- package/.docs/reference/core/getStorage.md +1 -1
- package/.docs/reference/core/getStoredAgentById.md +18 -20
- package/.docs/reference/core/getTelemetry.md +1 -1
- package/.docs/reference/core/getVector.md +2 -2
- package/.docs/reference/core/getWorkflow.md +3 -3
- package/.docs/reference/core/listAgents.md +1 -1
- package/.docs/reference/core/listGateways.md +1 -1
- package/.docs/reference/core/listLogs.md +9 -11
- package/.docs/reference/core/listLogsByRunId.md +9 -9
- package/.docs/reference/core/listMCPServers.md +1 -1
- package/.docs/reference/core/listMemory.md +1 -1
- package/.docs/reference/core/listScorers.md +1 -1
- package/.docs/reference/core/listStoredAgents.md +9 -11
- package/.docs/reference/core/listVectors.md +1 -1
- package/.docs/reference/core/listWorkflows.md +2 -2
- package/.docs/reference/core/mastra-class.md +17 -17
- package/.docs/reference/core/mastra-model-gateway.md +15 -15
- package/.docs/reference/core/setLogger.md +2 -4
- package/.docs/reference/core/setStorage.md +1 -1
- package/.docs/reference/datasets/addItem.md +20 -4
- package/.docs/reference/datasets/addItems.md +8 -2
- package/.docs/reference/datasets/compareExperiments.md +15 -3
- package/.docs/reference/datasets/create.md +6 -6
- package/.docs/reference/datasets/dataset.md +1 -1
- package/.docs/reference/datasets/delete.md +2 -2
- package/.docs/reference/datasets/deleteExperiment.md +2 -2
- package/.docs/reference/datasets/deleteItem.md +2 -2
- package/.docs/reference/datasets/deleteItems.md +2 -2
- package/.docs/reference/datasets/get.md +2 -2
- package/.docs/reference/datasets/getDetails.md +9 -9
- package/.docs/reference/datasets/getExperiment.md +2 -2
- package/.docs/reference/datasets/getItem.md +3 -3
- package/.docs/reference/datasets/getItemHistory.md +22 -2
- package/.docs/reference/datasets/list.md +7 -3
- package/.docs/reference/datasets/listExperimentResults.md +34 -4
- package/.docs/reference/datasets/listExperiments.md +41 -3
- package/.docs/reference/datasets/listItems.md +18 -6
- package/.docs/reference/datasets/listVersions.md +23 -3
- package/.docs/reference/datasets/startExperiment.md +62 -12
- package/.docs/reference/datasets/startExperimentAsync.md +5 -1
- package/.docs/reference/datasets/update.md +6 -6
- package/.docs/reference/datasets/updateItem.md +5 -5
- package/.docs/reference/deployer.md +8 -8
- package/.docs/reference/evals/answer-relevancy.md +11 -11
- package/.docs/reference/evals/answer-similarity.md +17 -19
- package/.docs/reference/evals/bias.md +10 -10
- package/.docs/reference/evals/completeness.md +3 -3
- package/.docs/reference/evals/content-similarity.md +6 -6
- package/.docs/reference/evals/context-precision.md +4 -4
- package/.docs/reference/evals/context-relevance.md +4 -4
- package/.docs/reference/evals/create-scorer.md +47 -49
- package/.docs/reference/evals/faithfulness.md +11 -11
- package/.docs/reference/evals/hallucination.md +17 -21
- package/.docs/reference/evals/keyword-coverage.md +4 -4
- package/.docs/reference/evals/mastra-scorer.md +14 -14
- package/.docs/reference/evals/noise-sensitivity.md +4 -4
- package/.docs/reference/evals/prompt-alignment.md +4 -4
- package/.docs/reference/evals/run-evals.md +16 -16
- package/.docs/reference/evals/scorer-utils.md +3 -3
- package/.docs/reference/evals/textual-difference.md +3 -3
- package/.docs/reference/evals/tone-consistency.md +3 -3
- package/.docs/reference/evals/tool-call-accuracy.md +5 -5
- package/.docs/reference/evals/toxicity.md +8 -8
- package/.docs/reference/harness/harness-class.md +34 -42
- package/.docs/reference/logging/pino-logger.md +5 -5
- package/.docs/reference/memory/clone-utilities.md +5 -5
- package/.docs/reference/memory/cloneThread.md +17 -21
- package/.docs/reference/memory/createThread.md +10 -10
- package/.docs/reference/memory/deleteMessages.md +2 -2
- package/.docs/reference/memory/getThreadById.md +2 -2
- package/.docs/reference/memory/listThreads.md +5 -5
- package/.docs/reference/memory/memory-class.md +12 -14
- package/.docs/reference/memory/observational-memory.md +102 -94
- package/.docs/reference/memory/recall.md +14 -16
- package/.docs/reference/observability/tracing/configuration.md +27 -10
- package/.docs/reference/observability/tracing/exporters/console-exporter.md +4 -7
- package/.docs/reference/processors/batch-parts-processor.md +8 -10
- package/.docs/reference/processors/language-detector.md +14 -16
- package/.docs/reference/processors/message-history-processor.md +7 -9
- package/.docs/reference/processors/moderation-processor.md +13 -15
- package/.docs/reference/processors/pii-detector.md +14 -16
- package/.docs/reference/processors/processor-interface.md +62 -62
- package/.docs/reference/processors/prompt-injection-detector.md +11 -13
- package/.docs/reference/processors/semantic-recall-processor.md +14 -16
- package/.docs/reference/processors/system-prompt-scrubber.md +12 -14
- package/.docs/reference/processors/token-limiter-processor.md +11 -13
- package/.docs/reference/processors/tool-call-filter.md +5 -7
- package/.docs/reference/processors/tool-search-processor.md +9 -11
- package/.docs/reference/processors/unicode-normalizer.md +8 -10
- package/.docs/reference/processors/working-memory-processor.md +14 -18
- package/.docs/reference/rag/chunk.md +38 -38
- package/.docs/reference/rag/database-config.md +11 -7
- package/.docs/reference/rag/document.md +2 -2
- package/.docs/reference/rag/embeddings.md +12 -12
- package/.docs/reference/rag/extract-params.md +23 -23
- package/.docs/reference/rag/graph-rag.md +12 -12
- package/.docs/reference/rag/rerank.md +25 -17
- package/.docs/reference/rag/rerankWithScorer.md +25 -17
- package/.docs/reference/server/create-route.md +14 -14
- package/.docs/reference/server/express-adapter.md +10 -10
- package/.docs/reference/server/fastify-adapter.md +10 -10
- package/.docs/reference/server/hono-adapter.md +10 -10
- package/.docs/reference/server/koa-adapter.md +10 -10
- package/.docs/reference/server/mastra-server.md +10 -10
- package/.docs/reference/server/register-api-route.md +13 -13
- package/.docs/reference/storage/cloudflare-d1.md +5 -5
- package/.docs/reference/storage/cloudflare.md +6 -6
- package/.docs/reference/storage/composite.md +9 -9
- package/.docs/reference/storage/convex.md +3 -3
- package/.docs/reference/storage/dynamodb.md +9 -9
- package/.docs/reference/storage/lance.md +3 -3
- package/.docs/reference/storage/libsql.md +2 -2
- package/.docs/reference/storage/mongodb.md +5 -5
- package/.docs/reference/storage/mssql.md +2 -2
- package/.docs/reference/storage/postgresql.md +25 -25
- package/.docs/reference/storage/upstash.md +3 -3
- package/.docs/reference/streaming/ChunkType.md +251 -59
- package/.docs/reference/streaming/agents/MastraModelOutput.md +86 -16
- package/.docs/reference/streaming/agents/stream.md +155 -43
- package/.docs/reference/streaming/agents/streamLegacy.md +79 -39
- package/.docs/reference/streaming/workflows/resumeStream.md +18 -8
- package/.docs/reference/streaming/workflows/stream.md +21 -9
- package/.docs/reference/streaming/workflows/timeTravelStream.md +4 -4
- package/.docs/reference/tools/create-tool.md +25 -21
- package/.docs/reference/tools/document-chunker-tool.md +7 -7
- package/.docs/reference/tools/graph-rag-tool.md +16 -18
- package/.docs/reference/tools/mcp-client.md +38 -27
- package/.docs/reference/tools/mcp-server.md +45 -45
- package/.docs/reference/tools/vector-query-tool.md +34 -22
- package/.docs/reference/vectors/astra.md +22 -22
- package/.docs/reference/vectors/chroma.md +44 -44
- package/.docs/reference/vectors/convex.md +26 -26
- package/.docs/reference/vectors/couchbase.md +30 -30
- package/.docs/reference/vectors/duckdb.md +29 -29
- package/.docs/reference/vectors/elasticsearch.md +27 -27
- package/.docs/reference/vectors/lance.md +46 -38
- package/.docs/reference/vectors/libsql.md +31 -31
- package/.docs/reference/vectors/mongodb.md +32 -32
- package/.docs/reference/vectors/opensearch.md +27 -27
- package/.docs/reference/vectors/pg.md +60 -44
- package/.docs/reference/vectors/pinecone.md +38 -38
- package/.docs/reference/vectors/qdrant.md +36 -36
- package/.docs/reference/vectors/s3vectors.md +24 -24
- package/.docs/reference/vectors/turbopuffer.md +29 -29
- package/.docs/reference/vectors/upstash.md +25 -25
- package/.docs/reference/vectors/vectorize.md +27 -27
- package/.docs/reference/voice/azure.md +19 -15
- package/.docs/reference/voice/cloudflare.md +10 -12
- package/.docs/reference/voice/composite-voice.md +10 -10
- package/.docs/reference/voice/deepgram.md +20 -14
- package/.docs/reference/voice/elevenlabs.md +20 -22
- package/.docs/reference/voice/google-gemini-live.md +42 -44
- package/.docs/reference/voice/google.md +25 -21
- package/.docs/reference/voice/mastra-voice.md +20 -20
- package/.docs/reference/voice/murf.md +24 -28
- package/.docs/reference/voice/openai-realtime.md +26 -26
- package/.docs/reference/voice/openai.md +14 -12
- package/.docs/reference/voice/playai.md +13 -15
- package/.docs/reference/voice/sarvam.md +21 -25
- package/.docs/reference/voice/speechify.md +11 -13
- package/.docs/reference/voice/voice.addInstructions.md +1 -1
- package/.docs/reference/voice/voice.addTools.md +1 -1
- package/.docs/reference/voice/voice.answer.md +1 -1
- package/.docs/reference/voice/voice.connect.md +3 -3
- package/.docs/reference/voice/voice.events.md +11 -11
- package/.docs/reference/voice/voice.getSpeakers.md +30 -30
- package/.docs/reference/voice/voice.listen.md +9 -9
- package/.docs/reference/voice/voice.off.md +2 -2
- package/.docs/reference/voice/voice.on.md +2 -2
- package/.docs/reference/voice/voice.send.md +1 -1
- package/.docs/reference/voice/voice.speak.md +11 -11
- package/.docs/reference/voice/voice.updateConfig.md +3 -3
- package/.docs/reference/workflows/run-methods/cancel.md +2 -2
- package/.docs/reference/workflows/run-methods/restart.md +17 -5
- package/.docs/reference/workflows/run-methods/resume.md +23 -9
- package/.docs/reference/workflows/run-methods/start.md +22 -8
- package/.docs/reference/workflows/run-methods/startAsync.md +12 -6
- package/.docs/reference/workflows/run-methods/timeTravel.md +29 -13
- package/.docs/reference/workflows/run.md +12 -12
- package/.docs/reference/workflows/step.md +24 -26
- package/.docs/reference/workflows/workflow-methods/branch.md +2 -2
- package/.docs/reference/workflows/workflow-methods/commit.md +1 -1
- package/.docs/reference/workflows/workflow-methods/create-run.md +4 -4
- package/.docs/reference/workflows/workflow-methods/dountil.md +3 -3
- package/.docs/reference/workflows/workflow-methods/dowhile.md +3 -3
- package/.docs/reference/workflows/workflow-methods/foreach.md +9 -9
- package/.docs/reference/workflows/workflow-methods/map.md +2 -2
- package/.docs/reference/workflows/workflow-methods/parallel.md +2 -2
- package/.docs/reference/workflows/workflow-methods/sleep.md +2 -2
- package/.docs/reference/workflows/workflow-methods/sleepUntil.md +2 -2
- package/.docs/reference/workflows/workflow-methods/then.md +2 -2
- package/.docs/reference/workflows/workflow.md +40 -50
- package/.docs/reference/workspace/daytona-sandbox.md +33 -33
- package/.docs/reference/workspace/e2b-sandbox.md +20 -20
- package/.docs/reference/workspace/filesystem.md +22 -22
- package/.docs/reference/workspace/gcs-filesystem.md +15 -15
- package/.docs/reference/workspace/local-filesystem.md +35 -35
- package/.docs/reference/workspace/local-sandbox.md +26 -26
- package/.docs/reference/workspace/s3-filesystem.md +18 -18
- package/.docs/reference/workspace/sandbox.md +8 -8
- package/.docs/reference/workspace/workspace-class.md +30 -34
- package/CHANGELOG.md +16 -0
- package/package.json +6 -6
- package/.docs/docs/getting-started/start.md +0 -28
|
@@ -124,43 +124,43 @@ const response = await agent.generate("Hello!", {
|
|
|
124
124
|
|
|
125
125
|
### Available Options
|
|
126
126
|
|
|
127
|
-
**conversation
|
|
127
|
+
**conversation** (`string | null | undefined`)
|
|
128
128
|
|
|
129
|
-
**include
|
|
129
|
+
**include** (`("file_search_call.results" | "message.output_text.logprobs" | "reasoning.encrypted_content")[] | null | undefined`)
|
|
130
130
|
|
|
131
|
-
**instructions
|
|
131
|
+
**instructions** (`string | null | undefined`)
|
|
132
132
|
|
|
133
|
-
**logprobs
|
|
133
|
+
**logprobs** (`number | boolean | undefined`)
|
|
134
134
|
|
|
135
|
-
**maxToolCalls
|
|
135
|
+
**maxToolCalls** (`number | null | undefined`)
|
|
136
136
|
|
|
137
|
-
**metadata
|
|
137
|
+
**metadata** (`any`)
|
|
138
138
|
|
|
139
|
-
**parallelToolCalls
|
|
139
|
+
**parallelToolCalls** (`boolean | null | undefined`)
|
|
140
140
|
|
|
141
|
-
**previousResponseId
|
|
141
|
+
**previousResponseId** (`string | null | undefined`)
|
|
142
142
|
|
|
143
|
-
**promptCacheKey
|
|
143
|
+
**promptCacheKey** (`string | null | undefined`)
|
|
144
144
|
|
|
145
|
-
**promptCacheRetention
|
|
145
|
+
**promptCacheRetention** (`"in_memory" | "24h" | null | undefined`)
|
|
146
146
|
|
|
147
|
-
**reasoningEffort
|
|
147
|
+
**reasoningEffort** (`string | null | undefined`)
|
|
148
148
|
|
|
149
|
-
**reasoningSummary
|
|
149
|
+
**reasoningSummary** (`string | null | undefined`)
|
|
150
150
|
|
|
151
|
-
**safetyIdentifier
|
|
151
|
+
**safetyIdentifier** (`string | null | undefined`)
|
|
152
152
|
|
|
153
|
-
**serviceTier
|
|
153
|
+
**serviceTier** (`"default" | "auto" | "flex" | "priority" | null | undefined`)
|
|
154
154
|
|
|
155
|
-
**store
|
|
155
|
+
**store** (`boolean | null | undefined`): Controls whether OpenAI stores your API requests for model training. Required to be "false" if your organization has zero data retention enabled. See: https\://platform.openai.com/docs/guides/your-data#zero-data-retention
|
|
156
156
|
|
|
157
|
-
**strictJsonSchema
|
|
157
|
+
**strictJsonSchema** (`boolean | null | undefined`)
|
|
158
158
|
|
|
159
|
-
**textVerbosity
|
|
159
|
+
**textVerbosity** (`"low" | "medium" | "high" | null | undefined`)
|
|
160
160
|
|
|
161
|
-
**truncation
|
|
161
|
+
**truncation** (`"auto" | "disabled" | null | undefined`)
|
|
162
162
|
|
|
163
|
-
**user
|
|
163
|
+
**user** (`string | null | undefined`)
|
|
164
164
|
|
|
165
165
|
## Direct Provider Installation
|
|
166
166
|
|
|
@@ -32,38 +32,38 @@ for await (const chunk of stream) {
|
|
|
32
32
|
|
|
33
33
|
## Models
|
|
34
34
|
|
|
35
|
-
| Model
|
|
36
|
-
|
|
|
37
|
-
| `opencode/big-pickle`
|
|
38
|
-
| `opencode/claude-3-5-haiku`
|
|
39
|
-
| `opencode/claude-haiku-4-5`
|
|
40
|
-
| `opencode/claude-opus-4-1`
|
|
41
|
-
| `opencode/claude-opus-4-5`
|
|
42
|
-
| `opencode/claude-opus-4-6`
|
|
43
|
-
| `opencode/claude-sonnet-4`
|
|
44
|
-
| `opencode/claude-sonnet-4-5`
|
|
45
|
-
| `opencode/claude-sonnet-4-6`
|
|
46
|
-
| `opencode/gemini-3-flash`
|
|
47
|
-
| `opencode/gemini-3-pro`
|
|
48
|
-
| `opencode/gemini-3.1-pro`
|
|
49
|
-
| `opencode/glm-4.6`
|
|
50
|
-
| `opencode/glm-4.7`
|
|
51
|
-
| `opencode/glm-5`
|
|
52
|
-
| `opencode/gpt-5`
|
|
53
|
-
| `opencode/gpt-5-codex`
|
|
54
|
-
| `opencode/gpt-5-nano`
|
|
55
|
-
| `opencode/gpt-5.1`
|
|
56
|
-
| `opencode/gpt-5.1-codex`
|
|
57
|
-
| `opencode/gpt-5.1-codex-max`
|
|
58
|
-
| `opencode/gpt-5.1-codex-mini`
|
|
59
|
-
| `opencode/gpt-5.2`
|
|
60
|
-
| `opencode/gpt-5.2-codex`
|
|
61
|
-
| `opencode/gpt-5.3-codex`
|
|
62
|
-
| `opencode/
|
|
63
|
-
| `opencode/
|
|
64
|
-
| `opencode/minimax-m2.
|
|
65
|
-
| `opencode/minimax-m2.5
|
|
66
|
-
| `opencode/
|
|
35
|
+
| Model | Context | Tools | Reasoning | Image | Audio | Video | Input $/1M | Output $/1M |
|
|
36
|
+
| ----------------------------- | ------- | ----- | --------- | ----- | ----- | ----- | ---------- | ----------- |
|
|
37
|
+
| `opencode/big-pickle` | 200K | | | | | | — | — |
|
|
38
|
+
| `opencode/claude-3-5-haiku` | 200K | | | | | | $0.80 | $4 |
|
|
39
|
+
| `opencode/claude-haiku-4-5` | 200K | | | | | | $1 | $5 |
|
|
40
|
+
| `opencode/claude-opus-4-1` | 200K | | | | | | $15 | $75 |
|
|
41
|
+
| `opencode/claude-opus-4-5` | 200K | | | | | | $5 | $25 |
|
|
42
|
+
| `opencode/claude-opus-4-6` | 1.0M | | | | | | $5 | $25 |
|
|
43
|
+
| `opencode/claude-sonnet-4` | 1.0M | | | | | | $3 | $15 |
|
|
44
|
+
| `opencode/claude-sonnet-4-5` | 1.0M | | | | | | $3 | $15 |
|
|
45
|
+
| `opencode/claude-sonnet-4-6` | 1.0M | | | | | | $3 | $15 |
|
|
46
|
+
| `opencode/gemini-3-flash` | 1.0M | | | | | | $0.50 | $3 |
|
|
47
|
+
| `opencode/gemini-3-pro` | 1.0M | | | | | | $2 | $12 |
|
|
48
|
+
| `opencode/gemini-3.1-pro` | 1.0M | | | | | | $2 | $12 |
|
|
49
|
+
| `opencode/glm-4.6` | 205K | | | | | | $0.60 | $2 |
|
|
50
|
+
| `opencode/glm-4.7` | 205K | | | | | | $0.60 | $2 |
|
|
51
|
+
| `opencode/glm-5` | 205K | | | | | | $1 | $3 |
|
|
52
|
+
| `opencode/gpt-5` | 400K | | | | | | $1 | $9 |
|
|
53
|
+
| `opencode/gpt-5-codex` | 400K | | | | | | $1 | $9 |
|
|
54
|
+
| `opencode/gpt-5-nano` | 400K | | | | | | — | — |
|
|
55
|
+
| `opencode/gpt-5.1` | 400K | | | | | | $1 | $9 |
|
|
56
|
+
| `opencode/gpt-5.1-codex` | 400K | | | | | | $1 | $9 |
|
|
57
|
+
| `opencode/gpt-5.1-codex-max` | 400K | | | | | | $1 | $10 |
|
|
58
|
+
| `opencode/gpt-5.1-codex-mini` | 400K | | | | | | $0.25 | $2 |
|
|
59
|
+
| `opencode/gpt-5.2` | 400K | | | | | | $2 | $14 |
|
|
60
|
+
| `opencode/gpt-5.2-codex` | 400K | | | | | | $2 | $14 |
|
|
61
|
+
| `opencode/gpt-5.3-codex` | 400K | | | | | | $2 | $14 |
|
|
62
|
+
| `opencode/gpt-5.4` | 1.1M | | | | | | $3 | $15 |
|
|
63
|
+
| `opencode/kimi-k2.5` | 262K | | | | | | $0.60 | $3 |
|
|
64
|
+
| `opencode/minimax-m2.1` | 205K | | | | | | $0.30 | $1 |
|
|
65
|
+
| `opencode/minimax-m2.5` | 205K | | | | | | $0.30 | $1 |
|
|
66
|
+
| `opencode/minimax-m2.5-free` | 205K | | | | | | — | — |
|
|
67
67
|
|
|
68
68
|
## Advanced Configuration
|
|
69
69
|
|
|
@@ -93,7 +93,7 @@ const agent = new Agent({
|
|
|
93
93
|
model: ({ requestContext }) => {
|
|
94
94
|
const useAdvanced = requestContext.task === "complex";
|
|
95
95
|
return useAdvanced
|
|
96
|
-
? "opencode/
|
|
96
|
+
? "opencode/minimax-m2.5-free"
|
|
97
97
|
: "opencode/big-pickle";
|
|
98
98
|
}
|
|
99
99
|
});
|
|
@@ -104,11 +104,11 @@ const response = await agent.generate("Hello!", {
|
|
|
104
104
|
|
|
105
105
|
### Available Options
|
|
106
106
|
|
|
107
|
-
**reasoningEffort
|
|
107
|
+
**reasoningEffort** (`"low" | "high" | undefined`)
|
|
108
108
|
|
|
109
|
-
**parallel\_function\_calling
|
|
109
|
+
**parallel\_function\_calling** (`boolean | undefined`)
|
|
110
110
|
|
|
111
|
-
**searchParameters
|
|
111
|
+
**searchParameters** (`{ mode: "off" | "auto" | "on"; returnCitations?: boolean | undefined; fromDate?: string | undefined; toDate?: string | undefined; maxSearchResults?: number | undefined; sources?: ({ ...; } | ... 2 more ... | { ...; })[] | undefined; } | undefined`)
|
|
112
112
|
|
|
113
113
|
## Direct Provider Installation
|
|
114
114
|
|
|
@@ -94,47 +94,47 @@ export const agent = new Agent({
|
|
|
94
94
|
|
|
95
95
|
## Constructor parameters
|
|
96
96
|
|
|
97
|
-
**id
|
|
97
|
+
**id** (`string`): Unique identifier for the agent. Defaults to \`name\` if not provided.
|
|
98
98
|
|
|
99
|
-
**name
|
|
99
|
+
**name** (`string`): Display name for the agent. Used as the identifier if \`id\` is not provided.
|
|
100
100
|
|
|
101
|
-
**description
|
|
101
|
+
**description** (`string`): Optional description of the agent's purpose and capabilities.
|
|
102
102
|
|
|
103
|
-
**instructions
|
|
103
|
+
**instructions** (`SystemMessage | ({ requestContext: RequestContext }) => SystemMessage | Promise<SystemMessage>`): Instructions that guide the agent's behavior. Can be a string, array of strings, system message object, array of system messages, or a function that returns any of these types dynamically. SystemMessage types: string | string\[] | CoreSystemMessage | CoreSystemMessage\[] | SystemModelMessage | SystemModelMessage\[]
|
|
104
104
|
|
|
105
|
-
**model
|
|
105
|
+
**model** (`MastraLanguageModel | ({ requestContext: RequestContext }) => MastraLanguageModel | Promise<MastraLanguageModel>`): The language model used by the agent. Can be provided statically or resolved at runtime.
|
|
106
106
|
|
|
107
|
-
**agents
|
|
107
|
+
**agents** (`Record<string, Agent> | ({ requestContext: RequestContext }) => Record<string, Agent> | Promise<Record<string, Agent>>`): Subagents that the agent can access. Can be provided statically or resolved dynamically.
|
|
108
108
|
|
|
109
|
-
**tools
|
|
109
|
+
**tools** (`ToolsInput | ({ requestContext: RequestContext }) => ToolsInput | Promise<ToolsInput>`): Tools that the agent can access. Can be provided statically or resolved dynamically.
|
|
110
110
|
|
|
111
|
-
**workflows
|
|
111
|
+
**workflows** (`Record<string, Workflow> | ({ requestContext: RequestContext }) => Record<string, Workflow> | Promise<Record<string, Workflow>>`): Workflows that the agent can execute. Can be static or dynamically resolved.
|
|
112
112
|
|
|
113
|
-
**defaultOptions
|
|
113
|
+
**defaultOptions** (`AgentExecutionOptions | ({ requestContext: RequestContext }) => AgentExecutionOptions | Promise<AgentExecutionOptions>`): Default options used when calling \`stream()\` and \`generate()\`.
|
|
114
114
|
|
|
115
|
-
**defaultGenerateOptionsLegacy
|
|
115
|
+
**defaultGenerateOptionsLegacy** (`AgentGenerateOptions | ({ requestContext: RequestContext }) => AgentGenerateOptions | Promise<AgentGenerateOptions>`): Default options used when calling \`generateLegacy()\`.
|
|
116
116
|
|
|
117
|
-
**defaultStreamOptionsLegacy
|
|
117
|
+
**defaultStreamOptionsLegacy** (`AgentStreamOptions | ({ requestContext: RequestContext }) => AgentStreamOptions | Promise<AgentStreamOptions>`): Default options used when calling \`streamLegacy()\`.
|
|
118
118
|
|
|
119
|
-
**mastra
|
|
119
|
+
**mastra** (`Mastra`): Reference to the Mastra runtime instance (injected automatically).
|
|
120
120
|
|
|
121
|
-
**scorers
|
|
121
|
+
**scorers** (`MastraScorers | ({ requestContext: RequestContext }) => MastraScorers | Promise<MastraScorers>`): Scoring configuration for runtime evaluation and telemetry. Can be static or dynamically provided.
|
|
122
122
|
|
|
123
|
-
**memory
|
|
123
|
+
**memory** (`MastraMemory | ({ requestContext: RequestContext }) => MastraMemory | Promise<MastraMemory>`): Memory module used for storing and retrieving stateful context.
|
|
124
124
|
|
|
125
|
-
**voice
|
|
125
|
+
**voice** (`CompositeVoice`): Voice settings for speech input and output.
|
|
126
126
|
|
|
127
|
-
**inputProcessors
|
|
127
|
+
**inputProcessors** (`(Processor | ProcessorWorkflow)[] | ({ requestContext: RequestContext }) => (Processor | ProcessorWorkflow)[] | Promise<(Processor | ProcessorWorkflow)[]>`): Input processors that can modify or validate messages before they are processed by the agent. Can be individual Processor objects or workflows created with \`createWorkflow()\` using ProcessorStepSchema.
|
|
128
128
|
|
|
129
|
-
**outputProcessors
|
|
129
|
+
**outputProcessors** (`(Processor | ProcessorWorkflow)[] | ({ requestContext: RequestContext }) => (Processor | ProcessorWorkflow)[] | Promise<(Processor | ProcessorWorkflow)[]>`): Output processors that can modify or validate messages from the agent before they are sent to the client. Can be individual Processor objects or workflows.
|
|
130
130
|
|
|
131
|
-
**maxProcessorRetries
|
|
131
|
+
**maxProcessorRetries** (`number`): Maximum number of times a processor can request retrying the LLM step.
|
|
132
132
|
|
|
133
|
-
**requestContextSchema
|
|
133
|
+
**requestContextSchema** (`z.ZodType<any>`): Zod schema for validating request context values. When provided, the context is validated at the start of generate() or stream(), throwing a MastraError if validation fails.
|
|
134
134
|
|
|
135
135
|
## Returns
|
|
136
136
|
|
|
137
|
-
**agent
|
|
137
|
+
**agent** (`Agent<TAgentId, TTools>`): A new Agent instance with the specified configuration.
|
|
138
138
|
|
|
139
139
|
## Related
|
|
140
140
|
|