@mastra/mcp-docs-server 0.13.18 → 0.13.19-alpha.1

package/.docs/raw/reference/auth/supabase.mdx

@@ -0,0 +1,62 @@
+---
+title: "MastraAuthSupabase Class"
+description: "API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
+---
+
+# MastraAuthSupabase Class
+
+The `MastraAuthSupabase` class provides authentication for Mastra using Supabase Auth. It verifies incoming requests using Supabase's authentication system and integrates with the Mastra server using the `experimental_auth` option.
+
+## Usage example
+
+```typescript filename="src/mastra/index.ts" showLineNumbers copy
+import { Mastra } from "@mastra/core/mastra";
+import { MastraAuthSupabase } from '@mastra/auth-supabase';
+
+export const mastra = new Mastra({
+  // ..
+  server: {
+    experimental_auth: new MastraAuthSupabase({
+      url: process.env.SUPABASE_URL,
+      anonKey: process.env.SUPABASE_ANON_KEY
+    }),
+  },
+});
+```
+
+## Constructor parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "url",
+      type: "string",
+      description: "The URL of your Supabase project. Can be found in your Supabase project settings.",
+      isOptional: true,
+      defaultValue: "process.env.SUPABASE_URL"
+    },
+    {
+      name: "anonKey",
+      type: "string",
+      description: "The anonymous/public key for your Supabase project. Used for client-side authentication.",
+      isOptional: true,
+      defaultValue: "process.env.SUPABASE_ANON_KEY"
+    },
+    {
+      name: "name",
+      type: "string",
+      description: "Custom name for the auth provider instance.",
+      isOptional: true,
+    },
+    {
+      name: "authorizeUser",
+      type: "(user: User, request: HoneRequest) => Promise<boolean> | boolean",
+      description: "Custom authorization function to determine if a user should be granted access. Called after token verification. By default, checks the 'isAdmin' column in the 'users' table.",
+      isOptional: true,
+    },
+  ]}
+/>
+
+## Related
+
+[MastraAuthSupabase](/docs/auth/supabase.mdx)

package/.docs/raw/reference/{agents → core}/getAgent.mdx

@@ -3,7 +3,7 @@ title: "Reference: Agent.getAgent() | Agents | Mastra Docs"
 description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
 ---
 
-# Agent.getAgent()
+# Mastra.getAgent()
 
 The `.getAgent()` method is used to retrieve an agent. The method accepts a single `string` parameter for the agent's name.
 
@@ -13,7 +13,6 @@ The `.getAgent()` method is used to retrieve an agent. The method accepts a sing
 mastra.getAgent("testAgent");
 ```
 
-
 ## Parameters
 
 <PropertiesTable

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

@@ -0,0 +1,43 @@
+---
+title: "Reference: Mastra.getAgentById() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID."
+---
+
+# Mastra.getAgentById()
+
+The `.getAgentById()` method is used to retrieve an agent by its ID. The method accepts a single `string` parameter for the agent's ID.
+
+## Usage example
+
+```typescript copy
+mastra.getAgentById("test-agent-123");
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "id",
+      type: "string",
+      description: "The ID of the agent to retrieve. The method will first search for an agent with this ID, and if not found, will attempt to use it as a name to call getAgent().",
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "agent",
+      type: "Agent",
+      description: "The agent instance with the specified ID. Throws an error if the agent is not found.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Agents overview](../../docs/agents/overview.mdx)
+- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

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

@@ -0,0 +1,35 @@
+---
+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.mdx)
+- [Dynamic agents](../../docs/agents/dynamic-agents.mdx)

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

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

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

@@ -0,0 +1,35 @@
+---
+title: "Reference: Mastra.getLogger() | Core | Mastra Docs"
+description: "Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance."
+---
+
+# Mastra.getLogger()
+
+The `.getLogger()` method is used to retrieve the logger instance that has been configured in the Mastra instance.
+
+## Usage example
+
+```typescript copy
+mastra.getLogger();
+```
+
+## Parameters
+
+This method does not accept any parameters.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: "logger",
+      type: "TLogger",
+      description: "The configured logger instance used for logging across all components (agents, workflows, etc.).",
+    },
+  ]}
+/>
+
+## Related
+
+- [Logging overview](../../docs/observability/logging.mdx)
+- [Logger reference](../../reference/observability/logger.mdx)

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

@@ -0,0 +1,92 @@
+---
+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.mdx)
+- [Logger reference](../../reference/observability/logger.mdx)

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

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

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

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

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

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

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

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

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