@mastra/mcp-docs-server 1.0.0-beta.1 → 1.0.0-beta.3

package/.docs/raw/reference/core/mastra-model-gateway.mdx

@@ -0,0 +1,241 @@
+---
+title: "Reference: MastraModelGateway | Core"
+description: "Base class for creating custom model gateways"
+---
+
+# MastraModelGateway
+
+Abstract base class for implementing custom model gateways. Gateways handle provider-specific logic for accessing language models, including provider configuration, authentication, URL construction, and model instantiation.
+
+## Class Overview
+
+```typescript
+import { MastraModelGateway, type ProviderConfig } from '@mastra/core/llm';
+import { createOpenAICompatible } from '@ai-sdk/openai-compatible-v5';
+import type { LanguageModelV2 } from '@ai-sdk/provider-v5';
+
+class MyCustomGateway extends MastraModelGateway {
+  readonly id = 'my-custom-gateway';
+  readonly name = 'My Custom Gateway';
+  readonly prefix = 'custom';
+
+  async fetchProviders(): Promise<Record<string, ProviderConfig>> {
+    return {
+      'my-provider': {
+        name: 'My Provider',
+        models: ['model-1', 'model-2'],
+        apiKeyEnvVar: 'MY_API_KEY',
+        gateway: this.id,
+      },
+    };
+  }
+
+  buildUrl(modelId: string, envVars?: Record<string, string>): string {
+    return 'https://api.my-provider.com/v1';
+  }
+
+  async getApiKey(modelId: string): Promise<string> {
+    const apiKey = process.env.MY_API_KEY;
+    if (!apiKey) throw new Error('MY_API_KEY not set');
+    return apiKey;
+  }
+
+  async resolveLanguageModel({
+    modelId,
+    providerId,
+    apiKey,
+  }: {
+    modelId: string;
+    providerId: string;
+    apiKey: string;
+  }): Promise<LanguageModelV2> {
+    const baseURL = this.buildUrl(`${providerId}/${modelId}`);
+    return createOpenAICompatible({
+      name: providerId,
+      apiKey,
+      baseURL,
+    }).chatModel(modelId);
+  }
+}
+```
+
+## Required Properties
+
+<PropertiesTable
+  content={[
+    {
+      name: 'id',
+      type: 'string',
+      description: 'Unique identifier for the gateway. Used for versioning and identification.',
+    },
+    {
+      name: 'name',
+      type: 'string',
+      description: 'Human-readable name for the gateway.',
+    },
+  ]}
+/>
+
+## Optional Properties
+
+<PropertiesTable
+  content={[
+    {
+      name: 'prefix',
+      type: 'string | undefined',
+      description: 'Optional prefix for provider IDs. If set, all providers from this gateway will be prefixed (e.g., "netlify/openai"). Registry gateways typically don\'t have a prefix.',
+    },
+  ]}
+/>
+
+## Required Methods
+
+### fetchProviders()
+
+Fetches provider configurations from the gateway.
+
+**Returns:** `Promise<Record<string, ProviderConfig>>`
+
+**ProviderConfig Structure:**
+<PropertiesTable
+  content={[
+    {
+      name: 'name',
+      type: 'string',
+      description: 'Display name of the provider',
+    },
+    {
+      name: 'models',
+      type: 'string[]',
+      description: 'Array of available model IDs',
+    },
+    {
+      name: 'apiKeyEnvVar',
+      type: 'string | string[]',
+      description: 'Environment variable(s) for API key',
+    },
+    {
+      name: 'gateway',
+      type: 'string',
+      description: 'Gateway identifier',
+    },
+    {
+      name: 'url',
+      type: 'string',
+      isOptional: true,
+      description: 'Optional base API URL',
+    },
+    {
+      name: 'apiKeyHeader',
+      type: 'string',
+      isOptional: true,
+      description: 'Optional custom auth header name',
+    },
+    {
+      name: 'docUrl',
+      type: 'string',
+      isOptional: true,
+      description: 'Optional documentation URL',
+    },
+  ]}
+/>
+
+### buildUrl()
+
+Builds the API URL for a specific model/provider combination.
+
+**Parameters:**
+<PropertiesTable
+  content={[
+    {
+      name: 'modelId',
+      type: 'string',
+      description: 'Full model ID (e.g., "custom/my-provider/model-1")',
+    },
+    {
+      name: 'envVars',
+      type: 'Record<string, string>',
+      isOptional: true,
+      description: 'Optional environment variables',
+    },
+  ]}
+/>
+
+**Returns:** `string | undefined | Promise<string | undefined>`
+
+### getApiKey()
+
+Retrieves the API key for authentication.
+
+**Parameters:**
+<PropertiesTable
+  content={[
+    {
+      name: 'modelId',
+      type: 'string',
+      description: 'Full model ID',
+    },
+  ]}
+/>
+
+**Returns:** `Promise<string>`
+
+### resolveLanguageModel()
+
+Creates a language model instance.
+
+**Parameters:**
+<PropertiesTable
+  content={[
+    {
+      name: 'modelId',
+      type: 'string',
+      description: 'The model ID',
+    },
+    {
+      name: 'providerId',
+      type: 'string',
+      description: 'The provider ID',
+    },
+    {
+      name: 'apiKey',
+      type: 'string',
+      description: 'The API key for authentication',
+    },
+  ]}
+/>
+
+**Returns:** `Promise<LanguageModelV2> | LanguageModelV2`
+
+## Instance Methods
+
+### getId()
+
+Returns the gateway's unique identifier.
+
+**Returns:** `string` - The gateway's `id` property
+
+## Model ID Format
+
+When a gateway has a prefix, models are accessed using this format:
+
+```
+[prefix]/[provider]/[model]
+```
+
+Examples:
+- With prefix `'custom'`: `'custom/my-provider/model-1'`
+- Without prefix: `'my-provider/model-1'`
+
+## Built-in Implementations
+
+- **NetlifyGateway** - Netlify AI Gateway integration
+- **ModelsDevGateway** - Registry of OpenAI-compatible providers
+
+## Related
+
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Complete guide to creating custom gateways
+- [Mastra.addGateway()](/reference/v1/core/addGateway) - Add a gateway to Mastra
+- [Mastra.getGateway()](/reference/v1/core/getGateway) - Get gateway by registration key
+- [Mastra.getGatewayById()](/reference/v1/core/getGatewayById) - Get gateway by ID
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways

package/.docs/raw/reference/core/setLogger.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.setLogger() | Core | Mastra Docs"
+title: "Reference: Mastra.setLogger() | Core"
 description: "Documentation for the `Mastra.setLogger()` method in Mastra, which sets the logger for all components (agents, workflows, etc.)."
 ---
 

package/.docs/raw/reference/core/setStorage.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.setStorage() | Core | Mastra Docs"
+title: "Reference: Mastra.setStorage() | Core"
 description: "Documentation for the `Mastra.setStorage()` method in Mastra, which sets the storage instance for the Mastra instance."
 ---
 

package/.docs/raw/reference/core/setTelemetry.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.setTelemetry() | Core | Mastra Docs"
+title: "Reference: Mastra.setTelemetry() | Core"
 description: "Documentation for the `Mastra.setTelemetry()` method in Mastra, which sets the telemetry configuration for all components."
 ---
 

package/.docs/raw/reference/deployer/cloudflare.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: CloudflareDeployer | Deployer | Mastra Docs"
+title: "Reference: CloudflareDeployer | Deployer"
 description: "Documentation for the CloudflareDeployer class, which deploys Mastra applications to Cloudflare Workers."
 ---
 

package/.docs/raw/reference/deployer/deployer.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Deployer | Deployer | Mastra Docs"
+title: "Reference: Deployer | Deployer"
 description: Documentation for the Deployer abstract class, which handles packaging and deployment of Mastra applications.
 asIndexPage: true
 ---

package/.docs/raw/reference/deployer/netlify.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: NetlifyDeployer | Deployer | Mastra Docs"
+title: "Reference: NetlifyDeployer | Deployer"
 description: "Documentation for the NetlifyDeployer class, which deploys Mastra applications to Netlify Functions."
 ---
 

package/.docs/raw/reference/deployer/vercel.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: VercelDeployer | Deployer | Mastra Docs"
+title: "Reference: VercelDeployer | Deployer"
 description: "Documentation for the VercelDeployer class, which deploys Mastra applications to Vercel."
 ---
 

package/.docs/raw/reference/evals/answer-relevancy.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Answer Relevancy Scorer | Evals | Mastra Docs"
+title: "Reference: Answer Relevancy Scorer | Evals"
 description: Documentation for the Answer Relevancy Scorer in Mastra, which evaluates how well LLM outputs address the input query.
 ---
 

package/.docs/raw/reference/evals/answer-similarity.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Answer Similarity Scorer | Evals | Mastra Docs"
+title: "Reference: Answer Similarity Scorer | Evals"
 description: Documentation for the Answer Similarity Scorer in Mastra, which compares agent outputs against ground truth answers for CI/CD testing.
 ---
 

package/.docs/raw/reference/evals/bias.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Bias Scorer | Evals | Mastra Docs"
+title: "Reference: Bias Scorer | Evals"
 description: Documentation for the Bias Scorer in Mastra, which evaluates LLM outputs for various forms of bias, including gender, political, racial/ethnic, or geographical bias.
 ---
 

package/.docs/raw/reference/evals/completeness.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Completeness Scorer | Evals | Mastra Docs"
+title: "Reference: Completeness Scorer | Evals"
 description: Documentation for the Completeness Scorer in Mastra, which evaluates how thoroughly LLM outputs cover key elements present in the input.
 ---
 

package/.docs/raw/reference/evals/content-similarity.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Content Similarity Scorer | Evals | Mastra Docs"
+title: "Reference: Content Similarity Scorer | Evals"
 description: Documentation for the Content Similarity Scorer in Mastra, which measures textual similarity between strings and provides a matching score.
 ---
 

package/.docs/raw/reference/evals/context-precision.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Context Precision Scorer | Evals | Mastra Docs"
+title: "Reference: Context Precision Scorer | Evals"
 description: Documentation for the Context Precision Scorer in Mastra. Evaluates the relevance and precision of retrieved context for generating expected outputs using Mean Average Precision.
 ---
 

package/.docs/raw/reference/evals/context-relevance.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Context Relevance Scorer | Evals | Mastra Docs"
+title: "Reference: Context Relevance Scorer | Evals"
 description: Documentation for the Context Relevance Scorer in Mastra. Evaluates the relevance and utility of provided context for generating agent responses using weighted relevance scoring.
 ---
 

package/.docs/raw/reference/evals/create-scorer.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: createScorer | Evals | Mastra Docs"
+title: "Reference: createScorer | Evals"
 description: Documentation for creating custom scorers in Mastra, allowing users to define their own evaluation logic using either JavaScript functions or LLM-based prompts.
 ---
 

package/.docs/raw/reference/evals/faithfulness.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Faithfulness Scorer | Evals | Mastra Docs"
+title: "Reference: Faithfulness Scorer | Evals"
 description: Documentation for the Faithfulness Scorer in Mastra, which evaluates the factual accuracy of LLM outputs compared to the provided context.
 ---
 

package/.docs/raw/reference/evals/hallucination.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Hallucination Scorer | Evals | Mastra Docs"
+title: "Reference: Hallucination Scorer | Evals"
 description: Documentation for the Hallucination Scorer in Mastra, which evaluates the factual correctness of LLM outputs by identifying contradictions with provided context.
 ---
 

package/.docs/raw/reference/evals/keyword-coverage.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Keyword Coverage Scorer | Evals | Mastra Docs"
+title: "Reference: Keyword Coverage Scorer | Evals"
 description: Documentation for the Keyword Coverage Scorer in Mastra, which evaluates how well LLM outputs cover important keywords from the input.
 ---
 

package/.docs/raw/reference/evals/mastra-scorer.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraScorer | Evals | Mastra Docs"
+title: "Reference: MastraScorer | Evals"
 description: Documentation for the MastraScorer base class in Mastra, which provides the foundation for all custom and built-in scorers.
 ---
 

package/.docs/raw/reference/evals/noise-sensitivity.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Noise Sensitivity Scorer | Evals | Mastra Docs"
+title: "Reference: Noise Sensitivity Scorer | Evals"
 description: Documentation for the Noise Sensitivity Scorer in Mastra. A CI/testing scorer that evaluates agent robustness by comparing responses between clean and noisy inputs in controlled test environments.
 ---
 

package/.docs/raw/reference/evals/prompt-alignment.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Prompt Alignment Scorer | Evals | Mastra Docs"
+title: "Reference: Prompt Alignment Scorer | Evals"
 description: Documentation for the Prompt Alignment Scorer in Mastra. Evaluates how well agent responses align with user prompt intent, requirements, completeness, and appropriateness using multi-dimensional analysis.
 ---
 

package/.docs/raw/reference/evals/run-evals.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: runEvals | Evals | Mastra Docs"
+title: "Reference: runEvals | Evals"
 description: "Documentation for the runEvals function in Mastra, which enables batch evaluation of agents and workflows using multiple scorers."
 ---
 

package/.docs/raw/reference/evals/textual-difference.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Textual Difference Scorer | Evals | Mastra Docs"
+title: "Reference: Textual Difference Scorer | Evals"
 description: Documentation for the Textual Difference Scorer in Mastra, which measures textual differences between strings using sequence matching.
 ---
 

package/.docs/raw/reference/evals/tone-consistency.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Tone Consistency Scorer | Evals | Mastra Docs"
+title: "Reference: Tone Consistency Scorer | Evals"
 description: Documentation for the Tone Consistency Scorer in Mastra, which evaluates emotional tone and sentiment consistency in text.
 ---
 

package/.docs/raw/reference/evals/tool-call-accuracy.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Tool Call Accuracy Scorers | Evals | Mastra Docs"
+title: "Reference: Tool Call Accuracy Scorers | Evals"
 description: Documentation for the Tool Call Accuracy Scorers in Mastra, which evaluate whether LLM outputs call the correct tools from available options.
 ---
 

package/.docs/raw/reference/evals/toxicity.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Toxicity Scorer | Evals | Mastra Docs"
+title: "Reference: Toxicity Scorer | Evals"
 description: Documentation for the Toxicity Scorer in Mastra, which evaluates LLM outputs for racist, biased, or toxic elements.
 ---
 

package/.docs/raw/reference/logging/pino-logger.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: PinoLogger | Observability | Mastra Docs"
+title: "Reference: PinoLogger | Observability"
 description: Documentation for PinoLogger, which provides methods to record events at various severity levels.
 ---
 
@@ -7,7 +7,7 @@ description: Documentation for PinoLogger, which provides methods to record even
 
 A Logger instance is created using `new PinoLogger()` and provides methods to record events at various severity levels.
 
-When deploying to Mastra Cloud, logs are displayed on the [Logs](/docs/v1/mastra-cloud/dashboard#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
+When deploying to Mastra Cloud, logs are displayed on the [Logs](/docs/v1/deployment/mastra-cloud/dashboard#logs) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
 
 ## Usage example
 

package/.docs/raw/reference/memory/createThread.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory.createThread() | Memory | Mastra Docs"
+title: "Reference: Memory.createThread() | Memory"
 description: "Documentation for the `Memory.createThread()` method in Mastra, which creates a new conversation thread in the memory system."
 ---
 

package/.docs/raw/reference/memory/deleteMessages.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory.deleteMessages() | Memory | Mastra Docs"
+title: "Reference: Memory.deleteMessages() | Memory"
 description: "Documentation for the `Memory.deleteMessages()` method in Mastra, which deletes multiple messages by their IDs."
 ---
 

package/.docs/raw/reference/memory/getThreadById.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory.getThreadById() | Memory | Mastra Docs"
+title: "Reference: Memory.getThreadById() | Memory"
 description: "Documentation for the `Memory.getThreadById()` method in Mastra, which retrieves a specific thread by its ID."
 ---
 

package/.docs/raw/reference/memory/listThreadsByResourceId.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory.listThreadsByResourceId() | Memory | Mastra Docs"
+title: "Reference: Memory.listThreadsByResourceId() | Memory"
 description: "Documentation for the `Memory.listThreadsByResourceId()` method in Mastra, which retrieves threads associated with a specific resource ID with pagination support."
 ---
 

package/.docs/raw/reference/memory/memory-class.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory Class | Memory | Mastra Docs"
+title: "Reference: Memory Class | Memory"
 description: "Documentation for the `Memory` class in Mastra, which provides a robust system for managing conversation history and thread-based message storage."
 ---
 

package/.docs/raw/reference/memory/query.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory.query() | Memory | Mastra Docs"
+title: "Reference: Memory.query() | Memory"
 description: "Documentation for the `Memory.query()` method in Mastra, which retrieves messages from a specific thread with support for pagination, filtering options, and semantic search."
 ---
 

package/.docs/raw/reference/memory/recall.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory.recall() | Memory | Mastra Docs"
+title: "Reference: Memory.recall() | Memory"
 description: "Documentation for the `Memory.recall()` method in Mastra, which retrieves messages from a specific thread with support for pagination, filtering options, and semantic search."
 ---
 

package/.docs/raw/reference/observability/tracing/configuration.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Configuration | Observability | Mastra Docs"
+title: "Reference: Configuration | Observability"
 description: Tracing configuration types and registry functions
 ---
 
@@ -234,7 +234,7 @@ Shuts down all observability instances and clears the registry.
 
 ### Examples
 
-- [Basic Tracing](/examples/v1/observability/basic-tracing) - Getting started
+- [Basic Tracing](/examples/v1/observability/basic-ai-tracing) - Getting started
 
 ### Exporters
 

package/.docs/raw/reference/observability/tracing/exporters/arize.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: ArizeExporter | Observability | Mastra Docs"
+title: "Reference: ArizeExporter | Observability"
 description: Arize exporter for Tracing using OpenInference
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: BraintrustExporter | Observability | Mastra Docs"
+title: "Reference: BraintrustExporter | Observability"
 description: Braintrust exporter for Tracing
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: CloudExporter | Observability | Mastra Docs"
+title: "Reference: CloudExporter | Observability"
 description: API reference for the CloudExporter
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: ConsoleExporter | Observability | Mastra Docs"
+title: "Reference: ConsoleExporter | Observability"
 description: API reference for the ConsoleExporter
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: DefaultExporter | Observability | Mastra Docs"
+title: "Reference: DefaultExporter | Observability"
 description: API reference for the DefaultExporter
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: LangfuseExporter | Observability | Mastra Docs"
+title: "Reference: LangfuseExporter | Observability"
 description: Langfuse exporter for Tracing
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: LangSmithExporter | Observability | Mastra Docs"
+title: "Reference: LangSmithExporter | Observability"
 description: LangSmith exporter for Tracing
 ---
 

package/.docs/raw/reference/observability/tracing/exporters/otel.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: OtelExporter | Observability | Mastra Docs"
+title: "Reference: OtelExporter | Observability"
 description: OpenTelemetry exporter for Tracing
 ---
 

package/.docs/raw/reference/observability/tracing/instances.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Tracing | Observability | Mastra Docs"
+title: "Reference: Tracing | Observability"
 description: Core Tracing classes and methods
 asIndexPage: true
 ---
@@ -159,7 +159,7 @@ class CustomObservabilityInstance extends BaseObservabilityInstance {
 
 ### Examples
 
-- [Basic Tracing](/examples/v1/observability/basic-tracing) - Getting started example
+- [Basic Tracing](/examples/v1/observability/basic-ai-tracing) - Getting started example
 
 ### Exporters
 

package/.docs/raw/reference/observability/tracing/interfaces.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Interfaces | Observability | Mastra Docs"
+title: "Reference: Interfaces | Observability"
 description: Tracing type definitions and interfaces
 ---
 
@@ -710,4 +710,4 @@ enum InternalSpans {
 
 ### Examples
 
-- [Basic Tracing](/examples/v1/observability/basic-tracing) - Implementation example
+- [Basic Tracing](/examples/v1/observability/basic-ai-tracing) - Implementation example

package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: SensitiveDataFilter | Observability | Mastra Docs"
+title: "Reference: SensitiveDataFilter | Observability"
 description: API reference for the SensitiveDataFilter processor
 ---