@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.0

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

@@ -1,78 +0,0 @@
----
-title: "Reference: getScorerByName() | Core | Mastra Docs"
-description: "Documentation for the `getScorerByName()` method in Mastra, which retrieves a scorer by its name property rather than registration key."
----
-
-# getScorerByName()
-
-The `getScorerByName()` method retrieves a scorer by searching for its `name` property rather than the registration key. This is useful when you know the scorer's display name but not necessarily how it was registered in the Mastra instance.
-
-## Usage Example
-
-```typescript
-import { mastra } from "./mastra";
-
-// Get a scorer by its name property
-const relevancyScorer = mastra.getScorerByName("Answer Relevancy");
-
-const weatherAgent = mastra.getAgent("weatherAgent");
-
-// Use the scorer to evaluate an AI output
-await weatherAgent.generate("What is the weather in Rome", {
-  scorers: {
-    answerRelevancy: {
-      scorer: relevancyScorer,
-    },
-  },
-});
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "name",
-      type: "string",
-      description:
-        "The name property of the scorer to retrieve. This should match the 'name' field specified when creating the scorer with createScorer().",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "scorer",
-      type: "MastraScorer",
-      description:
-        "The MastraScorer instance that has the matching name property.",
-    },
-  ]}
-/>
-
-## Error Handling
-
-This method throws a `MastraError` if:
-
-- No scorer with the specified name is found
-- No scorers are registered with the Mastra instance
-
-```typescript
-try {
-  const scorer = mastra.getScorerByName("Non-existent Scorer");
-} catch (error) {
-  if (error.id === "MASTRA_GET_SCORER_BY_NAME_NOT_FOUND") {
-    console.log("Scorer with that name not found");
-  }
-}
-```
-
-## Related
-
-- [getScorer()](../../reference/core/getScorer) - Get a scorer by its registration key
-- [listScorers()](../../reference/core/listScorers) - Get all registered scorers
-- [createScorer()](../../reference/scorers/create-scorer) - Learn how to create scorers with names

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

@@ -1,43 +0,0 @@
----
-title: "Reference: getScorers() | Core | Mastra Docs"
-description: "Documentation for the `getScorers()` method in Mastra, which returns all registered scorers for evaluating AI outputs."
----
-
-# getScorers()
-
-The `getScorers()` method returns all scorers that have been registered with the Mastra instance. Scorers are used for evaluating AI outputs and can override default scorers during agent generation or workflow execution.
-
-## Usage Example
-
-```typescript
-import { mastra } from "./mastra";
-
-// Get all registered scorers
-const allScorers = mastra.getScorers();
-
-// Access a specific scorer
-const myScorer = allScorers.relevancyScorer;
-```
-
-## Parameters
-
-This method takes no parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "scorers",
-      type: "Record<string, MastraScorer> | undefined",
-      description:
-        "An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.",
-    },
-  ]}
-/>
-
-## Related
-
-- [getScorer()](../../reference/core/getScorer) - Get a specific scorer by key
-- [getScorerByName()](../../reference/core/getScorerByName) - Get a scorer by its name property
-- [Scorers Overview](../../docs/scorers/overview) - Learn about creating and using scorers

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

@@ -1,36 +0,0 @@
----
-title: "Reference: Mastra.getVectors() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getVectors()` method in Mastra, which retrieves all configured vector stores."
----
-
-# Mastra.getVectors()
-
-The `.getVectors()` method is used to retrieve all vector stores that have been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getVectors();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "vectors",
-      type: "TVectors",
-      description:
-        "A record of all configured vector stores, where keys are vector store names and values are vector store instances.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Vector stores overview](/docs/rag/vector-databases)
-- [RAG overview](/docs/rag/overview)

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

@@ -1,45 +0,0 @@
----
-title: "Reference: Mastra.getWorkflows() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getWorkflows()` method in Mastra, which retrieves all configured workflows."
----
-
-# Mastra.getWorkflows()
-
-The `.getWorkflows()` method is used to retrieve all workflows that have been configured in the Mastra instance. The method accepts an optional options object.
-
-## Usage example
-
-```typescript copy
-mastra.getWorkflows();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ serialized?: boolean }",
-      description:
-        "Optional configuration object. When `serialized` is true, returns simplified workflow objects with only the name property instead of full workflow instances.",
-      optional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflows",
-      type: "Record<string, Workflow>",
-      description:
-        "A record of all configured workflows, where keys are workflow IDs and values are workflow instances (or simplified objects if serialized is true).",
-    },
-  ]}
-/>
-
-## Related
-
-- [Workflows overview](/docs/workflows/overview)

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

@@ -1,197 +0,0 @@
----
-title: "Reference: ContextPositionMetric | Evals | Mastra Docs"
-description: Documentation for the Context Position Metric in Mastra, which evaluates the ordering of context nodes based on their relevance to the query and output.
----
-
-# ContextPositionMetric
-
-:::info Scorers
-This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
-:::
-
-The `ContextPositionMetric` class evaluates how well context nodes are ordered based on their relevance to the query and output. It uses position-weighted scoring to emphasize the importance of having the most relevant context pieces appear earlier in the sequence.
-
-## Basic Usage
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { ContextPositionMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new ContextPositionMetric(model, {
-  context: [
-    "Photosynthesis is a biological process used by plants to create energy from sunlight.",
-    "The process of photosynthesis produces oxygen as a byproduct.",
-    "Plants need water and nutrients from the soil to grow.",
-  ],
-});
-
-const result = await metric.measure(
-  "What is photosynthesis?",
-  "Photosynthesis is the process by which plants convert sunlight into energy.",
-);
-
-console.log(result.score); // Position score from 0-1
-console.log(result.info.reason); // Explanation of the score
-```
-
-## Constructor Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "model",
-      type: "ModelConfig",
-      description:
-        "Configuration for the model used to evaluate context positioning",
-      isOptional: false,
-    },
-    {
-      name: "options",
-      type: "ContextPositionMetricOptions",
-      description: "Configuration options for the metric",
-      isOptional: false,
-    },
-  ]}
-/>
-
-### ContextPositionMetricOptions
-
-<PropertiesTable
-  content={[
-    {
-      name: "scale",
-      type: "number",
-      description: "Maximum score value",
-      isOptional: true,
-      defaultValue: "1",
-    },
-    {
-      name: "context",
-      type: "string[]",
-      description: "Array of context pieces in their retrieval order",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## measure() Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "input",
-      type: "string",
-      description: "The original query or prompt",
-      isOptional: false,
-    },
-    {
-      name: "output",
-      type: "string",
-      description: "The generated response to evaluate",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "score",
-      type: "number",
-      description: "Position score (0 to scale, default 0-1)",
-    },
-    {
-      name: "info",
-      type: "object",
-      description: "Object containing the reason for the score",
-      properties: [
-        {
-          type: "string",
-          parameters: [
-            {
-              name: "reason",
-              type: "string",
-              description: "Detailed explanation of the score",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-## Scoring Details
-
-The metric evaluates context positioning through binary relevance assessment and position-based weighting.
-
-### Scoring Process
-
-1. Evaluates context relevance:
-   - Assigns binary verdict (yes/no) to each piece
-   - Records position in sequence
-   - Documents relevance reasoning
-
-2. Applies position weights:
-   - Earlier positions weighted more heavily (weight = 1/(position + 1))
-   - Sums weights of relevant pieces
-   - Normalizes by maximum possible score
-
-Final score: `(weighted_sum / max_possible_sum) * scale`
-
-### Score interpretation
-
-(0 to scale, default 0-1)
-
-- 1.0: Optimal - most relevant context first
-- 0.7-0.9: Good - relevant context mostly early
-- 0.4-0.6: Mixed - relevant context scattered
-- 0.1-0.3: Suboptimal - relevant context mostly later
-- 0.0: Poor ordering - relevant context at end or missing
-
-## Example with Analysis
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { ContextPositionMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new ContextPositionMetric(model, {
-  context: [
-    "A balanced diet is important for health.",
-    "Exercise strengthens the heart and improves blood circulation.",
-    "Regular physical activity reduces stress and anxiety.",
-    "Exercise equipment can be expensive.",
-  ],
-});
-
-const result = await metric.measure(
-  "What are the benefits of exercise?",
-  "Regular exercise improves cardiovascular health and mental wellbeing.",
-);
-
-// Example output:
-// {
-//   score: 0.5,
-//   info: {
-//     reason: "The score is 0.5 because while the second and third contexts are highly
-//           relevant to the benefits of exercise, they are not optimally positioned at
-//           the beginning of the sequence. The first and last contexts are not relevant
-//           to the query, which impacts the position-weighted scoring."
-//   }
-// }
-```
-
-## Related
-
-- [Context Precision Metric](./context-precision)
-- [Answer Relevancy Metric](./answer-relevancy)
-- [Completeness Metric](./completeness)
-
-* [Context Relevancy Metric](./context-relevancy)

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

@@ -1,196 +0,0 @@
----
-title: "Reference: ContextRelevancyMetric | Evals | Mastra Docs"
-description: Documentation for the Context Relevancy Metric, which evaluates the relevance of retrieved context in RAG pipelines.
----
-
-# ContextRelevancyMetric
-
-:::info Scorers
-This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
-:::
-
-The `ContextRelevancyMetric` class evaluates the quality of your RAG (Retrieval-Augmented Generation) pipeline's retriever by measuring how relevant the retrieved context is to the input query. It uses an LLM-based evaluation system that first extracts statements from the context and then assesses their relevance to the input.
-
-## Basic Usage
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { ContextRelevancyMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new ContextRelevancyMetric(model, {
-  context: [
-    "All data is encrypted at rest and in transit",
-    "Two-factor authentication is mandatory",
-    "The platform supports multiple languages",
-    "Our offices are located in San Francisco",
-  ],
-});
-
-const result = await metric.measure(
-  "What are our product's security features?",
-  "Our product uses encryption and requires 2FA.",
-);
-
-console.log(result.score); // Score from 0-1
-console.log(result.info.reason); // Explanation of the relevancy assessment
-```
-
-## Constructor Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "model",
-      type: "LanguageModel",
-      description:
-        "Configuration for the model used to evaluate context relevancy",
-      isOptional: false,
-    },
-    {
-      name: "options",
-      type: "ContextRelevancyMetricOptions",
-      description: "Configuration options for the metric",
-      isOptional: false,
-    },
-  ]}
-/>
-
-### ContextRelevancyMetricOptions
-
-<PropertiesTable
-  content={[
-    {
-      name: "scale",
-      type: "number",
-      description: "Maximum score value",
-      isOptional: true,
-      defaultValue: "1",
-    },
-    {
-      name: "context",
-      type: "string[]",
-      description:
-        "Array of retrieved context documents used to generate the response",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## measure() Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "input",
-      type: "string",
-      description: "The original query or prompt",
-      isOptional: false,
-    },
-    {
-      name: "output",
-      type: "string",
-      description: "The LLM's response to evaluate",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "score",
-      type: "number",
-      description: "Context relevancy score (0 to scale, default 0-1)",
-    },
-    {
-      name: "info",
-      type: "object",
-      description: "Object containing the reason for the score",
-      properties: [
-        {
-          type: "string",
-          parameters: [
-            {
-              name: "reason",
-              type: "string",
-              description: "Detailed explanation of the relevancy assessment",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-## Scoring Details
-
-The metric evaluates how well retrieved context matches the query through binary relevance classification.
-
-### Scoring Process
-
-1. Extracts statements from context:
-   - Breaks down context into meaningful units
-   - Preserves semantic relationships
-
-2. Evaluates statement relevance:
-   - Assesses each statement against query
-   - Counts relevant statements
-   - Calculates relevance ratio
-
-Final score: `(relevant_statements / total_statements) * scale`
-
-### Score interpretation
-
-(0 to scale, default 0-1)
-
-- 1.0: Perfect relevancy - all retrieved context is relevant
-- 0.7-0.9: High relevancy - most context is relevant with few irrelevant pieces
-- 0.4-0.6: Moderate relevancy - a mix of relevant and irrelevant context
-- 0.1-0.3: Low relevancy - mostly irrelevant context
-- 0.0: No relevancy - completely irrelevant context
-
-## Example with Custom Configuration
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { ContextRelevancyMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new ContextRelevancyMetric(model, {
-  scale: 100, // Use 0-100 scale instead of 0-1
-  context: [
-    "Basic plan costs $10/month",
-    "Pro plan includes advanced features at $30/month",
-    "Enterprise plan has custom pricing",
-    "Our company was founded in 2020",
-    "We have offices worldwide",
-  ],
-});
-
-const result = await metric.measure(
-  "What are our pricing plans?",
-  "We offer Basic, Pro, and Enterprise plans.",
-);
-
-// Example output:
-// {
-//   score: 60,
-//   info: {
-//     reason: "3 out of 5 statements are relevant to pricing plans. The statements about
-//           company founding and office locations are not relevant to the pricing query."
-//   }
-// }
-```
-
-## Related
-
-- [Contextual Recall Metric](./contextual-recall)
-- [Context Precision Metric](./context-precision)
-- [Context Position Metric](./context-position)