@mastra/mcp-docs-server 0.13.37 → 0.13.39-alpha.0

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

@@ -10,15 +10,15 @@ The `getScorer()` method retrieves a specific scorer that was registered with th
 ## Usage Example
 
 ```typescript
-import { mastra } from './mastra';
+import { mastra } from "./mastra";
 
 // Get a specific scorer by key
-const relevancyScorer = mastra.getScorer('relevancyScorer');
+const relevancyScorer = mastra.getScorer("relevancyScorer");
 
-const weatherAgent = mastra.getAgent('weatherAgent')
+const weatherAgent = mastra.getAgent("weatherAgent");
 
 // Use the scorer to evaluate an AI output
-await weatherAgent.generate('What is the weather in Rome', {
+await weatherAgent.generate("What is the weather in Rome", {
   scorers: {
     answerRelevancy: {
       scorer: relevancyScorer,
@@ -34,7 +34,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       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.",
+      description:
+        "The registration key of the scorer to retrieve. This should match a key used when registering scorers in the Mastra constructor.",
       isOptional: false,
     },
   ]}
@@ -47,7 +48,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       name: "scorer",
       type: "MastraScorer",
-      description: "The MastraScorer instance associated with the provided key.",
+      description:
+        "The MastraScorer instance associated with the provided key.",
     },
   ]}
 />
@@ -55,21 +57,22 @@ await weatherAgent.generate('What is the weather in Rome', {
 ## 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');
+  const scorer = mastra.getScorer("nonExistentScorer");
 } catch (error) {
-  if (error.id === 'MASTRA_GET_SCORER_NOT_FOUND') {
-    console.log('Scorer not found, using default evaluation');
+  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
+- [getScorers()](/reference/core/getScorers) - Get all registered scorers
+- [getScorerByName()](/reference/core/getScorerByName) - Get a scorer by its name property
+- [Custom Scorers](/docs/scorers/custom-scorers) - Learn how to create custom scorers

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

@@ -10,15 +10,15 @@ The `getScorerByName()` method retrieves a scorer by searching for its `name` pr
 ## Usage Example
 
 ```typescript
-import { mastra } from './mastra';
+import { mastra } from "./mastra";
 
 // Get a scorer by its name property
-const relevancyScorer = mastra.getScorerByName('Answer Relevancy');
+const relevancyScorer = mastra.getScorerByName("Answer Relevancy");
 
-const weatherAgent = mastra.getAgent('weatherAgent')
+const weatherAgent = mastra.getAgent("weatherAgent");
 
 // Use the scorer to evaluate an AI output
-await weatherAgent.generate('What is the weather in Rome', {
+await weatherAgent.generate("What is the weather in Rome", {
   scorers: {
     answerRelevancy: {
       scorer: relevancyScorer,
@@ -34,7 +34,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       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().",
+      description:
+        "The name property of the scorer to retrieve. This should match the 'name' field specified when creating the scorer with createScorer().",
       isOptional: false,
     },
   ]}
@@ -47,7 +48,8 @@ await weatherAgent.generate('What is the weather in Rome', {
     {
       name: "scorer",
       type: "MastraScorer",
-      description: "The MastraScorer instance that has the matching name property.",
+      description:
+        "The MastraScorer instance that has the matching name property.",
     },
   ]}
 />
@@ -55,15 +57,16 @@ await weatherAgent.generate('What is the weather in Rome', {
 ## 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');
+  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');
+  if (error.id === "MASTRA_GET_SCORER_BY_NAME_NOT_FOUND") {
+    console.log("Scorer with that name not found");
   }
 }
 ```
@@ -71,5 +74,5 @@ try {
 ## Related
 
 - [getScorer()](../../reference/core/getScorer) - Get a scorer by its registration key
-- [getScorers()](../../reference/core/getScorers) - Get all registered scorers
+- [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

@@ -10,7 +10,7 @@ The `getScorers()` method returns all scorers that have been registered with the
 ## Usage Example
 
 ```typescript
-import { mastra } from './mastra';
+import { mastra } from "./mastra";
 
 // Get all registered scorers
 const allScorers = mastra.getScorers();
@@ -30,7 +30,8 @@ This method takes no parameters.
     {
       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.",
+      description:
+        "An object containing all registered scorers, where keys are scorer names and values are MastraScorer instances. Returns undefined if no scorers are registered.",
     },
   ]}
 />

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       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.",
+      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)
+- [Server deployment](/docs/deployment/server-deployment)
+- [Server configuration](/docs/server-db/custom-api-routes)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       name: "storage",
       type: "MastraStorage | undefined",
-      description: "The configured storage instance, or undefined if no storage has been configured.",
+      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)
+- [Storage overview](/docs/server-db/storage)
+- [Storage reference](/reference/storage/libsql)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       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.",
+      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)
+- [AI tracing](/docs/observability/ai-tracing/overview)
+- [Telemetry reference](/reference/observability/otel-tracing/otel-config)

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

@@ -20,7 +20,8 @@ mastra.getVector("testVectorStore");
     {
       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.",
+      description:
+        "The name of the vector store to retrieve. Must be a valid vector store name that exists in the Mastra configuration.",
     },
   ]}
 />
@@ -32,12 +33,13 @@ mastra.getVector("testVectorStore");
     {
       name: "vector",
       type: "TVectors[TVectorName]",
-      description: "The vector store instance with the specified name. Throws an error if the vector store is not found.",
+      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)
+- [Vector stores overview](/docs/rag/vector-databases)
+- [RAG overview](/docs/rag/overview)

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

@@ -24,12 +24,13 @@ This method does not accept any parameters.
     {
       name: "vectors",
       type: "TVectors",
-      description: "A record of all configured vector stores, where keys are vector store names and values are vector store instances.",
+      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)
+- [Vector stores overview](/docs/rag/vector-databases)
+- [RAG overview](/docs/rag/overview)

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

@@ -20,12 +20,14 @@ mastra.getWorkflow("testWorkflow");
     {
       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.",
+      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.",
+      description:
+        "Optional configuration object. When `serialized` is true, returns only the workflow name instead of the full workflow instance.",
       optional: true,
     },
   ]}
@@ -38,11 +40,12 @@ mastra.getWorkflow("testWorkflow");
     {
       name: "workflow",
       type: "TWorkflows[TWorkflowId]",
-      description: "The workflow instance with the specified ID. Throws an error if the workflow is not found.",
+      description:
+        "The workflow instance with the specified ID. Throws an error if the workflow is not found.",
     },
   ]}
 />
 
 ## Related
 
-- [Workflows overview](../../docs/workflows/overview.mdx)
+- [Workflows overview](/docs/workflows/overview)

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

@@ -20,7 +20,8 @@ mastra.getWorkflows();
     {
       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.",
+      description:
+        "Optional configuration object. When `serialized` is true, returns simplified workflow objects with only the name property instead of full workflow instances.",
       optional: true,
     },
   ]}
@@ -33,11 +34,12 @@ mastra.getWorkflows();
     {
       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).",
+      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)
+- [Workflows overview](/docs/workflows/overview)

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

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

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

@@ -0,0 +1,96 @@
+---
+title: "Reference: Mastra.listLogs() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
+---
+
+# Mastra.listLogs()
+
+The `.listLogs()` method is used to retrieve all logs for a specific transport ID. This method requires a configured logger that supports the `listLogs` operation.
+
+## Usage example
+
+```typescript copy
+mastra.listLogs("456");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "transportId",
+      type: "string",
+      description: "The transport ID to retrieve logs from.",
+    },
+    {
+      name: "options",
+      type: "object",
+      description:
+        "Optional parameters for filtering and pagination. See Options section below for details.",
+      optional: true,
+    },
+  ]}
+/>
+
+### Options
+
+<PropertiesTable
+  content={[
+    {
+      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 transport ID.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Logging overview](/docs/observability/logging)
+- [Logger reference](/reference/observability/logging/pino-logger)

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

@@ -0,0 +1,87 @@
+---
+title: "Reference: Mastra.listLogsByRunId() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.listLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID."
+---
+
+# Mastra.listLogsByRunId()
+
+The `.listLogsByRunId()` method is used to retrieve logs for a specific run ID and transport ID. This method requires a configured logger that supports the `listLogsByRunId` operation.
+
+## Usage example
+
+```typescript copy
+mastra.listLogsByRunId({ 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)
+- [Logger reference](/reference/observability/logging/pino-logger)

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

@@ -0,0 +1,43 @@
+---
+title: "Reference: listScorers() | Core | Mastra Docs"
+description: "Documentation for the `listScorers()` method in Mastra, which returns all registered scorers for evaluating AI outputs."
+---
+
+# listScorers()
+
+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
+
+```typescript
+import { mastra } from "./mastra";
+
+// Get all registered scorers
+const allScorers = mastra.listScorers();
+
+// 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/listWorkflows.mdx

@@ -0,0 +1,45 @@
+---
+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)