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

package/.docs/raw/reference/evals/contextual-recall.mdx

@@ -1,196 +0,0 @@
----
-title: "Reference: ContextualRecallMetric | Evals | Mastra Docs"
-description: Documentation for the Contextual Recall Metric, which evaluates the completeness of LLM responses in incorporating relevant context.
----
-
-# ContextualRecallMetric
-
-:::info Scorers
-This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
-:::
-
-The `ContextualRecallMetric` class evaluates how effectively an LLM's response incorporates all relevant information from the provided context. It measures whether important information from the reference documents was successfully included in the response, focusing on completeness rather than precision.
-
-## Basic Usage
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { ContextualRecallMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new ContextualRecallMetric(model, {
-  context: [
-    "Product features: cloud synchronization capability",
-    "Offline mode available for all users",
-    "Supports multiple devices simultaneously",
-    "End-to-end encryption for all data",
-  ],
-});
-
-const result = await metric.measure(
-  "What are the key features of the product?",
-  "The product includes cloud sync, offline mode, and multi-device support.",
-);
-
-console.log(result.score); // Score from 0-1
-```
-
-## Constructor Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "model",
-      type: "LanguageModel",
-      description:
-        "Configuration for the model used to evaluate contextual recall",
-      isOptional: false,
-    },
-    {
-      name: "options",
-      type: "ContextualRecallMetricOptions",
-      description: "Configuration options for the metric",
-      isOptional: false,
-    },
-  ]}
-/>
-
-### ContextualRecallMetricOptions
-
-<PropertiesTable
-  content={[
-    {
-      name: "scale",
-      type: "number",
-      description: "Maximum score value",
-      isOptional: true,
-      defaultValue: "1",
-    },
-    {
-      name: "context",
-      type: "string[]",
-      description:
-        "Array of reference documents or pieces of information to check against",
-      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: "Recall 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 recall through comparison of response content against relevant context items.
-
-### Scoring Process
-
-1. Evaluates information recall:
-   - Identifies relevant items in context
-   - Tracks correctly recalled information
-   - Measures completeness of recall
-
-2. Calculates recall score:
-   - Counts correctly recalled items
-   - Compares against total relevant items
-   - Computes coverage ratio
-
-Final score: `(correctly_recalled_items / total_relevant_items) * scale`
-
-### Score interpretation
-
-(0 to scale, default 0-1)
-
-- 1.0: Perfect recall - all relevant information included
-- 0.7-0.9: High recall - most relevant information included
-- 0.4-0.6: Moderate recall - some relevant information missed
-- 0.1-0.3: Low recall - significant information missed
-- 0.0: No recall - no relevant information included
-
-## Example with Custom Configuration
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { ContextualRecallMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new ContextualRecallMetric(model, {
-  scale: 100, // Use 0-100 scale instead of 0-1
-  context: [
-    "All data is encrypted at rest and in transit",
-    "Two-factor authentication (2FA) is mandatory",
-    "Regular security audits are performed",
-    "Incident response team available 24/7",
-  ],
-});
-
-const result = await metric.measure(
-  "Summarize the company's security measures",
-  "The company implements encryption for data protection and requires 2FA for all users.",
-);
-
-// Example output:
-// {
-//   score: 50, // Only half of the security measures were mentioned
-//   info: {
-//     reason: "The score is 50 because only half of the security measures were mentioned
-//           in the response. The response missed the regular security audits and incident
-//           response team information."
-//   }
-// }
-```
-
-## Related
-
-- [Context Relevancy Metric](./context-relevancy)
-- [Completeness Metric](./completeness)
-- [Summarization Metric](./summarization)

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

@@ -1,212 +0,0 @@
----
-title: "Reference: SummarizationMetric | Evals | Mastra Docs"
-description: Documentation for the Summarization Metric in Mastra, which evaluates the quality of LLM-generated summaries for content and factual accuracy.
----
-
-# SummarizationMetric
-
-:::info Scorers
-This documentation refers to the legacy evals API. For the latest scorer features, see [Scorers](/docs/scorers/overview).
-:::
-
-The `SummarizationMetric` evaluates how well an LLM's summary captures the original text's content while maintaining factual accuracy. It combines two aspects: alignment (factual correctness) and coverage (inclusion of key information), using the minimum scores to ensure both qualities are necessary for a good summary.
-
-## Basic Usage
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { SummarizationMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new SummarizationMetric(model);
-
-const result = await metric.measure(
-  "The company was founded in 1995 by John Smith. It started with 10 employees and grew to 500 by 2020. The company is based in Seattle.",
-  "Founded in 1995 by John Smith, the company grew from 10 to 500 employees by 2020.",
-);
-
-console.log(result.score); // Score from 0-1
-console.log(result.info); // Object containing detailed metrics about the summary
-```
-
-## Constructor Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "model",
-      type: "LanguageModel",
-      description: "Configuration for the model used to evaluate summaries",
-      isOptional: false,
-    },
-    {
-      name: "options",
-      type: "SummarizationMetricOptions",
-      description: "Configuration options for the metric",
-      isOptional: true,
-      defaultValue: "{ scale: 1 }",
-    },
-  ]}
-/>
-
-### SummarizationMetricOptions
-
-<PropertiesTable
-  content={[
-    {
-      name: "scale",
-      type: "number",
-      description: "Maximum score value",
-      isOptional: true,
-      defaultValue: "1",
-    },
-  ]}
-/>
-
-## measure() Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "input",
-      type: "string",
-      description: "The original text to be summarized",
-      isOptional: false,
-    },
-    {
-      name: "output",
-      type: "string",
-      description: "The generated summary to evaluate",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "score",
-      type: "number",
-      description: "Summarization score (0 to scale, default 0-1)",
-    },
-    {
-      name: "info",
-      type: "object",
-      description: "Object containing detailed metrics about the summary",
-      properties: [
-        {
-          type: "string",
-          parameters: [
-            {
-              name: "reason",
-              type: "string",
-              description:
-                "Detailed explanation of the score, including both alignment and coverage aspects",
-            },
-          ],
-        },
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "alignmentScore",
-              type: "number",
-              description: "Alignment score (0 to 1)",
-            },
-          ],
-        },
-        {
-          type: "number",
-          parameters: [
-            {
-              name: "coverageScore",
-              type: "number",
-              description: "Coverage score (0 to 1)",
-            },
-          ],
-        },
-      ],
-    },
-  ]}
-/>
-
-## Scoring Details
-
-The metric evaluates summaries through two essential components:
-
-1. **Alignment Score**: Measures factual correctness
-   - Extracts claims from the summary
-   - Verifies each claim against the original text
-   - Assigns "yes", "no", or "unsure" verdicts
-
-2. **Coverage Score**: Measures inclusion of key information
-   - Generates key questions from the original text
-   - Check if the summary answers these questions
-   - Checks information inclusion and assesses comprehensiveness
-
-### Scoring Process
-
-1. Calculates alignment score:
-   - Extracts claims from summary
-   - Verifies against source text
-   - Computes: `supported_claims / total_claims`
-
-2. Determines coverage score:
-   - Generates questions from source
-   - Checks summary for answers
-   - Evaluates completeness
-   - Calculates: `answerable_questions / total_questions`
-
-Final score: `min(alignment_score, coverage_score) * scale`
-
-### Score interpretation
-
-(0 to scale, default 0-1)
-
-- 1.0: Perfect summary - completely factual and covers all key information
-- 0.7-0.9: Strong summary with minor omissions or slight inaccuracies
-- 0.4-0.6: Moderate quality with significant gaps or inaccuracies
-- 0.1-0.3: Poor summary with major omissions or factual errors
-- 0.0: Invalid summary - either completely inaccurate or missing critical information
-
-## Example with Analysis
-
-```typescript
-import { openai } from "@ai-sdk/openai";
-import { SummarizationMetric } from "@mastra/evals/llm";
-
-// Configure the model for evaluation
-const model = openai("gpt-4o-mini");
-
-const metric = new SummarizationMetric(model);
-
-const result = await metric.measure(
-  "The electric car company Tesla was founded in 2003 by Martin Eberhard and Marc Tarpenning. Elon Musk joined in 2004 as the largest investor and became CEO in 2008. The company's first car, the Roadster, was launched in 2008.",
-  "Tesla, founded by Elon Musk in 2003, revolutionized the electric car industry starting with the Roadster in 2008.",
-);
-
-// Example output:
-// {
-//   score: 0.5,
-//   info: {
-//     reason: "The score is 0.5 because while the coverage is good (0.75) - mentioning the founding year,
-//           first car model, and launch date - the alignment score is lower (0.5) due to incorrectly
-//           attributing the company's founding to Elon Musk instead of Martin Eberhard and Marc Tarpenning.
-//           The final score takes the minimum of these two scores to ensure both factual accuracy and
-//           coverage are necessary for a good summary."
-//     alignmentScore: 0.5,
-//     coverageScore: 0.75,
-//   }
-// }
-```
-
-## Related
-
-- [Faithfulness Metric](./faithfulness)
-- [Completeness Metric](./completeness)
-- [Contextual Recall Metric](./contextual-recall)
-- [Hallucination Metric](./hallucination)

package/.docs/raw/reference/legacyWorkflows/after.mdx

@@ -1,89 +0,0 @@
----
-title: "Reference: .after() | Legacy Workflows | Mastra Docs"
-description: Documentation for the `after()` method in workflows (legacy), enabling branching and merging paths.
----
-
-# .after()
-
-The `.after()` method defines explicit dependencies between workflow steps, enabling branching and merging paths in your workflow execution.
-
-## Usage
-
-### Basic Branching
-
-```typescript
-workflow
-  .step(stepA)
-  .then(stepB)
-  .after(stepA) // Create new branch after stepA completes
-  .step(stepC);
-```
-
-### Merging Multiple Branches
-
-```typescript
-workflow
-  .step(stepA)
-  .then(stepB)
-  .step(stepC)
-  .then(stepD)
-  .after([stepB, stepD]) // Create a step that depends on multiple steps
-  .step(stepE);
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "steps",
-      type: "Step | Step[]",
-      description:
-        "A single step or array of steps that must complete before continuing",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflow",
-      type: "LegacyWorkflow",
-      description: "The workflow instance for method chaining",
-    },
-  ]}
-/>
-
-## Examples
-
-### Single Dependency
-
-```typescript
-workflow
-  .step(fetchData)
-  .then(processData)
-  .after(fetchData) // Branch after fetchData
-  .step(logData);
-```
-
-### Multiple Dependencies (Merging Branches)
-
-```typescript
-workflow
-  .step(fetchUserData)
-  .then(validateUserData)
-  .step(fetchProductData)
-  .then(validateProductData)
-  .after([validateUserData, validateProductData]) // Wait for both validations to complete
-  .step(processOrder);
-```
-
-## Related
-
-- [Branching Paths example](/examples/workflows_legacy/branching-paths)
-- [Workflow Class Reference](./workflow)
-- [Step Reference](./step-class)
-- [Control Flow Guide](/docs/workflows-legacy/control-flow)

package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx

@@ -1,79 +0,0 @@
----
-title: "Reference: afterEvent() | Legacy Workflows | Mastra Docs"
-description: "Reference for the afterEvent method in Mastra workflows that creates event-based suspension points."
----
-
-# afterEvent()
-
-The `afterEvent()` method creates a suspension point in your workflow that waits for a specific event to occur before continuing execution.
-
-## Syntax
-
-```typescript
-workflow.afterEvent(eventName: string): Workflow
-```
-
-## Parameters
-
-| Parameter | Type   | Description                                                                                              |
-| --------- | ------ | -------------------------------------------------------------------------------------------------------- |
-| eventName | string | The name of the event to wait for. Must match an event defined in the workflow's `events` configuration. |
-
-## Return Value
-
-Returns the workflow instance for method chaining.
-
-## Description
-
-The `afterEvent()` method is used to create an automatic suspension point in your workflow that waits for a specific named event. It's essentially a declarative way to define a point where your workflow should pause and wait for an external event to occur.
-
-When you call `afterEvent()`, Mastra:
-
-1. Creates a special step with ID `__eventName_event`
-2. This step automatically suspends the workflow execution
-3. The workflow remains suspended until the specified event is triggered via `resumeWithEvent()`
-4. When the event occurs, execution continues with the step following the `afterEvent()` call
-
-This method is part of Mastra's event-driven workflow capabilities, allowing you to create workflows that coordinate with external systems or user interactions without manually implementing suspension logic.
-
-## Usage Notes
-
-- The event specified in `afterEvent()` must be defined in the workflow's `events` configuration with a schema
-- The special step created has a predictable ID format: `__eventName_event` (e.g., `__approvalReceived_event`)
-- Any step following `afterEvent()` can access the event data via `context.inputData.resumedEvent`
-- Event data is validated against the schema defined for that event when `resumeWithEvent()` is called
-
-## Examples
-
-### Basic Usage
-
-```typescript
-import { LegacyWorkflow } from "@mastra/core/workflows/legacy";
-
-// Define workflow with events
-const workflow = new LegacyWorkflow({
-  name: "approval-workflow",
-  events: {
-    approval: {
-      schema: z.object({
-        approved: z.boolean(),
-        approverName: z.string(),
-      }),
-    },
-  },
-});
-
-// Build workflow with event suspension point
-workflow
-  .step(submitRequest)
-  .afterEvent("approval") // Workflow suspends here
-  .step(processApproval) // This step runs after the event occurs
-  .commit();
-```
-
-## Related
-
-- [Event-Driven Workflows](./events)
-- [resumeWithEvent()](./resumeWithEvent)
-- [Suspend and Resume](/docs/workflows-legacy/suspend-and-resume)
-- [Workflow Class](./workflow)

package/.docs/raw/reference/legacyWorkflows/commit.mdx

@@ -1,33 +0,0 @@
----
-title: "Reference: Workflow.commit() | Legacy Workflows | Mastra Docs"
-description: Documentation for the `.commit()` method in workflows, which re-initializes the workflow machine with the current step configuration.
----
-
-# Workflow.commit()
-
-The `.commit()` method re-initializes the workflow's state machine with the current step configuration.
-
-## Usage
-
-```typescript
-workflow.step(stepA).then(stepB).commit();
-```
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflow",
-      type: "LegacyWorkflow",
-      description: "The workflow instance",
-    },
-  ]}
-/>
-
-## Related
-
-- [Branching Paths example](/examples/workflows_legacy/branching-paths)
-- [Workflow Class Reference](./workflow)
-- [Step Reference](./step-class)
-- [Control Flow Guide](/docs/workflows-legacy/control-flow)

package/.docs/raw/reference/legacyWorkflows/createRun.mdx

@@ -1,76 +0,0 @@
----
-title: "Reference: Workflow.createRun() | Legacy Workflows | Mastra Docs"
-description: "Documentation for the `.createRun()` method in workflows (legacy), which initializes a new workflow run instance."
----
-
-# Workflow.createRun()
-
-The `.createRun()` method initializes a new workflow run instance. It generates a unique run ID for tracking and returns a start function that begins workflow execution when called.
-
-One reason to use `.createRun()` vs `.execute()` is to get a unique run ID for tracking, logging, or subscribing via `.watch()`.
-
-## Usage
-
-```typescript
-const { runId, start, watch } = workflow.createRun();
-
-const result = await start();
-```
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "runId",
-      type: "string",
-      description: "Unique identifier for tracking this workflow run",
-    },
-    {
-      name: "start",
-      type: "() => Promise<LegacyWorkflowResult>",
-      description: "Function that begins workflow execution when called",
-    },
-    {
-      name: "watch",
-      type: "(callback: (record: LegacyWorkflowResult) => void) => () => void",
-      description:
-        "Function that accepts a callback function that will be called with each transition of the workflow run",
-    },
-    {
-      name: "resume",
-      type: "({stepId: string, context: Record<string, any>}) => Promise<LegacyWorkflowResult>",
-      description:
-        "Function that resumes a workflow run from a given step ID and context",
-    },
-    {
-      name: "resumeWithEvent",
-      type: "(eventName: string, data: any) => Promise<LegacyWorkflowResult>",
-      description:
-        "Function that resumes a workflow run from a given event name and data",
-    },
-  ]}
-/>
-
-## Error Handling
-
-The start function may throw validation errors if the workflow configuration is invalid:
-
-```typescript
-try {
-  const { runId, start, watch, resume, resumeWithEvent } = workflow.createRun();
-  await start({ triggerData: data });
-} catch (error) {
-  if (error instanceof ValidationError) {
-    // Handle validation errors
-    console.log(error.type); // 'circular_dependency' | 'no_terminal_path' | 'unreachable_step'
-    console.log(error.details);
-  }
-}
-```
-
-## Related
-
-- [Workflow Class Reference](./workflow)
-- [Step Class Reference](./step-class)
-- See the [Creating a Workflow](/examples/workflows_legacy/creating-a-workflow) example for complete usage