# How to integrate Emailoctopus MCP with Vercel AI SDK v6 ```json { "title": "How to integrate Emailoctopus MCP with Vercel AI SDK v6", "toolkit": "Emailoctopus", "toolkit_slug": "emailoctopus", "framework": "Vercel AI SDK", "framework_slug": "ai-sdk", "url": "https://composio.dev/toolkits/emailoctopus/framework/ai-sdk", "markdown_url": "https://composio.dev/toolkits/emailoctopus/framework/ai-sdk.md", "updated_at": "2026-05-12T10:10:16.645Z" } ``` ## Introduction This guide walks you through connecting Emailoctopus to Vercel AI SDK v6 using the Composio tool router. By the end, you'll have a working Emailoctopus agent that can add new subscribers to your newsletter list, unsubscribe a user from marketing emails, list all recent email campaigns sent through natural language commands. This guide will help you understand how to give your Vercel AI SDK agent real control over a Emailoctopus account through Composio's Emailoctopus MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Emailoctopus with - [OpenAI Agents SDK](https://composio.dev/toolkits/emailoctopus/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/emailoctopus/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/emailoctopus/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/emailoctopus/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/emailoctopus/framework/codex) - [OpenClaw](https://composio.dev/toolkits/emailoctopus/framework/openclaw) - [Hermes](https://composio.dev/toolkits/emailoctopus/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/emailoctopus/framework/cli) - [Google ADK](https://composio.dev/toolkits/emailoctopus/framework/google-adk) - [LangChain](https://composio.dev/toolkits/emailoctopus/framework/langchain) - [Mastra AI](https://composio.dev/toolkits/emailoctopus/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/emailoctopus/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/emailoctopus/framework/crew-ai) ## TL;DR Here's what you'll learn: - How to set up and configure a Vercel AI SDK agent with Emailoctopus integration - Using Composio's Tool Router to dynamically load and access Emailoctopus tools - Creating an MCP client connection using HTTP transport - Building an interactive CLI chat interface with conversation history management - Handling tool calls and results within the Vercel AI SDK framework ## What is Vercel AI SDK? The Vercel AI SDK is a TypeScript library for building AI-powered applications. It provides tools for creating agents that can use external services and maintain conversation state. Key features include: - streamText: Core function for streaming responses with real-time tool support - MCP Client: Built-in support for Model Context Protocol via @ai-sdk/mcp - Step Counting: Control multi-step tool execution with stopWhen: stepCountIs() - OpenAI Provider: Native integration with OpenAI models ## What is the Emailoctopus MCP server, and what's possible with it? The Emailoctopus MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Emailoctopus account. It provides structured and secure access to your subscriber lists, contacts, and campaigns, so your agent can perform actions like managing lists, adding contacts, launching campaigns, and handling unsubscriptions on your behalf. - Seamless contact management: Your agent can create new contacts, update details, or remove subscribers from your marketing lists in seconds. - Mailing list creation and organization: Effortlessly set up new mailing lists and keep your audience segmented for targeted campaigns. - Campaign insights and retrieval: Instantly access details about your recent email campaigns, including summaries and performance data. - Automated unsubscriptions and compliance: Quickly unsubscribe contacts or delete them to keep your lists clean and privacy-compliant. - Bulk list management: Retrieve and organize all mailing lists in your account, making it easy to scale and update your marketing efforts. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `EMAILOCTOPUS_CREATE_CONTACT` | Create Contact | This tool creates a new contact in EmailOctopus. The tool will add a contact to a specified list with the provided information. | | `EMAILOCTOPUS_CREATE_FIELD` | Create Field | Tool to create a new custom field on an EmailOctopus mailing list. Use when you need to add additional data fields beyond the default Email, First Name, and Last Name fields. | | `EMAILOCTOPUS_CREATE_LIST` | Create List | Creates a new mailing list in EmailOctopus for organizing and managing email contacts. The list is created with default fields (Email address, First name, Last name) and can be used to add contacts, send campaigns, and track subscriber engagement. | | `EMAILOCTOPUS_CREATE_TAG` | Create Tag | Tool to create a new tag on an EmailOctopus mailing list. Use when you need to add a new tag for contact segmentation and filtering purposes. | | `EMAILOCTOPUS_DELETE_CONTACT` | Delete Contact | Permanently deletes a contact from a specified EmailOctopus list. This action is irreversible - once deleted, the contact and all associated data will be removed from the list. Use this for list management, honoring deletion requests, and data privacy compliance (e.g., GDPR right to erasure). | | `EMAILOCTOPUS_DELETE_FIELD` | Delete Field | Permanently deletes a custom field from a specified EmailOctopus list. This action is irreversible - once deleted, the field and all associated data will be removed from the list. Use this for list customization and field management. | | `EMAILOCTOPUS_DELETE_LIST` | Delete List | This tool allows you to delete an existing mailing list from your EmailOctopus account. Once a list is deleted, it cannot be recovered, and all contacts within the list will be permanently removed. Note: Lists can only be deleted if no contacts within the list have received an email in the last 7 days. | | `EMAILOCTOPUS_DELETE_TAG` | Delete Tag | Tool to delete a tag from a mailing list in EmailOctopus. Use when you need to remove an existing tag that is no longer needed for contact organization or segmentation. | | `EMAILOCTOPUS_GET_ALL_LISTS` | Get All Lists | This tool retrieves all the mailing lists associated with the EmailOctopus account. | | `EMAILOCTOPUS_GET_CONTACT` | Get Contact | Tool to retrieve details of a specific contact from an EmailOctopus list. Use when you need to fetch contact information including email, fields, tags, and subscription status. | | `EMAILOCTOPUS_GET_LIST` | Get List | Retrieves details of a specific mailing list by ID. Use when you need to fetch list information, including its name, fields, tags, contact counts, and opt-in settings. | | `EMAILOCTOPUS_GET_RECENT_CAMPAIGNS` | Get Recent Campaigns | This tool retrieves a list of recent campaigns from the EmailOctopus account. | | `EMAILOCTOPUS_LIST_CONTACTS` | List Contacts | Tool to retrieve contacts from an EmailOctopus list. Returns a paginated list of contacts with optional filtering by tag, status, and date ranges. | | `EMAILOCTOPUS_LIST_TAGS` | List Tags | Tool to retrieve all tags from a mailing list. Use when you need to see what tags are available on a specific list for contact segmentation. | | `EMAILOCTOPUS_UNSUBSCRIBE_CONTACT` | Unsubscribe Contact | Unsubscribes a contact from an EmailOctopus mailing list. This tool updates the contact's subscription status to 'unsubscribed', which stops them from receiving future emails from the specified list. The contact record is preserved but marked as unsubscribed. | | `EMAILOCTOPUS_UPDATE_CONTACTS_BATCH` | Batch Update Contacts | Tool to update multiple contacts in an EmailOctopus list in a single batch operation. Use when you need to efficiently update multiple contacts at once with changes to their email, fields, status, or tags. | | `EMAILOCTOPUS_UPDATE_FIELD` | Update Field | Updates an existing custom field on an EmailOctopus list including its label, tag, type, and fallback value. Use this action to modify field properties or rename field tags. Note that changing the tag will affect how the field is referenced in email templates. | | `EMAILOCTOPUS_UPDATE_LIST` | Update List | Tool to update an existing mailing list's name in EmailOctopus. Use when you need to rename a list. | | `EMAILOCTOPUS_UPDATE_TAG` | Update Tag | Tool to update an existing tag on a mailing list. Use when you need to rename a tag. | | `EMAILOCTOPUS_UPSERT_CONTACT` | Create or Update Contact | Tool to create or update a contact in EmailOctopus. If the contact does not exist, it will be created. If the contact already exists, it will be updated. Use when you need to ensure a contact exists with specific information regardless of whether they're already in the list. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Emailoctopus MCP server is an implementation of the Model Context Protocol that connects your AI agent to Emailoctopus. It provides structured and secure access so your agent can perform Emailoctopus 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 you begin, make sure you have: - Node.js and npm installed - A Composio account with API key - An OpenAI API key ### 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'll need credits to use the models, or you can connect to another model provider. - Keep the API key safe. Composio API Key - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install required dependencies First, install the necessary packages for your project. What you're installing: - @ai-sdk/openai: Vercel AI SDK's OpenAI provider - @ai-sdk/mcp: MCP client for Vercel AI SDK - @composio/core: Composio SDK for tool integration - ai: Core Vercel AI SDK - dotenv: Environment variable management ```bash npm install @ai-sdk/openai @ai-sdk/mcp @composio/core ai dotenv ``` ### 3. Set up environment variables Create a .env file in your project root. What's needed: - OPENAI_API_KEY: Your OpenAI API key for GPT model access - COMPOSIO_API_KEY: Your Composio API key for tool access - COMPOSIO_USER_ID: A unique identifier for the user session ```bash OPENAI_API_KEY=your_openai_api_key_here COMPOSIO_API_KEY=your_composio_api_key_here COMPOSIO_USER_ID=your_user_id_here ``` ### 4. Import required modules and validate environment What's happening: - We're importing all necessary libraries including Vercel AI SDK's OpenAI provider and Composio - The dotenv/config import automatically loads environment variables - The MCP client import enables connection to Composio's tool server ```typescript import "dotenv/config"; import { openai } from "@ai-sdk/openai"; import { Composio } from "@composio/core"; import * as readline from "readline"; import { streamText, type ModelMessage, stepCountIs } from "ai"; import { createMCPClient } from "@ai-sdk/mcp"; const composioAPIKey = process.env.COMPOSIO_API_KEY; const composioUserID = process.env.COMPOSIO_USER_ID; if (!process.env.OPENAI_API_KEY) 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, }); ``` ### 5. Create Tool Router session and initialize MCP client What's happening: - We're creating a Tool Router session that gives your agent access to Emailoctopus tools - The create method takes the user ID and specifies which toolkits should be available - The returned mcp object contains the URL and authentication headers needed to connect to the MCP server - This session provides access to all Emailoctopus-related tools through the MCP protocol ```typescript async function main() { // Create a tool router session for the user const session = await composio.create(composioUserID!, { toolkits: ["emailoctopus"], }); const mcpUrl = session.mcp.url; ``` ### 6. Connect to MCP server and retrieve tools What's happening: - We're creating an MCP client that connects to our Composio Tool Router session via HTTP - The mcp.url provides the endpoint, and mcp.headers contains authentication credentials - The type: "http" is important - Composio requires HTTP transport - tools() retrieves all available Emailoctopus tools that the agent can use ```typescript const mcpClient = await createMCPClient({ transport: { type: "http", url: mcpUrl, headers: session.mcp.headers, // Authentication headers for the Composio MCP server }, }); const tools = await mcpClient.tools(); ``` ### 7. Initialize conversation and CLI interface What's happening: - We initialize an empty messages array to maintain conversation history - A readline interface is created to accept user input from the command line - Instructions are displayed to guide the user on how to interact with the agent ```typescript let messages: ModelMessage[] = []; console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n"); console.log( "Ask any questions related to emailoctopus, like summarize my last 5 emails, send an email, etc... :)))\n", ); const rl = readline.createInterface({ input: process.stdin, output: process.stdout, prompt: "> ", }); rl.prompt(); ``` ### 8. Handle user input and stream responses with real-time tool feedback What's happening: - We use streamText instead of generateText to stream responses in real-time - toolChoice: "auto" allows the model to decide when to use Emailoctopus tools - stopWhen: stepCountIs(10) allows up to 10 steps for complex multi-tool operations - onStepFinish callback displays which tools are being used in real-time - We iterate through the text stream to create a typewriter effect as the agent responds - The complete response is added to conversation history to maintain context - Errors are caught and displayed with helpful retry suggestions ```typescript 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({ role: "user", content: trimmedInput }); console.log("\nAgent is thinking...\n"); try { const stream = streamText({ model: openai("gpt-5"), messages, tools, toolChoice: "auto", stopWhen: stepCountIs(10), onStepFinish: (step) => { for (const toolCall of step.toolCalls) { console.log(`[Using tool: ${toolCall.toolName}]`); } if (step.toolCalls.length > 0) { console.log(""); // Add space after tool calls } }, }); for await (const chunk of stream.textStream) { process.stdout.write(chunk); } console.log("\n\n---\n"); // Get final result for message history const response = await stream.response; if (response?.messages?.length) { messages.push(...response.messages); } } catch (error) { console.error("\nAn error occurred while talking to the agent:"); console.error(error); console.log( "\nYou can try again or restart the app if it keeps happening.\n", ); } finally { rl.prompt(); } }); rl.on("close", async () => { await mcpClient.close(); console.log("\n👋 Session ended."); 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 { Composio } from "@composio/core"; import * as readline from "readline"; import { streamText, type ModelMessage, stepCountIs } from "ai"; import { createMCPClient } from "@ai-sdk/mcp"; const composioAPIKey = process.env.COMPOSIO_API_KEY; const composioUserID = process.env.COMPOSIO_USER_ID; if (!process.env.OPENAI_API_KEY) 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, }); async function main() { // Create a tool router session for the user const session = await composio.create(composioUserID!, { toolkits: ["emailoctopus"], }); const mcpUrl = session.mcp.url; const mcpClient = await createMCPClient({ transport: { type: "http", url: mcpUrl, headers: session.mcp.headers, // Authentication headers for the Composio MCP server }, }); const tools = await mcpClient.tools(); let messages: ModelMessage[] = []; console.log("Chat started! Type 'exit' or 'quit' to end the conversation.\n"); console.log( "Ask any questions related to emailoctopus, like summarize my last 5 emails, send an email, etc... :)))\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({ role: "user", content: trimmedInput }); console.log("\nAgent is thinking...\n"); try { const stream = streamText({ model: openai("gpt-5"), messages, tools, toolChoice: "auto", stopWhen: stepCountIs(10), onStepFinish: (step) => { for (const toolCall of step.toolCalls) { console.log(`[Using tool: ${toolCall.toolName}]`); } if (step.toolCalls.length > 0) { console.log(""); // Add space after tool calls } }, }); for await (const chunk of stream.textStream) { process.stdout.write(chunk); } console.log("\n\n---\n"); // Get final result for message history const response = await stream.response; if (response?.messages?.length) { messages.push(...response.messages); } } catch (error) { console.error("\nAn error occurred while talking to the agent:"); console.error(error); console.log( "\nYou can try again or restart the app if it keeps happening.\n", ); } finally { rl.prompt(); } }); rl.on("close", async () => { await mcpClient.close(); console.log("\n👋 Session ended."); process.exit(0); }); } main().catch((err) => { console.error("Fatal error:", err); process.exit(1); }); ``` ## Conclusion You've successfully built a Emailoctopus agent using the Vercel AI SDK with streaming capabilities! This implementation provides a powerful foundation for building AI applications with natural language interfaces and real-time feedback. Key features of this implementation: - Real-time streaming responses for a better user experience with typewriter effect - Live tool execution feedback showing which tools are being used as the agent works - Dynamic tool loading through Composio's Tool Router with secure authentication - Multi-step tool execution with configurable step limits (up to 10 steps) - Comprehensive error handling for robust agent execution - Conversation history maintenance for context-aware responses You can extend this further by adding custom error handling, implementing specific business logic, or integrating additional Composio toolkits to create multi-app workflows. ## How to build Emailoctopus MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/emailoctopus/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/emailoctopus/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/emailoctopus/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/emailoctopus/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/emailoctopus/framework/codex) - [OpenClaw](https://composio.dev/toolkits/emailoctopus/framework/openclaw) - [Hermes](https://composio.dev/toolkits/emailoctopus/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/emailoctopus/framework/cli) - [Google ADK](https://composio.dev/toolkits/emailoctopus/framework/google-adk) - [LangChain](https://composio.dev/toolkits/emailoctopus/framework/langchain) - [Mastra AI](https://composio.dev/toolkits/emailoctopus/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/emailoctopus/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/emailoctopus/framework/crew-ai) ## Related Toolkits - [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. - [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. - [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. - [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. - [Bigmailer](https://composio.dev/toolkits/bigmailer) - BigMailer is an email marketing platform for managing multiple brands with white-labeling and automation. It helps teams streamline campaigns and simplify integration with Amazon SES. - [Brandfetch](https://composio.dev/toolkits/brandfetch) - Brandfetch is an API that delivers company logos, colors, and visual branding assets. It helps marketers and developers keep brand visuals consistent everywhere. - [Brevo](https://composio.dev/toolkits/brevo) - Brevo is an all-in-one email and SMS marketing platform for transactional messaging, automation, and CRM. It helps businesses engage customers and streamline communications through powerful campaign tools. - [Campayn](https://composio.dev/toolkits/campayn) - Campayn is an email marketing platform for creating, sending, and managing campaigns. It helps businesses engage contacts and grow audiences with easy-to-use tools. - [Cardly](https://composio.dev/toolkits/cardly) - Cardly is a platform for creating and sending personalized direct mail to customers. It helps businesses break through the digital clutter by getting real engagement via physical mailboxes. - [ClickSend](https://composio.dev/toolkits/clicksend) - ClickSend is a cloud-based SMS and email marketing platform for businesses. It streamlines communication by enabling quick message delivery and contact management. - [Crustdata](https://composio.dev/toolkits/crustdata) - CrustData is an AI-powered data intelligence platform for real-time company and people data. It helps B2B sales teams, AI SDRs, and investors react to live business signals. - [Curated](https://composio.dev/toolkits/curated) - Curated is a platform for collecting, curating, and publishing newsletters. It streamlines content aggregation and distribution for creators and teams. - [Customerio](https://composio.dev/toolkits/customerio) - Customer.io is a customer engagement platform for targeted messaging across email, SMS, and push. Easily automate, segment, and track communications with your audience. - [Cutt ly](https://composio.dev/toolkits/cutt_ly) - Cutt.ly is a URL shortening service for managing and analyzing links. Streamline your workflows with quick, trackable, and branded short URLs. - [Demio](https://composio.dev/toolkits/demio) - Demio is webinar software built for marketers, offering both live and automated sessions with interactive features. It helps teams engage audiences and optimize lead generation through detailed analytics. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Emailoctopus MCP? With a standalone Emailoctopus MCP server, the agents and LLMs can only access a fixed set of Emailoctopus tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Emailoctopus and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Vercel AI SDK v6? Yes, you can. Vercel AI SDK v6 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 Emailoctopus tools. ### Can I manage the permissions and scopes for Emailoctopus while using Tool Router? Yes, absolutely. You can configure which Emailoctopus 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 Emailoctopus data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)