# How to integrate Heyy MCP with Mastra AI ```json { "title": "How to integrate Heyy MCP with Mastra AI", "toolkit": "Heyy", "toolkit_slug": "heyy", "framework": "Mastra AI", "framework_slug": "mastra-ai", "url": "https://composio.dev/toolkits/heyy/framework/mastra-ai", "markdown_url": "https://composio.dev/toolkits/heyy/framework/mastra-ai.md", "updated_at": "2026-03-29T06:37:25.481Z" } ``` ## Introduction This guide walks you through connecting Heyy to Mastra AI using the Composio tool router. By the end, you'll have a working Heyy agent that can send promotional sms to vip customers, reply to unread instagram messages, broadcast order updates on whatsapp group through natural language commands. This guide will help you understand how to give your Mastra AI agent real control over a Heyy account through Composio's Heyy MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Heyy with - [OpenAI Agents SDK](https://composio.dev/toolkits/heyy/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/heyy/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/heyy/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/heyy/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/heyy/framework/codex) - [OpenClaw](https://composio.dev/toolkits/heyy/framework/openclaw) - [Hermes](https://composio.dev/toolkits/heyy/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/heyy/framework/cli) - [Google ADK](https://composio.dev/toolkits/heyy/framework/google-adk) - [LangChain](https://composio.dev/toolkits/heyy/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/heyy/framework/ai-sdk) - [LlamaIndex](https://composio.dev/toolkits/heyy/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/heyy/framework/crew-ai) ## TL;DR Here's what you'll learn: - Set up your environment so Mastra, OpenAI, and Composio work together - Create a Tool Router session in Composio that exposes Heyy tools - Connect Mastra's MCP client to the Composio generated MCP URL - Fetch Heyy tool definitions and attach them as a toolset - Build a Mastra agent that can reason, call tools, and return structured results - Run an interactive CLI where you can chat with your Heyy agent ## What is Mastra AI? Mastra AI is a TypeScript framework for building AI agents with tool support. It provides a clean API for creating agents that can use external services through MCP. Key features include: - MCP Client: Built-in support for Model Context Protocol servers - Toolsets: Organize tools into logical groups - Step Callbacks: Monitor and debug agent execution - OpenAI Integration: Works with OpenAI models via @ai-sdk/openai ## What is the Heyy MCP server, and what's possible with it? The Heyy MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Heyy account. It provides structured and secure access so your agent can perform Heyy operations on your behalf. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `HEYY_CREATE_ATTRIBUTE` | Create Contact Attribute | Tool to create a new custom attribute for contacts in Heyy. Use when you need to add custom fields to track additional information about contacts, such as customer segments, preferences, or custom identifiers. | | `HEYY_CREATE_CONTACT` | Create Contact | Tool to create a new contact in Heyy with optional details including first name, last name, email, phone number, labels, and custom attributes. Use when you need to add a new contact to your Heyy account. | | `HEYY_CREATE_LABEL` | Create Label | Tool to create a new label for categorizing contacts in Heyy. Use when you need to organize contacts into categories or groups. | | `HEYY_CREATE_WEBHOOK` | Create Webhook | Tool to create a new webhook for receiving event notifications across multiple channels. Use when you need to set up real-time event notifications for messages. | | `HEYY_DELETE_ATTRIBUTE` | Delete Attribute | Tool to delete an attribute by its unique identifier. Use when you need to remove an attribute from the system. | | `HEYY_DELETE_LABEL` | Delete Label | Tool to delete a label by its unique identifier. Use when you need to remove a label from the system. | | `HEYY_DELETE_WEBHOOK` | Delete Webhook | Tool to delete a webhook by its unique identifier. Use when you need to remove a webhook from Heyy. | | `HEYY_LIST_ATTRIBUTES` | List Attributes | Tool to retrieve all attributes available in the Heyy system. Use when you need to get a list of all attributes with their properties and visibility settings. | | `HEYY_LIST_AUTOMATIONS` | List Automations | Tool to retrieve automation workflows for a specified channel. Use when you need to get all workflows configured for a channel. | | `HEYY_LIST_CHANNELS` | List Channels | Tool to retrieve all available channels from the Heyy system. Use when you need to get a complete list of channels with their details including name, type, status, and timestamps. | | `HEYY_LIST_MESSAGE_TEMPLATES` | List Message Templates | Tool to retrieve all message templates available in the Heyy system. Use when you need to view all existing templates for messaging. | | `HEYY_LIST_API_WEBHOOKS` | List API Webhooks | Tool to retrieve all API webhooks configured for the account. Use when you need to inspect or manage webhook configurations. | | `HEYY_UPDATE_WEBHOOK` | Update Webhook | Tool to update a webhook's URL and active status. Use when you need to modify an existing webhook's endpoint or enable/disable it. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Heyy MCP server is an implementation of the Model Context Protocol that connects your AI agent to Heyy. It provides structured and secure access so your agent can perform Heyy operations on your behalf through a secure, permission-based interface. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites Before starting, make sure you have: - Node.js 18 or higher - A Composio account with an active API key - An OpenAI API key - Basic familiarity with TypeScript ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key. - You need credits or a connected billing setup to use the models. - Store the key somewhere safe. Composio API Key - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Go to Settings and copy your API key. - This key lets your Mastra agent talk to Composio and reach Heyy through MCP. ### 2. Install dependencies Install the required packages. What's happening: - @composio/core is the Composio SDK for creating MCP sessions - @mastra/core provides the Agent class - @mastra/mcp is Mastra's MCP client - @ai-sdk/openai is the model wrapper for OpenAI - dotenv loads environment variables from .env ```bash npm install @composio/core @mastra/core @mastra/mcp @ai-sdk/openai dotenv ``` ### 3. Set up environment variables Create a .env file in your project root. What's happening: - COMPOSIO_API_KEY authenticates your requests to Composio - COMPOSIO_USER_ID tells Composio which user this session belongs to - OPENAI_API_KEY lets the Mastra agent call OpenAI models ```bash COMPOSIO_API_KEY=your_composio_api_key_here COMPOSIO_USER_ID=your_user_id_here OPENAI_API_KEY=your_openai_api_key_here ``` ### 4. Import libraries and validate environment What's happening: - dotenv/config auto loads your .env so process.env.* is available - openai gives you a Mastra compatible model wrapper - Agent is the Mastra agent that will call tools and produce answers - MCPClient connects Mastra to your Composio MCP server - Composio is used to create a Tool Router session ```typescript import "dotenv/config"; import { openai } from "@ai-sdk/openai"; import { Agent } from "@mastra/core/agent"; import { MCPClient } from "@mastra/mcp"; import { Composio } from "@composio/core"; import * as readline from "readline"; import type { AiMessageType } from "@mastra/core/agent"; const openaiAPIKey = process.env.OPENAI_API_KEY; const composioAPIKey = process.env.COMPOSIO_API_KEY; const composioUserID = process.env.COMPOSIO_USER_ID; if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set"); if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set"); if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set"); const composio = new Composio({ apiKey: composioAPIKey as string, }); ``` ### 5. Create a Tool Router session for Heyy What's happening: - create spins up a short-lived MCP HTTP endpoint for this user - The toolkits array contains "heyy" for Heyy access - session.mcp.url is the MCP URL that Mastra's MCPClient will connect to ```typescript async function main() { const session = await composio.create( composioUserID as string, { toolkits: ["heyy"], }, ); const composioMCPUrl = session.mcp.url; console.log("Heyy MCP URL:", composioMCPUrl); ``` ### 6. Configure Mastra MCP client and fetch tools What's happening: - MCPClient takes an id for this client and a list of MCP servers - The headers property includes the x-api-key for authentication - getTools fetches the tool definitions exposed by the Heyy toolkit ```typescript const mcpClient = new MCPClient({ id: composioUserID as string, servers: { nasdaq: { url: new URL(composioMCPUrl), requestInit: { headers: session.mcp.headers, }, }, }, timeout: 30_000, }); console.log("Fetching MCP tools from Composio..."); const composioTools = await mcpClient.getTools(); console.log("Number of tools:", Object.keys(composioTools).length); ``` ### 7. Create the Mastra agent What's happening: - Agent is the core Mastra agent - name is just an identifier for logging and debugging - instructions guide the agent to use tools instead of only answering in natural language - model uses openai("gpt-5") to configure the underlying LLM ```typescript const agent = new Agent({ name: "heyy-mastra-agent", instructions: "You are an AI agent with Heyy tools via Composio.", model: "openai/gpt-5", }); ``` ### 8. Set up interactive chat interface What's happening: - messages keeps the full conversation history in Mastra's expected format - agent.generate runs the agent with conversation history and Heyy toolsets - maxSteps limits how many tool calls the agent can take in a single run - onStepFinish is a hook that prints intermediate steps for debugging ```typescript let messages: AiMessageType[] = []; console.log("Chat started! Type 'exit' or 'quit' to end.\n"); const rl = readline.createInterface({ input: process.stdin, output: process.stdout, prompt: "> ", }); rl.prompt(); rl.on("line", async (userInput: string) => { const trimmedInput = userInput.trim(); if (["exit", "quit", "bye"].includes(trimmedInput.toLowerCase())) { console.log("\nGoodbye!"); rl.close(); process.exit(0); } if (!trimmedInput) { rl.prompt(); return; } messages.push({ id: crypto.randomUUID(), role: "user", content: trimmedInput, }); console.log("\nAgent is thinking...\n"); try { const response = await agent.generate(messages, { toolsets: { heyy: composioTools, }, maxSteps: 8, }); const { text } = response; if (text && text.trim().length > 0) { console.log(`Agent: ${text}\n`); messages.push({ id: crypto.randomUUID(), role: "assistant", content: text, }); } } catch (error) { console.error("\nError:", error); } rl.prompt(); }); rl.on("close", async () => { console.log("\nSession ended."); await mcpClient.disconnect(); process.exit(0); }); } main().catch((err) => { console.error("Fatal error:", err); process.exit(1); }); ``` ## Complete Code ```typescript import "dotenv/config"; import { openai } from "@ai-sdk/openai"; import { Agent } from "@mastra/core/agent"; import { MCPClient } from "@mastra/mcp"; import { Composio } from "@composio/core"; import * as readline from "readline"; import type { AiMessageType } from "@mastra/core/agent"; const openaiAPIKey = process.env.OPENAI_API_KEY; const composioAPIKey = process.env.COMPOSIO_API_KEY; const composioUserID = process.env.COMPOSIO_USER_ID; if (!openaiAPIKey) throw new Error("OPENAI_API_KEY is not set"); if (!composioAPIKey) throw new Error("COMPOSIO_API_KEY is not set"); if (!composioUserID) throw new Error("COMPOSIO_USER_ID is not set"); const composio = new Composio({ apiKey: composioAPIKey as string }); async function main() { const session = await composio.create(composioUserID as string, { toolkits: ["heyy"], }); const composioMCPUrl = session.mcp.url; const mcpClient = new MCPClient({ id: composioUserID as string, servers: { heyy: { url: new URL(composioMCPUrl), requestInit: { headers: session.mcp.headers, }, }, }, timeout: 30_000, }); const composioTools = await mcpClient.getTools(); const agent = new Agent({ name: "heyy-mastra-agent", instructions: "You are an AI agent with Heyy tools via Composio.", model: "openai/gpt-5", }); let messages: AiMessageType[] = []; const rl = readline.createInterface({ input: process.stdin, output: process.stdout, prompt: "> ", }); rl.prompt(); rl.on("line", async (input: string) => { const trimmed = input.trim(); if (["exit", "quit"].includes(trimmed.toLowerCase())) { rl.close(); return; } messages.push({ id: crypto.randomUUID(), role: "user", content: trimmed }); const { text } = await agent.generate(messages, { toolsets: { heyy: composioTools }, maxSteps: 8, }); if (text) { console.log(`Agent: ${text}\n`); messages.push({ id: crypto.randomUUID(), role: "assistant", content: text }); } rl.prompt(); }); rl.on("close", async () => { await mcpClient.disconnect(); process.exit(0); }); } main(); ``` ## Conclusion You've built a Mastra AI agent that can interact with Heyy through Composio's Tool Router. You can extend this further by: - Adding other toolkits like Gmail, Slack, or GitHub - Building a web-based chat interface around this agent - Using multiple MCP endpoints to enable cross-app workflows ## How to build Heyy MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/heyy/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/heyy/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/heyy/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/heyy/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/heyy/framework/codex) - [OpenClaw](https://composio.dev/toolkits/heyy/framework/openclaw) - [Hermes](https://composio.dev/toolkits/heyy/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/heyy/framework/cli) - [Google ADK](https://composio.dev/toolkits/heyy/framework/google-adk) - [LangChain](https://composio.dev/toolkits/heyy/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/heyy/framework/ai-sdk) - [LlamaIndex](https://composio.dev/toolkits/heyy/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/heyy/framework/crew-ai) ## Related Toolkits - [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable. - [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management. - [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place. - [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action. - [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication. - [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack. - [Reddit](https://composio.dev/toolkits/reddit) - Reddit is a social news platform with thriving user-driven communities (subreddits). It's the go-to place for discussion, content sharing, and viral marketing. - [Facebook](https://composio.dev/toolkits/facebook) - Facebook is a social media and advertising platform for businesses and creators. It helps you connect, share, and manage content across your public Facebook Pages. - [Linkedin](https://composio.dev/toolkits/linkedin) - LinkedIn is a professional networking platform for connecting, sharing content, and engaging with business opportunities. It's the go-to place for building your professional brand and unlocking new career connections. - [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers. - [Active campaign](https://composio.dev/toolkits/active_campaign) - ActiveCampaign is a marketing automation and CRM platform for managing email campaigns, sales pipelines, and customer segmentation. It helps businesses engage customers and drive growth through smart automation and targeted outreach. - [ActiveTrail](https://composio.dev/toolkits/active_trail) - ActiveTrail is a user-friendly email marketing and automation platform. It helps you reach subscribers and automate campaigns with ease. - [Aeroleads](https://composio.dev/toolkits/aeroleads) - Aeroleads is a B2B lead generation platform for finding business emails and phone numbers. Grow your sales pipeline faster with powerful prospecting tools. - [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed. - [Ahrefs](https://composio.dev/toolkits/ahrefs) - Ahrefs is an SEO and marketing platform for site audits, keyword research, and competitor insights. It helps you improve search rankings and drive organic traffic. - [Amcards](https://composio.dev/toolkits/amcards) - AMCards lets you create and mail personalized greeting cards online. Build stronger customer relationships with easy, automated card campaigns. - [Autobound](https://composio.dev/toolkits/autobound) - Autobound is an AI-powered sales engagement platform that crafts hyper-personalized outreach and insights. It helps sales teams boost response rates and close more deals through tailored content and recommendations. - [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place. - [Beamer](https://composio.dev/toolkits/beamer) - Beamer is a news and changelog platform for in-app announcements and feature updates. It helps companies boost user engagement by sharing news where users are most active. - [Benchmark email](https://composio.dev/toolkits/benchmark_email) - Benchmark Email is a platform for creating, sending, and tracking email campaigns. It's built to help you engage audiences and analyze results—all in one place. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Heyy MCP? With a standalone Heyy MCP server, the agents and LLMs can only access a fixed set of Heyy tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Heyy and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Mastra AI? Yes, you can. Mastra AI fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Heyy tools. ### Can I manage the permissions and scopes for Heyy while using Tool Router? Yes, absolutely. You can configure which Heyy scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do. ### How safe is my data with Composio Tool Router? All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Heyy data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)