Supports Google as an email service provider for mailbox operations and email management within the Zapmail platform
Built on Node.js runtime for executing Zapmail API operations and MCP server functionality
Distributed via npm package manager for easy installation and deployment of the Zapmail MCP server
Optionally integrates with OpenAI API for enhanced natural language processing capabilities when interpreting Zapmail commands
Zapmail MCP Server
A Model Context Protocol (MCP) server for the Zapmail API that provides natural language access to domain management, mailbox operations, and exports. This package enables AI assistants like Claude to interact with Zapmail through natural language commands.
Features
- Complete Zapmail API coverage (46+ tools)
- Natural language command processing
- Dynamic tool generation from API documentation
- Export support for Reachinbox, Instantly, Smartlead, Reply.io, and CSV
- Caching system with TTL
- Rate limiting and error handling
- Multi-workspace support
- MCP integration with Claude Desktop and Cursor
Prerequisites
- Node.js 18+
- Zapmail API key
- MCP-compatible client (Claude Desktop, Cursor, etc.)
- Optional: OpenAI API key for enhanced natural language processing
Installation
Option 1: Using npx (Recommended)
No installation required - run directly with npx:
Option 2: Global Installation
Install globally for persistent access:
MCP Configuration
For Claude Desktop
Create or update claude_desktop_config.json
:
macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%\Claude\claude_desktop_config.json
Using npx (Recommended):
Using global installation:
For Cursor
Add to your Cursor MCP settings:
Using npx (Recommended):
Using global installation:
Quick Start
- Get your Zapmail API key:
- Sign up at Zapmail
- Navigate to your API settings
- Generate a new API key
- Configure your MCP client:
- Choose your preferred MCP client (Claude Desktop or Cursor)
- Add the configuration JSON above to your MCP settings
- Replace
your-zapmail-api-key
with your actual API key
- Test the connection:
- Open your MCP client
- Try natural language commands like:
- "List all my Zapmail workspaces"
- "Show me my domains"
- "Check if example.com is available for purchase"
Available Tools
Core Management Tools
set_context
- Set workspace and provider contextwallet_balance
- Get wallet balancelist_workspaces
- List all workspaceslist_domains
- List domains in workspacecheck_domain_availability
- Check domain availabilitypurchase_domains
- Purchase domains (wallet-first)create_mailboxes_for_zero_domains
- Create mailboxes on empty domainsadd_third_party_account
- Add third-party export accountcall_endpoint
- Call any Zapmail endpointgenerate_usernames
- Generate mailbox usernamesgenerate_name_pairs
- Generate name pairsgenerate_domains
- Generate AI-powered domain suggestionscheck_domain_availability_batch
- Batch domain availability checkplan_and_execute
- Natural-language plan & executeget_server_info
- Get server information
System Management Tools
get_metrics
- Get system metrics and performance dataclear_cache
- Clear system cachehealth_check
- System health check
Advanced Mailbox Tools
bulk_update_mailboxes
- Bulk update mailboxessearch_mailboxes
- Search mailboxes with advanced filters
Export System Tools
get_export_info
- Get export system informationget_export_scenario
- Get export scenario instructionsvalidate_export_request
- Validate export request parametersexport_guidance
- Get export guidance and best practices
API Documentation Tools
get_api_info
- Get comprehensive API endpoint informationsearch_api_endpoints
- Search API endpoints by keywordget_api_scenarios
- Get common API usage scenariosget_api_best_practices
- Get API best practices and recommendationsgenerate_api_examples
- Generate API usage examples
Dynamic API Tools
All documented API endpoints with automatic tool generation
Natural Language Commands
Once connected to your MCP client, you can use natural language to control Zapmail:
Workspace & Domain Management
- "List all my workspaces"
- "Show domains in current workspace containing 'lead'"
- "Check if leadconnectlab.com is available for 2 years"
- "Buy leadconnectlab.com and outreachprohub.com for 1 year using wallet if possible"
Mailbox Management
- "Create 3 mailboxes per domain where there are zero mailboxes"
- "Setup 100 mailboxes and connect to Instantly.ai for me"
- "Update all mailboxes with new names"
Export Operations
- "Export all mailboxes to reachinbox"
- "Export mailboxes to instantly"
- "Export mailboxes as CSV"
- "Export specific mailboxes"
- "Export mailboxes from leadconnectio.com domain"
Third-Party Integration
- "Connect reachinbox account"
- "Add instantly credentials"
- "Link smartlead account"
- "Setup reply.io integration"
Configuration
Environment Variables
Variable | Description | Default | Required |
---|---|---|---|
ZAPMAIL_API_KEY | Your Zapmail API key | - | Yes |
ZAPMAIL_WORKSPACE_KEY | Default workspace ID | - | No |
ZAPMAIL_SERVICE_PROVIDER | Email provider (GOOGLE/MICROSOFT) | No | |
ZAPMAIL_LOG_LEVEL | Logging level (DEBUG/INFO/WARN/ERROR) | INFO | No |
ZAPMAIL_MAX_RETRIES | Maximum retry attempts | 3 | No |
ZAPMAIL_TIMEOUT_MS | Request timeout in milliseconds | 30000 | No |
ZAPMAIL_ENABLE_CACHE | Enable response caching | true | No |
ZAPMAIL_ENABLE_METRICS | Enable performance metrics | true | No |
ZAPMAIL_RATE_LIMIT_DELAY | Rate limiting delay in ms | 1000 | No |
OPENAI_API_KEY | OpenAI API key for enhanced NLP | - | No |
Usage Examples
Domain Operations
Check Domain Availability
In Claude Desktop or Cursor:
Purchase Domains
In Claude Desktop or Cursor:
Mailbox Management
Create Mailboxes on Empty Domains
In Claude Desktop or Cursor:
Bulk Update Mailboxes
In Claude Desktop or Cursor:
Export Operations
Export to Reachinbox
In Claude Desktop or Cursor:
Get Export Guidance
In Claude Desktop or Cursor:
Complex Workflows
Multi-Step Operations
In Claude Desktop or Cursor:
Workspace Management
In Claude Desktop or Cursor:
System Monitoring
Health Check
In Claude Desktop or Cursor:
Get Metrics
In Claude Desktop or Cursor:
Troubleshooting
MCP Connection Issues
1. MCP Server Not Found
Problem: "zapmail-mcp command not found" or "npx zapmail-mcp not found" Solutions:
For npx usage:
For global installation:
2. MCP Client Not Detecting Server
Problem: Zapmail tools not appearing in Claude Desktop/Cursor Solutions:
- Restart your MCP client (Claude Desktop/Cursor)
- Check your MCP configuration file syntax
- Verify the command path in your config
3. API Key Issues
Problem: "ZAPMAIL_API_KEY not configured" Solutions:
- Set environment variable in your MCP config:
- Or set globally:
4. Workspace Context Issues
Problem: Getting data from wrong workspace Solution: Set workspace in MCP config:
Performance Issues
1. Slow Response Times
Problem: MCP operations taking too long Solutions:
- Enable caching:
ZAPMAIL_ENABLE_CACHE="true"
- Increase rate limit delay:
ZAPMAIL_RATE_LIMIT_DELAY="2000"
- Check your internet connection
2. Rate Limiting
Problem: "Too many requests" errors Solution: Increase rate limit delay in MCP config:
Debug Mode
Enable debug logging for detailed troubleshooting:
Health Check
Test your MCP connection: In Claude Desktop or Cursor:
Common MCP Configuration Errors
1. Invalid JSON Syntax
Problem: MCP client fails to load configuration Solution: Validate your JSON configuration using a JSON validator
2. Wrong Command Path
Problem: "Command not found" in MCP client
Solution: Use full path or ensure zapmail-mcp
is in your PATH
3. Environment Variables Not Loading
Problem: API key not being passed to MCP server
Solution: Use the env
section in your MCP configuration instead of global environment variables
Getting Started with MCP
Step 1: Install the Package
Option A: Using npx (Recommended) No installation needed - just use npx:
Option B: Global Installation
Step 2: Get Your Zapmail API Key
- Sign up at Zapmail
- Navigate to your API settings
- Generate a new API key
- Note your workspace ID (optional but recommended)
Step 3: Configure Your MCP Client
Choose your preferred MCP client and follow the configuration steps above.
Step 4: Test the Connection
Open your MCP client and try a simple command:
- "List my Zapmail workspaces"
- "Show me my domains"
Step 5: Explore Advanced Features
Once connected, you can:
- Manage domains and mailboxes through natural language
- Export to third-party platforms
- Set up complex automation workflows
- Monitor performance and health
Package Information
- Package Name:
zapmail-mcp
- Version: 0.0.2
- NPM: zapmail-mcp
- GitHub: dsouzaalan/zapmail-mcp
- License: MIT
Command Line Options
The MCP server supports the following command-line options:
Version Information
Help Information
Support
For support and questions:
- Check the troubleshooting section above
- Review the MCP configuration examples
- Test your connection with health checks
- Enable debug logging for detailed error information
- Visit the GitHub repository for issues and discussions
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
License
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ for the Zapmail community
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Enables AI assistants to interact with the Zapmail API through natural language commands for domain management, mailbox operations, and exports to third-party platforms like Reachinbox and Instantly. Provides complete coverage of 46+ Zapmail tools with dynamic API integration and multi-workspace support.