@mastra/mcp-docs-server 1.0.0-beta.1 → 1.0.0-beta.3

package/.docs/raw/reference/client-js/error-handling.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Error Handling | Client SDK | Mastra Docs"
+title: "Reference: Error Handling | Client SDK"
 description: Learn about the built-in retry mechanism and error handling capabilities in the Mastra client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/logs.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Logs API | Client SDK | Mastra Docs"
+title: "Reference: Logs API | Client SDK"
 description: Learn how to access and query system logs and debugging information in Mastra using the client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/mastra-client.mdx

@@ -1,11 +1,11 @@
 ---
-title: "Reference: Mastra Client SDK | Client SDK | Mastra Docs"
+title: "Reference: Mastra Client SDK | Client SDK"
 description: Learn how to interact with Mastra using the client-js SDK.
 ---
 
 # Mastra Client SDK
 
-The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/deployment/server-deployment) from your client environment.
+The Mastra Client SDK provides a simple and type-safe interface for interacting with your [Mastra Server](/docs/v1/deployment/building-mastra) from your client environment.
 
 ## Usage example
 

package/.docs/raw/reference/client-js/memory.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Memory API | Client SDK | Mastra Docs"
+title: "Reference: Memory API | Client SDK"
 description: Learn how to manage conversation threads and message history in Mastra using the client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/observability.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Observability API | Client SDK | Mastra Docs"
+title: "Reference: Observability API | Client SDK"
 description: Learn how to retrieve traces, monitor application performance, and score traces using the client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/telemetry.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Telemetry API | Client SDK | Mastra Docs"
+title: "Reference: Telemetry API | Client SDK"
 description: Learn how to retrieve and analyze traces from your Mastra application for monitoring and debugging using the client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/tools.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Tools API | Client SDK | Mastra Docs"
+title: "Reference: Tools API | Client SDK"
 description: Learn how to interact with and execute tools available in the Mastra platform using the client-js SDK.
 ---
 

package/.docs/raw/reference/client-js/vectors.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Vectors API | Client SDK | Mastra Docs"
+title: "Reference: Vectors API | Client SDK"
 description: Learn how to work with vector embeddings for semantic search and similarity matching in Mastra using the client-js SDK.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Workflows API | Client SDK | Mastra Docs"
+title: "Reference: Workflows API | Client SDK"
 description: Learn how to interact with and execute automated workflows in Mastra using the client-js SDK.
 ---
 

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

@@ -0,0 +1,59 @@
+---
+title: "Reference: Mastra.addGateway() | Core"
+description: "Add a gateway to the Mastra instance"
+---
+
+# Mastra.addGateway()
+
+Dynamically adds a gateway to the Mastra instance. Can be used during or after initialization.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra();
+
+// Add with explicit key
+mastra.addGateway(new MyCustomGateway(), 'myGateway');
+
+// Add using gateway's ID as the key
+mastra.addGateway(new MyCustomGateway());
+// Stored with key 'my-custom-gateway' (the gateway's id)
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateway',
+      type: 'MastraModelGateway',
+      description: 'The gateway instance to add',
+    },
+    {
+      name: 'key',
+      type: 'string',
+      isOptional: true,
+      description: 'Optional registration key. If not provided, uses gateway.getId()',
+    },
+  ]}
+/>
+
+## Returns
+
+Void. The gateway is added to the internal registry.
+
+## Behavior
+
+- If a gateway with the same key already exists, the addition is skipped
+- In development mode (`MASTRA_DEV=true`), automatically triggers type generation for custom gateways
+- The gateway becomes available immediately for model resolution
+
+## Related
+
+- [Mastra.getGateway()](/reference/v1/core/getGateway) - Get gateway by registration key
+- [Mastra.getGatewayById()](/reference/v1/core/getGatewayById) - Get gateway by ID
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getAgent() | Core | Mastra Docs"
+title: "Reference: Mastra.getAgent() | Core"
 description: "Documentation for the `Agent.getAgent()` method in Mastra, which retrieves an agent by name."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getAgentById() | Core | Mastra Docs"
+title: "Reference: Mastra.getAgentById() | Core"
 description: "Documentation for the `Mastra.getAgentById()` method in Mastra, which retrieves an agent by its ID."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getDeployer() | Core | Mastra Docs"
+title: "Reference: Mastra.getDeployer() | Core"
 description: "Documentation for the `Mastra.getDeployer()` method in Mastra, which retrieves the configured deployer instance."
 ---
 

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

@@ -0,0 +1,59 @@
+---
+title: "Reference: Mastra.getGateway() | Core"
+description: "Retrieve a registered gateway by its registration key"
+---
+
+# Mastra.getGateway()
+
+Retrieves a gateway by its registration key (the key used when adding the gateway to Mastra).
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra({
+  gateways: {
+    myGateway: new MyCustomGateway(),
+  },
+});
+
+const gateway = mastra.getGateway('myGateway');
+console.log(gateway.name); // 'My Custom Gateway'
+```
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'key',
+      type: 'string',
+      description: 'The registration key of the gateway',
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateway',
+      type: 'MastraModelGateway',
+      description: 'The gateway instance',
+    },
+  ]}
+/>
+
+## Throws
+
+Throws an error if no gateway is found with the specified key.
+
+## Related
+
+- [Mastra.getGatewayById()](/reference/v1/core/getGatewayById) - Get gateway by ID
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways
+- [Mastra.addGateway()](/reference/v1/core/addGateway) - Add a gateway
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -0,0 +1,62 @@
+---
+title: "Reference: Mastra.getGatewayById() | Core"
+description: "Retrieve a registered gateway by its unique ID"
+---
+
+# Mastra.getGatewayById()
+
+Retrieves a gateway by its unique ID (the `id` property of the gateway instance). This is useful when you need to find a gateway by its intrinsic identifier rather than its registration key.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra({
+  gateways: {
+    customKey: new MyCustomGateway(), // id = 'my-custom-gateway'
+  },
+});
+
+// Retrieve by ID (not registration key)
+const gateway = mastra.getGatewayById('my-custom-gateway');
+console.log(gateway.name); // 'My Custom Gateway'
+```
+
+## Use Cases
+
+- Gateway versioning: Different versions with unique IDs (`'gateway-v1'`, `'gateway-v2'`)
+- Finding gateways when registration keys are unknown
+- Identifying gateways across different Mastra instances
+
+## Parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: 'id',
+      type: 'string',
+      description: 'The unique ID of the gateway (gateway.id property)',
+    },
+  ]}
+/>
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateway',
+      type: 'MastraModelGateway | undefined',
+      description: 'The gateway instance, or undefined if not found',
+    },
+  ]}
+/>
+
+## Related
+
+- [Mastra.getGateway()](/reference/v1/core/getGateway) - Get gateway by registration key
+- [Mastra.listGateways()](/reference/v1/core/listGateways) - List all gateways
+- [Mastra.addGateway()](/reference/v1/core/addGateway) - Add a gateway
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getLogger() | Core | Mastra Docs"
+title: "Reference: Mastra.getLogger() | Core"
 description: "Documentation for the `Mastra.getLogger()` method in Mastra, which retrieves the configured logger instance."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getMCPServer() | Core | Mastra Docs"
+title: "Reference: Mastra.getMCPServer() | Core"
 description: "Documentation for the `Mastra.getMCPServer()` method in Mastra, which retrieves a specific MCP server instance by ID and optional version."
 ---
 
@@ -64,5 +64,5 @@ const serverById = mastra.getMCPServerById('my-mcp-server');
 
 ## See Also
 
-- [MCP overview](/docs/v1/tools-mcp/mcp-overview)
+- [MCP overview](/docs/v1/mcp/overview)
 - [MCP server reference](/reference/v1/tools/mcp-server)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getMCPServerById() | Core | Mastra Docs"
+title: "Reference: Mastra.getMCPServerById() | Core"
 description: "Documentation for the `Mastra.getMCPServerById()` method in Mastra, which retrieves a specific MCP server instance by its intrinsic id property."
 ---
 
@@ -77,5 +77,5 @@ const serverByKey = mastra.getMCPServer('customKey');
 
 ## See Also
 
-- [MCP overview](/docs/v1/tools-mcp/mcp-overview)
+- [MCP overview](/docs/v1/mcp/overview)
 - [MCP server reference](/reference/v1/tools/mcp-server)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: getScorer() | Core | Mastra Docs"
+title: "Reference: getScorer() | Core"
 description: "Documentation for the `getScorer()` method in Mastra, which retrieves a specific scorer by its registration key."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: getScorerById() | Core | Mastra Docs"
+title: "Reference: getScorerById() | Core"
 description: "Documentation for the `getScorerById()` method in Mastra, which retrieves a scorer by its id property rather than registration key."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getServer() | Core | Mastra Docs"
+title: "Reference: Mastra.getServer() | Core"
 description: "Documentation for the `Mastra.getServer()` method in Mastra, which retrieves the configured server configuration."
 ---
 
@@ -32,5 +32,5 @@ This method does not accept any parameters.
 
 ## Related
 
-- [Server deployment](/docs/v1/deployment/server-deployment)
+- [Server deployment](/docs/v1/deployment/building-mastra)
 - [Server configuration](/docs/v1/server-db/custom-api-routes)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getStorage() | Core | Mastra Docs"
+title: "Reference: Mastra.getStorage() | Core"
 description: "Documentation for the `Mastra.getStorage()` method in Mastra, which retrieves the configured storage instance."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getTelemetry() | Core | Mastra Docs"
+title: "Reference: Mastra.getTelemetry() | Core"
 description: "Documentation for the `Mastra.getTelemetry()` method in Mastra, which retrieves the configured telemetry instance."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getVector() | Core | Mastra Docs"
+title: "Reference: Mastra.getVector() | Core"
 description: "Documentation for the `Mastra.getVector()` method in Mastra, which retrieves a vector store by name."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.getWorkflow() | Core | Mastra Docs"
+title: "Reference: Mastra.getWorkflow() | Core"
 description: "Documentation for the `Mastra.getWorkflow()` method in Mastra, which retrieves a workflow by ID."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.listAgents() | Core | Mastra Docs"
+title: "Reference: Mastra.listAgents() | Core"
 description: "Documentation for the `Mastra.listAgents()` method in Mastra, which retrieves all configured agents."
 ---
 

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

@@ -0,0 +1,53 @@
+---
+title: "Reference: Mastra.listGateways() | Core"
+description: "List all registered gateways"
+---
+
+# Mastra.listGateways()
+
+Returns a record of all registered gateways, indexed by their registration keys.
+
+## Usage example
+
+```typescript
+import { Mastra } from '@mastra/core';
+
+const mastra = new Mastra({
+  gateways: {
+    myGateway: new MyCustomGateway(),
+    anotherGateway: new AnotherGateway(),
+  },
+});
+
+const gateways = mastra.listGateways();
+console.log(Object.keys(gateways)); // ['myGateway', 'anotherGateway']
+
+// Iterate over all gateways
+for (const [key, gateway] of Object.entries(gateways)) {
+  console.log(`${key}: ${gateway.name}`);
+}
+```
+
+## Parameters
+
+None.
+
+## Returns
+
+<PropertiesTable
+  content={[
+    {
+      name: 'gateways',
+      type: 'Record<string, MastraModelGateway>',
+      description: 'A record of gateway instances indexed by registration key',
+    },
+  ]}
+/>
+
+## Related
+
+- [Mastra.getGateway()](/reference/v1/core/getGateway) - Get gateway by registration key
+- [Mastra.getGatewayById()](/reference/v1/core/getGatewayById) - Get gateway by ID
+- [Mastra.addGateway()](/reference/v1/core/addGateway) - Add a gateway
+- [MastraModelGateway](/reference/v1/core/mastra-model-gateway) - Gateway base class
+- [Custom Gateways Guide](/models/v1/gateways/custom-gateways) - Creating custom gateways

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.listLogs() | Core | Mastra Docs"
+title: "Reference: Mastra.listLogs() | Core"
 description: "Documentation for the `Mastra.listLogs()` method in Mastra, which retrieves all logs for a specific transport ID."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.listLogsByRunId() | Core | Mastra Docs"
+title: "Reference: Mastra.listLogsByRunId() | Core"
 description: "Documentation for the `Mastra.listLogsByRunId()` method in Mastra, which retrieves logs for a specific run ID and transport ID."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.listMCPServers() | Core | Mastra Docs"
+title: "Reference: Mastra.listMCPServers() | Core"
 description: "Documentation for the `Mastra.listMCPServers()` method in Mastra, which retrieves all registered MCP server instances."
 ---
 
@@ -61,5 +61,5 @@ This method does not accept any parameters.
 
 ## See Also
 
-- [MCP overview](/docs/v1/tools-mcp/mcp-overview)
+- [MCP overview](/docs/v1/mcp/overview)
 - [MCP server reference](/reference/v1/tools/mcp-server)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: listScorers() | Core | Mastra Docs"
+title: "Reference: listScorers() | Core"
 description: "Documentation for the `listScorers()` method in Mastra, which returns all registered scorers for evaluating AI outputs."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.listVectors() | Core | Mastra Docs"
+title: "Reference: Mastra.listVectors() | Core"
 description: "Documentation for the `Mastra.listVectors()` method in Mastra, which retrieves all configured vector stores."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra.listWorkflows() | Core | Mastra Docs"
+title: "Reference: Mastra.listWorkflows() | Core"
 description: "Documentation for the `Mastra.listWorkflows()` method in Mastra, which retrieves all configured workflows."
 ---
 

package/.docs/raw/reference/core/mastra-class.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Mastra Class | Core | Mastra Docs"
+title: "Reference: Mastra Class | Core"
 description: "Documentation for the `Mastra` class in Mastra, the core entry point for managing agents, workflows, MCP servers, and server endpoints."
 ---
 
@@ -140,5 +140,13 @@ export const mastra = new Mastra({
       isOptional: true,
       defaultValue: "{}",
     },
+    {
+      name: "gateways",
+      type: "Record<string, MastraModelGateway>",
+      description:
+        "Custom model gateways to register for accessing AI models through alternative providers or private deployments. Structured as a key-value pair, with keys being the registry key (used for getGateway()) and values being gateway instances.",
+      isOptional: true,
+      defaultValue: "{}",
+    },
   ]}
 />