The Instantly MCP Server enables AI assistants to comprehensively manage Instantly.ai's email campaigns, accounts, leads, and analytics through seamless API integration.
Core Capabilities:
Campaign Management: Create campaigns with intelligent three-stage workflows, update details and status, activate campaigns, and retrieve complete campaign data with pagination
Account Management: List and update sending accounts, monitor warmup analytics, validate account eligibility, and manage daily limits and settings
Lead Management: Create, update, filter, and organize leads across campaigns and lists with comprehensive pagination support
Analytics & Reporting: Track campaign performance, get overview analytics, and monitor warmup progress for sending accounts
Email Operations: Reply to existing emails, list email history with filtering, and verify email addresses for deliverability
Administrative Tools: Manage API keys, check premium feature availability, and validate account permissions
Flexible Deployment: Support for both local (stdio) and remote (HTTP) deployment with robust authentication options
The server provides complete dataset retrieval through automatic pagination and offers premium features like email verification based on your Instantly.ai plan.
Enables connection to Gmail accounts through the Instantly API, supporting email campaign management and deliverability monitoring through IMAP/SMTP authentication.
Provides integration with Google-based email accounts for managing email campaigns, monitoring account health, and handling email verification through the Instantly platform.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Instantly MCP Servershow me my active campaigns"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Instantly MCP Server (Python)
A lightweight, robust Model Context Protocol (MCP) server for the Instantly.ai V2 API, built with FastMCP.
Features
38 tools across 6 categories (accounts, campaigns, leads, emails, analytics, background_jobs)
Dual transport support: HTTP (remote deployment) + stdio (local)
Lazy loading: Reduce context window by loading only specific tool categories
Multi-tenant support: Per-request API keys for HTTP deployments
Comprehensive error handling: Detailed, actionable error messages
Rate limiting: Automatic tracking from API response headers
Dynamic timeouts: Extended timeouts for search and bulk operations
Related MCP server: SendGrid MCP Server
Quick Start
Installation
# Clone or navigate to the repository
cd instantly-mcp-python
# Install with pip
pip install -e .
# Or install dependencies directly
pip install fastmcp httpx pydantic python-dotenvConfiguration
Set your Instantly API key:
export INSTANTLY_API_KEY="your-api-key-here"Or create a .env file:
INSTANTLY_API_KEY=your-api-key-hereRunning the Server
HTTP Mode (Recommended for Remote Deployment)
# Using FastMCP CLI
fastmcp run src/instantly_mcp/server.py --transport http --port 8000
# Using Python directly
python -m instantly_mcp.server --transport http --port 8000
# Or with uvicorn for production
uvicorn instantly_mcp.server:mcp.app --host 0.0.0.0 --port 8000stdio Mode (Local Development)
# Using FastMCP CLI
fastmcp run src/instantly_mcp/server.py
# Using Python directly
python -m instantly_mcp.serverTool Categories
Accounts (6 tools)
Tool | Description |
| List email accounts with filtering |
| Get account details and warmup status |
| Create account with IMAP/SMTP credentials |
| Update account settings |
| Pause, resume, warmup control, test vitals |
| ⚠️ Permanently delete account |
Campaigns (8 tools)
Tool | Description |
| Create email campaign (two-step process) |
| List campaigns with pagination |
| Get campaign details and sequences |
| Update campaign settings |
| Start campaign sending |
| Stop campaign sending |
| ⚠️ Permanently delete campaign |
| Find campaigns a contact is enrolled in |
Leads (12 tools)
Tool | Description |
| List leads with filtering |
| Get lead details |
| Create single lead |
| Update lead (⚠️ custom_variables replaces all) |
| List lead lists |
| Create lead list |
| Update lead list |
| Get email verification stats |
| Bulk add up to 1,000 leads |
| ⚠️ Permanently delete lead |
| ⚠️ Permanently delete lead list |
| Move/copy leads between campaigns/lists |
Emails (6 tools)
Tool | Description |
| List emails with filtering |
| Get email details |
| 🚨 Send real email reply |
| Count unread inbox emails |
| Verify email deliverability |
| Mark email thread as read |
Analytics (3 tools)
Tool | Description |
| Campaign metrics (opens, clicks, replies) |
| Day-by-day performance |
| Account warmup metrics |
Background Jobs (2 tools)
Tool | Description |
| List async background jobs with pagination |
| Get details of a specific background job |
Lazy Loading (Context Window Optimization)
Reduce context window usage by loading only the categories you need:
# Load only accounts and campaigns (14 tools instead of 38)
export TOOL_CATEGORIES="accounts,campaigns"
# Load only leads and analytics
export TOOL_CATEGORIES="leads,analytics"Valid categories: accounts, campaigns, leads, emails, analytics, background_jobs
Authentication Methods
The server supports multiple authentication methods for flexibility:
1. URL-based Authentication
Include your API key directly in the URL path:
https://your-server.com/mcp/YOUR_API_KEY2. Header Authentication
URL: https://your-server.com/mcp
Header: Authorization: YOUR_API_KEYNote: Bearer token prefix is optional
3. Custom Header
URL: https://your-server.com/mcp
Header: x-instantly-api-key: YOUR_API_KEY4. Environment Variable
export INSTANTLY_API_KEY="your-api-key-here"MCP Client Configuration
Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json:
stdio Mode (Local)
{
"mcpServers": {
"instantly": {
"command": "python",
"args": ["-m", "instantly_mcp.server"],
"env": {
"INSTANTLY_API_KEY": "your-api-key-here"
}
}
}
}HTTP Mode with URL Auth (Recommended)
{
"mcpServers": {
"instantly": {
"url": "https://your-server.com/mcp/YOUR_API_KEY"
}
}
}HTTP Mode with Header Auth
{
"mcpServers": {
"instantly": {
"url": "https://your-server.com/mcp",
"transport": "streamable-http",
"headers": {
"Authorization": "your-api-key-here"
}
}
}
}Cursor IDE
Add to ~/.cursor/mcp.json:
With URL Authentication
{
"mcpServers": {
"instantly": {
"url": "https://your-server.com/mcp/YOUR_API_KEY"
}
}
}With Header Authentication
{
"mcpServers": {
"instantly": {
"url": "https://your-server.com/mcp",
"transport": "streamable-http",
"headers": {
"x-instantly-api-key": "your-api-key-here"
}
}
}
}DigitalOcean App Platform Deployment
App Spec
name: instantly-mcp
services:
- name: instantly-mcp
source:
git:
branch: main
repo_clone_url: https://github.com/your-username/instantly-mcp-python.git
build_command: pip install -e .
run_command: python -m instantly_mcp.server --transport http --port 8080
http_port: 8080
instance_size_slug: basic-xxs
instance_count: 1
envs:
- key: INSTANTLY_API_KEY
scope: RUN_TIME
type: SECRET
- key: PORT
scope: RUN_TIME
value: "8080"Dockerfile (Alternative)
FROM python:3.11-slim
WORKDIR /app
COPY pyproject.toml .
COPY src/ src/
RUN pip install -e .
EXPOSE 8000
CMD ["python", "-m", "instantly_mcp.server", "--transport", "http", "--host", "0.0.0.0", "--port", "8000"]Multi-Tenant HTTP Mode
For deployments serving multiple users, the server supports per-request API keys:
# Start server without default API key
python -m instantly_mcp.server --transport http --port 8000
# Clients provide API key via header
curl -X POST http://localhost:8000/mcp \
-H "x-instantly-api-key: user-specific-api-key" \
-H "Content-Type: application/json" \
-d '{"method": "tools/list"}'Error Handling
The server provides detailed, actionable error messages:
{
"error": {
"code": "invalid_api_key",
"message": "Instantly API key is required. Provide via:\n - INSTANTLY_API_KEY environment variable\n - api_key parameter\n - x-instantly-api-key header (HTTP mode)"
}
}Rate Limiting
The server automatically tracks rate limits from API response headers:
# Access via get_server_info tool
{
"rate_limit": {
"remaining": 95,
"limit": 100,
"reset_at": "2024-01-15T12:00:00"
}
}Project Structure
instantly-mcp-python/
├── src/
│ └── instantly_mcp/
│ ├── __init__.py # Package exports
│ ├── server.py # FastMCP server (~180 lines)
│ ├── client.py # API client (~200 lines)
│ ├── models/ # Pydantic models
│ │ ├── __init__.py
│ │ ├── common.py # Pagination
│ │ ├── accounts.py # Account models
│ │ ├── campaigns.py # Campaign models
│ │ ├── leads.py # Lead models
│ │ ├── emails.py # Email models
│ │ └── analytics.py # Analytics models
│ └── tools/ # Tool implementations
│ ├── __init__.py # Lazy loading logic
│ ├── accounts.py # 6 account tools
│ ├── campaigns.py # 8 campaign tools
│ ├── leads.py # 12 lead tools
│ ├── emails.py # 6 email tools
│ ├── analytics.py # 3 analytics tools
│ └── background_jobs.py # 2 background job tools
├── pyproject.toml # Dependencies
├── env.example # Environment template
└── README.md # This fileComparison with TypeScript Version
Aspect | TypeScript | Python FastMCP |
Lines of Code | ~5,000+ | ~1,500 |
Tool Registration | Manual handlers |
|
Input Validation | Zod schemas | Pydantic (auto) |
Error Messages | Manual | Auto from Pydantic |
HTTP Server | Custom transport | Built-in |
Context Window | Larger schemas | Smaller, cleaner |
API Reference
For detailed API documentation, see: Instantly V2 API Docs
License
MIT License
Contributing
Contributions welcome! Please open an issue or PR.