@mastra/mcp-docs-server 1.2.13-alpha.1 → 1.2.13-alpha.12

package/.docs/docs/what-is-mastra.md

@@ -1,161 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# What is Mastra?
-
-Mastra is an open-source TypeScript framework for building AI applications and autonomous AI systems. Use it for anything from an AI feature inside an existing product to long-running agents that run entire processes on their own, such as a software factory that plans, builds, reviews, and ships code.
-
-Mastra gives you everything you need to build an agent harness out of the box. It's built on established patterns, so you make fewer integration decisions and spend more time on your product. And, as you'd expect from an AI framework, it includes a [skill and CLI](https://mastra.ai/docs/getting-started/build-with-ai) that help your coding agent write accurate, up-to-date Mastra code.
-
-Run Mastra standalone or inside your existing web server, and call your agents from your own code, over HTTP using the [Mastra client](https://mastra.ai/docs/server/mastra-client), or from channels (for example, Slack).
-
-> **📹 Video:** [A quick tour of the Mastra platform](https://www.youtube.com/watch?v=NosES9aJxCc) shows how the pieces fit together.
-
-## Framework
-
-Mastra is batteries-included, but not all-or-nothing. A single agent can start small:
-
-```typescript
-import { Agent } from '@mastra/core/agent'
-import { searchDocs } from '../tools/search-docs'
-
-export const supportAgent = new Agent({
-  id: 'support-agent',
-  name: 'Support Agent',
-  instructions: 'Answer customer support questions clearly.',
-  model: 'openai/gpt-5.6-sol',
-  tools: { searchDocs },
-})
-```
-
-Then add the capabilities your agent needs:
-
-- **Act in real environments**: Use [workspaces](https://mastra.ai/docs/workspace/overview) so agents can read and write files, run commands, and work inside a sandbox.
-- **Bring the right context**: Use tools, [memory](https://mastra.ai/docs/memory/observational-memory), [skills](https://mastra.ai/docs/agents/skills), and domain knowledge so agents remember what matters and stay within the context window.
-- **Coordinate complex work**: Run typed [workflows](https://mastra.ai/docs/workflows/overview), [tasks](https://mastra.ai/docs/agents/using-tools), and [subagents](https://mastra.ai/docs/agents/supervisor-agents) when work needs multiple steps or parallel execution.
-- **Control the agent loop**: [Suspend](https://mastra.ai/docs/agents/agent-approval) for human approval, steer an in-flight loop with [signals](https://mastra.ai/docs/long-running-agents/signals), or queue input for the next turn.
-- **Meet users where they work**: Connect agents to Slack, Discord, GitHub, and other [channels](https://mastra.ai/docs/capabilities/channels/overview).
-- **Manage risk and cost**: Configure authentication, multi-tenant isolation, and [guardrails](https://mastra.ai/docs/agents/guardrails), including [`CostGuardProcessor`](https://mastra.ai/reference/processors/cost-guard-processor).
-
-See the left-hand sidebar for the full menu of features.
-
-## Studio
-
-![Agents page in Mastra Studio. A sidebar lists primitives like agents, workflows, and tools, a middle panel lists recent chats, and a chat panel shows the agent responding to a prompt with collapsible tool calls and a task list tracking progress. Below the chat is a message box with a model picker.](/assets/images/studio-agent-chat-e516834f26abd332aa54cbffa7553028.png)
-
-[Studio](https://mastra.ai/docs/studio/overview) is usually the first place you go after creating a Mastra app. It gives you a live environment for testing agents, inspecting runs, and iterating quickly.
-
-Studio isn't just for engineers. Deploy it and share it with your team, so collaborators can try an agent before it ships. With the [Editor](https://mastra.ai/docs/editor/overview) and [Agent Builder](https://mastra.ai/docs/agent-builder/overview), non-technical teammates can create and iterate on agents themselves, with every change versioned in code.
-
-## Observability and evals
-
-![Traces page in Mastra Studio. A table lists recent agent runs with timestamps and inputs. A details panel shows the selected trace as an expandable tree of model, tool, and workspace spans with per-span timings, plus actions to evaluate the trace or save it as a dataset item.](/assets/images/studio-traces-e061dbd62a9c7f2ac2d61ad172125be6.png)
-
-Mastra has built-in logs, traces, and metrics, so you can understand every run in development and production. See [Observability](https://mastra.ai/docs/observability/overview).
-
-Evals close the loop. Score outputs with rule-based or LLM-as-judge [scorers](https://mastra.ai/docs/evals/overview), live in production or offline in CI. Create datasets from real traces, run experiments, and compare versions. Because you own the code and the observability layer, you get a closed loop from trace to prompt edit to measurable improvement.
-
-## Long-running agents
-
-Some agents finish in a single request. Others run for hours or days, like a sales agent that watches for signups or an SRE agent that handles incidents. Mastra supports [long-running agents](https://mastra.ai/docs/long-running-agents/durable-agents) with these capabilities:
-
-- **Survive restarts and disconnects**: [Durable agents](https://mastra.ai/docs/long-running-agents/durable-agents) persist run state so work resumes and clients reconnect.
-- **Wake and steer agents mid-run**: Send [messages and signals](https://mastra.ai/docs/long-running-agents/signals) to wake an agent, add context, or queue input.
-- **Keep working toward a goal**: [Goals](https://mastra.ai/docs/long-running-agents/goals) persist an objective until it's met or the run budget is spent.
-- **Run work outside the request**: Use [schedules](https://mastra.ai/docs/long-running-agents/schedules) and [background tasks](https://mastra.ai/docs/long-running-agents/background-tasks) for recurring jobs, slow tools, and work that shouldn't block the agent loop.
-
-For long-running interactive applications, [AgentController](https://mastra.ai/docs/agent-controller/overview) manages threads, modes, tool approvals, and model switching. It powers [Mastra Code](https://code.mastra.ai/) and lets you build a Claude Code-style experience for your own domain.
-
-## Deployment
-
-Mastra is open source and infrastructure-neutral. The framework fits your stack instead of requiring your stack to fit one vendor. Choose from an ecosystem of model providers, databases, sandboxes, and observability platforms, and change providers without rewriting your application around proprietary infrastructure.
-
-When you're ready to deploy:
-
-- **[Mastra Server](https://mastra.ai/docs/mastra-platform/server)**: The quickest path to production. Mastra builds and hosts your application as an API server with a stable endpoint, environment variables, custom domains, and deploy history.
-- **Your infrastructure**: Use Mastra's [deployers for major platforms](https://mastra.ai/docs/deployment/overview), deploy a standard server to your preferred virtual machine, container, or platform as a service, or run Mastra inside an existing TypeScript application with a [server adapter](https://mastra.ai/docs/server/server-adapters).
-
-## Use cases
-
-Here are some of the ways you can use Mastra:
-
-<details>
-**Embed agents in your product**
-
-Add AI capabilities to your platform so your users can build or interact with agents.
-
-Used by [Replit](https://mastra.ai/blog/replitagent3), [Fireworks](https://mastra.ai/blog/fireworks-xml-prompting), [Medusa](https://mastra.ai/blog/medusa-ecommerce)
-
-</details>
-
-<details>
-**Customer-facing assistants**
-
-Build agents that handle inquiries, schedule appointments, send reminders, and answer questions via chat, WhatsApp, or voice.
-
-Used by [Vetnio](https://mastra.ai/blog/vetnio), [Lua](https://mastra.ai/blog/lua-scaling)
-
-Templates: [Docs Chatbot](https://mastra.ai/templates/docs-chatbot), [Slack Agent](https://mastra.ai/templates/slack-agent)
-
-</details>
-
-<details>
-**Internal copilots**
-
-Help employees work faster with AI that understands your domain—HR queries, clinical documentation, sales prep, or document generation.
-
-Used by [Factorial](https://mastra.ai/blog/factorial-case-study), [Counsel Health](https://mastra.ai/blog/counsel-health), [Cedar](https://mastra.ai/blog/cedar-case-study), [SoftBank](https://mastra.ai/blog/softbank-productivity-mastra-2025-08-20)
-
-Templates: [Chat with PDF](https://mastra.ai/templates/chat-with-pdf), [Google Sheet Analysis](https://mastra.ai/templates/google-sheets-analysis)
-
-</details>
-
-<details>
-**Data analysis agents**
-
-Let users query databases and dashboards in natural language. Connect to your data sources and return answers, charts, or reports.
-
-Used by [Index](https://mastra.ai/blog/index-case-study), [PLAID Japan](https://mastra.ai/blog/plaid-jpn-gcp-agents)
-
-Templates: [Chat with Database](https://mastra.ai/templates/text-to-sql), [CSV to Questions](https://mastra.ai/templates/csv-to-questions)
-
-</details>
-
-<details>
-**Content automation**
-
-Generate, transform, and manage structured content at scale—whether for a CMS, knowledge base, or documentation system.
-
-Used by [Sanity](https://mastra.ai/blog/sanity)
-
-Templates: [Chat with YouTube](https://mastra.ai/templates/chat-with-youtube), [Flash Cards from PDF](https://mastra.ai/templates/flash-cards-from-pdf)
-
-</details>
-
-<details>
-**DevOps & engineering automation**
-
-Automate deployments, debug production issues, manage infrastructure, and handle on-call workflows.
-
-Used by [StarSling](https://mastra.ai/blog/starsling)
-
-Templates: [GitHub PR Code Review](https://mastra.ai/templates/github-pr-code-review-agent), [Browser Agent](https://mastra.ai/templates/browsing-agent)
-
-</details>
-
-<details>
-**Sales & GTM workflows**
-
-Turn customer conversations into structured tasks, generate investment memos, or automate outreach sequences.
-
-Used by [Kestral](https://mastra.ai/blog/kestral), [Orange Collective](https://mastra.ai/blog/orange-collective-vc-operating-system), [WorkOS](https://mastra.ai/blog/workos-teaching-mastra)
-
-Templates: [Customer Feedback Summarization](https://mastra.ai/templates/customer-feedback-summarization)
-
-</details>
-
-Browse [templates](https://mastra.ai/templates) for working examples.
-
-## Next steps
-
-- [Get started](https://mastra.ai/docs)
-- [Agents overview](https://mastra.ai/docs/agents/overview)

package/.docs/reference/client-js/agent-builder.md

@@ -1,163 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# Agent Builder API
-
-The Agent Builder API provides methods to interact with [Agent Builder](https://mastra.ai/docs/agent-builder/overview) actions on the server. Each action is a workflow exposed under `/agent-builder/:actionId/*`. The Builder must be enabled on the server via `MastraEditor.builder.enabled`, with a valid `MASTRA_EE_LICENSE` in production.
-
-## Getting all actions
-
-Retrieve a record of available Agent Builder actions:
-
-```typescript
-const actions = await mastraClient.getAgentBuilderActions()
-```
-
-Returns a `Record<string, WorkflowInfo>` keyed by action ID.
-
-## Working with a specific action
-
-Get an instance of a specific action by its ID:
-
-```typescript
-const action = mastraClient.getAgentBuilderAction('create-agent')
-```
-
-## Action methods
-
-### `details()`
-
-Retrieve metadata about an Agent Builder action:
-
-```typescript
-const info = await action.details()
-```
-
-### `createRun()`
-
-Create a new run for this action and receive a `runId`. Use the returned id with `startActionRun()`, `stream()`, `resume()`, or `observeStream()`.
-
-```typescript
-const { runId } = await action.createRun()
-```
-
-You can also pass an explicit `runId`:
-
-```typescript
-const { runId } = await action.createRun({ runId: 'my-run-id' })
-```
-
-### `startAsync()`
-
-Start the action and wait for completion. Returns the final `AgentBuilderActionResult` with `success`, `applied`, `branchName`, `message`, `validationResults`, `error`, `errors`, and `stepResults`.
-
-```typescript
-const result = await action.startAsync({
-  inputData: { agentName: 'support-bot' },
-})
-```
-
-Pass an existing `runId` as the second argument to start a previously created run:
-
-```typescript
-const { runId } = await action.createRun()
-const result = await action.startAsync({ inputData }, runId)
-```
-
-### `startActionRun()`
-
-Start an existing run without waiting for completion. Returns `{ message }`.
-
-```typescript
-const { runId } = await action.createRun()
-await action.startActionRun({ inputData }, runId)
-```
-
-### `stream()`
-
-Start an existing run and stream progress events as a `ReadableStream<{ type, payload }>`.
-
-```typescript
-const { runId } = await action.createRun()
-const stream = await action.stream({ inputData }, runId)
-
-for await (const event of stream) {
-  console.log(event.type, event.payload)
-}
-```
-
-### `resume()`
-
-Resume a suspended step on a run. Returns `{ message }`.
-
-```typescript
-await action.resume({ step: 'review', resumeData: { approved: true } }, runId)
-```
-
-### `resumeAsync()`
-
-Resume a suspended step and wait for completion. Returns an `AgentBuilderActionResult`.
-
-```typescript
-const result = await action.resumeAsync({ step: 'review', resumeData: { approved: true } }, runId)
-```
-
-### `resumeStream()`
-
-Resume a suspended step and stream subsequent events.
-
-```typescript
-const stream = await action.resumeStream({
-  runId,
-  step: 'review',
-  resumeData: { approved: true },
-})
-```
-
-### `observeStream()`
-
-Attach to an existing run, replaying cached events from the beginning, then continuing with live events. Use this to recover after a page refresh or hot reload.
-
-```typescript
-const stream = await action.observeStream({ runId })
-```
-
-### `observeStreamLegacy()`
-
-Same as `observeStream()` but uses the legacy streaming endpoint. Prefer `observeStream()` for new code.
-
-```typescript
-const stream = await action.observeStreamLegacy({ runId })
-```
-
-### `runs()`
-
-List runs for this action with optional filters.
-
-```typescript
-const runs = await action.runs({ page: 0, perPage: 20 })
-```
-
-Accepts `fromDate`, `toDate`, `page`, `perPage`, `resourceId`, and legacy `limit`/`offset`.
-
-### `runById()`
-
-Fetch a specific run by ID. Use `fields` to limit the returned payload and `withNestedWorkflows` to skip nested workflow data.
-
-```typescript
-const run = await action.runById(runId, {
-  fields: ['result', 'steps'],
-  withNestedWorkflows: false,
-})
-```
-
-### `cancelRun()`
-
-Cancel an in-flight run.
-
-```typescript
-await action.cancelRun(runId)
-```
-
-## Access control
-
-The `/agent-builder/*` routes are gated by the `agent-builder` permission resource. Calling clients need at minimum `agent-builder:read` and `agent-builder:execute`, plus any picker resources the action touches (`stored-agents`, `stored-skills`, `tools`, `workflows`, `memory`). See [Access control](https://mastra.ai/docs/agent-builder/access-control) for the full grant list.

package/.docs/reference/editor/agent-builder/agent-builder-options.md

@@ -1,76 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# AgentBuilderOptions
-
-`AgentBuilderOptions` configures the Agent Builder. Pass it as `MastraEditor.builder` to enable the Builder UI, toggle visible surfaces, pin admin defaults, and opt into skill registries.
-
-See the [Configuration](https://mastra.ai/docs/agent-builder/configuration) page for concepts and worked examples.
-
-## Usage example
-
-```typescript
-import { MastraEditor } from '@mastra/editor'
-
-new MastraEditor({
-  builder: {
-    enabled: true,
-    features: {
-      agent: { browser: false },
-    },
-    configuration: {
-      agent: {
-        memory: { observationalMemory: true },
-        models: {
-          allowed: [
-            { provider: 'openai', modelId: 'gpt-5.4-mini' },
-            { provider: 'openai', modelId: 'gpt-5.4' },
-            { provider: 'anthropic', modelId: 'claude-opus-4-7' },
-          ],
-        },
-      },
-    },
-    registries: {
-      skillsSh: { enabled: true },
-    },
-  },
-})
-```
-
-## Properties
-
-**enabled** (`boolean`): Master switch. When false, the Builder UI is disabled and MastraEditor.resolveBuilder() returns undefined. (Default: `true`)
-
-**features** (`{ agent?: AgentFeatures }`): UI toggles. Each key on features.agent defaults to true when omitted.
-
-**features.agent.tools** (`boolean`): Show the tools tab in the agent editor.
-
-**features.agent.agents** (`boolean`): Show the sub-agents picker in the agent editor.
-
-**features.agent.workflows** (`boolean`): Show the workflows picker in the agent editor.
-
-**features.agent.skills** (`boolean`): Show the skills tab and library for the agent.
-
-**features.agent.memory** (`boolean`): Show the memory configuration in the agent editor.
-
-**features.agent.model** (`boolean`): Show the model picker in the agent editor. When false, the admin-pinned default model applies.
-
-**features.agent.browser** (`boolean`): Show the browser tab. Resolves to true only when a valid browser provider is registered on MastraEditor.browsers; otherwise it is downgraded to false and a warning is logged.
-
-**features.agent.avatarUpload** (`boolean`): Allow end users to upload an avatar for stored agents.
-
-**features.agent.favorites** (`boolean`): Show favorite agents and skills with per-user state and aggregate counts.
-
-**configuration** (`{ agent?: BuilderAgentDefaults }`): Admin-pinned defaults applied to every Builder-created agent. End users cannot override these values. See the BuilderAgentDefaults reference for the full schema.
-
-**registries** (`{ skillsSh?: { enabled: boolean } }`): Opt-in third-party skill registries. When no registry is enabled, the Builder hides registry browse UI.
-
-**registries.skillsSh** (`{ enabled: boolean }`): Enable the skills.sh registry. When enabled, the Builder shows registry browse UI for skills.sh skills.
-
-**registries.skillsSh.enabled** (`boolean`): Set to true to opt in. Defaults to false.
-
-## Related
-
-- [Configuration](https://mastra.ai/docs/agent-builder/configuration): Concept and worked examples.
-- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Full schema for `configuration.agent`.
-- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models): Model allowlist and default model.
-- [MastraEditor class](https://mastra.ai/reference/editor/mastra-editor): The parent surface that hosts `builder`.

package/.docs/reference/editor/agent-builder/builder-agent-defaults.md

@@ -1,79 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# BuilderAgentDefaults
-
-`BuilderAgentDefaults` describes the admin-pinned defaults applied to every agent the Agent Builder produces. Pass it as `builder.configuration.agent`. End users can't override these values from the Builder UI.
-
-See [Configuration](https://mastra.ai/docs/agent-builder/configuration) and [Memory](https://mastra.ai/docs/agent-builder/memory) for worked examples.
-
-## Usage example
-
-```typescript
-import { MastraEditor } from '@mastra/editor'
-
-new MastraEditor({
-  builder: {
-    enabled: true,
-    configuration: {
-      agent: {
-        memory: { observationalMemory: true },
-        workspace: {
-          type: 'inline',
-          config: {
-            name: 'builder-workspace',
-            filesystem: {
-              provider: 'local',
-              config: { basePath: './workspace' },
-            },
-          },
-        },
-        models: {
-          allowed: [
-            { provider: 'openai', modelId: 'gpt-5.4-mini' },
-            { provider: 'openai', modelId: 'gpt-5.4' },
-            { provider: 'anthropic', modelId: 'claude-opus-4-7' },
-          ],
-        },
-        tools: { allowed: ['weather-info'] },
-        agents: { allowed: ['weather-agent'] },
-        workflows: { allowed: ['greet-workflow'] },
-      },
-    },
-  },
-})
-```
-
-## Properties
-
-**memory** (`SerializedMemoryConfig`): Default memory configuration for new agents. Pass { observationalMemory: true } to enable long-lived fact extraction. Requires Mastra.storage. See the SerializedMemoryConfig reference for the full schema.
-
-**workspace** (`StorageWorkspaceRef`): Default workspace reference for new agents. Pass { type: 'inline', config } to embed a snapshot, or { type: 'id', workspaceId } to point at a workspace registered on Mastra.workspace. See the StorageWorkspaceRef reference for both variants.
-
-**browser** (`StorageBrowserRef`): Default browser configuration for new agents. Pass { type: 'inline', config: { provider } } to attach a registered browser provider. See the StorageBrowserRef reference for the full schema.
-
-**models** (`{ allowed?: ProviderModelEntry[]; default?: DefaultModelEntry }`): Model allowlist and default applied to every Builder-created agent. See the BuilderModels reference for the full schema and validation rules.
-
-**models.allowed** (`ProviderModelEntry[]`): Allowlist of providers and models. Omit to allow every registered model. ProviderModelEntry is a discriminated union (known providers vs. custom).
-
-**models.default** (`DefaultModelEntry`): Pre-selected model on new-agent create. Required when the model picker is hidden. DefaultModelEntry requires provider and modelId, with an optional kind.
-
-**tools** (`{ allowed?: string[] }`): Allowlist of tool IDs visible in the Builder tools picker. Unknown IDs are dropped and surfaced as warnings.
-
-**tools.allowed** (`string[]`): Allowlist of tool.id values. Omit for unrestricted, pass \[] to lock the picker down, pass \[...ids] to restrict to the listed tools.
-
-**agents** (`{ allowed?: string[] }`): Allowlist of agent IDs visible in the Builder sub-agents picker. Unknown IDs are dropped and surfaced as warnings.
-
-**agents.allowed** (`string[]`): Allowlist of Agent.id values. Omit for unrestricted, pass \[] to lock the picker down, pass \[...ids] to restrict to the listed agents.
-
-**workflows** (`{ allowed?: string[] }`): Allowlist of workflow IDs visible in the Builder workflows picker. Unknown IDs are dropped and surfaced as warnings.
-
-**workflows.allowed** (`string[]`): Allowlist of workflow\.id values. Omit for unrestricted, pass \[] to lock the picker down, pass \[...ids] to restrict to the listed workflows.
-
-## Related
-
-- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options): The parent options object.
-- [builder.configuration.agent.models](https://mastra.ai/reference/editor/agent-builder/builder-models): Admin-facing model allowlist and default.
-- [SerializedMemoryConfig](https://mastra.ai/reference/memory/serialized-memory-config): Memory shape for new agents.
-- [StorageWorkspaceRef](https://mastra.ai/reference/editor/storage-workspace-ref): Workspace reference shape.
-- [StorageBrowserRef](https://mastra.ai/reference/editor/storage-browser-ref): Browser reference shape.
-- [Configuration](https://mastra.ai/docs/agent-builder/configuration): Concept and worked examples.

package/.docs/reference/editor/agent-builder/builder-models.md

@@ -1,66 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# builder.configuration.agent.models
-
-`builder.configuration.agent.models` is the admin-facing model policy input on `AgentBuilderOptions`. It controls which providers and models the Agent Builder exposes, and which model is pre-selected on new-agent create.
-
-See [Model policy](https://mastra.ai/docs/agent-builder/model-policy) for concepts and worked examples.
-
-## Usage example
-
-```typescript
-import { MastraEditor } from '@mastra/editor'
-
-new MastraEditor({
-  builder: {
-    enabled: true,
-    configuration: {
-      agent: {
-        models: {
-          allowed: [
-            { provider: 'openai', modelId: 'gpt-5.4-mini' },
-            { provider: 'openai', modelId: 'gpt-5.4' },
-            { provider: 'anthropic', modelId: 'claude-opus-4-7' },
-          ],
-        },
-      },
-    },
-  },
-})
-```
-
-## Properties
-
-**allowed** (`ProviderModelEntry[]`): Allowlist of providers and models. Omit to allow every registered model. When non-empty, only the listed entries are selectable in the Builder.
-
-**allowed.provider** (`Provider`): Provider id from the generated provider registry (for example, openai, anthropic).
-
-**allowed.modelId** (`ModelForProvider<Provider>`): Specific model id for that provider. Omit to allow every model under the provider.
-
-**allowed.kind** (`'custom'`): Discriminant marking this entry as a gateway or self-hosted provider not in the registry.
-
-**allowed.provider** (`string`): Provider id for the custom provider.
-
-**allowed.modelId** (`string`): Specific model id under the custom provider. Omit to allow every model under it.
-
-**default** (`DefaultModelEntry`): Pre-selected model on new-agent create. Same shape as ProviderModelEntry, but modelId is required. Must satisfy the allowed list when set.
-
-**default.provider** (`Provider | string`): Provider id. Use a Provider literal for known providers, or any string with kind: 'custom'.
-
-**default.modelId** (`string`): Required model id. Points at a specific model, not a whole provider.
-
-**default.kind** (`'custom'`): Set to custom when targeting a provider that isn't in the generated registry.
-
-## Validation rules
-
-Mastra validates the admin policy at server boot. Violations surface as warnings on `GET /editor/builder/settings.modelPolicyWarnings`.
-
-- `allowed` empty or omitted: no restriction. Every registered model is available.
-- When `allowed` is non-empty and a `default` is set: `default` must satisfy `isModelAllowed(allowed, default)`. A `default` that fails this check is dropped and surfaced as a warning.
-- To hide the end-user model picker, set `features.agent.model: false` in [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options). When the picker is hidden, provide a `default` so new agents resolve a model.
-
-## Related
-
-- [BuilderAgentDefaults](https://mastra.ai/reference/editor/agent-builder/builder-agent-defaults): Parent object containing `models`.
-- [AgentBuilderOptions](https://mastra.ai/reference/editor/agent-builder/agent-builder-options): The top-level Builder options.
-- [Model policy](https://mastra.ai/docs/agent-builder/model-policy): Concept and worked examples.