@mastra/mcp-docs-server 1.1.9-alpha.0 → 1.1.9-alpha.2

package/.docs/reference/client-js/workflows.md

@@ -2,7 +2,7 @@
 
 The Workflows API provides methods to interact with and execute automated workflows in Mastra.
 
-## Getting All Workflows
+## Getting all workflows
 
 Retrieve a list of all available workflows:
 
@@ -10,7 +10,7 @@ Retrieve a list of all available workflows:
 const workflows = await mastraClient.listWorkflows()
 ```
 
-## Working with a Specific Workflow
+## Working with a specific workflow
 
 Get an instance of a specific workflow by its ID:
 
@@ -24,9 +24,9 @@ export const testWorkflow = createWorkflow({
 const workflow = mastraClient.getWorkflow('city-workflow')
 ```
 
-## Workflow Methods
+## Workflow methods
 
-### details()
+### `details()`
 
 Retrieve detailed information about a workflow:
 
@@ -34,7 +34,7 @@ Retrieve detailed information about a workflow:
 const details = await workflow.details()
 ```
 
-### createRun()
+### `createRun()`
 
 Create a new workflow run instance:
 
@@ -53,7 +53,7 @@ const run = await workflow.createRun({
 
 The `resourceId` parameter associates the workflow run with a specific resource (e.g., user ID, tenant ID). This value is persisted with the run and can be used for filtering and querying runs later.
 
-### startAsync()
+### `startAsync()`
 
 Start a workflow run and await the full result:
 
@@ -95,7 +95,7 @@ const result = await run.startAsync({
 })
 ```
 
-### start()
+### `start()`
 
 Start a workflow run without waiting for completion:
 
@@ -114,7 +114,7 @@ const result = await workflow.runById(run.runId)
 
 This is useful for long-running workflows where you want to start execution and check results later.
 
-### resumeAsync()
+### `resumeAsync()`
 
 Resume a suspended workflow step and await the full result:
 
@@ -127,7 +127,7 @@ const result = await run.resumeAsync({
 })
 ```
 
-### resume()
+### `resume()`
 
 Resume a suspended workflow step without waiting for completion:
 
@@ -140,7 +140,7 @@ await run.resume({
 })
 ```
 
-### cancel()
+### `cancel()`
 
 Cancel a running workflow:
 
@@ -155,7 +155,7 @@ This method stops any running steps and prevents subsequent steps from executing
 
 See the [Run.cancel()](https://mastra.ai/reference/workflows/run-methods/cancel) reference for detailed information about how cancellation works and how to write steps that respond to cancellation.
 
-### stream()
+### `stream()`
 
 Stream workflow execution for real-time updates:
 
@@ -173,7 +173,7 @@ for await (const chunk of stream) {
 }
 ```
 
-### runById()
+### `runById()`
 
 Get the execution result for a workflow run:
 

package/.docs/reference/core/getGatewayById.md

@@ -18,7 +18,7 @@ const gateway = mastra.getGatewayById('my-custom-gateway')
 console.log(gateway.name) // 'My Custom Gateway'
 ```
 
-## Use Cases
+## Use cases
 
 - Gateway versioning: Different versions with unique IDs (`'gateway-v1'`, `'gateway-v2'`)
 - Finding gateways when registration keys are unknown

package/.docs/reference/core/getMCPServer.md

@@ -36,12 +36,12 @@ const serverById = mastra.getMCPServerById('my-mcp-server')
 
 **server** (`MCPServerBase | undefined`): The MCP server instance with the specified registry key, or undefined if not found.
 
-## Related Methods
+## Related methods
 
 - [Mastra.getMCPServerById()](https://mastra.ai/reference/core/getMCPServerById) - Retrieve an MCP server by its intrinsic `id` property
 - [Mastra.listMCPServers()](https://mastra.ai/reference/core/listMCPServers) - List all registered MCP servers
 
-## See Also
+## See also
 
 - [MCP overview](https://mastra.ai/docs/mcp/overview)
 - [MCP server reference](https://mastra.ai/reference/tools/mcp-server)

package/.docs/reference/core/getMCPServerById.md

@@ -44,12 +44,12 @@ const serverByKey = mastra.getMCPServer('customKey')
 - If multiple servers have the same `id` but different versions, you must provide the `version` parameter to disambiguate
 - If no `version` is provided and multiple versions exist, the method returns the first match
 
-## Related Methods
+## Related methods
 
 - [Mastra.getMCPServer()](https://mastra.ai/reference/core/getMCPServer) - Retrieve an MCP server by its registry key
 - [Mastra.listMCPServers()](https://mastra.ai/reference/core/listMCPServers) - List all registered MCP servers
 
-## See Also
+## See also
 
 - [MCP overview](https://mastra.ai/docs/mcp/overview)
 - [MCP server reference](https://mastra.ai/reference/tools/mcp-server)

package/.docs/reference/core/getMemory.md

@@ -22,7 +22,7 @@ const thread = await memory.createThread({
 
 **memory** (`TMemory[TMemoryKey]`): The memory instance with the specified key. Throws an error if the memory is not found.
 
-## Example: Registering and Retrieving Memory
+## Example: Registering and retrieving memory
 
 ```typescript
 import { Mastra } from '@mastra/core'

package/.docs/reference/core/getScorer.md

@@ -2,7 +2,7 @@
 
 The `getScorer()` method retrieves a specific scorer that was registered with the Mastra instance using its registration key. This method provides type-safe access to scorers and throws an error if the requested scorer isn't found.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { mastra } from './mastra'
@@ -30,7 +30,7 @@ await weatherAgent.generate('What is the weather in Rome', {
 
 **scorer** (`MastraScorer`): The MastraScorer instance associated with the provided key.
 
-## Error Handling
+## Error handling
 
 This method throws a `MastraError` if:
 

package/.docs/reference/core/getScorerById.md

@@ -2,7 +2,7 @@
 
 The `getScorerById()` method retrieves a scorer by searching for its `id` property (or `name` property as a fallback) rather than the registration key. This is useful when you know the scorer's id but not necessarily how it was registered in the Mastra instance.
 
-## Usage Example
+## Usage example
 
 ```typescript
 import { mastra } from './mastra'
@@ -30,7 +30,7 @@ await weatherAgent.generate('What is the weather in Rome', {
 
 **scorer** (`MastraScorer`): The MastraScorer instance that has the matching id (or name) property.
 
-## Error Handling
+## Error handling
 
 This method throws a `MastraError` if:
 

package/.docs/reference/core/getStoredAgentById.md

@@ -36,7 +36,7 @@ if (storedConfig) {
 
 **result** (`Agent | StorageAgentType | null`): Returns an \`Agent\` instance by default, or \`StorageAgentType\` when \`raw: true\`. Returns \`null\` if no agent with the given ID exists.
 
-## Primitive Resolution
+## Primitive resolution
 
 When creating an `Agent` instance from stored configuration, the method resolves references to registered primitives:
 
@@ -48,7 +48,7 @@ When creating an `Agent` instance from stored configuration, the method resolves
 
 If a referenced primitive isn't found in the registry, a warning is logged but the agent is still created.
 
-## StorageAgentType
+## `StorageAgentType`
 
 When using `raw: true`, the returned object has the following structure:
 

package/.docs/reference/core/listMCPServers.md

@@ -44,12 +44,12 @@ This method doesn't accept any parameters.
 
 **servers** (`Record<string, MCPServerBase> | undefined`): A record of all registered MCP server instances, where keys are the registry keys (from mcpServers configuration) and values are MCPServerBase instances, or undefined if no servers are registered.
 
-## Related Methods
+## Related methods
 
 - [Mastra.getMCPServer()](https://mastra.ai/reference/core/getMCPServer) - Retrieve an MCP server by its registry key
 - [Mastra.getMCPServerById()](https://mastra.ai/reference/core/getMCPServerById) - Retrieve an MCP server by its intrinsic `id` property
 
-## See Also
+## See also
 
 - [MCP overview](https://mastra.ai/docs/mcp/overview)
 - [MCP server reference](https://mastra.ai/reference/tools/mcp-server)

package/.docs/reference/core/listMemory.md

@@ -20,7 +20,7 @@ This method takes no parameters.
 
 **memory** (`Record<string, MastraMemory>`): An object containing all registered memory instances, keyed by their registry keys.
 
-## Example: Checking Registered Memory
+## Example: Checking registered memory
 
 ```typescript
 import { Mastra } from '@mastra/core'

package/.docs/reference/core/listScorers.md

@@ -2,7 +2,7 @@
 
 The `listScorers()` 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
+## Usage example
 
 ```typescript
 import { mastra } from './mastra'

package/.docs/reference/core/listStoredAgents.md

@@ -53,7 +53,7 @@ for (const config of result.agents) {
 
 **hasMore** (`boolean`): Whether there are more pages available.
 
-## Primitive Resolution
+## Primitive resolution
 
 When creating `Agent` instances (default behavior), each stored agent's configuration is resolved against registered primitives:
 
@@ -65,7 +65,7 @@ When creating `Agent` instances (default behavior), each stored agent's configur
 
 If a referenced primitive isn't found, a warning is logged but the agent is still created.
 
-## Example: Iterating Through All Stored Agents
+## Example: Iterating through all stored agents
 
 ```typescript
 async function getAllStoredAgents(mastra: Mastra) {

package/.docs/reference/core/mastra-class.md

@@ -1,4 +1,4 @@
-# Mastra Class
+# Mastra class
 
 The `Mastra` class is the central orchestrator in any Mastra application, managing agents, workflows, storage, logging, observability, and more. Typically, you create a single instance of `Mastra` to coordinate your application.
 

package/.docs/reference/core/mastra-model-gateway.md

@@ -2,7 +2,7 @@
 
 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
+## Class overview
 
 ```typescript
 import { MastraModelGateway, type ProviderConfig } from '@mastra/core/llm'
@@ -53,15 +53,15 @@ class MyCustomGateway extends MastraModelGateway {
 }
 ```
 
-## Required Properties
+## Required properties
 
 **id** (`string`): 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** (`string`): Human-readable name for the gateway.
 
-## Required Methods
+## Required methods
 
-### fetchProviders()
+### `fetchProviders()`
 
 Fetches provider configurations from the gateway.
 
@@ -83,7 +83,7 @@ Fetches provider configurations from the gateway.
 
 **docUrl** (`string`): Optional documentation URL
 
-### buildUrl()
+### `buildUrl()`
 
 Builds the API URL for a specific model/provider combination.
 
@@ -95,7 +95,7 @@ Builds the API URL for a specific model/provider combination.
 
 **Returns:** `string | undefined | Promise<string | undefined>`
 
-### getApiKey()
+### `getApiKey()`
 
 Retrieves the API key for authentication.
 
@@ -105,7 +105,7 @@ Retrieves the API key for authentication.
 
 **Returns:** `Promise<string>`
 
-### resolveLanguageModel()
+### `resolveLanguageModel()`
 
 Creates a language model instance.
 
@@ -119,15 +119,15 @@ Creates a language model instance.
 
 **Returns:** `Promise<LanguageModelV2> | LanguageModelV2`
 
-## Instance Methods
+## Instance methods
 
-### getId()
+### `getId()`
 
 Returns the gateway's unique identifier.
 
 **Returns:** `string` - The gateway's `id` property
 
-## Model ID Format
+## Model ID format
 
 For true gateways, the gateway ID is used as a prefix and models are accessed using this format:
 
@@ -139,7 +139,7 @@ Examples:
 
 - Gateway with `id = 'custom'`: `'custom/my-provider/model-1'`
 
-## Built-in Implementations
+## Built-in implementations
 
 - **NetlifyGateway** - Netlify AI Gateway integration
 - **ModelsDevGateway** - Registry of OpenAI-compatible providers

package/.docs/reference/datasets/dataset.md

@@ -1,4 +1,4 @@
-# Dataset Class
+# Dataset class
 
 **Added in:** `@mastra/core@1.4.0`
 

package/.docs/reference/deployer.md

@@ -2,7 +2,7 @@
 
 The Deployer handles the deployment of standalone Mastra applications by packaging code, managing environment files, and serving applications using the Hono framework. Concrete implementations must define the deploy method for specific deployment targets.
 
-## Usage Example
+## Usage example
 
 If you want to create a custom deployer, you can extend the abstract `Deployer` class and implement the `deploy` method with your specific deployment logic. Here's an example:
 
@@ -28,7 +28,7 @@ class CustomDeployer extends Deployer {
 
 ## Parameters
 
-### Constructor Parameters
+### Constructor parameters
 
 **args** (`object`): Configuration options for the Deployer.
 
@@ -44,7 +44,7 @@ class CustomDeployer extends Deployer {
 
 **deploy** (`(outputDirectory: string) => Promise<void>`): Abstract method that must be implemented by subclasses. Handles the deployment process to the specified output directory.
 
-## Inherited Methods from Bundler
+## Inherited methods from bundler
 
 The Deployer class inherits the following key methods from the Bundler class:
 
@@ -54,7 +54,7 @@ The Deployer class inherits the following key methods from the Bundler class:
 
 **\_bundle** (`(serverFile: string, mastraEntryFile: string, outputDirectory: string, bundleLocation?: string) => Promise<void>`): Bundles the application using the specified server and Mastra entry files.
 
-## Core Concepts
+## Core concepts
 
 ### Deployment Lifecycle
 

package/.docs/reference/evals/answer-relevancy.md

@@ -1,4 +1,4 @@
-# Answer Relevancy Scorer
+# Answer relevancy scorer
 
 The `createAnswerRelevancyScorer()` function accepts a single options object with the following properties:
 
@@ -12,7 +12,7 @@ The `createAnswerRelevancyScorer()` function accepts a single options object wit
 
 This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
 
-## .run() Returns
+## `.run()` returns
 
 **runId** (`string`): The id of the run (optional).
 
@@ -30,7 +30,7 @@ This function returns an instance of the MastraScorer class. The `.run()` method
 
 **reason** (`string`): Explanation of the score.
 
-## Scoring Details
+## Scoring details
 
 The scorer evaluates relevancy through query-answer alignment, considering completeness and detail level, but not factual correctness.
 

package/.docs/reference/evals/answer-similarity.md

@@ -1,4 +1,4 @@
-# Answer Similarity Scorer
+# Answer similarity scorer
 
 The `createAnswerSimilarityScorer()` function creates a scorer that evaluates how similar an agent's output is to a ground truth answer. This scorer is specifically designed for CI/CD testing scenarios where you have expected answers and want to ensure consistency over time.
 
@@ -24,7 +24,7 @@ The `createAnswerSimilarityScorer()` function creates a scorer that evaluates ho
 
 This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but **requires ground truth** to be provided in the run object.
 
-## .run() Returns
+## `.run()` returns
 
 **runId** (`string`): The id of the run (optional).
 
@@ -42,7 +42,7 @@ This function returns an instance of the MastraScorer class. The `.run()` method
 
 **generateReasonPrompt** (`string`): The prompt used for generating the explanation.
 
-## Scoring Details
+## Scoring details
 
 The scorer uses a multi-step process:
 

package/.docs/reference/evals/bias.md

@@ -1,4 +1,4 @@
-# Bias Scorer
+# Bias scorer
 
 The `createBiasScorer()` function accepts a single options object with the following properties:
 
@@ -10,7 +10,7 @@ The `createBiasScorer()` function accepts a single options object with the follo
 
 This function returns an instance of the MastraScorer class. The `.run()` method accepts the same input as other scorers (see the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer)), but the return value includes LLM-specific fields as documented below.
 
-## .run() Returns
+## `.run()` returns
 
 **runId** (`string`): The id of the run (optional).
 
@@ -28,7 +28,7 @@ This function returns an instance of the MastraScorer class. The `.run()` method
 
 **generateReasonPrompt** (`string`): The prompt sent to the LLM for the generateReason step (optional).
 
-## Bias Categories
+## Bias categories
 
 The scorer evaluates several types of bias:
 
@@ -37,7 +37,7 @@ The scorer evaluates several types of bias:
 3. **Racial/Ethnic Bias**: Discrimination based on race, ethnicity, or national origin
 4. **Geographical Bias**: Prejudice based on location or regional stereotypes
 
-## Scoring Details
+## Scoring details
 
 The scorer evaluates bias through opinion analysis based on:
 

package/.docs/reference/evals/completeness.md

@@ -1,4 +1,4 @@
-# Completeness Scorer
+# Completeness scorer
 
 The `createCompletenessScorer()` function evaluates how thoroughly an LLM's output covers the key elements present in the input. It analyzes nouns, verbs, topics, and terms to determine coverage and provides a detailed completeness score.
 
@@ -8,7 +8,7 @@ The `createCompletenessScorer()` function doesn't take any options.
 
 This function returns an instance of the MastraScorer class. See the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer) for details on the `.run()` method and its input/output.
 
-## .run() Returns
+## `.run()` returns
 
 **runId** (`string`): The id of the run (optional).
 
@@ -31,7 +31,7 @@ The `.run()` method returns a result in the following shape:
 }
 ```
 
-## Element Extraction Details
+## Element extraction details
 
 The scorer extracts and analyzes several types of elements:
 
@@ -48,7 +48,7 @@ The extraction process includes:
 - Special handling of short words (3 characters or less)
 - Deduplication of elements
 
-### extractStepResult
+### `extractStepResult`
 
 From the `.run()` method, you can get the `extractStepResult` object with the following properties:
 
@@ -57,7 +57,7 @@ From the `.run()` method, you can get the `extractStepResult` object with the fo
 - **missingElements**: Input elements not found in the output.
 - **elementCounts**: The number of elements in the input and output.
 
-## Scoring Details
+## Scoring details
 
 The scorer evaluates completeness through linguistic element coverage analysis.
 

package/.docs/reference/evals/content-similarity.md

@@ -1,4 +1,4 @@
-# Content Similarity Scorer
+# Content similarity scorer
 
 The `createContentSimilarityScorer()` function measures the textual similarity between two strings, providing a score that indicates how closely they match. It supports configurable options for case sensitivity and whitespace handling.
 
@@ -12,7 +12,7 @@ The `createContentSimilarityScorer()` function accepts a single options object w
 
 This function returns an instance of the MastraScorer class. See the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer) for details on the `.run()` method and its input/output.
 
-## .run() Returns
+## `.run()` returns
 
 **runId** (`string`): The id of the run (optional).
 
@@ -22,7 +22,7 @@ This function returns an instance of the MastraScorer class. See the [MastraScor
 
 **score** (`number`): Similarity score (0-1) where 1 indicates perfect similarity.
 
-## Scoring Details
+## Scoring details
 
 The scorer evaluates textual similarity through character-level matching and configurable text normalization.
 

package/.docs/reference/evals/context-precision.md

@@ -1,10 +1,10 @@
-# Context Precision Scorer
+# Context precision scorer
 
 The `createContextPrecisionScorer()` function creates a scorer that evaluates how relevant and well-positioned retrieved context pieces are for generating expected outputs. It uses **Mean Average Precision (MAP)** to reward systems that place relevant context earlier in the sequence.
 
 It's especially useful for these use cases:
 
-## RAG System Evaluation
+## RAG system evaluation
 
 Ideal for evaluating retrieved context in RAG pipelines where:
 
@@ -12,7 +12,7 @@ Ideal for evaluating retrieved context in RAG pipelines where:
 - You need to measure retrieval quality beyond basic relevance
 - Early relevant context is more valuable than later relevant context
 
-## Context Window Optimization
+## Context window optimization
 
 Use when optimizing context selection for:
 
@@ -28,13 +28,13 @@ Use when optimizing context selection for:
 
 **Note**: Either `context` or `contextExtractor` must be provided. If both are provided, `contextExtractor` takes precedence.
 
-## .run() Returns
+## `.run()` returns
 
 **score** (`number`): Mean Average Precision score between 0 and scale (default 0-1)
 
 **reason** (`string`): Human-readable explanation of the context precision evaluation
 
-## Scoring Details
+## Scoring details
 
 ### Mean Average Precision (MAP)
 
@@ -177,7 +177,7 @@ For more details on `runEvals`, see the [runEvals reference](https://mastra.ai/r
 
 To add this scorer to an agent, see the [Scorers overview](https://mastra.ai/docs/evals/overview) guide.
 
-## Comparison with Context Relevance
+## Comparison with context relevance
 
 Choose the right scorer for your needs:
 

package/.docs/reference/evals/context-relevance.md

@@ -1,10 +1,10 @@
-# Context Relevance Scorer
+# Context relevance scorer
 
 The `createContextRelevanceScorerLLM()` function creates a scorer that evaluates how relevant and useful provided context was for generating agent responses. It uses weighted relevance levels and applies penalties for unused high-relevance context and missing information.
 
 It's especially useful for these use cases:
 
-## Content Generation Evaluation
+## Content generation evaluation
 
 Best for evaluating context quality in:
 
@@ -12,7 +12,7 @@ Best for evaluating context quality in:
 - RAG pipelines needing nuanced relevance assessment
 - Systems where missing context affects quality
 
-## Context Selection Optimization
+## Context selection optimization
 
 Use when optimizing for:
 
@@ -28,13 +28,13 @@ Use when optimizing for:
 
 Note: Either `context` or `contextExtractor` must be provided. If both are provided, `contextExtractor` takes precedence.
 
-## .run() Returns
+## `.run()` returns
 
 **score** (`number`): Weighted relevance score between 0 and scale (default 0-1)
 
 **reason** (`string`): Human-readable explanation of the context relevance evaluation
 
-## Scoring Details
+## Scoring details
 
 ### Weighted Relevance Scoring
 
@@ -512,7 +512,7 @@ const evaluateRAG = async testCases => {
 }
 ```
 
-## Comparison with Context Precision
+## Comparison with context precision
 
 Choose the right scorer for your needs: