@mastra/mcp-docs-server 0.13.37 → 0.13.38

package/.docs/raw/tools-mcp/advanced-usage.mdx

@@ -88,7 +88,7 @@ npm install ai
 
 Here's an example of a tool defined using the Vercel AI SDK format:
 
-```typescript filename="src/mastra/tools/vercelWeatherTool.ts" copy
+```typescript title="src/mastra/tools/vercelWeatherTool.ts" copy
 import { tool } from "ai";
 import { z } from "zod";
 
@@ -108,7 +108,7 @@ export const vercelWeatherTool = tool({
 
 You can then add this tool to your Mastra agent just like any other tool:
 
-```typescript filename="src/mastra/agents/mixedToolsAgent.ts"
+```typescript title="src/mastra/agents/mixedToolsAgent.ts"
 import { Agent } from "@mastra/core/agent";
 import { openai } from "@ai-sdk/openai";
 import { vercelWeatherTool } from "../tools/vercelWeatherTool"; // Vercel AI SDK tool

package/.docs/raw/tools-mcp/mcp-overview.mdx

@@ -3,7 +3,8 @@ title: "MCP Overview | Tools & MCP | Mastra Docs"
 description: Learn about the Model Context Protocol (MCP), how to use third-party tools via MCPClient, connect to registries, and share your own tools using MCPServer.
 ---
 
-import { Tabs } from "nextra/components";
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
 
 # MCP Overview
 
@@ -28,7 +29,7 @@ npm install @mastra/mcp@latest
 
 The `MCPClient` connects Mastra primitives to external MCP servers, which can be local packages (invoked using `npx`) or remote HTTP(S) endpoints. Each server must be configured with either a `command` or a `url`, depending on how it's hosted.
 
-```typescript filename="src/mastra/mcp/test-mcp-client.ts" showLineNumbers copy
+```typescript title="src/mastra/mcp/test-mcp-client.ts" showLineNumbers copy
 import { MCPClient } from "@mastra/mcp";
 
 export const testMcpClient = new MCPClient({
@@ -36,22 +37,24 @@ export const testMcpClient = new MCPClient({
   servers: {
     wikipedia: {
       command: "npx",
-      args: ["-y", "wikipedia-mcp"]
+      args: ["-y", "wikipedia-mcp"],
     },
     weather: {
-      url: new URL(`https://server.smithery.ai/@smithery-ai/national-weather-service/mcp?api_key=${process.env.SMITHERY_API_KEY}`)
+      url: new URL(
+        `https://server.smithery.ai/@smithery-ai/national-weather-service/mcp?api_key=${process.env.SMITHERY_API_KEY}`,
+      ),
     },
-  }
+  },
 });
 ```
 
-> See [MCPClient](../../reference/tools/mcp-client.mdx) for a full list of configuration options.
+> See [MCPClient](/reference/tools/mcp-client) for a full list of configuration options.
 
 ## Using `MCPClient` with an agent
 
 To use tools from an MCP server in an agent, import your `MCPClient` and call `.getTools()` in the `tools` parameter. This loads from the defined MCP servers, making them available to the agent.
 
-```typescript {4,16} filename="src/mastra/agents/test-agent.ts" showLineNumbers copy
+```typescript {4,16} title="src/mastra/agents/test-agent.ts" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 
@@ -67,16 +70,17 @@ export const testAgent = new Agent({
 
       Answer questions using the information you find using the MCP Servers.`,
   model: openai("gpt-4o-mini"),
-  tools: await testMcpClient.getTools()
+  tools: await testMcpClient.getTools(),
 });
 ```
-> See the [Agent Class](../../reference/agents/agent.mdx) for a full list of configuration options.
+
+> See the [Agent Class](/reference/agents/agent) for a full list of configuration options.
 
 ## Configuring `MCPServer`
 
 To expose agents, tools, and workflows from your Mastra application to external systems over HTTP(S) use the `MCPServer` class. This makes them accessible to any system or agent that supports the protocol.
 
-```typescript filename="src/mastra/mcp/test-mcp-server.ts" showLineNumbers copy
+```typescript title="src/mastra/mcp/test-mcp-server.ts" showLineNumbers copy
 import { MCPServer } from "@mastra/mcp";
 
 import { testAgent } from "../agents/test-agent";
@@ -89,24 +93,24 @@ export const testMcpServer = new MCPServer({
   version: "1.0.0",
   agents: { testAgent },
   tools: { testTool },
-  workflows: { testWorkflow }
+  workflows: { testWorkflow },
 });
 ```
 
-> See [MCPServer](../../reference/tools/mcp-server.mdx) for a full list of configuration options.
+> See [MCPServer](/reference/tools/mcp-server) for a full list of configuration options.
 
 ## Registering an `MCPServer`
 
 To make an MCP server available to other systems or agents that support the protocol, register it in the main `Mastra` instance using `mcpServers`.
 
-```typescript filename="src/mastra/index.ts" showLineNumbers copy
+```typescript title="src/mastra/index.ts" showLineNumbers copy
 import { Mastra } from "@mastra/core/mastra";
 
 import { testMcpServer } from "./mcp/test-mcp-server";
 
 export const mastra = new Mastra({
   // ...
-  mcpServers: { testMcpServer }
+  mcpServers: { testMcpServer },
 });
 ```
 
@@ -114,10 +118,10 @@ export const mastra = new Mastra({
 
 `MCPClient` offers two approaches to retrieving tools from connected servers, suitable for different application architectures:
 
-| Feature           | Static Configuration (`await mcp.getTools()`)  | Dynamic Configuration (`await mcp.getToolsets()`)     |
-| :---------------- | :---------------------------------------------| :--------------------------------------------------- |
-| **Use Case**      | Single-user, static config (e.g., CLI tool)    | Multi-user, dynamic config (e.g., SaaS app)           |
-| **Configuration**  | Fixed at agent initialization                 | Per-request, dynamic                                 |
+| Feature           | Static Configuration (`await mcp.getTools()`) | Dynamic Configuration (`await mcp.getToolsets()`)    |
+| :---------------- | :-------------------------------------------- | :--------------------------------------------------- |
+| **Use Case**      | Single-user, static config (e.g., CLI tool)   | Multi-user, dynamic config (e.g., SaaS app)          |
+| **Configuration** | Fixed at agent initialization                 | Per-request, dynamic                                 |
 | **Credentials**   | Shared across all uses                        | Can vary per user/request                            |
 | **Agent Setup**   | Tools added in `Agent` constructor            | Tools passed in `.generate()` or `.stream()` options |
 
@@ -125,9 +129,9 @@ export const mastra = new Mastra({
 
 Use the `.getTools()` method to fetch tools from all configured MCP servers. This is suitable when configuration (such as API keys) is static and consistent across users or requests. Call it once and pass the result to the `tools` property when defining your agent.
 
-> See [getTools()](../../reference/tools/mcp-client.mdx#gettools) for more information.
+> See [getTools()](/reference/tools/mcp-client#gettools) for more information.
 
-```typescript {8} filename="src/mastra/agents/test-agent.ts" showLineNumbers copy
+```typescript {8} title="src/mastra/agents/test-agent.ts" showLineNumbers copy
 import { openai } from "@ai-sdk/openai";
 import { Agent } from "@mastra/core/agent";
 
@@ -135,7 +139,7 @@ import { testMcpClient } from "../mcp/test-mcp-client";
 
 export const testAgent = new Agent({
   // ...
-  tools: await testMcpClient.getTools()
+  tools: await testMcpClient.getTools(),
 });
 ```
 
@@ -154,45 +158,35 @@ async function handleRequest(userPrompt: string, userApiKey: string) {
         url: new URL("http://localhost:8080/mcp"),
         requestInit: {
           headers: {
-            Authorization: `Bearer ${userApiKey}`
-          }
-        }
-      }
-    }
+            Authorization: `Bearer ${userApiKey}`,
+          },
+        },
+      },
+    },
   });
 
   const agent = mastra.getAgent("testAgent");
 
   const response = await agent.generate(userPrompt, {
-    toolsets: await userMcp.getToolsets()
+    toolsets: await userMcp.getToolsets(),
   });
 
   await userMcp.disconnect();
 
   return Response.json({
-    data: response.text
+    data: response.text,
   });
 }
 ```
 
-> See [getToolsets()](../../reference/tools/mcp-client.mdx#gettoolsets) for more information.
-
-
+> See [getToolsets()](/reference/tools/mcp-client#gettoolsets) for more information.
 
 ## Connecting to an MCP registry
 
 MCP servers can be discovered through registries. Here's how to connect to some popular ones using `MCPClient`:
 
-
-{/*
-LLM CONTEXT: This Tabs component shows how to connect to different MCP (Model Context Protocol) registries.
-Each tab demonstrates the configuration for a specific MCP registry service (mcp.run, Composio.dev, Smithery.ai).
-The tabs help users understand how to connect to various MCP server providers and their different authentication methods.
-Each tab shows the specific URL patterns and configuration needed for that registry service.
-*/}
-
-<Tabs items={["Klavis AI", "mcp.run", "Composio.dev", "Smithery.ai", "Ampersand"]}>
-  <Tabs.Tab>
+<Tabs>
+  <TabItem value="klavis" label="Klavis AI">
     [Klavis AI](https://klavis.ai) provides hosted, enterprise-authenticated, high-quality MCP servers.
 
     ```typescript
@@ -214,8 +208,8 @@ Each tab shows the specific URL patterns and configuration needed for that regis
 
     For more details on how to integrate Mastra with Klavis, check out their [documentation](https://docs.klavis.ai/documentation/ai-platform-integration/mastra).
 
-  </Tabs.Tab>
-  <Tabs.Tab>
+  </TabItem>
+  <TabItem value="mcp-run" label="mcp.run">
     [mcp.run](https://www.mcp.run/) provides pre-authenticated, managed MCP servers. Tools are grouped into Profiles, each with a unique, signed URL.
 
     ```typescript
@@ -231,12 +225,12 @@ Each tab shows the specific URL patterns and configuration needed for that regis
     ```
 
     > **Important:** Treat the mcp.run SSE URL like a password. Store it securely, for example, in an environment variable.
-    > ```bash filename=".env"
+    > ```bash title=".env"
     > MCP_RUN_SSE_URL=https://www.mcp.run/api/mcp/sse?nonce=...
     > ```
 
-  </Tabs.Tab>
-  <Tabs.Tab>
+  </TabItem>
+  <TabItem value="composio" label="Composio.dev">
     [Composio.dev](https://composio.dev) offers a registry of [SSE-based MCP servers](https://mcp.composio.dev). You can use the SSE URL generated for tools like Cursor directly.
 
     ```typescript
@@ -258,8 +252,8 @@ Each tab shows the specific URL patterns and configuration needed for that regis
 
     *Note: Composio URLs are typically tied to a single user account, making them best suited for personal automation rather than multi-tenant applications.*
 
-  </Tabs.Tab>
-  <Tabs.Tab>
+  </TabItem>
+  <TabItem value="smithery" label="Smithery.ai">
     [Smithery.ai](https://smithery.ai) provides a registry accessible via their CLI.
 
     ```typescript
@@ -304,67 +298,63 @@ Each tab shows the specific URL patterns and configuration needed for that regis
     });
     ```
 
-  </Tabs.Tab>
-    <Tabs.Tab>
+  </TabItem>
+  <TabItem value="ampersand" label="Ampersand">
 
-    [Ampersand](https://withampersand.com?utm_source=mastra-docs) offers an [MCP Server](https://docs.withampersand.com/mcp) that allows you to connect your agent to 150+ integrations with SaaS products like Salesforce, Hubspot, and Zendesk.
+[Ampersand](https://withampersand.com?utm_source=mastra-docs) offers an [MCP Server](https://docs.withampersand.com/mcp) that allows you to connect your agent to 150+ integrations with SaaS products like Salesforce, Hubspot, and Zendesk.
 
+```typescript
+// MCPClient with Ampersand MCP Server using SSE
+export const mcp = new MCPClient({
+  servers: {
+    "@amp-labs/mcp-server": {
+      url: `https://mcp.withampersand.com/v1/sse?${new URLSearchParams({
+        apiKey: process.env.AMPERSAND_API_KEY,
+        project: process.env.AMPERSAND_PROJECT_ID,
+        integrationName: process.env.AMPERSAND_INTEGRATION_NAME,
+        groupRef: process.env.AMPERSAND_GROUP_REF,
+      })}`,
+    },
+  },
+});
+```
 
-    ```typescript
-
-    // MCPClient with Ampersand MCP Server using SSE
-    export const mcp = new MCPClient({
-        servers: {
-        "@amp-labs/mcp-server": {
-          "url": `https://mcp.withampersand.com/v1/sse?${new URLSearchParams({
-            apiKey: process.env.AMPERSAND_API_KEY,
-            project: process.env.AMPERSAND_PROJECT_ID,
-            integrationName: process.env.AMPERSAND_INTEGRATION_NAME,
-            groupRef: process.env.AMPERSAND_GROUP_REF
-          })}`
-        }
-      }
-    });
-
-    ```
-
-    ```typescript
-    // If you prefer to run the MCP server locally:
-
-    import { MCPClient } from "@mastra/mcp";
+```typescript
+// If you prefer to run the MCP server locally:
+import { MCPClient } from "@mastra/mcp";
 
-    // MCPClient with Ampersand MCP Server using stdio transport
-    export const mcp = new MCPClient({
-        servers: {
-          "@amp-labs/mcp-server": {
-            command: "npx",
-            args: [
-              "-y",
-              "@amp-labs/mcp-server@latest",
-              "--transport",
-              "stdio",
-              "--project",
-              process.env.AMPERSAND_PROJECT_ID,
-              "--integrationName",
-              process.env.AMPERSAND_INTEGRATION_NAME,
-              "--groupRef",
-              process.env.AMPERSAND_GROUP_REF, // optional
-            ],
-            env: {
-              AMPERSAND_API_KEY: process.env.AMPERSAND_API_KEY,
-            },
-          },
-        },
-    });
-    ```
+// MCPClient with Ampersand MCP Server using stdio transport
+export const mcp = new MCPClient({
+  servers: {
+    "@amp-labs/mcp-server": {
+      command: "npx",
+      args: [
+        "-y",
+        "@amp-labs/mcp-server@latest",
+        "--transport",
+        "stdio",
+        "--project",
+        process.env.AMPERSAND_PROJECT_ID,
+        "--integrationName",
+        process.env.AMPERSAND_INTEGRATION_NAME,
+        "--groupRef",
+        process.env.AMPERSAND_GROUP_REF, // optional
+      ],
+      env: {
+        AMPERSAND_API_KEY: process.env.AMPERSAND_API_KEY,
+      },
+    },
+  },
+});
+```
 
-    As an alternative to MCP, Ampersand's AI SDK also has an adapter for Mastra, so you can [directly import Ampersand tools](https://docs.withampersand.com/ai-sdk#use-with-mastra) for your agent to access.
+As an alternative to MCP, Ampersand's AI SDK also has an adapter for Mastra, so you can [directly import Ampersand tools](https://docs.withampersand.com/ai-sdk#use-with-mastra) for your agent to access.
 
-  </Tabs.Tab>
+  </TabItem>
 </Tabs>
 
 ## Related
 
-- [Using Tools and MCP](../agents/using-tools-and-mcp.mdx)
-- [MCPClient](../../reference/tools/mcp-client.mdx)
-- [MCPServer](../../reference/tools/mcp-server.mdx)
+- [Using Tools](/docs/agents/using-tools)
+- [MCPClient](/reference/tools/mcp-client)
+- [MCPServer](/reference/tools/mcp-server)

package/.docs/raw/tools-mcp/overview.mdx

@@ -3,8 +3,6 @@ title: "Using Tools | Tools & MCP | Mastra Docs"
 description: Understand what tools are in Mastra, how to add them to agents, and best practices for designing effective tools.
 ---
 
-import { Steps } from "nextra/components";
-
 # Using Tools
 
 Tools are functions that agents can execute to perform specific tasks or access external information. They extend an agent's capabilities beyond simple text generation, allowing interaction with APIs, databases, or other systems.
@@ -20,7 +18,7 @@ Each tool typically defines:
 
 In Mastra, you create tools using the [`createTool`](/reference/tools/create-tool) function from the `@mastra/core/tools` package.
 
-```typescript filename="src/mastra/tools/weatherInfo.ts" copy
+```typescript title="src/mastra/tools/weatherInfo.ts" copy
 import { createTool } from "@mastra/core/tools";
 import { z } from "zod";
 
@@ -54,13 +52,13 @@ When creating tools, keep tool descriptions simple and focused on **what** the t
 
 ## Adding Tools to an Agent
 
-To make tools available to an agent, you configure them in the agent's definition. Mentioning available tools and their general purpose in the agent's system prompt can also improve tool usage. For detailed steps and examples, see the guide on [Using Tools and MCP with Agents](/docs/agents/using-tools-and-mcp#add-tools-to-an-agent).
+To make tools available to an agent, you configure them in the agent's definition. Mentioning available tools and their general purpose in the agent's system prompt can also improve tool usage. For detailed steps and examples, see the guide on [Using Tools with Agents](/docs/agents/using-tools#adding-tools-to-an-agent).
 
 ## Using `RuntimeContext`
 
-Use [RuntimeContext](../server-db/runtime-context.mdx) to access request-specific values. This lets you conditionally adjust behavior based on the context of the request.
+Use [RuntimeContext](/docs/server-db/runtime-context) to access request-specific values. This lets you conditionally adjust behavior based on the context of the request.
 
-```typescript filename="src/mastra/tools/test-tool.ts" showLineNumbers
+```typescript title="src/mastra/tools/test-tool.ts" showLineNumbers
 export type UserTier = {
   "user-tier": "enterprise" | "pro";
 };
@@ -69,7 +67,7 @@ const advancedTools = () => {
   // ...
 };
 
-const baseTools =  () => {
+const baseTools = () => {
   // ...
 };
 
@@ -78,16 +76,13 @@ export const testTool = createTool({
   execute: async ({ runtimeContext }) => {
     const userTier = runtimeContext.get("user-tier") as UserTier["user-tier"];
 
-    return userTier === "enterprise"
-      ? advancedTools
-      : baseTools;
-  }
+    return userTier === "enterprise" ? advancedTools : baseTools;
+  },
 });
 ```
 
-> See [Runtime Context](../server-db/runtime-context.mdx) for more information.
+> See [Runtime Context](/docs/server-db/runtime-context) for more information.
 
 ## Testing with Mastra Playground
 
-Use the Mastra [Playground](../server-db/local-dev-playground.mdx) to test tools with different inputs, inspect execution results, and verify tool behavior.
-
+Use the Mastra [Playground](/docs/getting-started/studio) to test tools with different inputs, inspect execution results, and verify tool behavior.