@mastra/mcp-docs-server 1.2.15-alpha.9 → 1.2.16-alpha.1

package/.docs/guides/guide/slack-assistant.md

@@ -1,193 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# Building a Slack assistant
-
-In this guide, you'll build a Mastra agent that responds to messages and mentions on Slack. You'll learn how to configure a channel adapter, set up a Slack app with the right permissions, connect it to your agent via a webhook, and test the interaction.
-
-## Prerequisites
-
-- Node.js `v22.13.0` or later installed
-- An API key from a supported [Model Provider](https://mastra.ai/models)
-- An existing Mastra project. Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) if needed.
-- A [Slack workspace](https://slack.com/) where you can create apps
-
-## Create the agent
-
-Install the Slack adapter:
-
-**npm**:
-
-```bash
-npm install @chat-adapter/slack
-```
-
-**pnpm**:
-
-```bash
-pnpm add @chat-adapter/slack
-```
-
-**Yarn**:
-
-```bash
-yarn add @chat-adapter/slack
-```
-
-**Bun**:
-
-```bash
-bun add @chat-adapter/slack
-```
-
-Create a new file `src/mastra/agents/slack-agent.ts` and define your agent:
-
-```ts
-import { Agent } from '@mastra/core/agent'
-import { createSlackAdapter } from '@chat-adapter/slack'
-
-export const slackAgent = new Agent({
-  id: 'slack-agent',
-  name: 'Slack Agent',
-  instructions:
-    'You are a helpful assistant. Answer questions, help with tasks, and have natural conversations.',
-  model: 'anthropic/claude-opus-4-7',
-  channels: {
-    adapters: {
-      slack: createSlackAdapter(),
-    },
-  },
-})
-```
-
-The `channels` property tells Mastra to generate a webhook endpoint for each adapter. In this case, the Slack adapter handles event verification, signature validation, and message formatting automatically.
-
-Register the agent in your `src/mastra/index.ts` file:
-
-```ts
-import { Mastra } from '@mastra/core'
-import { slackAgent } from './agents/slack-agent'
-
-export const mastra = new Mastra({
-  agents: { slackAgent },
-})
-```
-
-## Create a Slack app
-
-You need a Slack app to connect your agent to a workspace.
-
-Go to <https://api.slack.com/apps> and select **Create New App** > **From scratch**. Give it a name and select your workspace.
-
-Navigate to **OAuth & Permissions** and scroll to **Bot Token Scopes**. Add the following scopes:
-
-- `app_mentions:read`
-- `channels:history`
-- `channels:read`
-- `chat:write`
-- `users:read`
-
-At the top of **OAuth & Permissions**, select **Install to Workspace**. Copy the **Bot User OAuth Token** (`xoxb-...`).
-
-Go to **Basic Information** > **App Credentials** and copy the **Signing Secret** (e.g. `c3a4...`).
-
-Ensure **Socket Mode** is turned **off** under **Settings** > **Socket Mode**.
-
-Add the credentials to your `.env` file:
-
-```bash
-SLACK_SIGNING_SECRET=your-signing-secret
-SLACK_BOT_TOKEN=xoxb-your-bot-token
-```
-
-The adapter reads these environment variables by default. See the [Chat SDK Slack adapter docs](https://chat-sdk.dev/adapters/slack) for more details.
-
-## Connect the webhook
-
-Slack delivers events to your agent via a webhook. Mastra generates this endpoint automatically for each channel adapter.
-
-Start the dev server:
-
-**npm**:
-
-```bash
-npm run dev
-```
-
-**pnpm**:
-
-```bash
-pnpm run dev
-```
-
-**Yarn**:
-
-```bash
-yarn dev
-```
-
-**Bun**:
-
-```bash
-bun run dev
-```
-
-During local development, Slack needs a public URL to reach your local server. Open a new terminal and start a tunnel:
-
-```bash
-npx cloudflared tunnel --url http://localhost:4111
-```
-
-This outputs a temporary public URL like `https://triple-arms-solutions-kit.trycloudflare.com`. The URL changes each time you restart the tunnel.
-
-In your Slack app settings, go to **Event Subscriptions** and toggle **Enable Events** to **On**.
-
-Set the **Request URL** to your tunnel URL with the agent webhook path:
-
-```text
-https://<your-tunnel-url>/api/agents/slack-agent/channels/slack/webhook
-```
-
-Slack sends a verification request. If your dev server is running, it responds with a green checkmark.
-
-Under **Subscribe to bot events**, add:
-
-- `app_mention`
-- `message.channels`
-
-Select **Save Changes**. Slack requires you to reinstall the app after changing event subscriptions. Go to **OAuth & Permissions** and select **Reinstall to Workspace** to apply the updated permissions.
-
-> **Note:** The tunnel URL is for local development only. When you [deploy your application](https://mastra.ai/docs/deployment/overview), update the **Request URL** in your Slack app's **Event Subscriptions** to your production URL (e.g. `https://your-app.example.com/api/agents/slack-agent/channels/slack/webhook`).
-
-## Test the agent
-
-Before testing with Slack, you can refine your agent's behavior in [Studio](https://mastra.ai/docs/studio/overview). Open <http://localhost:4111/> to chat with your agent and adjust its instructions. Inspect traces to see how responses are generated.
-
-Once you're happy with the agent's responses, test the Slack integration. Invite the bot to a channel in Slack:
-
-```text
-/invite @your-bot-name
-```
-
-Mention the bot in the channel:
-
-```text
-@your-bot-name What can you help me with?
-```
-
-The agent responds in the thread. Output may vary depending on the model and instructions.
-
-## Next steps
-
-You can extend this agent to:
-
-- [Deploy your application](https://mastra.ai/docs/deployment/overview) and update the Slack **Request URL** to your production endpoint
-- Add more adapters (Discord, Telegram) to the same agent so it responds on multiple platforms
-- Configure [multimodal content](https://mastra.ai/docs/capabilities/channels/overview) to let your agent process images, video, and audio shared in chat
-- Add [tools](https://mastra.ai/docs/agents/using-tools) to give the agent access to external APIs and data
-
-Learn more:
-
-- [Channels overview](https://mastra.ai/docs/capabilities/channels/overview)
-- [Studio](https://mastra.ai/docs/studio/overview)
-- [Deployment overview](https://mastra.ai/docs/deployment/overview)
-- [Chat SDK adapter docs](https://chat-sdk.dev)

package/.docs/guides/guide/stock-agent.md

@@ -1,132 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# Building an AI stock agent
-
-In this guide, you'll create an agent that fetches the previous day's closing stock price for a symbol. You'll create a tool and add it to an agent, then use the agent to fetch stock prices.
-
-## Prerequisites
-
-- Node.js `v22.13.0` or later installed
-- An API key from a supported [Model Provider](https://mastra.ai/models)
-- An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
-
-## Creating the agent
-
-To create an agent in Mastra use the `Agent` class to define it and then register it with Mastra.
-
-1. Create a new file `src/mastra/agents/stockAgent.ts` and define your agent:
-
-   ```ts
-   import { Agent } from '@mastra/core/agent'
-
-   export const stockAgent = new Agent({
-     id: 'stock-agent',
-     name: 'Stock Agent',
-     instructions:
-       'You are a helpful assistant that provides current stock prices. When asked about a stock, use the stock price tool to fetch the stock price.',
-     model: 'openai/gpt-5.6-sol',
-   })
-   ```
-
-2. In your `src/mastra/index.ts` file, register the agent:
-
-   ```ts
-   import { Mastra } from '@mastra/core'
-   import { stockAgent } from './agents/stockAgent'
-
-   export const mastra = new Mastra({
-     agents: { stockAgent },
-   })
-   ```
-
-## Creating the stock price tool
-
-The Stock Agent doesn't yet know anything about current stock prices. To change this, create a tool and add it to the agent.
-
-1. Create a new file `src/mastra/tools/stockPrices.ts`. Inside, add a `stockPrices` tool that will fetch the last day's closing stock price for a given symbol:
-
-   ```ts
-   import { createTool } from '@mastra/core/tools'
-   import { z } from 'zod'
-
-   const getStockPrice = async (symbol: string) => {
-     const data = await fetch(
-       `https://mastra-stock-data.vercel.app/api/stock-data?symbol=${symbol}`,
-     ).then(r => r.json())
-     return data.prices['4. close']
-   }
-
-   export const stockPrices = createTool({
-     id: 'Get Stock Price',
-     inputSchema: z.object({
-       symbol: z.string(),
-     }),
-     description: `Fetches the last day's closing stock price for a given symbol`,
-     execute: async inputData => {
-       console.log('Using tool to fetch stock price for', inputData.symbol)
-       return {
-         symbol: inputData.symbol,
-         currentPrice: await getStockPrice(inputData.symbol),
-       }
-     },
-   })
-   ```
-
-2. Inside `src/mastra/agents/stockAgent.ts` import your newly created `stockPrices` tool and add it to the agent.
-
-   ```ts
-   import { Agent } from '@mastra/core/agent'
-   import { stockPrices } from '../tools/stockPrices'
-
-   export const stockAgent = new Agent({
-     id: 'stock-agent',
-     name: 'Stock Agent',
-     instructions:
-       'You are a helpful assistant that provides current stock prices. When asked about a stock, use the stock price tool to fetch the stock price.',
-     model: 'openai/gpt-5.6-sol',
-     tools: {
-       stockPrices,
-     },
-   })
-   ```
-
-## Running the agent server
-
-Learn how to interact with your agent through Mastra's API.
-
-1. You can run your agent as a service using the `mastra dev` command:
-
-   ```bash
-   mastra dev
-   ```
-
-   This will start a server exposing endpoints to interact with your registered agents. Within [Studio](https://mastra.ai/docs/studio/overview) you can test your `stockAgent` and `stockPrices` tool through a UI.
-
-2. By default, `mastra dev` runs on `http://localhost:4111`. Your Stock agent will be available at:
-
-   ```text
-   POST http://localhost:4111/api/agents/stockAgent/generate
-   ```
-
-3. You can interact with the agent using `curl` from the command line:
-
-   ```bash
-   curl -X POST http://localhost:4111/api/agents/stockAgent/generate \
-     -H "Content-Type: application/json" \
-     -d '{
-       "messages": [
-         { "role": "user", "content": "What is the current stock price of Apple (AAPL)?" }
-       ]
-     }'
-   ```
-
-   You should receive a JSON response similar to:
-
-   ```json
-   {
-     "text": "The current price of Apple (AAPL) is $174.55.",
-     "agent": "Stock Agent"
-   }
-   ```
-
-   This indicates that your agent successfully processed the request, used the `stockPrices` tool to fetch the stock price, and returned the result.

package/.docs/guides/guide/web-search.md

@@ -1,322 +0,0 @@
-> Discover all available pages from the documentation index: https://mastra.ai/llms.txt
-
-# Building an agent that can search the web
-
-When building a web search agent, you have two main strategies to consider:
-
-1. **Native search tools from the LLM**: Certain language models offer integrated web search capabilities that work out of the box.
-2. **Implement a custom search tool**: Develop your own integration with a search provider's API to handle queries and retrieve results.
-
-## Prerequisites
-
-- Node.js `v22.13.0` or later installed
-- An API key from a supported [Model Provider](https://mastra.ai/models)
-- An existing Mastra project (Follow the [installation guide](https://mastra.ai/guides/getting-started/quickstart) to set up a new project)
-
-## Using native search tools
-
-Some LLM providers include built-in web search capabilities that can be used directly without additional API integrations. OpenAI's and Google's models both offer native search tools that the model can invoke during generation.
-
-1. Install dependencies
-
-   **OpenAI**:
-
-   **npm**:
-
-   ```bash
-   npm install @ai-sdk/openai
-   ```
-
-   **pnpm**:
-
-   ```bash
-   pnpm add @ai-sdk/openai
-   ```
-
-   **Yarn**:
-
-   ```bash
-   yarn add @ai-sdk/openai
-   ```
-
-   **Bun**:
-
-   ```bash
-   bun add @ai-sdk/openai
-   ```
-
-   **Gemini**:
-
-   ```bash
-   npm install @ai-sdk/openai
-   ```
-
-   **Tab 3**:
-
-   ```bash
-   pnpm add @ai-sdk/openai
-   ```
-
-   **Tab 4**:
-
-   ```bash
-   yarn add @ai-sdk/openai
-   ```
-
-   **Tab 5**:
-
-   ```bash
-   bun add @ai-sdk/openai
-   ```
-
-   **Tab 6**:
-
-   **npm**:
-
-   ```bash
-   npm install @ai-sdk/google
-   ```
-
-   **pnpm**:
-
-   ```bash
-   pnpm add @ai-sdk/google
-   ```
-
-   **Yarn**:
-
-   ```bash
-   yarn add @ai-sdk/google
-   ```
-
-   **Bun**:
-
-   ```bash
-   bun add @ai-sdk/google
-   ```
-
-   **Tab 7**:
-
-   ```bash
-   npm install @ai-sdk/google
-   ```
-
-   **Tab 8**:
-
-   ```bash
-   pnpm add @ai-sdk/google
-   ```
-
-   **Tab 9**:
-
-   ```bash
-   yarn add @ai-sdk/google
-   ```
-
-   **Tab 10**:
-
-   ```bash
-   bun add @ai-sdk/google
-   ```
-
-2. Create a new file `src/mastra/agents/searchAgent.ts` and define your agent:
-
-   **OpenAI**:
-
-   ```ts
-   import { Agent } from '@mastra/core/agent'
-
-   export const searchAgent = new Agent({
-     id: 'search-agent',
-     name: 'Search Agent',
-     instructions: 'You are a search agent that can search the web for information.',
-     model: 'openai/gpt-5.6-sol',
-   })
-   ```
-
-   **Gemini**:
-
-   ```ts
-   import { Agent } from '@mastra/core/agent'
-
-   export const searchAgent = new Agent({
-     id: 'search-agent',
-     name: 'Search Agent',
-     instructions: 'You are a search agent that can search the web for information.',
-     model: 'google/gemini-2.5-flash',
-   })
-   ```
-
-3. Setup the tool:
-
-   **OpenAI**:
-
-   ```ts
-   import { openai } from '@ai-sdk/openai'
-   import { Agent } from '@mastra/core/agent'
-
-   export const searchAgent = new Agent({
-     id: 'search-agent',
-     name: 'Search Agent',
-     instructions: 'You are a search agent that can search the web for information.',
-     model: 'openai/gpt-5.6-sol',
-     tools: {
-       webSearch: openai.tools.webSearch(),
-     },
-   })
-   ```
-
-   **Gemini**:
-
-   ```ts
-   import { google } from '@ai-sdk/google'
-   import { Agent } from '@mastra/core/agent'
-
-   export const searchAgent = new Agent({
-     id: 'search-agent',
-     name: 'Search Agent',
-     instructions: 'You are a search agent that can search the web for information.',
-     model: 'google/gemini-2.5-flash',
-     tools: {
-       webSearch: google.tools.googleSearch({
-         mode: 'MODE_DYNAMIC',
-       }),
-     },
-   })
-   ```
-
-4. In your `src/mastra/index.ts` file, register the agent:
-
-   ```ts
-   import { Mastra } from '@mastra/core'
-   import { searchAgent } from './agents/searchAgent'
-
-   export const mastra = new Mastra({
-     agents: { searchAgent },
-   })
-   ```
-
-5. You can test your agent with [Studio](https://mastra.ai/docs/studio/overview) using the `mastra dev` command:
-
-   ```bash
-   mastra dev
-   ```
-
-   Inside Studio navigate to the **"Search Agent"** and ask it: "What happened last week in AI news?"
-
-## Using search APIs
-
-For more control over search behavior, you can integrate external search APIs as custom tools. [Exa](https://exa.ai/) is a search engine built specifically for AI applications, offering semantic search, configurable filters (category, domain, date range), and the ability to retrieve full page contents. The search API is wrapped in a Mastra tool that defines the input schema, output format, and execution logic.
-
-1. Install dependencies
-
-   **npm**:
-
-   ```bash
-   npm install exa-js
-   ```
-
-   **pnpm**:
-
-   ```bash
-   pnpm add exa-js
-   ```
-
-   **Yarn**:
-
-   ```bash
-   yarn add exa-js
-   ```
-
-   **Bun**:
-
-   ```bash
-   bun add exa-js
-   ```
-
-2. Create a new file `src/mastra/agents/searchAgent.ts` and define your agent:
-
-   ```ts
-   import { Agent } from '@mastra/core/agent'
-
-   export const searchAgent = new Agent({
-     id: 'search-agent',
-     name: 'Search Agent',
-     instructions: 'You are a search agent that can search the web for information.',
-     model: 'openai/gpt-5.6-sol',
-   })
-   ```
-
-3. Setup the tool
-
-   ```ts
-   import { createTool } from '@mastra/core/tools'
-   import z from 'zod'
-   import Exa from 'exa-js'
-
-   export const exa = new Exa(process.env.EXA_API_KEY)
-
-   export const webSearch = createTool({
-     id: 'exa-web-search',
-     description: 'Search the web',
-     inputSchema: z.object({
-       query: z.string().min(1).max(50).describe('The search query'),
-     }),
-     outputSchema: z.array(
-       z.object({
-         title: z.string().nullable(),
-         url: z.string(),
-         content: z.string(),
-         publishedDate: z.string().optional(),
-       }),
-     ),
-     execute: async inputData => {
-       const { results } = await exa.searchAndContents(inputData.query, {
-         livecrawl: 'always',
-         numResults: 2,
-       })
-
-       return results.map(result => ({
-         title: result.title,
-         url: result.url,
-         content: result.text.slice(0, 500),
-         publishedDate: result.publishedDate,
-       }))
-     },
-   })
-   ```
-
-4. Add to your Agent
-
-   ```ts
-   import { webSearch } from './tools/searchTool'
-
-   export const searchAgent = new Agent({
-     id: 'search-agent',
-     name: 'Search Agent',
-     instructions: 'You are a search agent that can search the web for information.',
-     model: 'openai/gpt-5.6-sol',
-     tools: {
-       webSearch,
-     },
-   })
-   ```
-
-5. In your `src/mastra/index.ts` file, register the agent:
-
-   ```ts
-   import { Mastra } from '@mastra/core'
-   import { searchAgent } from './agents/searchAgent'
-
-   export const mastra = new Mastra({
-     agents: { searchAgent },
-   })
-   ```
-
-6. You can test your agent with [Studio](https://mastra.ai/docs/studio/overview) using the `mastra dev` command:
-
-   ```bash
-   mastra dev
-   ```
-
-   Inside Studio navigate to the **"Search Agent"** and ask it: "What happened last week in AI news?"