Schema

Server Configuration

Describes the environment variables required to run the server.

Name	Required	Description	Default
`OPENAI_API_KEY`	No	OpenAI API key for enhanced NLP
`ZAPMAIL_API_KEY`	Yes	Your Zapmail API key
`ZAPMAIL_LOG_LEVEL`	No	Logging level (DEBUG/INFO/WARN/ERROR)	INFO
`ZAPMAIL_TIMEOUT_MS`	No	Request timeout in milliseconds	30000
`ZAPMAIL_MAX_RETRIES`	No	Maximum retry attempts	3
`ZAPMAIL_ENABLE_CACHE`	No	Enable response caching	true
`ZAPMAIL_WORKSPACE_KEY`	No	Default workspace ID
`ZAPMAIL_ENABLE_METRICS`	No	Enable performance metrics	true
`ZAPMAIL_RATE_LIMIT_DELAY`	No	Rate limiting delay in ms	1000
`ZAPMAIL_SERVICE_PROVIDER`	No	Email provider (GOOGLE/MICROSOFT)	GOOGLE

Prompts

Interactive templates invoked by user choice

Name	Description
No prompts

Resources

Contextual data attached and managed by the client

Name	Description
`zapmail/llms`
`zapmail/prompts/name_generation`
`zapmail/prompts/pair_generation`
`zapmail/prompts/gender_ethnicity_detection`
`zapmail/prompts/domain_generation`
`zapmail/examples/nl`

Tools

Functions exposed to the LLM to take actions

Name	Description
set_context	Set default x-workspace-key and x-service-provider headers for subsequent API calls.
wallet_balance	Return the current wallet balance for the active workspace.
list_workspaces	Retrieve all workspaces associated with the account.
list_domains	List domains in the active workspace. Use set_context to choose the workspace.
check_domain_availability	Check if a domain is available for registration and return pricing.
purchase_domains	Purchase one or more domains. Prefers wallet funds if sufficient; otherwise returns a payment link.
create_mailboxes_for_zero_domains	Create N mailboxes on every domain in the active workspace with zero mailboxes.
add_third_party_account	Add credentials for a third-party export integration.
call_endpoint	Invoke any Zapmail API endpoint by its documentation slug or an explicit path.
generate_usernames	Create professional mailbox usernames from a full name or single word using built-in patterns.
generate_name_pairs	Generate culturally appropriate firstname/lastname pairs for a given ethnicity and gender.
generate_domains	Generate professional domain name suggestions (local rules).
check_domain_availability_batch	Check availability and pricing for multiple domains at once.
plan_and_execute	Give a natural language instruction (e.g., 'buy 5 domains and connect Instantly') and the server will plan steps and optionally execute them.
get_metrics	Retrieve system metrics including API call statistics, cache performance, and error rates.
clear_cache	Clear all cached data to free memory and ensure fresh data retrieval.
health_check	Perform a comprehensive health check of the MCP server including API connectivity, cache status, and configuration validation.
bulk_update_mailboxes	Update multiple mailboxes with new names, usernames, or other properties in a single operation.
search_mailboxes	Search for mailboxes using various criteria like name, username, domain, or status.
get_server_info	Retrieve detailed information about the MCP server configuration, features, and capabilities.
get_export_info	Get comprehensive information about supported export platforms, flows, and scenarios.
get_export_scenario	Get step-by-step instructions for specific export scenarios.
validate_export_request	Validate export request parameters before execution to prevent errors.
export_guidance	Get AI-powered guidance for export operations including best practices and recommendations.
get_api_info	Get detailed information about API endpoints, parameters, responses, and usage examples.
search_api_endpoints	Search for API endpoints using keywords to find relevant functionality.
get_api_scenarios	Get step-by-step scenarios for common API operations and workflows.
get_api_best_practices	Get comprehensive best practices for using the Zapmail API effectively.
generate_api_examples	Generate practical examples for API endpoint usage with custom parameters.
zapmail_docs_825990m0	API Docs Invoke this endpoint.
retrieve_user_details_13489341e0	This endpoint allows you to fetch information about a user. Invoke this endpoint.
retrieve_all_workspaces_13489896e0	This endpoint allows you to get user workspaces. Invoke this endpoint.
create_new_workspace_13489947e0	Create a New Workspace Invoke this endpoint.
update_workspace_13489975e0	Update Workspace Invoke this endpoint.
add_billing_details_13490005e0	Add User Billing Details Invoke this endpoint.
_update_billing_details_13517578e0	Update User Billing Details Invoke this endpoint.
retrieve_all_mailboxes_13490172e0	This endpoint lets you fetch a list of all mailboxes. Invoke this endpoint.
get_mailbox_details_by_id_13490215e0	Use this endpoint to retrieve the details of a specific mailbox by its ID. Invoke this endpoint.
assign_new_mailboxes_to_domains_13490321e0	Add Mailboxes to a Domain Invoke this endpoint.
update_mailbox_13490429e0	Update Mailbox Details API Invoke this endpoint.
remove_mailboxes_on_next_renewal_13490521e0	Remove Mailboxes on Next Renewal API Invoke this endpoint.
get_authenticator_code_13648760e0	This API allows you to retrieve authenticator code for a specific mailbox. Invoke this endpoint.
remove_mailboxes_instantly_19455787e0	This endpoint is used to instantly remove one or more mailboxes from the system. It supports bulk removal. Invoke this endpoint.
add_balance_to_wallet_13490582e0	Add Balance to Wallet Invoke this endpoint.
get_wallet_balance_13490707e0	This endpoint allows you to get wallet balance. Invoke this endpoint.
enable_auto_recharge_13490713e0	This endpoint allows you enable auto recharge. Invoke this endpoint.
export_mailboxes_13490737e0	Export Mailboxes Invoke this endpoint.
add_third_party_account_details_13490752e0	Add Third-Party Account for Mailbox Export Invoke this endpoint.
update_third_party_account_details_13490787e0	Update Third-Party Account Invoke this endpoint.
get_all_subscriptions_13489431e0	This endpoint allows you to fetch user's subscriptions. Invoke this endpoint.
cancel_subscription_13489478e0	Cancel Subscription Invoke this endpoint.
upgrade_existing_subscription_13489501e0	Upgrade Subscription Invoke this endpoint.
retrieve_all_domains_13520015e0	This endpoint retrieves a list of all domains. Invoke this endpoint.
list_assignable_domains_13520727e0	List of Domains for Mailbox Assignment Invoke this endpoint.
add_dmarc_record_13520817e0	Add DMARC Record to Domain Invoke this endpoint.
add_domain_forwarding_13520843e0	Set Up Domain Forwarding Invoke this endpoint.
get_name_servers_to_connect_domain_13520972e0	Get nameservers Invoke this endpoint.
verify_name_server_propagation_13520984e0	Verify Name Servers for Domain Connection with Zapmail Invoke this endpoint.
connect_domain_with_zapmail_13521006e0	Connect Domain with Zapmail Invoke this endpoint.
enable_email_forwarding_13521023e0	Activate Email Forwarding for Domain Invoke this endpoint.
remove_email_forwarding_13521037e0	Deactivate Email Forwarding for Domain Invoke this endpoint.
enable_catch_all_emails_13521061e0	Activate Catch-All Email Forwarding for Domain Invoke this endpoint.
remove_catch_all_emails_13521079e0	Deactivate Catch-All Email Forwarding for Domain Invoke this endpoint.
check_dns_records_13521093e0	Check DNS Records for Domain Invoke this endpoint.
remove_unused_domains_13521144e0	Remove Unused Domains Invoke this endpoint.
get_available_domains_for_registration_13521189e0	Check Domain Availability Invoke this endpoint.
get_domains_purchase_payment_link_13521209e0	Purchase Domain Invoke this endpoint.
get_domain_connection_requests_18247843e0	This endpoint allows you to retrieve a list of domains that are still in progress and pending connection with Zapmail. Invoke this endpoint.
remove_domain_connection_requests_18247913e0	This endpoint allows you to remove a domain from the connection request if it has already been successfully connected to Zapmail. Invoke this endpoint.
connect_domain_with_zapmail_new_18248433e0	Call this endpoint to start the domain connection process with Zapmail. Invoke this endpoint.
add_google_client_id_to_domain_19401086e0	Associates a Google OAuth Client ID with one or more domain IDs for a specified application. Invoke this endpoint.
get_dns_records_13627177e0	This endpoint retrieves all DNS records for a domain associated with a user. The domain is identified by the `id` parameter provided in the request. Invoke this endpoint.
add_dns_records_13629231e0	This endpoints lets you add dns records on a domain. Invoke this endpoint.
update_dns_records_13629370e0	This endpoints lets you update dns records for a domain. Invoke this endpoint.
delete_dns_records_14109023e0	Delete DNS Record API Invoke this endpoint.

Server Configuration

Schema

Prompts

Resources

Tools

API Docs Invoke this endpoint.

Create a New Workspace Invoke this endpoint.

Update Workspace Invoke this endpoint.

Add User Billing Details Invoke this endpoint.

Update User Billing Details Invoke this endpoint.

Add Mailboxes to a Domain Invoke this endpoint.

Update Mailbox Details API Invoke this endpoint.

Remove Mailboxes on Next Renewal API Invoke this endpoint.

Add Balance to Wallet Invoke this endpoint.

Export Mailboxes Invoke this endpoint.

Add Third-Party Account for Mailbox Export Invoke this endpoint.

Update Third-Party Account Invoke this endpoint.

Cancel Subscription Invoke this endpoint.

Upgrade Subscription Invoke this endpoint.

List of Domains for Mailbox Assignment Invoke this endpoint.

Add DMARC Record to Domain Invoke this endpoint.

Set Up Domain Forwarding Invoke this endpoint.

Get nameservers Invoke this endpoint.

Verify Name Servers for Domain Connection with Zapmail Invoke this endpoint.

Connect Domain with Zapmail Invoke this endpoint.

Activate Email Forwarding for Domain Invoke this endpoint.

Deactivate Email Forwarding for Domain Invoke this endpoint.

Activate Catch-All Email Forwarding for Domain Invoke this endpoint.

Deactivate Catch-All Email Forwarding for Domain Invoke this endpoint.

Check DNS Records for Domain Invoke this endpoint.

Remove Unused Domains Invoke this endpoint.

Check Domain Availability Invoke this endpoint.

Purchase Domain Invoke this endpoint.

Delete DNS Record API Invoke this endpoint.

MCP directory API