# How to integrate Emailoctopus MCP with Autogen ```json { "title": "How to integrate Emailoctopus MCP with Autogen", "toolkit": "Emailoctopus", "toolkit_slug": "emailoctopus", "framework": "AutoGen", "framework_slug": "autogen", "url": "https://composio.dev/toolkits/emailoctopus/framework/autogen", "markdown_url": "https://composio.dev/toolkits/emailoctopus/framework/autogen.md", "updated_at": "2026-05-12T10:10:16.645Z" } ``` ## Introduction This guide walks you through connecting Emailoctopus to AutoGen 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 AutoGen 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) - [Vercel AI SDK](https://composio.dev/toolkits/emailoctopus/framework/ai-sdk) - [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: - Get and set up your OpenAI and Composio API keys - Install the required dependencies for Autogen and Composio - Initialize Composio and create a Tool Router session for Emailoctopus - Wire that MCP URL into Autogen using McpWorkbench and StreamableHttpServerParams - Configure an Autogen AssistantAgent that can call Emailoctopus tools - Run a live chat loop where you ask the agent to perform Emailoctopus operations ## What is AutoGen? Autogen is a framework for building multi-agent conversational AI systems from Microsoft. It enables you to create agents that can collaborate, use tools, and maintain complex workflows. Key features include: - Multi-Agent Systems: Build collaborative agent workflows - MCP Workbench: Native support for Model Context Protocol tools - Streaming HTTP: Connect to external services through streamable HTTP - AssistantAgent: Pre-built agent class for tool-using assistants ## 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 agents and assistants directly to Emailoctopus. Instead of manually wiring Emailoctopus APIs, OAuth, and scopes yourself, you get a structured, tool-based interface that an LLM can call safely. 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 You will need: - A Composio API key - An OpenAI API key (used by Autogen's OpenAIChatCompletionClient) - A Emailoctopus account you can connect to Composio - Some basic familiarity with Autogen and Python async ### 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 dependencies Install Composio, Autogen extensions, and dotenv. What's happening: - composio connects your agent to Emailoctopus via MCP - autogen-agentchat provides the AssistantAgent class - autogen-ext-openai provides the OpenAI model client - autogen-ext-tools provides MCP workbench support ```bash pip install composio python-dotenv pip install autogen-agentchat autogen-ext-openai autogen-ext-tools ``` ### 3. Set up environment variables Create a .env file in your project folder. What's happening: - COMPOSIO_API_KEY is required to talk to Composio - OPENAI_API_KEY is used by Autogen's OpenAI client - USER_ID is how Composio identifies which user's Emailoctopus connections to use ```bash COMPOSIO_API_KEY=your-composio-api-key OPENAI_API_KEY=your-openai-api-key USER_ID=your-user-identifier@example.com ``` ### 4. Import dependencies and create Tool Router session What's happening: - load_dotenv() reads your .env file - Composio(api_key=...) initializes the SDK - create(...) creates a Tool Router session that exposes Emailoctopus tools - session.mcp.url is the MCP endpoint that Autogen will connect to ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Emailoctopus session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["emailoctopus"] ) url = session.mcp.url ``` ### 5. Configure MCP parameters for Autogen Autogen expects parameters describing how to talk to the MCP server. That is what StreamableHttpServerParams is for. What's happening: - url points to the Tool Router MCP endpoint from Composio - timeout is the HTTP timeout for requests - sse_read_timeout controls how long to wait when streaming responses - terminate_on_close=True cleans up the MCP server process when the workbench is closed ```python # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) ``` ### 6. Create the model client and agent What's happening: - OpenAIChatCompletionClient wraps the OpenAI model for Autogen - McpWorkbench connects the agent to the MCP tools - AssistantAgent is configured with the Emailoctopus tools from the workbench ```python # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Emailoctopus assistant agent with MCP tools agent = AssistantAgent( name="emailoctopus_assistant", description="An AI assistant that helps with Emailoctopus operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) ``` ### 7. Run the interactive chat loop What's happening: - The script prompts you in a loop with You: - Autogen passes your input to the model, which decides which Emailoctopus tools to call via MCP - agent.run_stream(...) yields streaming messages as the agent thinks and calls tools - Typing exit, quit, or bye ends the loop ```python print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Emailoctopus related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ["exit", "quit", "bye"]: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, "content") and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Emailoctopus session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["emailoctopus"] ) url = session.mcp.url # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Emailoctopus assistant agent with MCP tools agent = AssistantAgent( name="emailoctopus_assistant", description="An AI assistant that helps with Emailoctopus operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Emailoctopus related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ['exit', 'quit', 'bye']: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, 'content') and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You now have an Autogen assistant wired into Emailoctopus through Composio's Tool Router and MCP. From here you can: - Add more toolkits to the toolkits list, for example notion or hubspot - Refine the agent description to point it at specific workflows - Wrap this script behind a UI, Slack bot, or internal tool Once the pattern is clear for Emailoctopus, you can reuse the same structure for other MCP-enabled apps with minimal code changes. ## 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) - [Vercel AI SDK](https://composio.dev/toolkits/emailoctopus/framework/ai-sdk) - [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 Autogen? Yes, you can. Autogen 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)