@mastra/mcp-docs-server 0.13.44 → 0.13.45

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

@@ -0,0 +1,223 @@
+---
+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 = 'custom';
+  readonly name = 'My Custom Gateway';
+
+  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. This ID is used as the prefix for all providers from this gateway (e.g., "netlify/anthropic"). Exception: models.dev is a provider registry and doesn\'t use a prefix.',
+    },
+    {
+      name: 'name',
+      type: 'string',
+      description: 'Human-readable name for the gateway.',
+    },
+  ]}
+/>
+
+## 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
+
+For true gateways, the gateway ID is used as a prefix and models are accessed using this format:
+
+```
+[gateway-id]/[provider]/[model]
+```
+
+Examples:
+- Gateway with `id = 'custom'`: `'custom/my-provider/model-1'`
+
+## Built-in Implementations
+
+- **NetlifyGateway** - Netlify AI Gateway integration
+- **ModelsDevGateway** - Registry of OpenAI-compatible providers
+
+## Related
+
+- [Custom Gateways Guide](/models/gateways/custom-gateways) - Complete guide to creating custom gateways

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

@@ -112,115 +112,45 @@ A relevancy score between 0 and 1:
 - **0.1–0.3**: The response includes minimal relevant content and largely misses the intent of the query.
 - **0.0**: The response is entirely unrelated and does not answer the query.
 
-## Examples
+## Example
 
-### High relevancy example
+Evaluate agent responses for relevancy across different scenarios:
 
-In this example, the response accurately addresses the input query with specific and relevant information.
-
-```typescript title="src/example-high-answer-relevancy.ts" showLineNumbers copy
+```typescript title="src/example-answer-relevancy.ts" showLineNumbers copy
+import { runExperiment } from "@mastra/core/scores";
 import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/llm";
+import { myAgent } from "./agent";
 
-const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o-mini" });
+const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o" });
 
-const inputMessages = [
-  {
-    role: "user",
-    content: "What are the health benefits of regular exercise?",
+const result = await runExperiment({
+  data: [
+    {
+      input: "What are the health benefits of regular exercise?",
+    },
+    {
+      input: "What should a healthy breakfast include?",
+    },
+    {
+      input: "What are the benefits of meditation?",
+    },
+  ],
+  scorers: [scorer],
+  target: myAgent,
+  onItemComplete: ({ scorerResults }) => {
+    console.log({
+      score: scorerResults[scorer.name].score,
+      reason: scorerResults[scorer.name].reason,
+    });
   },
-];
-const outputMessage = {
-  text: "Regular exercise improves cardiovascular health, strengthens muscles, boosts metabolism, and enhances mental well-being through the release of endorphins.",
-};
-
-const result = await scorer.run({
-  input: inputMessages,
-  output: outputMessage,
 });
 
-console.log(result);
+console.log(result.scores);
 ```
 
-#### High relevancy output
-
-The output receives a high score because it accurately answers the query without including unrelated information.
-
-```typescript
-{
-  score: 1,
-  reason: 'The score is 1 because the output directly addresses the question by providing multiple explicit health benefits of regular exercise, including improvements in cardiovascular health, muscle strength, metabolism, and mental well-being. Each point is relevant and contributes to a comprehensive understanding of the health benefits.'
-}
-```
+For more details on `runExperiment`, see the [runExperiment reference](/reference/scorers/run-experiment).
 
-### Partial relevancy example
-
-In this example, the response addresses the query in part but includes additional information that isn’t directly relevant.
-
-```typescript title="src/example-partial-answer-relevancy.ts" showLineNumbers copy
-import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/llm";
-
-const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o-mini" });
-
-const inputMessages = [
-  { role: "user", content: "What should a healthy breakfast include?" },
-];
-const outputMessage = {
-  text: "A nutritious breakfast should include whole grains and protein. However, the timing of your breakfast is just as important - studies show eating within 2 hours of waking optimizes metabolism and energy levels throughout the day.",
-};
-
-const result = await scorer.run({
-  input: inputMessages,
-  output: outputMessage,
-});
-
-console.log(result);
-```
-
-#### Partial relevancy output
-
-The output receives a lower score because it partially answers the query. While some relevant information is included, unrelated details reduce the overall relevance.
-
-```typescript
-{
-  score: 0.25,
-  reason: 'The score is 0.25 because the output provides a direct answer by mentioning whole grains and protein as components of a healthy breakfast, which is relevant. However, the additional information about the timing of breakfast and its effects on metabolism and energy levels is not directly related to the question, leading to a lower overall relevance score.'
-}
-```
-
-## Low relevancy example
-
-In this example, the response does not address the query and contains information that is entirely unrelated.
-
-```typescript title="src/example-low-answer-relevancy.ts" showLineNumbers copy
-import { createAnswerRelevancyScorer } from "@mastra/evals/scorers/llm";
-
-const scorer = createAnswerRelevancyScorer({ model: "openai/gpt-4o-mini" });
-
-const inputMessages = [
-  { role: "user", content: "What are the benefits of meditation?" },
-];
-const outputMessage = {
-  text: "The Great Wall of China is over 13,000 miles long and was built during the Ming Dynasty to protect against invasions.",
-};
-
-const result = await scorer.run({
-  input: inputMessages,
-  output: outputMessage,
-});
-
-console.log(result);
-```
-
-#### Low relevancy output
-
-The output receives a score of 0 because it fails to answer the query or provide any relevant information.
-
-```typescript
-{
-  score: 0,
-  reason: 'The score is 0 because the output about the Great Wall of China is completely unrelated to the benefits of meditation, providing no relevant information or context that addresses the input question.'
-}
-```
+To add this scorer to an agent, see the [Scorers overview](/docs/scorers/overview) guide.
 
 ## Related
 

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

@@ -149,46 +149,16 @@ The scorer uses a multi-step process:
 
 Score calculation: `max(0, base_score - contradiction_penalty - missing_penalty - extra_info_penalty) × scale`
 
-## Examples
+## Example
 
-### Usage with runExperiment
+Evaluate agent responses for similarity to ground truth across different scenarios:
 
-This scorer is designed for use with `runExperiment` for CI/CD testing:
-
-```typescript
-import { runExperiment } from "@mastra/core/scores";
-import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
-
-const scorer = createAnswerSimilarityScorer({ model });
-
-await runExperiment({
-  data: [
-    {
-      input: "What is the capital of France?",
-      groundTruth: "Paris is the capital of France",
-    },
-  ],
-  scorers: [scorer],
-  target: myAgent,
-  onItemComplete: ({ scorerResults }) => {
-    // Assert similarity score meets threshold
-    expect(scorerResults["Answer Similarity Scorer"].score).toBeGreaterThan(
-      0.8,
-    );
-  },
-});
-```
-
-### Perfect similarity example
-
-In this example, the agent's output semantically matches the ground truth perfectly.
-
-```typescript title="src/example-perfect-similarity.ts" showLineNumbers copy
+```typescript title="src/example-answer-similarity.ts" showLineNumbers copy
 import { runExperiment } from "@mastra/core/scores";
 import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
 import { myAgent } from "./agent";
 
-const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o-mini" });
+const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o" });
 
 const result = await runExperiment({
   data: [
@@ -196,78 +166,10 @@ const result = await runExperiment({
       input: "What is 2+2?",
       groundTruth: "4",
     },
-  ],
-  scorers: [scorer],
-  target: myAgent,
-});
-
-console.log(result.scores);
-```
-
-#### Perfect similarity output
-
-The output receives a perfect score because both the agent's answer and ground truth are identical.
-
-```typescript
-{
-  "Answer Similarity Scorer": {
-    score: 1.0,
-    reason: "The score is 1.0/1 because the output matches the ground truth exactly. The agent correctly provided the numerical answer. No improvements needed as the response is fully accurate."
-  }
-}
-```
-
-### High semantic similarity example
-
-In this example, the agent provides the same information as the ground truth but with different phrasing.
-
-```typescript title="src/example-semantic-similarity.ts" showLineNumbers copy
-import { runExperiment } from "@mastra/core/scores";
-import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
-import { myAgent } from "./agent";
-
-const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o-mini" });
-
-const result = await runExperiment({
-  data: [
     {
       input: "What is the capital of France?",
       groundTruth: "The capital of France is Paris",
     },
-  ],
-  scorers: [scorer],
-  target: myAgent,
-});
-
-console.log(result.scores);
-```
-
-#### High semantic similarity output
-
-The output receives a high score because it conveys the same information with equivalent meaning.
-
-```typescript
-{
-  "Answer Similarity Scorer": {
-    score: 0.9,
-    reason: "The score is 0.9/1 because both answers convey the same information about Paris being the capital of France. The agent correctly identified the main fact with slightly different phrasing. Minor variation in structure but semantically equivalent."
-  }
-}
-```
-
-### Partial similarity example
-
-In this example, the agent's response is partially correct but missing key information.
-
-```typescript title="src/example-partial-similarity.ts" showLineNumbers copy
-import { runExperiment } from "@mastra/core/scores";
-import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
-import { myAgent } from "./agent";
-
-const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o-mini" });
-
-const result = await runExperiment({
-  data: [
     {
       input: "What are the primary colors?",
       groundTruth: "The primary colors are red, blue, and yellow",
@@ -275,165 +177,17 @@ const result = await runExperiment({
   ],
   scorers: [scorer],
   target: myAgent,
-});
-
-console.log(result.scores);
-```
-
-#### Partial similarity output
-
-The output receives a moderate score because it includes some correct information but is incomplete.
-
-```typescript
-{
-  "Answer Similarity Scorer": {
-    score: 0.6,
-    reason: "The score is 0.6/1 because the answer captures some key elements but is incomplete. The agent correctly identified red and blue as primary colors. However, it missed the critical color yellow, which is essential for a complete answer."
-  }
-}
-```
-
-### Contradiction example
-
-In this example, the agent provides factually incorrect information that contradicts the ground truth.
-
-```typescript title="src/example-contradiction.ts" showLineNumbers copy
-import { runExperiment } from "@mastra/core/scores";
-import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
-import { myAgent } from "./agent";
-
-const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o-mini" });
-
-const result = await runExperiment({
-  data: [
-    {
-      input: "Who wrote Romeo and Juliet?",
-      groundTruth: "William Shakespeare wrote Romeo and Juliet",
-    },
-  ],
-  scorers: [scorer],
-  target: myAgent,
-});
-
-console.log(result.scores);
-```
-
-#### Contradiction output
-
-The output receives a very low score because it contains factually incorrect information.
-
-```typescript
-{
-  "Answer Similarity Scorer": {
-    score: 0.0,
-    reason: "The score is 0.0/1 because the output contains a critical error regarding authorship. The agent correctly identified the play title but incorrectly attributed it to Christopher Marlowe instead of William Shakespeare, which is a fundamental contradiction."
-  }
-}
-```
-
-### CI/CD Integration example
-
-Use the scorer in your test suites to ensure agent consistency over time:
-
-```typescript title="src/ci-integration.test.ts" showLineNumbers copy
-import { describe, it, expect } from "vitest";
-import { runExperiment } from "@mastra/core/scores";
-import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
-import { myAgent } from "./agent";
-
-describe("Agent Consistency Tests", () => {
-  const scorer = createAnswerSimilarityScorer({ model: "openai/gpt-4o-mini" });
-
-  it("should provide accurate factual answers", async () => {
-    const result = await runExperiment({
-      data: [
-        {
-          input: "What is the speed of light?",
-          groundTruth:
-            "The speed of light in vacuum is 299,792,458 meters per second",
-        },
-        {
-          input: "What is the capital of Japan?",
-          groundTruth: "Tokyo is the capital of Japan",
-        },
-      ],
-      scorers: [scorer],
-      target: myAgent,
+  onItemComplete: ({ scorerResults }) => {
+    console.log({ 
+      score: scorerResults[scorer.name].score,
+      reason: scorerResults[scorer.name].reason,
     });
-
-    // Assert all answers meet similarity threshold
-    expect(result.scores["Answer Similarity Scorer"].score).toBeGreaterThan(
-      0.8,
-    );
-  });
-
-  it("should maintain consistency across runs", async () => {
-    const testData = {
-      input: "Define machine learning",
-      groundTruth:
-        "Machine learning is a subset of AI that enables systems to learn and improve from experience",
-    };
-
-    // Run multiple times to check consistency
-    const results = await Promise.all([
-      runExperiment({ data: [testData], scorers: [scorer], target: myAgent }),
-      runExperiment({ data: [testData], scorers: [scorer], target: myAgent }),
-      runExperiment({ data: [testData], scorers: [scorer], target: myAgent }),
-    ]);
-
-    // Check that all runs produce similar scores (within 0.1 tolerance)
-    const scores = results.map(
-      (r) => r.scores["Answer Similarity Scorer"].score,
-    );
-    const maxDiff = Math.max(...scores) - Math.min(...scores);
-    expect(maxDiff).toBeLessThan(0.1);
-  });
-});
-```
-
-### Custom configuration example
-
-Customize the scorer behavior for specific use cases:
-
-```typescript title="src/custom-config.ts" showLineNumbers copy
-import { runExperiment } from "@mastra/core/scores";
-import { createAnswerSimilarityScorer } from "@mastra/evals/scorers/llm";
-import { myAgent } from "./agent";
-
-// Configure for strict exact matching with high scale
-const strictScorer = createAnswerSimilarityScorer({
-  model: "openai/gpt-4o-mini",
-  options: {
-    exactMatchBonus: 0.5, // Higher bonus for exact matches
-    contradictionPenalty: 2.0, // Very strict on contradictions
-    missingPenalty: 0.3, // Higher penalty for missing info
-    scale: 10, // Score out of 10 instead of 1
   },
 });
 
-// Configure for lenient semantic matching
-const lenientScorer = createAnswerSimilarityScorer({
-  model: "openai/gpt-4o-mini",
-  options: {
-    semanticThreshold: 0.6, // Lower threshold for semantic matches
-    contradictionPenalty: 0.5, // More forgiving on minor contradictions
-    extraInfoPenalty: 0, // No penalty for extra information
-    requireGroundTruth: false, // Allow missing ground truth
-  },
-});
+console.log(result.scores);
+```
 
-const result = await runExperiment({
-  data: [
-    {
-      input: "Explain photosynthesis",
-      groundTruth:
-        "Photosynthesis is the process by which plants convert light energy into chemical energy",
-    },
-  ],
-  scorers: [strictScorer, lenientScorer],
-  target: myAgent,
-});
+For more details on `runExperiment`, see the [runExperiment reference](/reference/scorers/run-experiment).
 
-console.log("Strict scorer:", result.scores["Answer Similarity Scorer"].score); // Out of 10
-console.log("Lenient scorer:", result.scores["Answer Similarity Scorer"].score); // Out of 1
-```
+To add this scorer to an agent, see the [Scorers overview](/docs/scorers/overview#adding-scorers-to-agents) guide.