Instantly-MCP

Instantly-MCP

2
communicationdeveloper_toolsai_chatbotknowledge_and_memorycustomer_data_platforms

The Instantly MCP Server allows the integration of Instantly.ai's email automation features into AI assistants using Model Context Protocol. It simplifies the management of email campaigns, contacts, and analytics, which is beneficial for sales and marketing teams.

Instantly MCP Server

npm version License: MIT

MCP server for Instantly.ai v2 API - Manage email campaigns, accounts, leads, and analytics through Claude AI. Perfect for email automation and cold outreach campaigns.

Overview

The Instantly MCP Server is a powerful integration that brings Instantly.ai's email automation capabilities directly into Claude and other AI assistants through the Model Context Protocol. This enables AI-powered management of:

  • 📧 Email campaigns and sequences
  • 👥 Account management and warmup
  • 📊 Analytics and performance tracking
  • 🎯 Lead management and segmentation
  • ✉️ Email sending and verification
  • 🔑 API key management

Perfect for sales teams, marketers, and developers who want to automate their cold outreach workflows using AI.

Quick Start

Using with npx (no installation required)

Add to your MCP settings configuration:

{
  "mcpServers": {
    "instantly": {
      "command": "npx",
      "args": ["instantly-mcp", "--api-key", "YOUR_INSTANTLY_API_KEY"]
    }
  }
}

Local Installation

  1. Clone and install:
npm install
npm run build
  1. Add to your MCP settings:
{
  "mcpServers": {
    "instantly": {
      "command": "node",
      "args": ["/path/to/instantly-mcp/dist/index.js", "--api-key", "YOUR_INSTANTLY_API_KEY"]
    }
  }
}

Getting Your API Key

  1. Log in to Instantly.ai
  2. Navigate to Settings > Integrations > API
  3. Generate or copy your API key

Available Tools

Campaign Management

  • list_campaigns - List all campaigns with optional filters and pagination
  • get_campaign - Get details of a specific campaign
  • create_campaign - Create a new email campaign
  • update_campaign - Update an existing campaign
  • activate_campaign - Activate a campaign

Analytics

  • get_campaign_analytics - Get analytics for campaigns
  • get_campaign_analytics_overview - Get analytics overview for all campaigns

Account Management

  • list_accounts - List all sending accounts with pagination
  • create_account - Create a new sending account
  • update_account - Update a sending account
  • get_warmup_analytics - Get warmup analytics for an account

Lead Management

  • list_leads - List leads with filters and pagination
  • create_lead - Create a new lead
  • update_lead - Update a lead
  • move_leads - Move leads between campaigns or lists

Lead Lists

  • list_lead_lists - List all lead lists with pagination
  • create_lead_list - Create a new lead list

Email Operations

  • send_email - Send a single email
  • list_emails - List emails with filters and pagination

Email Verification

  • verify_email - Verify if an email address is valid

API Key Management

  • list_api_keys - List all API keys
  • create_api_key - Create a new API key

Example Usage

Once configured, you can use natural language to interact with Instantly:

  • "List all my active campaigns"
  • "Show me the analytics for campaign XYZ"
  • "Create a new campaign called 'Summer Sale'"
  • "List all my sending accounts"

Development

# Install dependencies
npm install

# Run in development mode
npm run dev -- --api-key YOUR_API_KEY

# Build for production
npm run build

Testing

Local Testing

  1. Test the API endpoints directly:
# Install dependencies
npm install

# Run the test script
tsx test-endpoints.ts --api-key YOUR_API_KEY
  1. Test with MCP Inspector:
# Build the project
npm run build

# Test with MCP Inspector
npx @modelcontextprotocol/inspector dist/index.js -- --api-key YOUR_API_KEY
  1. Test with Claude Desktop: Add to your Claude Desktop configuration:
{
  "mcpServers": {
    "instantly": {
      "command": "node",
      "args": ["/absolute/path/to/dist/index.js", "--api-key", "YOUR_API_KEY"]
    }
  }
}

Endpoint Documentation

The MCP server includes all major Instantly v2 API endpoints:

  • Campaigns: Create, list, update, activate campaigns
  • Analytics: Get campaign analytics and overview
  • Accounts: Manage sending accounts and warmup
  • Leads: Create, list, update, move leads
  • Lead Lists: Create and manage lead lists
  • Emails: Send emails and list email history
  • Email Verification: Verify email addresses
  • API Keys: Manage API keys

For full API documentation, visit: https://developer.instantly.ai/

License

MIT

Features

  • 🚀 Full Instantly v2 API coverage
  • 📄 Pagination support for all list endpoints
  • ⚡ Rate limiting with informative messages
  • 🔧 Comprehensive error handling
  • 📝 TypeScript support
  • 🔐 Secure API key handling
  • 📚 Example scripts included

Recent Updates

v2.0.13 (Latest)

  • Fixed campaign creation with improved field structure
  • Added timezone and days configuration for campaigns
  • Enhanced debug logging for troubleshooting
  • Fallback mechanism for different API structures

See for complete version history.

Known Issues

  • Campaign creation may require specific account configuration
  • Some endpoints return empty results despite data existing (working on fixes)
  • Email sending requires verified sender accounts

Contributing

Pull requests are welcome! Please ensure all tests pass and follow the existing code style.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Support

Publishing

This package is automatically published to npm when a new version tag is pushed:

npm version patch|minor|major
git push --tags

Support

Changelog

See for a list of changes.

Author

Created by bcharleson