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

package/.docs/raw/observability/tracing/overview.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Tracing | Observability | Mastra Docs"
+title: "Tracing | Observability"
 description: "Set up Tracing for Mastra applications"
 ---
 
@@ -753,7 +753,7 @@ Mastra automatically creates spans for:
 
 ### Examples
 
-- [Basic Tracing Example](/examples/v1/observability/basic-tracing) - Working implementation
+- [Basic Tracing Example](/examples/v1/observability/basic-ai-tracing) - Working implementation
 
 ### Reference Documentation
 

package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Sensitive Data Filter | Processors | Observability | Mastra Docs"
+title: "Sensitive Data Filter | Processors | Observability"
 description: "Protect sensitive information in your traces with automatic data redaction"
 ---
 
@@ -293,4 +293,4 @@ This ensures that processing errors don't prevent traces from being exported or
 ## Related
 
 - [SensitiveDataFilter API](/reference/v1/observability/tracing/processors/sensitive-data-filter)
-- [Basic Tracing Example](/examples/v1/observability/basic-tracing)
+- [Basic Tracing Example](/examples/v1/observability/basic-ai-tracing)

package/.docs/raw/rag/overview.mdx

@@ -1,5 +1,5 @@
 ---
-title: "RAG (Retrieval-Augmented Generation) in Mastra | RAG | Mastra Docs"
+title: "RAG (Retrieval-Augmented Generation) in Mastra | RAG"
 description: Overview of Retrieval-Augmented Generation (RAG) in Mastra, detailing its capabilities for enhancing LLM outputs with relevant context.
 ---
 

package/.docs/raw/rag/retrieval.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Retrieval, Semantic Search, Reranking | RAG | Mastra Docs"
+title: "Retrieval, Semantic Search, Reranking | RAG"
 description: Guide on retrieval processes in Mastra's RAG systems, including semantic search, filtering, and re-ranking.
 ---
 

package/.docs/raw/rag/vector-databases.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Storing Embeddings in A Vector Database | RAG | Mastra Docs"
+title: "Storing Embeddings in A Vector Database | RAG"
 description: Guide on vector storage options in Mastra, including embedded and dedicated vector databases for similarity search.
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent Class | Agents | Mastra Docs"
+title: "Reference: Agent Class | Agents"
 description: "Documentation for the `Agent` class in Mastra, which provides the foundation for creating AI agents with various capabilities."
 ---
 
@@ -245,4 +245,3 @@ export const agent = new Agent({
 ## Related
 
 - [Agents overview](/docs/v1/agents/overview)
-- [Calling Agents](/examples/v1/agents/calling-agents)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.generate() | Agents | Mastra Docs"
+title: "Reference: Agent.generate() | Agents"
 description: "Documentation for the `Agent.generate()` method in Mastra agents, which enables non-streaming generation of responses with enhanced capabilities."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.generateLegacy() (Legacy) | Agents | Mastra Docs"
+title: "Reference: Agent.generateLegacy() (Legacy) | Agents"
 description: "Documentation for the legacy `Agent.generateLegacy()` method in Mastra agents. This method is deprecated and will be removed in a future version."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getDefaultGenerateOptionsLegacy() | Agents | Mastra Docs"
+title: "Reference: Agent.getDefaultGenerateOptionsLegacy() | Agents"
 description: "Documentation for the `Agent.getDefaultGenerateOptionsLegacy()` method in Mastra agents, which retrieves the default options used for generateLegacy calls."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getDefaultOptions() | Agents | Mastra Docs"
+title: "Reference: Agent.getDefaultOptions() | Agents"
 description: "Documentation for the `Agent.getDefaultOptions()` method in Mastra agents, which retrieves the default options used for stream and generate calls."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getDefaultStreamOptionsLegacy() | Agents | Mastra Docs"
+title: "Reference: Agent.getDefaultStreamOptionsLegacy() | Agents"
 description: "Documentation for the `Agent.getDefaultStreamOptionsLegacy()` method in Mastra agents, which retrieves the default options used for streamLegacy calls."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getDescription() | Agents | Mastra Docs"
+title: "Reference: Agent.getDescription() | Agents"
 description: "Documentation for the `Agent.getDescription()` method in Mastra agents, which retrieves the agent's description."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getInstructions() | Agents | Mastra Docs"
+title: "Reference: Agent.getInstructions() | Agents"
 description: "Documentation for the `Agent.getInstructions()` method in Mastra agents, which retrieves the instructions that guide the agent's behavior."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getLLM() | Agents | Mastra Docs"
+title: "Reference: Agent.getLLM() | Agents"
 description: "Documentation for the `Agent.getLLM()` method in Mastra agents, which retrieves the language model instance."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getMemory() | Agents | Mastra Docs"
+title: "Reference: Agent.getMemory() | Agents"
 description: "Documentation for the `Agent.getMemory()` method in Mastra agents, which retrieves the memory system associated with the agent."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getModel() | Agents | Mastra Docs"
+title: "Reference: Agent.getModel() | Agents"
 description: "Documentation for the `Agent.getModel()` method in Mastra agents, which retrieves the language model that powers the agent."
 ---
 

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

@@ -0,0 +1,69 @@
+---
+title: "Reference: Agent.getTools() | Agents"
+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: "{ requestContext?: RequestContext }",
+      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({
+  requestContext: new RequestContext(),
+});
+```
+
+### Options parameters
+
+<PropertiesTable
+  content={[
+    {
+      name: "requestContext",
+      type: "RequestContext",
+      isOptional: true,
+      defaultValue: "new RequestContext()",
+      description:
+        "Runtime context for dependency injection and contextual information.",
+    },
+  ]}
+/>
+
+## Related
+
+- [Using tools with agents](/docs/v1/agents/using-tools)
+- [MCP Overview](/docs/v1/mcp/overview)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.getVoice() | Agents | Mastra Docs"
+title: "Reference: Agent.getVoice() | Agents"
 description: "Documentation for the `Agent.getVoice()` method in Mastra agents, which retrieves the voice provider for speech capabilities."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.listAgents() | Agents | Mastra Docs"
+title: "Reference: Agent.listAgents() | Agents"
 description: "Documentation for the `Agent.listAgents()` method in Mastra agents, which retrieves the sub-agents that the agent can access."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.listScorers() | Agents | Mastra Docs"
+title: "Reference: Agent.listScorers() | Agents"
 description: "Documentation for the `Agent.listScorers()` method in Mastra agents, which retrieves the scoring configuration."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.listTools() | Agents | Mastra Docs"
+title: "Reference: Agent.listTools() | Agents"
 description: "Documentation for the `Agent.listTools()` method in Mastra agents, which retrieves the tools that the agent can use."
 ---
 
@@ -66,4 +66,4 @@ await agent.listTools({
 ## Related
 
 - [Using tools with agents](/docs/v1/agents/using-tools)
-- [Creating tools](/docs/v1/tools-mcp/overview)
+- [Creating tools](/docs/v1/mcp/overview)

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.listWorkflows() | Agents | Mastra Docs"
+title: "Reference: Agent.listWorkflows() | Agents"
 description: "Documentation for the `Agent.listWorkflows()` method in Mastra agents, which retrieves the workflows that the agent can execute."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agent.network() | Agents | Mastra Docs"
+title: "Reference: Agent.network() | Agents"
 description: "Documentation for the `Agent.network()` method in Mastra agents, which enables multi-agent collaboration and routing."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraAuthAuth0 Class | Auth | Mastra Docs"
+title: "Reference: MastraAuthAuth0 Class | Auth"
 description: "API reference for the MastraAuthAuth0 class, which authenticates Mastra applications using Auth0 authentication."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraAuthClerk Class | Auth | Mastra Docs"
+title: "Reference: MastraAuthClerk Class | Auth"
 description: "API reference for the MastraAuthClerk class, which authenticates Mastra applications using Clerk authentication."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraAuthFirebase Class | Auth | Mastra Docs"
+title: "Reference: MastraAuthFirebase Class | Auth"
 description: "API reference for the MastraAuthFirebase class, which authenticates Mastra applications using Firebase Authentication."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraJwtAuth Class | Auth | Mastra Docs"
+title: "Reference: MastraJwtAuth Class | Auth"
 description: "API reference for the MastraJwtAuth class, which authenticates Mastra applications using JSON Web Tokens."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraAuthSupabase Class | Auth | Mastra Docs"
+title: "Reference: MastraAuthSupabase Class | Auth"
 description: "API reference for the MastraAuthSupabase class, which authenticates Mastra applications using Supabase Auth."
 ---
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MastraAuthWorkos Class | Auth | Mastra Docs"
+title: "Reference: MastraAuthWorkos Class | Auth"
 description: "API reference for the MastraAuthWorkos class, which authenticates Mastra applications using WorkOS authentication."
 ---
 

package/.docs/raw/reference/cli/create-mastra.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: create-mastra | CLI | Mastra Docs"
+title: "Reference: create-mastra | CLI"
 description: Documentation for the create-mastra command, which creates a new Mastra project with interactive setup options.
 ---
 

package/.docs/raw/reference/cli/mastra.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: CLI Commands | CLI | Mastra Docs"
+title: "Reference: CLI Commands | CLI"
 description: Documentation for the Mastra CLI to develop, build, and start your project.
 ---
 
@@ -23,11 +23,11 @@ Enable local HTTPS support. [Learn more](/docs/v1/getting-started/studio#local-h
 
 #### `--inspect`
 
-Start the development server in inspect mode, helpful for debugging. This can't be used together with `--inspect-brk`.
+Start the development server in inspect mode, helpful for debugging. Optionally specify a custom host and port (e.g., `--inspect=0.0.0.0:9229` for Docker). This can't be used together with `--inspect-brk`.
 
 #### `--inspect-brk`
 
-Start the development server in inspect mode and break at the beginning of the script. This can't be used together with `--inspect`.
+Start the development server in inspect mode and break at the beginning of the script. Optionally specify a custom host and port (e.g., `--inspect-brk=0.0.0.0:9229`). This can't be used together with `--inspect`.
 
 #### `--custom-args`
 
@@ -85,7 +85,7 @@ Under the hood Mastra's Rollup server locates your Mastra entry file and bundles
 
 The output in `.mastra` can be deployed to any cloud server using [`mastra start`](#mastra-start).
 
-If you're deploying to a [serverless platform](/docs/v1/deployment/serverless-platforms) you need to install the correct deployer in order to receive the correct output in `.mastra`.
+If you're deploying to a [serverless platform](/docs/v1/deployment/cloud-providers) you need to install the correct deployer in order to receive the correct output in `.mastra`.
 
 It accepts [common flags][common-flags].
 

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

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Agents API | Client SDK | Mastra Docs"
+title: "Reference: Agents API | Client SDK"
 description: Learn how to interact with Mastra AI agents, including generating responses, streaming interactions, and managing agent tools using the client-js SDK.
 ---
 

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