@mastra/mcp-docs-server 1.1.5 → 1.1.6

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

@@ -0,0 +1,320 @@
+# 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 GPT-4o-mini and Google's Gemini 2.5 Flash both offer native search tools that the model can invoke during generation.
+
+1. Install dependencies
+
+   **Open AI**:
+
+   **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:
+
+   **Open AI**:
+
+   ```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.1',
+   })
+   ```
+
+   **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:
+
+   **Open AI**:
+
+   ```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.1',
+     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/getting-started/studio) 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.1',
+   })
+   ```
+
+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.1',
+     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/getting-started/studio) 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?"

package/.docs/guides/guide/whatsapp-chat-bot.md

@@ -0,0 +1,405 @@
+# WhatsApp Chat Bot
+
+This guide demonstrates how to create a WhatsApp chat bot using Mastra agents and workflows. The bot receives incoming WhatsApp messages via webhook, processes them through an AI agent, breaks responses into natural text messages, and sends them back via the WhatsApp Business API.
+
+## Prerequisites
+
+This example requires a WhatsApp Business API setup and uses the `anthropic` model. Add these environment variables to your `.env` file:
+
+```bash
+ANTHROPIC_API_KEY=<your-anthropic-api-key>
+WHATSAPP_VERIFY_TOKEN=<your-verify-token>
+WHATSAPP_ACCESS_TOKEN=<your-whatsapp-access-token>
+WHATSAPP_BUSINESS_PHONE_NUMBER_ID=<your-phone-number-id>
+WHATSAPP_API_VERSION=v22.0
+```
+
+## Creating the WhatsApp client
+
+This client handles sending messages to users via the WhatsApp Business API.
+
+```typescript
+// Simple WhatsApp Business API client for sending messages
+
+interface SendMessageParams {
+  to: string
+  message: string
+}
+
+export async function sendWhatsAppMessage({ to, message }: SendMessageParams) {
+  // Get environment variables for WhatsApp API
+  const apiVersion = process.env.WHATSAPP_API_VERSION || 'v22.0'
+  const phoneNumberId = process.env.WHATSAPP_BUSINESS_PHONE_NUMBER_ID
+  const accessToken = process.env.WHATSAPP_ACCESS_TOKEN
+
+  // Check if required environment variables are set
+  if (!phoneNumberId || !accessToken) {
+    return false
+  }
+
+  // WhatsApp Business API endpoint
+  const url = `https://graph.facebook.com/${apiVersion}/${phoneNumberId}/messages`
+
+  // Message payload following WhatsApp API format
+  const payload = {
+    messaging_product: 'whatsapp',
+    recipient_type: 'individual',
+    to: to,
+    type: 'text',
+    text: {
+      body: message,
+    },
+  }
+
+  try {
+    // Send message via WhatsApp Business API
+    const response = await fetch(url, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${accessToken}`,
+      },
+      body: JSON.stringify(payload),
+    })
+
+    const result = await response.json()
+
+    if (response.ok) {
+      console.log(`✅ WhatsApp message sent to ${to}: "${message}"`)
+      return true
+    } else {
+      console.error('❌ Failed to send WhatsApp message:', result)
+      return false
+    }
+  } catch (error) {
+    console.error('❌ Error sending WhatsApp message:', error)
+    return false
+  }
+}
+```
+
+## Creating the chat agent
+
+This agent handles the main conversation logic with a friendly, conversational personality.
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { Memory } from '@mastra/memory'
+import { LibSQLStore } from '@mastra/libsql'
+
+export const chatAgent = new Agent({
+  id: 'chat-agent',
+  name: 'Chat Agent',
+  instructions: `
+    You are a helpful, friendly, and knowledgeable AI assistant that loves to chat with users via WhatsApp.
+
+    Your personality:
+    - Warm, approachable, and conversational
+    - Enthusiastic about helping with any topic
+    - Use a casual, friendly tone like you're chatting with a friend
+    - Be concise but informative
+    - Show genuine interest in the user's questions
+
+    Your capabilities:
+    - Answer questions on a wide variety of topics
+    - Provide helpful advice and suggestions
+    - Engage in casual conversation
+    - Help with problem-solving and creative tasks
+    - Explain complex topics in simple terms
+
+    Guidelines:
+    - Keep responses informative but not overwhelming
+    - Ask follow-up questions when appropriate
+    - Be encouraging and positive
+    - If you don't know something, admit it honestly
+    - Adapt your communication style to match the user's tone
+    - Remember this is WhatsApp, so keep it conversational and natural
+
+    Always aim to be helpful while maintaining a friendly, approachable conversation style.
+  `,
+  model: 'anthropic/claude-4-sonnet-20250514',
+  memory: new Memory({
+    storage: new LibSQLStore({
+      id: 'agent-storage',
+      url: 'file:../mastra.db',
+    }),
+  }),
+})
+```
+
+## Creating the text message agent
+
+This agent converts longer responses into natural, bite-sized text messages suitable for WhatsApp.
+
+```typescript
+import { Agent } from '@mastra/core/agent'
+import { Memory } from '@mastra/memory'
+import { LibSQLStore } from '@mastra/libsql'
+
+export const textMessageAgent = new Agent({
+  id: 'text-message-agent',
+  name: 'Text Message Agent',
+  instructions: `
+    You are a text message converter that takes formal or lengthy text and breaks it down into natural, casual text messages.
+
+    Your job is to:
+    - Convert any input text into 5-8 short, casual text messages
+    - Each message should be 1-2 sentences maximum
+    - Use natural, friendly texting language (contractions, casual tone)
+    - Maintain all the important information from the original text
+    - Make it feel like you're texting a friend
+    - Use appropriate emojis sparingly to add personality
+    - Keep the conversational flow logical and easy to follow
+
+    Think of it like you're explaining something exciting to a friend via text - break it into bite-sized, engaging messages that don't overwhelm them with a long paragraph.
+
+    Always return exactly 5-8 messages in the messages array.
+  `,
+  model: 'anthropic/claude-4-sonnet-20250514',
+  memory: new Memory({
+    storage: new LibSQLStore({
+      id: 'agent-storage',
+      url: 'file:../mastra.db',
+    }),
+  }),
+})
+```
+
+## Creating the chat workflow
+
+This workflow orchestrates the entire chat process: generating a response, breaking it into messages, and sending them via WhatsApp.
+
+```typescript
+import { createStep, createWorkflow } from '@mastra/core/workflows'
+import { z } from 'zod'
+import { sendWhatsAppMessage } from '../../whatsapp-client'
+
+const respondToMessage = createStep({
+  id: 'respond-to-message',
+  description: 'Generate response to user message',
+  inputSchema: z.object({ userMessage: z.string() }),
+  outputSchema: z.object({ response: z.string() }),
+  execute: async ({ inputData, mastra }) => {
+    const agent = mastra?.getAgent('chatAgent')
+    if (!agent) {
+      throw new Error('Chat agent not found')
+    }
+
+    const response = await agent.generate([{ role: 'user', content: inputData.userMessage }])
+
+    return { response: response.text }
+  },
+})
+
+const breakIntoMessages = createStep({
+  id: 'break-into-messages',
+  description: 'Breaks response into text messages',
+  inputSchema: z.object({ prompt: z.string() }),
+  outputSchema: z.object({ messages: z.array(z.string()) }),
+  execute: async ({ inputData, mastra }) => {
+    const agent = mastra?.getAgent('textMessageAgent')
+    if (!agent) {
+      throw new Error('Text Message agent not found')
+    }
+
+    const response = await agent.generate([{ role: 'user', content: inputData.prompt }], {
+      structuredOutput: {
+        schema: z.object({
+          messages: z.array(z.string()),
+        }),
+      },
+    })
+
+    if (!response.object) throw new Error('Error generating messages')
+
+    return response.object
+  },
+})
+
+const sendMessages = createStep({
+  id: 'send-messages',
+  description: 'Sends text messages via WhatsApp',
+  inputSchema: z.object({
+    messages: z.array(z.string()),
+    userPhone: z.string(),
+  }),
+  outputSchema: z.object({ sentCount: z.number() }),
+  execute: async ({ inputData }) => {
+    const { messages, userPhone } = inputData
+
+    console.log(`\n🔥 Sending ${messages.length} WhatsApp messages to ${userPhone}...`)
+
+    let sentCount = 0
+
+    // Send each message with a small delay for natural flow
+    for (let i = 0; i < messages.length; i++) {
+      const success = await sendWhatsAppMessage({
+        to: userPhone,
+        message: messages[i],
+      })
+
+      if (success) {
+        sentCount++
+      }
+
+      // Add delay between messages for natural texting rhythm
+      if (i < messages.length - 1) {
+        await new Promise(resolve => setTimeout(resolve, 1000))
+      }
+    }
+
+    console.log(`\n✅ Successfully sent ${sentCount}/${messages.length} WhatsApp messages\n`)
+
+    return { sentCount }
+  },
+})
+
+export const chatWorkflow = createWorkflow({
+  id: 'chat-workflow',
+  inputSchema: z.object({ userMessage: z.string() }),
+  outputSchema: z.object({ sentCount: z.number() }),
+})
+  .then(respondToMessage)
+  .map(async ({ inputData }) => ({
+    prompt: `Break this AI response into 3-8 casual, friendly text messages that feel natural for WhatsApp conversation:\n\n${inputData.response}`,
+  }))
+  .then(breakIntoMessages)
+  .map(async ({ inputData, getInitData }) => {
+    // Parse the original stringified input to get user phone
+    const initData = getInitData<typeof chatWorkflow>()
+    const webhookData = JSON.parse(initData.userMessage)
+    const userPhone = webhookData.entry?.[0]?.changes?.[0]?.value?.messages?.[0]?.from || 'unknown'
+
+    return {
+      messages: inputData.messages,
+      userPhone,
+    }
+  })
+  .then(sendMessages)
+
+chatWorkflow.commit()
+```
+
+## Setting up Mastra configuration
+
+Configure your Mastra instance with the agents, workflow, and WhatsApp webhook endpoints.
+
+```typescript
+import { Mastra } from '@mastra/core'
+import { registerApiRoute } from '@mastra/core/server'
+import { PinoLogger } from '@mastra/loggers'
+import { LibSQLStore } from '@mastra/libsql'
+
+import { chatWorkflow } from './workflows/chat-workflow'
+import { textMessageAgent } from './agents/text-message-agent'
+import { chatAgent } from './agents/chat-agent'
+
+export const mastra = new Mastra({
+  workflows: { chatWorkflow },
+  agents: { textMessageAgent, chatAgent },
+  storage: new LibSQLStore({
+    id: 'agent-storage',
+    url: ':memory:',
+  }),
+  logger: new PinoLogger({
+    name: 'Mastra',
+    level: 'info',
+  }),
+  server: {
+    apiRoutes: [
+      registerApiRoute('/whatsapp', {
+        method: 'GET',
+        handler: async c => {
+          const verifyToken = process.env.WHATSAPP_VERIFY_TOKEN
+          const {
+            'hub.mode': mode,
+            'hub.challenge': challenge,
+            'hub.verify_token': token,
+          } = c.req.query()
+
+          if (mode === 'subscribe' && token === verifyToken) {
+            return c.text(challenge, 200)
+          } else {
+            return c.status(403)
+          }
+        },
+      }),
+      registerApiRoute('/whatsapp', {
+        method: 'POST',
+        handler: async c => {
+          const mastra = c.get('mastra')
+          const chatWorkflow = mastra.getWorkflow('chatWorkflow')
+
+          const body = await c.req.json()
+
+          const workflowRun = await chatWorkflow.createRun()
+          const runResult = await workflowRun.start({
+            inputData: { userMessage: JSON.stringify(body) },
+          })
+
+          return c.json(runResult)
+        },
+      }),
+    ],
+  },
+})
+```
+
+## Testing the chat bot
+
+You can test the chat bot locally by simulating a WhatsApp webhook payload.
+
+```typescript
+import 'dotenv/config'
+
+import { mastra } from './mastra'
+
+// Simulate a WhatsApp webhook payload
+const mockWebhookData = {
+  entry: [
+    {
+      changes: [
+        {
+          value: {
+            messages: [
+              {
+                from: '1234567890', // Test phone number
+                text: {
+                  body: 'Hello! How are you today?',
+                },
+              },
+            ],
+          },
+        },
+      ],
+    },
+  ],
+}
+
+const workflow = mastra.getWorkflow('chatWorkflow')
+const workflowRun = await workflow.createRun()
+
+const result = await workflowRun.start({
+  inputData: { userMessage: JSON.stringify(mockWebhookData) },
+})
+
+console.log('Workflow completed:', result)
+```
+
+## Example output
+
+When a user sends "Hello! How are you today?" to your WhatsApp bot, it might respond with multiple messages like:
+
+```text
+Hey there! 👋 I'm doing great, thanks for asking!
+
+How's your day going so far?
+
+I'm here and ready to chat about whatever's on your mind
+
+Whether you need help with something or just want to talk, I'm all ears! 😊
+
+What's new with you?
+```
+
+The bot maintains conversation context through memory and delivers responses that feel natural for WhatsApp messaging.