@mastra/mcp-docs-server 0.0.0-error-handler-fix-20251020202607 → 0.0.0-execa-dynamic-import-20260304221256

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

@@ -1,84 +0,0 @@
----
-title: "Reference: Mastra.getLogsByRunId() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID."
----
-
-# Mastra.getLogsByRunId()
-
-The `.getLogsByRunId()` method is used to retrieve logs for a specific run ID and transport ID. This method requires a configured logger that supports the `getLogsByRunId` operation.
-
-## Usage example
-
-```typescript copy
-mastra.getLogsByRunId({ runId: "123", transportId: "456" });
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runId",
-      type: "string",
-      description: "The run ID to retrieve logs for.",
-    },
-    {
-      name: "transportId",
-      type: "string",
-      description: "The transport ID to retrieve logs from.",
-    },
-    {
-      name: "fromDate",
-      type: "Date",
-      description: "Optional start date for filtering logs. e.g., new Date('2024-01-01').",
-      optional: true,
-    },
-    {
-      name: "toDate",
-      type: "Date",
-      description: "Optional end date for filtering logs. e.g., new Date('2024-01-31').",
-      optional: true,
-    },
-    {
-      name: "logLevel",
-      type: "LogLevel",
-      description: "Optional log level to filter by.",
-      optional: true,
-    },
-    {
-      name: "filters",
-      type: "Record<string, any>",
-      description: "Optional additional filters to apply to the log query.",
-      optional: true,
-    },
-    {
-      name: "page",
-      type: "number",
-      description: "Optional page number for pagination.",
-      optional: true,
-    },
-    {
-      name: "perPage",
-      type: "number",
-      description: "Optional number of logs per page for pagination.",
-      optional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "logs",
-      type: "Promise<any>",
-      description: "A promise that resolves to the logs for the specified run ID and transport ID.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Logging overview](../../docs/observability/logging.mdx)
-- [Logger reference](../../reference/observability/logger.mdx)

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

@@ -1,49 +0,0 @@
----
-title: "Reference: Mastra.getMCPServer() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getMCPServer()` method in Mastra, which retrieves a specific MCP server instance by ID and optional version."
----
-
-# Mastra.getMCPServer()
-
-The `.getMCPServer()` method is used to retrieve a specific MCP server instance by its logical ID and optional version. If a version is provided, it attempts to find the server with that exact logical ID and version. If no version is provided, it returns the server with the specified logical ID that has the most recent releaseDate.
-
-## Usage example
-
-```typescript copy
-mastra.getMCPServer("1.2.0");
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "serverId",
-      type: "string",
-      description: "The logical ID of the MCP server to retrieve. Should match the `id` property of the MCPServer instance.",
-    },
-    {
-      name: "version",
-      type: "string",
-      description: "Optional specific version of the MCP server to retrieve. If not provided, returns the server with the most recent releaseDate.",
-      optional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "server",
-      type: "MCPServerBase | undefined",
-      description: "The MCP server instance with the specified ID and version, or undefined if not found or if the specific version is not found.",
-    },
-  ]}
-/>
-
-## Related
-
-- [MCP overview](../../docs/tools-mcp/mcp-overview.mdx)
-- [MCP server reference](../../reference/tools/mcp-server.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getMCPServers() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getMCPServers()` method in Mastra, which retrieves all registered MCP server instances."
----
-
-# Mastra.getMCPServers()
-
-The `.getMCPServers()` method is used to retrieve all MCP server instances that have been registered in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getMCPServers();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "servers",
-      type: "Record<string, MCPServerBase> | undefined",
-      description: "A record of all registered MCP server instances, where keys are server IDs and values are MCPServerBase instances, or undefined if no servers are registered.",
-    },
-  ]}
-/>
-
-## Related
-
-- [MCP overview](../../docs/tools-mcp/mcp-overview.mdx)
-- [MCP server reference](../../reference/tools/mcp-server.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getMemory() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getMemory()` method in Mastra, which retrieves the configured memory instance."
----
-
-# Mastra.getMemory()
-
-The `.getMemory()` method is used to retrieve the memory instance that has been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getMemory();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "memory",
-      type: "MastraMemory | undefined",
-      description: "The configured memory instance, or undefined if no memory has been configured.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Memory overview](../../docs/memory/overview.mdx)
-- [Memory reference](../../reference/memory/Memory.mdx)

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

@@ -1,75 +0,0 @@
----
-title: "Reference: getScorer() | Core | Mastra Docs"
-description: "Documentation for the `getScorer()` method in Mastra, which retrieves a specific scorer by its registration key."
----
-
-# getScorer()
-
-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 is not found.
-
-## Usage Example
-
-```typescript
-import { mastra } from './mastra';
-
-// Get a specific scorer by key
-const relevancyScorer = mastra.getScorer('relevancyScorer');
-
-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: "key",
-      type: "string",
-      description: "The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.",
-      isOptional: false,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "scorer",
-      type: "MastraScorer",
-      description: "The MastraScorer instance associated with the provided key.",
-    },
-  ]}
-/>
-
-## Error Handling
-
-This method throws a `MastraError` if:
-- The scorer with the specified key is not found
-- No scorers are registered with the Mastra instance
-
-```typescript
-try {
-  const scorer = mastra.getScorer('nonExistentScorer');
-} catch (error) {
-  if (error.id === 'MASTRA_GET_SCORER_NOT_FOUND') {
-    console.log('Scorer not found, using default evaluation');
-  }
-}
-```
-
-## Related
-
-- [getScorers()](../../reference/core/getScorers.mdx) - Get all registered scorers
-- [getScorerByName()](../../reference/core/getScorerByName.mdx) - Get a scorer by its name property
-- [Custom Scorers](../../docs/scorers/custom-scorers.mdx) - Learn how to create custom scorers

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

@@ -1,75 +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
-- [getScorers()](../../reference/core/getScorers) - Get all registered scorers
-- [createScorer()](../../reference/scorers/create-scorer) - Learn how to create scorers with names

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

@@ -1,42 +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/getServer.mdx

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getServer() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getServer()` method in Mastra, which retrieves the configured server configuration."
----
-
-# Mastra.getServer()
-
-The `.getServer()` method is used to retrieve the server configuration that has been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getServer();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "server",
-      type: "ServerConfig | undefined",
-      description: "The configured server configuration including port, timeout, API routes, middleware, CORS settings, and build options, or undefined if no server has been configured.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Server deployment](../../docs/deployment/server-deployment.mdx)
-- [Server configuration](../../docs/server-db/custom-api-routes.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getStorage() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getStorage()` method in Mastra, which retrieves the configured storage instance."
----
-
-# Mastra.getStorage()
-
-The `.getStorage()` method is used to retrieve the storage instance that has been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getStorage();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "storage",
-      type: "MastraStorage | undefined",
-      description: "The configured storage instance, or undefined if no storage has been configured.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Storage overview](../../docs/server-db/storage.mdx)
-- [Storage reference](../../reference/storage/libsql.mdx)

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getTelemetry() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getTelemetry()` method in Mastra, which retrieves the configured telemetry instance."
----
-
-# Mastra.getTelemetry()
-
-The `.getTelemetry()` method is used to retrieve the telemetry instance that has been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getTelemetry();
-```
-
-## Parameters
-
-This method does not accept any parameters.
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "telemetry",
-      type: "Telemetry | undefined",
-      description: "The configured telemetry instance used for tracing and observability across all components, or undefined if no telemetry has been configured.",
-    },
-  ]}
-/>
-
-## Related
-
-- [AI tracing](../../docs/observability/ai-tracing.mdx)
-- [Telemetry reference](../../reference/observability/otel-config.mdx)

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

@@ -1,43 +0,0 @@
----
-title: "Reference: Mastra.getVector() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getVector()` method in Mastra, which retrieves a vector store by name."
----
-
-# Mastra.getVector()
-
-The `.getVector()` method is used to retrieve a vector store by its name. The method accepts a single `string` parameter for the vector store's name.
-
-## Usage example
-
-```typescript copy
-mastra.getVector("testVectorStore");
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "name",
-      type: "TVectorName extends keyof TVectors",
-      description: "The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "vector",
-      type: "TVectors[TVectorName]",
-      description: "The vector store instance with the specified name. Throws an error if the vector store is not found.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Vector stores overview](../../docs/rag/vector-databases.mdx)
-- [RAG overview](../../docs/rag/overview.mdx)

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

@@ -1,35 +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.mdx)
-- [RAG overview](../../docs/rag/overview.mdx)

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

@@ -1,48 +0,0 @@
----
-title: "Reference: Mastra.getWorkflow() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getWorkflow()` method in Mastra, which retrieves a workflow by ID."
----
-
-# Mastra.getWorkflow()
-
-The `.getWorkflow()` method is used to retrieve a workflow by its ID. The method accepts a workflow ID and an optional options object.
-
-## Usage example
-
-```typescript copy
-mastra.getWorkflow("testWorkflow");
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "id",
-      type: "TWorkflowId extends keyof TWorkflows",
-      description: "The ID of the workflow to retrieve. Must be a valid workflow ID that exists in the Mastra configuration.",
-    },
-    {
-      name: "options",
-      type: "{ serialized?: boolean }",
-      description: "Optional configuration object. When `serialized` is true, returns only the workflow name instead of the full workflow instance.",
-      optional: true,
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflow",
-      type: "TWorkflows[TWorkflowId]",
-      description: "The workflow instance with the specified ID. Throws an error if the workflow is not found.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Workflows overview](../../docs/workflows/overview.mdx)

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

@@ -1,43 +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.mdx)