Elasticemail MCP Server

🚀 Email Automation Tool

A tool that integrates with Copilot to interact with Elastic Email API for various email - related operations.

🚀 Quick Start

📦 Installation

• You need .NET SDK 10 or higher.
• Ensure a connection to the Elastic Email API for proper functionality.
• Open port 5001 for HTTP.

✨ Copilot Integration

1. Use VS Code.
2. Open the Chat window.
3. Choose 'Agent' mode.
4. Use the settings.json file to connect to the mcp server (open the folder containing this file). You should see small controls near "servers".
5. Add a settings file as a context to the agent.
6. Open the "Select tools..." window (click on the screwdriver and wrench icon).
7. Find the mcp server and make sure all tools are selected.
8. Click "Start".

💻 Usage Examples

Basic Usage

Here is an example configuration for the agent:

"my-server-unique-number": {
    "url": "http://localhost:5001/",
    "headers": {
        "X-Auth-Token": <api_key>
    }
}

✨ Features

Tools

• HealthCheck.IsReady: A tool to check if the Elastic Email API server is available and responding.
• CampaignManagement.CreateCampaign: Creates a campaign in the system.
• CampaignManagement.ListCampaigns: Lists existing campaigns.
• CampaignManagement.GetCampaign: Gets campaign details.
• CampaignManagement.Pause: Stops campaign processing.
• CampaignManagement.UpdateCampaign: Changes campaign data (can be restarted by editing the status).
• CampaignManagement.GetAllCampaignStatistics: Gets all campaign statistics such as the number of opened emails.
• CampaignManagement.GetCampaignStatistics: Gets campaign (by name) statistics like opened, clicked, etc.
• SegmentsManagement.CreateSegment: Creates a new segment.
• SegmentsManagement.GetSegments: Gets a list of existing segments.
• SegmentsManagement.GetSegment: Gets a segment by name.
• TemplateManagement.FetchTemplate: Gets template details.
• TemplateManagement.FetchTemplates: Gets a list of templates, filtering by type and accessibility.
• EmailSending.SendBulkEmails: Sends emails to multiple users (can use a contacts list), provides content or uses a template.
• EmailSending.SendTransactionalEmail: Sends an email to contacts, can provide a template.
• ContactsManagement.FetchContacts: Gets a contacts list.
• ContactsManagement.FetchContactHistory: Gets contact history (if enabled).
• ContactsManagement.FetchLists: Gets all contact lists.
• ContactsManagement.FetchList: Gets contact list details.
• ContactsManagement.FetchListContacts: Gets contacts on a list (by name).
• ContactsManagement.AddContactToList: Adds a contact to a list.
• ContactsManagement.RemoveContactsToList: Removes a provided contact from a list (by name).
• ContactsManagement.CreateList: Creates a new contacts list.
• ContactsManagement.AddContact: Adds a new contact.
• ContactsManagement.DeleteContacts: Deletes contacts (provide emails).
• ContactsManagement.UploadContacts: Uploads and adds new contacts from a file.