Zapmail

You run a Zapmail MCP Server to expose Zapmail capabilities through natural language in your MCP client. With steady API coverage, you gain hands-free control over domains, workspaces, mailboxes, exports, and more, all via intuitive commands. This guide walks you through using the server, installing it, and configuring your MCP client for seamless natural language interactions.

How to use

After you connect your MCP client to the Zapmail MCP Server, you can perform everyday domain, mailbox, and export operations with natural language prompts. Typical goals include listing workspaces, checking domain availability, creating mailboxes on empty domains, and exporting mailbox data to third‑party services.

Practical usage patterns include:

In your MCP client, you’ll primarily issue natural language commands. The server translates those into the corresponding actions against Zapmail’s API, handles authentication via your API key, and returns results or confirms actions. If you need to run multiple steps, combine them into a single plan and execution sequence supported by your client.

How to install

Prerequisites you need before installation:

• Node.js 18+
• Zapmail API key
• An MCP-compatible client (Claude Desktop, Cursor, etc.)
• Optional: OpenAI API key for enhanced NLP

Choose your installation method and follow the steps.

Option A: Using npx (Recommended) this runs without installation.

npx zapmail-mcp

Option B: Global Installation this keeps the tool available system-wide.

npm install -g zapmail-mcp

After you have installed or prepared to run via npx, you’ll configure your MCP client to connect to the Zapmail MCP Server.

Configuration and usage notes

Environment variable you must provide in your MCP configuration is the Zapmail API key.

Example configuration snippet for Claude Desktop or Cursor, using npx to run the MCP server:

{
  "mcpServers": {
    "zapmail": {
      "command": "npx",
      "args": ["zapmail-mcp"],
      "env": {
        "ZAPMAIL_API_KEY": "your-zapmail-api-key"
      }
    }
  }
}

Security and best practices

Protect your API key. Treat it as a secret and scope it to the minimum permissions needed for your workflows. If you are using shared machines, consider revoking and rotating keys as part of routine security hygiene.

Troubleshooting

If the MCP client does not detect the Zapmail server, verify the MCP configuration syntax and ensure the command path is correct. Restart your MCP client after configuration changes.

Common issues include missing or invalid API keys, misconfigured workspace context, or network connectivity problems. Run a health check in your MCP client to verify connectivity and permissions.

Getting started with advanced use

Once connected, you can chain domain, mailbox, and export tasks into multi-step workflows. For example, you can buy domains, create mailboxes on each domain, and export to a chosen platform, all in a single natural language plan.

Available tools

set_context

Set workspace and provider context for subsequent operations

wallet_balance

Get wallet balance for the current Zapmail account

list_workspaces

List all workspaces available to you

list_domains

List domains within a workspace

check_domain_availability

Check if a domain is available for purchase or use

purchase_domains

Purchase one or more domains, using wallet-first flow if required

create_mailboxes_for_zero_domains

Create mailboxes for domains that currently have zero mailboxes

add_third_party_account

Add an external export account for third-party integrations

call_endpoint

Call a specific Zapmail API endpoint

generate_usernames

Generate mailbox usernames programmatically

generate_name_pairs

Generate realistic name pairs for mailboxes or domains

generate_domains

Generate AI-powered domain suggestions or ideas

check_domain_availability_batch

Batch check multiple domain availabilities in one request

plan_and_execute

Create a natural-language plan and execute it against Zapmail APIs

get_server_info

Retrieve server information and status

get_metrics

Retrieve system metrics and performance data

clear_cache

Clear the internal response cache

health_check

Perform a system health check of the MCP connection to Zapmail

bulk_update_mailboxes

Update multiple mailboxes in bulk with new configurations

search_mailboxes

Search mailboxes with advanced filters

get_export_info

Get information about export capabilities and status

get_export_scenario

Retrieve export workflow instructions and scenarios

validate_export_request

Validate parameters for export requests

export_guidance

Provide guidance for exporting mailboxes to third-party platforms

get_api_info

Get comprehensive API endpoint information