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

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

@@ -1,69 +0,0 @@
----
-title: "Reference: Agent.getScorers() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getScorers()` method in Mastra agents, which retrieves the scoring configuration."
----
-
-# Agent.getScorers()
-
-The `.getScorers()` method retrieves the scoring configuration configured for an agent, resolving it if it's a function. This method provides access to the scoring system used for evaluating agent responses and performance.
-
-## Usage example
-
-```typescript copy
-await agent.getScorers();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "scorers",
-      type: "MastraScorers | Promise<MastraScorers>",
-      description:
-        "The scoring configuration configured for the agent, either as a direct object or a promise that resolves to the scorers.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getScorers({
-  runtimeContext: new RuntimeContext(),
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description:
-        "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](/docs/agents/overview)
-- [Runtime Context](/docs/server-db/runtime-context)

package/.docs/raw/reference/agents/getTools.mdx

@@ -1,69 +0,0 @@
----
-title: "Reference: Agent.getTools() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getTools()` method in Mastra agents, which retrieves the tools that the agent can use."
----
-
-# Agent.getTools()
-
-The `.getTools()` method retrieves the tools configured for an agent, resolving them if they're a function. These tools extend the agent's capabilities, allowing it to perform specific actions or access external systems.
-
-## Usage example
-
-```typescript copy
-await agent.getTools();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "tools",
-      type: "TTools | Promise<TTools>",
-      description:
-        "The tools configured for the agent, either as a direct object or a promise that resolves to the tools.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getTools({
-  runtimeContext: new RuntimeContext(),
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description:
-        "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Using tools with agents](/docs/agents/using-tools)
-- [Creating tools](/docs/tools-mcp/overview)

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

@@ -1,69 +0,0 @@
----
-title: "Reference: Agent.getWorkflows() | Agents | Mastra Docs"
-description: "Documentation for the `Agent.getWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
----
-
-# Agent.getWorkflows()
-
-The `.getWorkflows()` method retrieves the workflows configured for an agent, resolving them if they're a function. These workflows enable the agent to execute complex, multi-step processes with defined execution paths.
-
-## Usage example
-
-```typescript copy
-await agent.getWorkflows();
-```
-
-## Parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "options",
-      type: "{ runtimeContext?: RuntimeContext }",
-      isOptional: true,
-      defaultValue: "{}",
-      description: "Optional configuration object containing runtime context.",
-    },
-  ]}
-/>
-
-## Returns
-
-<PropertiesTable
-  content={[
-    {
-      name: "workflows",
-      type: "Promise<Record<string, Workflow>>",
-      description:
-        "A promise that resolves to a record of workflow names to their corresponding Workflow instances.",
-    },
-  ]}
-/>
-
-## Extended usage example
-
-```typescript copy
-await agent.getWorkflows({
-  runtimeContext: new RuntimeContext(),
-});
-```
-
-### Options parameters
-
-<PropertiesTable
-  content={[
-    {
-      name: "runtimeContext",
-      type: "RuntimeContext",
-      isOptional: true,
-      defaultValue: "new RuntimeContext()",
-      description:
-        "Runtime context for dependency injection and contextual information.",
-    },
-  ]}
-/>
-
-## Related
-
-- [Agents overview](/docs/agents/overview)
-- [Workflows overview](/docs/workflows/overview)

package/.docs/raw/reference/client-js/workflows-legacy.mdx

@@ -1,143 +0,0 @@
----
-title: "Reference: Workflows (Legacy) API | Client SDK | Mastra Docs"
-description: Learn how to interact with and execute automated legacy workflows in Mastra using the client-js SDK.
----
-
-# Workflows (Legacy) API
-
-The Workflows (Legacy) API provides methods to interact with and execute automated legacy workflows in Mastra.
-
-## Getting All Legacy Workflows
-
-Retrieve a list of all available legacy workflows:
-
-```typescript
-const workflows = await mastraClient.getLegacyWorkflows();
-```
-
-## Working with a Specific Legacy Workflow
-
-Get an instance of a specific legacy workflow:
-
-```typescript
-const workflow = mastraClient.getLegacyWorkflow("workflow-id");
-```
-
-## Legacy Workflow Methods
-
-### Get Legacy Workflow Details
-
-Retrieve detailed information about a legacy workflow:
-
-```typescript
-const details = await workflow.details();
-```
-
-### Start Legacy Workflow run asynchronously
-
-Start a legacy workflow run with triggerData and await full run results:
-
-```typescript
-const { runId } = workflow.createRun();
-
-const result = await workflow.startAsync({
-  runId,
-  triggerData: {
-    param1: "value1",
-    param2: "value2",
-  },
-});
-```
-
-### Resume Legacy Workflow run asynchronously
-
-Resume a suspended legacy workflow step and await full run result:
-
-```typescript
-const { runId } = createRun({ runId: prevRunId });
-
-const result = await workflow.resumeAsync({
-  runId,
-  stepId: "step-id",
-  contextData: { key: "value" },
-});
-```
-
-### Watch Legacy Workflow
-
-Watch legacy workflow transitions
-
-```typescript
-try {
-  // Get workflow instance
-  const workflow = mastraClient.getLegacyWorkflow("workflow-id");
-
-  // Create a workflow run
-  const { runId } = workflow.createRun();
-
-  // Watch workflow run
-  workflow.watch({ runId }, (record) => {
-    // Every new record is the latest transition state of the workflow run
-
-    console.log({
-      activePaths: record.activePaths,
-      results: record.results,
-      timestamp: record.timestamp,
-      runId: record.runId,
-    });
-  });
-
-  // Start workflow run
-  workflow.start({
-    runId,
-    triggerData: {
-      city: "New York",
-    },
-  });
-} catch (e) {
-  console.error(e);
-}
-```
-
-### Resume Legacy Workflow
-
-Resume legacy workflow run and watch legacy workflow step transitions
-
-```typescript
-try {
-  //To resume a workflow run, when a step is suspended
-  const { run } = createRun({ runId: prevRunId });
-
-  //Watch run
-  workflow.watch({ runId }, (record) => {
-    // Every new record is the latest transition state of the workflow run
-
-    console.log({
-      activePaths: record.activePaths,
-      results: record.results,
-      timestamp: record.timestamp,
-      runId: record.runId,
-    });
-  });
-
-  //resume run
-  workflow.resume({
-    runId,
-    stepId: "step-id",
-    contextData: { key: "value" },
-  });
-} catch (e) {
-  console.error(e);
-}
-```
-
-### Legacy Workflow run result
-
-A legacy workflow run result yields the following:
-
-| Field         | Type                                                                           | Description                                                        |
-| ------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------ |
-| `activePaths` | `Record<string, { status: string; suspendPayload?: any; stepPath: string[] }>` | Currently active paths in the workflow with their execution status |
-| `results`     | `LegacyWorkflowRunResult<any, any, any>['results']`                            | Results from the workflow execution                                |
-| `timestamp`   | `number`                                                                       | Unix timestamp of when this transition occurred                    |
-| `runId`       | `string`                                                                       | Unique identifier for this workflow run instance                   |

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

@@ -1,35 +0,0 @@
----
-title: "Reference: Mastra.getAgents() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getAgents()` method in Mastra, which retrieves all configured agents."
----
-
-# Mastra.getAgents()
-
-The `.getAgents()` method is used to retrieve all agents that have been configured in the Mastra instance.
-
-## Usage example
-
-```typescript copy
-mastra.getAgents();
-```
-
-## 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/getLogs.mdx

@@ -1,96 +0,0 @@
----
-title: "Reference: Mastra.getLogs() | Core | Mastra Docs"
-description: "Documentation for the `Mastra.getLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
----
-
-# Mastra.getLogs()
-
-The `.getLogs()` method is used to retrieve all logs for a specific transport ID. This method requires a configured logger that supports the `getLogs` operation.
-
-## Usage example
-
-```typescript copy
-mastra.getLogs("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/getLogsByRunId.mdx

@@ -1,87 +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)
-- [Logger reference](/reference/observability/logging/pino-logger)

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

@@ -1,36 +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)
-- [MCP server reference](/reference/tools/mcp-server)

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

@@ -1,36 +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)
-- [Memory reference](/reference/memory/memory-class)