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

package/.docs/raw/reference/tools/mcp-server.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: MCPServer | Exposing Mastra Tools via MCP | Mastra Docs"
+title: "Reference: MCPServer | Tools & MCP | Mastra Docs"
 description: API Reference for MCPServer - A class for exposing Mastra tools and capabilities as a Model Context Protocol server.
 ---
 
@@ -165,7 +165,6 @@ A powerful feature of `MCPServer` is its ability to automatically expose your Ma
 - **Tool Naming**: Each agent is converted into a tool named `ask_<agentKey>`, where `<agentKey>` is the key you used for that agent in the `agents` object. For instance, if you configure `agents: { myAgentKey: myAgentInstance }`, a tool named `ask_myAgentKey` will be created.
 
 - **Tool Functionality**:
-
   - **Description**: The generated tool's description will be in the format: "Ask agent `<AgentName>` a question. Original agent instructions: `<agent description>`".
   - **Input**: The tool expects a single object argument with a `message` property (string): `{ message: "Your question for the agent" }`.
   - **Execution**: When this tool is called, it invokes the `generate()` method of the corresponding agent, passing the provided `query`.
@@ -383,7 +382,7 @@ import http from "http";
 
 const httpServer = http.createServer(async (req, res) => {
   await server.startHTTP({
-    url: new URL(req.url || '', 'http://localhost:1234'),
+    url: new URL(req.url || "", "http://localhost:1234"),
     httpPath: `/mcp`,
     req,
     res,
@@ -403,32 +402,32 @@ Here are the details for the values needed by the `startHTTP` method:
 <PropertiesTable
   content={[
     {
-      name: 'url',
-      type: 'URL',
-      description: 'The web address the user is requesting.',
+      name: "url",
+      type: "URL",
+      description: "The web address the user is requesting.",
     },
     {
-      name: 'httpPath',
-      type: 'string',
+      name: "httpPath",
+      type: "string",
       description:
         "The specific part of the URL where the MCP server will handle HTTP requests (e.g., '/mcp').",
     },
     {
-      name: 'req',
-      type: 'http.IncomingMessage',
-      description: 'The incoming request object from your web server.',
+      name: "req",
+      type: "http.IncomingMessage",
+      description: "The incoming request object from your web server.",
     },
     {
-      name: 'res',
-      type: 'http.ServerResponse',
+      name: "res",
+      type: "http.ServerResponse",
       description:
-        'The response object from your web server, used to send data back.',
+        "The response object from your web server, used to send data back.",
     },
     {
-      name: 'options',
-      type: 'StreamableHTTPServerTransportOptions',
+      name: "options",
+      type: "StreamableHTTPServerTransportOptions",
       description:
-        'Optional configuration for the HTTP transport. See the options table below for more details.',
+        "Optional configuration for the HTTP transport. See the options table below for more details.",
       optional: true,
     },
   ]}
@@ -439,30 +438,30 @@ The `StreamableHTTPServerTransportOptions` object allows you to customize the be
 <PropertiesTable
   content={[
     {
-      name: 'sessionIdGenerator',
-      type: '(() => string) | undefined',
+      name: "sessionIdGenerator",
+      type: "(() => string) | undefined",
       description:
-        'A function that generates a unique session ID. This should be a cryptographically secure, globally unique string. Return `undefined` to disable session management.',
+        "A function that generates a unique session ID. This should be a cryptographically secure, globally unique string. Return `undefined` to disable session management.",
     },
     {
-      name: 'onsessioninitialized',
-      type: '(sessionId: string) => void',
+      name: "onsessioninitialized",
+      type: "(sessionId: string) => void",
       description:
-        'A callback that is invoked when a new session is initialized. This is useful for tracking active MCP sessions.',
+        "A callback that is invoked when a new session is initialized. This is useful for tracking active MCP sessions.",
       optional: true,
     },
     {
-      name: 'enableJsonResponse',
-      type: 'boolean',
+      name: "enableJsonResponse",
+      type: "boolean",
       description:
-        'If `true`, the server will return plain JSON responses instead of using Server-Sent Events (SSE) for streaming. Defaults to `false`.',
+        "If `true`, the server will return plain JSON responses instead of using Server-Sent Events (SSE) for streaming. Defaults to `false`.",
       optional: true,
     },
     {
-      name: 'eventStore',
-      type: 'EventStore',
+      name: "eventStore",
+      type: "EventStore",
       description:
-        'An event store for message resumability. Providing this enables clients to reconnect and resume message streams.',
+        "An event store for message resumability. Providing this enables clients to reconnect and resume message streams.",
       optional: true,
     },
   ]}
@@ -752,13 +751,13 @@ const prompts: Prompt[] = [
   {
     name: "analyze-code",
     description: "Analyze code for improvements",
-    version: "v1"
+    version: "v1",
   },
   {
     name: "analyze-code",
     description: "Analyze code for improvements (new logic)",
-    version: "v2"
-  }
+    version: "v2",
+  },
 ];
 
 const myPromptHandlers: MCPServerPrompts = {
@@ -766,39 +765,46 @@ const myPromptHandlers: MCPServerPrompts = {
   getPromptMessages: async ({ name, version, args }) => {
     if (name === "analyze-code") {
       if (version === "v2") {
-        const prompt = prompts.find(p => p.name === name && p.version === "v2");
+        const prompt = prompts.find(
+          (p) => p.name === name && p.version === "v2",
+        );
         if (!prompt) throw new Error("Prompt version not found");
         return {
           prompt,
           messages: [
             {
               role: "user",
-              content: { type: "text", text: `Analyze this code with the new logic: ${args.code}` }
-            }
-          ]
+              content: {
+                type: "text",
+                text: `Analyze this code with the new logic: ${args.code}`,
+              },
+            },
+          ],
         };
       }
       // Default or v1
-      const prompt = prompts.find(p => p.name === name && p.version === "v1");
+      const prompt = prompts.find((p) => p.name === name && p.version === "v1");
       if (!prompt) throw new Error("Prompt version not found");
       return {
         prompt,
         messages: [
           {
             role: "user",
-            content: { type: "text", text: `Analyze this code: ${args.code}` }
-          }
-        ]
+            content: { type: "text", text: `Analyze this code: ${args.code}` },
+          },
+        ],
       };
     }
     throw new Error("Prompt not found");
-  }
+  },
 };
 
 const serverWithPrompts = new MCPServer({
   name: "Promptful Server",
   version: "1.0.0",
-  tools: { /* ... */ },
+  tools: {
+    /* ... */
+  },
   prompts: myPromptHandlers,
 });
 ```
@@ -849,20 +855,22 @@ When tools are executed within an MCP server context, they receive an additional
 execute: async ({ context }, options) => {
   // context contains the tool's input parameters
   // options contains server capabilities like elicitation and authentication info
-  
+
   // Access authentication information (when available)
   if (options.extra?.authInfo) {
-    console.log('Authenticated request from:', options.extra.authInfo.clientId);
+    console.log("Authenticated request from:", options.extra.authInfo.clientId);
   }
-  
+
   // Use elicitation capabilities
   const result = await options.elicitation.sendRequest({
     message: "Please provide information",
-    requestedSchema: { /* schema */ }
+    requestedSchema: {
+      /* schema */
+    },
   });
-  
+
   return result;
-}
+};
 ```
 
 ### How Elicitation Works
@@ -893,51 +901,54 @@ const server = new MCPServer({
       id: "collectContactInfo",
       description: "Collects user contact information through elicitation",
       inputSchema: z.object({
-        reason: z.string().optional().describe("Reason for collecting contact info"),
+        reason: z
+          .string()
+          .optional()
+          .describe("Reason for collecting contact info"),
       }),
       execute: async ({ context }, options) => {
         const { reason } = context;
-        
+
         // Log session info if available
-        console.log('Request from session:', options.extra?.sessionId);
+        console.log("Request from session:", options.extra?.sessionId);
 
         try {
           // Request user input via elicitation
           const result = await options.elicitation.sendRequest({
-            message: reason 
+            message: reason
               ? `Please provide your contact information. ${reason}`
-              : 'Please provide your contact information',
+              : "Please provide your contact information",
             requestedSchema: {
-              type: 'object',
+              type: "object",
               properties: {
                 name: {
-                  type: 'string',
-                  title: 'Full Name',
-                  description: 'Your full name',
+                  type: "string",
+                  title: "Full Name",
+                  description: "Your full name",
                 },
                 email: {
-                  type: 'string',
-                  title: 'Email Address', 
-                  description: 'Your email address',
-                  format: 'email',
+                  type: "string",
+                  title: "Email Address",
+                  description: "Your email address",
+                  format: "email",
                 },
                 phone: {
-                  type: 'string',
-                  title: 'Phone Number',
-                  description: 'Your phone number (optional)',
+                  type: "string",
+                  title: "Phone Number",
+                  description: "Your phone number (optional)",
                 },
               },
-              required: ['name', 'email'],
+              required: ["name", "email"],
             },
           });
 
           // Handle the user's response
-          if (result.action === 'accept') {
+          if (result.action === "accept") {
             return `Contact information collected: ${JSON.stringify(result.content, null, 2)}`;
-          } else if (result.action === 'decline') {
-            return 'Contact information collection was declined by the user.';
+          } else if (result.action === "decline") {
+            return "Contact information collection was declined by the user.";
           } else {
-            return 'Contact information collection was cancelled by the user.';
+            return "Contact information collection was cancelled by the user.";
           }
         } catch (error) {
           return `Error collecting contact information: ${error}`;
@@ -1017,7 +1028,7 @@ execute: async ({ context }, options) => {
     message: string,           // Message to display to user
     requestedSchema: object    // JSON schema defining expected response structure
   }): Promise<ElicitResult>
-  
+
   // Access authentication info if needed
   if (options.extra?.authInfo) {
     // Use options.extra.authInfo.token, etc.
@@ -1031,9 +1042,9 @@ The `ElicitResult` type:
 
 ```typescript
 type ElicitResult = {
-  action: 'accept' | 'decline' | 'cancel';
+  action: "accept" | "decline" | "cancel";
   content?: any; // Only present when action is 'accept'
-}
+};
 ```
 
 ## Authentication Context
@@ -1045,29 +1056,31 @@ execute: async ({ context }, options) => {
   if (!options.extra?.authInfo?.token) {
     return "Authentication required";
   }
-  
+
   // Use the auth token
-  const response = await fetch('/api/data', {
+  const response = await fetch("/api/data", {
     headers: { Authorization: `Bearer ${options.extra.authInfo.token}` },
     signal: options.extra.signal,
   });
-  
+
   return response.json();
-}
+};
 ```
 
 The `extra` object contains:
+
 - `authInfo`: Authentication info (when provided by server middleware)
-- `sessionId`: Session identifier  
+- `sessionId`: Session identifier
 - `signal`: AbortSignal for cancellation
 - `sendNotification`/`sendRequest`: MCP protocol functions
 
 > Note: To enable authentication, your HTTP server needs middleware that populates `req.auth` before calling `server.startHTTP()`. For example:
+>
 > ```typescript
 > httpServer.createServer((req, res) => {
 >   // Add auth middleware
 >   req.auth = validateAuthToken(req.headers.authorization);
->   
+>
 >   // Then pass to MCP server
 >   await server.startHTTP({ url, httpPath, req, res });
 > });

package/.docs/raw/reference/tools/vector-query-tool.mdx

@@ -1,10 +1,10 @@
 ---
-title: "Reference: createVectorQueryTool() | RAG | Mastra Tools Docs"
+title: "Reference: createVectorQueryTool() | Tools & MCP | Mastra Docs"
 description: Documentation for the Vector Query Tool in Mastra, which facilitates semantic search over vector stores with filtering and reranking capabilities.
 ---
 
-import { Callout } from "nextra/components";
-import { Tabs } from "nextra/components";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
 
 # createVectorQueryTool()
 
@@ -25,13 +25,15 @@ const queryTool = createVectorQueryTool({
 
 ## Parameters
 
-<Callout>
-  **Parameter Requirements:** Most fields can be set at creation as defaults.
-  Some fields can be overridden at runtime via the runtime context or input. If
-  a required field is missing from both creation and runtime, an error will be
-  thrown. Note that `model`, `id`, and `description` can only be set at creation
-  time.
-</Callout>
+:::note
+
+**Parameter Requirements:** Most fields can be set at creation as defaults.
+Some fields can be overridden at runtime via the runtime context or input. If
+a required field is missing from both creation and runtime, an error will be
+thrown. Note that `model`, `id`, and `description` can only be set at creation
+time.
+
+:::
 
 <PropertiesTable
   content={[
@@ -152,7 +154,8 @@ The `DatabaseConfig` type allows you to specify database-specific configurations
     {
       name: "pgvector",
       type: "PgVectorConfig",
-      description: "Configuration specific to PostgreSQL with pgvector extension",
+      description:
+        "Configuration specific to PostgreSQL with pgvector extension",
       isOptional: true,
       properties: [
         {
@@ -166,13 +169,15 @@ The `DatabaseConfig` type allows you to specify database-specific configurations
             },
             {
               name: "ef",
-              description: "HNSW search parameter - controls accuracy vs speed tradeoff",
+              description:
+                "HNSW search parameter - controls accuracy vs speed tradeoff",
               isOptional: true,
               type: "number",
             },
             {
               name: "probes",
-              description: "IVFFlat probe parameter - number of cells to visit during search",
+              description:
+                "IVFFlat probe parameter - number of cells to visit during search",
               isOptional: true,
               type: "number",
             },
@@ -321,7 +326,7 @@ This agent-driven approach:
 
 For detailed filter syntax and store-specific capabilities, see the [Metadata Filters](../rag/metadata-filters) documentation.
 
-For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](../../../examples/rag/usage/filter-rag.mdx) example.
+For an example of how agent-driven filtering works, see the [Agent-Driven Metadata Filtering](/examples/rag/usage/filter-rag) example.
 
 ## Example with Reranking
 
@@ -371,8 +376,8 @@ This example shows how to customize the tool description for a specific use case
 
 The `databaseConfig` parameter allows you to leverage unique features and optimizations specific to each vector database. These configurations are automatically applied during query execution.
 
-<Tabs items={['Pinecone', 'pgVector', 'Chroma', 'Multiple Configs']}>
-  <Tabs.Tab>
+<Tabs>
+  <TabItem value="pinecone" label="Pinecone">
     ### Pinecone Configuration
 
     ```typescript
@@ -396,9 +401,10 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
     - **Namespace**: Isolate different data sets within the same index
     - **Sparse Vector**: Combine dense and sparse embeddings for improved search quality
     - **Use Cases**: Multi-tenant applications, hybrid semantic search
-  </Tabs.Tab>
 
-  <Tabs.Tab>
+  </TabItem>
+
+  <TabItem value="pgvector" label="pgVector">
     ### pgVector Configuration
 
     ```typescript
@@ -421,9 +427,10 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
     - **ef (HNSW)**: Control accuracy vs speed for HNSW indexes
     - **probes (IVFFlat)**: Control recall vs speed for IVFFlat indexes
     - **Use Cases**: Performance tuning, quality filtering
-  </Tabs.Tab>
 
-  <Tabs.Tab>
+  </TabItem>
+
+  <TabItem value="chroma" label="Chroma">
     ### Chroma Configuration
 
     ```typescript
@@ -449,9 +456,10 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
     - **where**: Filter by metadata fields
     - **whereDocument**: Filter by document content
     - **Use Cases**: Advanced filtering, content-based search
-  </Tabs.Tab>
 
-  <Tabs.Tab>
+  </TabItem>
+
+  <TabItem value="multiple-configs" label="Multiple Configs">
     ### Multiple Database Configurations
 
     ```typescript
@@ -479,7 +487,8 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
     - Support multiple vector stores with one tool
     - Database-specific optimizations are automatically applied
     - Flexible deployment scenarios
-  </Tabs.Tab>
+
+  </TabItem>
 </Tabs>
 
 ### Runtime Configuration Override
@@ -487,7 +496,7 @@ The `databaseConfig` parameter allows you to leverage unique features and optimi
 You can override database configurations at runtime to adapt to different scenarios:
 
 ```typescript
-import { RuntimeContext } from '@mastra/core/runtime-context';
+import { RuntimeContext } from "@mastra/core/runtime-context";
 
 const queryTool = createVectorQueryTool({
   vectorStoreName: "pinecone",
@@ -495,26 +504,26 @@ const queryTool = createVectorQueryTool({
   model: openai.embedding("text-embedding-3-small"),
   databaseConfig: {
     pinecone: {
-      namespace: "development"
-    }
-  }
+      namespace: "development",
+    },
+  },
 });
 
 // Override at runtime
 const runtimeContext = new RuntimeContext();
-runtimeContext.set('databaseConfig', {
+runtimeContext.set("databaseConfig", {
   pinecone: {
-    namespace: 'production'  // Switch to production namespace
-  }
+    namespace: "production", // Switch to production namespace
+  },
 });
 
-const response = await agent.generate(
-  "Find information about deployment",
-  { runtimeContext }
-);
+const response = await agent.generate("Find information about deployment", {
+  runtimeContext,
+});
 ```
 
 This approach allows you to:
+
 - Switch between environments (dev/staging/prod)
 - Adjust performance parameters based on load
 - Apply different filtering strategies per request
@@ -544,7 +553,7 @@ runtimeContext.set("indexName", "my-index");
 runtimeContext.set("topK", 5);
 runtimeContext.set("filter", { category: "docs" });
 runtimeContext.set("databaseConfig", {
-  pinecone: { namespace: "runtime-namespace" }
+  pinecone: { namespace: "runtime-namespace" },
 });
 runtimeContext.set("model", openai.embedding("text-embedding-3-small"));
 
@@ -558,13 +567,14 @@ const response = await agent.generate(
 
 For more information on runtime context, please see:
 
-- [Agent Runtime Context](../../docs/server-db/runtime-context.mdx)
-- [Tool Runtime Context](../../docs/tools-mcp/overview.mdx#using-runtimecontext)
+- [Agent Runtime Context](/docs/server-db/runtime-context)
+- [Tool Runtime Context](/docs/tools-mcp/overview#using-runtimecontext)
 
 ## Usage Without a Mastra Server
 
 The tool can be used by itself to retrieve documents matching a query:
-```typescript copy showLineNumbers filename="src/index.ts"
+
+```typescript copy showLineNumbers title="src/index.ts"
 import { openai } from "@ai-sdk/openai";
 import { RuntimeContext } from "@mastra/core/runtime-context";
 import { createVectorQueryTool } from "@mastra/rag";

package/.docs/raw/reference/vectors/astra.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Reference: Astra Vector Store | Vector Databases | Mastra Docs"
+title: "Reference: Astra Vector Store | Vectors | Mastra Docs"
 description: Documentation for the AstraVector class in Mastra, which provides vector search using DataStax Astra DB.
 ---