Repository avatar
AI Tools
v1.0.0
active

byteplant-mcp

io.github.byteplant-dev/byteplant-mcp

An MCP server that provides Email, Phone and Address Validation Services from Byteplant

Documentation

Byteplant Validator MCP Server

Email, Phone Number, and Address Validation for the Model Context Protocol (MCP)

This package provides an MCP server that uses Byteplant’s Email-Validator, Phone-Validator, and Address-Validator APIs to deliver real-time live validation in any MCP-compatible client.

Features

  • Email validation
  • Phone number validation
  • Postal address validation
  • Fast studio MCP server
  • Local execution
  • Easy integration with Claude Desktop

Requirements

MCP Configuration (Claude Desktop)

1. Installation

First, install the python module. You can use local installation (like venv) or global.

pip install byteplant-mcp

2. Configuration

Next, add the MCP server to Claude configuration.

{
	"mcpServers": {
		"byteplant": {
			"command": "path/to/python/installation",
			"args": ["-m", "byteplant-mcp"],
			"env": {
				"EV_TOKEN": "<EMAIL VALIDATOR API TOKEN>",
				"PV_TOKEN": "<PHONE VALIDATOR API TOKEN>",
				"AV_TOKEN": "<ADDRESS VALIDATOR API TOKEN>"
			}
		}
	}
}	

Byteplant's Email, Phone, and Address Validation Tools

1. validate_email

Real-Time Email Validation API

The Email Validation API returns the deliverability status and detailed information for the email that is provided as input.


API Endpoint

ParameterValue
API URLhttps://api.email-validator.net/api/verify
MethodGET or POST

Example API Request (GET)

https://api.email-validator.net/api/verify?EmailAddress=support@byteplant.com&APIKey=your API key


Input Parameters

ParameterDescription
EmailAddressEmail address to validate (string).
APIKeyYour API key (string).
TimeoutTimeout in seconds (int). Default: 10 (min 5, max 300).

API Result (JSON)

ParameterDescription
statusAPI result code. 401, 118, 119 indicate API errors:
401 → Email address missing
118 → Rate Limit Exceeded
119 → API Key Invalid or Depleted
infoShort status description.
detailsFull status description.
freemailIndicates if email is from a freemail provider (true / false).
ratelimit_remainRemaining API requests before rate limit is reached (default: 100 requests / 300s).
ratelimit_secondsSeconds remaining in the current rate-limit interval.

2. validate_phone

Real-Time Phone Validation API

The Real-Time Phone Verification API validates a single phone number in real-time.
It returns the status (VALID_CONFIRMED, VALID_UNCONFIRMED, INVALID) as well as details such as line type, carrier/operator, and location.


API Endpoint

ParameterValue
API URLhttps://api.phone-validator.net/api/v2/verify
MethodGET or POST

Example API Request (GET)

https://api.phone-validator.net/api/v2/verify?PhoneNumber=09874-322466&CountryCode=de&APIKey=your API key


Input Parameters

ParameterDescription
PhoneNumberPhone number to validate (string, URL encoded). Accepts national format or international format with leading + (+%2B, space → %20).
CountryCodeTwo-letter ISO 3166-1 country code (string). Optional if number is in international format.
LocaleIETF language tag for geocoding (string). Optional; default: en-US.
ModeValidation mode (string): express (static checks) or extensive (full validation). Optional; default: extensive.
APIKeyYour API key (string).
TimeoutTimeout in seconds (int). Optional; default: 10 (min 5, max 300).

API Result (JSON)

ParameterDescription
statusVALID_CONFIRMED, VALID_UNCONFIRMED, INVALID, DELAYED, RATE_LIMIT_EXCEEDED, API_KEY_INVALID_OR_DEPLETED
linetypeFIXED_LINE, MOBILE, VOIP, TOLL_FREE, PREMIUM_RATE, SHARED_COST, PERSONAL_NUMBER, PAGER, UAN, VOICEMAIL
locationGeographical location (city, county, state).
countrycodeTwo-letter ISO 3166-1 country code.
formatnationalPhone number in national format.
formatinternationalPhone number in international format.
mccMobile Country Code (GSM/UMTS/LTE).
mncMobile Network Code (GSM/UMTS/LTE).
ratelimit_remainRemaining API requests before rate limit is hit (default limit: 100 requests / 300s).
ratelimit_secondsSeconds remaining in current rate-limit interval.

3 validate_address

Real-Time Address Validation API

The Address Validation API returns the deliverability status and detailed information for the address that is provided as input.


API Endpoint

ParameterValue
API URLhttps://api.address-validator.net/api/verify
MethodGET or POST

Example API Request (GET)

https://api.address-validator.net/api/verify?StreetAddress=Heilsbronner Str. 4&City=Neuendettelsau&PostalCode=91564&CountryCode=de&Geocoding=true&APIKey=your API key

Input Parameters

ParameterDescription
CountryCodeTwo-letter ISO 3166-1 country code (string). Use 'XX' for international.
StreetAddressStreet/house number/building; may include unit/apartment info (string).
StreetNumberHouse number/building (optional) (string).
House number/building may be part of StreetAddress or provided separately.
AdditionalAddressInfoBuilding/unit/apt/floor etc. (optional) (string)
CityCity or locality (city, district) (optional) (string)
PostalCodeZIP / postal code (optional) (string)
StateState/province (optional) (string)
GeocodingEnable Geocoding (true/false); default: false (optional)
LocaleOutput language for countries with multiple postal languages—use only for translation; leave empty for validation. Default: local language (optional)
OutputCharsetOutput character set: us-ascii or utf-8 (default). (optional)
APIKeyYour API key (string)
TimeoutTimeout in seconds (default: 10s, min 5s, max 300s) (int)

General Usage Notes

Always use commas (",") to separate address elements where needed.

StreetAddress may contain the complete address; optional fields may be left empty.

China / Japan / Korea

Native script: Use big → small order for all fields.

English script: Use small → big order for all fields.

API Result (JSON)

ParameterDescription
statusVALID: address is correct and deliverable.
SUSPECT: address is incorrect and needs corrections to be deliverable, a suggested correction is provided.
INVALID: address is incorrect and not deliverable - either there is no match at all in the reference data or the address is ambiguous and there are many matches. In these cases automatic correction suggestions are not available.
DELAYED, NO_COUNTRY, RATE_LIMIT_EXCEEDED, API_KEY_INVALID_OR_DEPLETED, RESTRICTED, INTERNAL_ERROR
formattedaddressFull address in standardized format.
supplementAdditional address details (building / unit / apt / suite etc.).
streetStreet address in standardized format.
streetnumberStreet number in standardized format.
postalcodeZIP / postal code in standardized format.
cityCity in standardized format.
typeAddress type: S = Street address / P = P.O. Box, Pick-Up, or other delivery service.
rdiResidential Delivery Indicator (Commercial / Residential).
districtDistrict in standardized format.
countyCounty in standardized format.
stateState / province in standardized format.
countryTwo-letter ISO 3166-1 country code.
latitudeLatitude (for valid addresses if Geocoding is enabled).
longitudeLongitude (for valid addresses if Geocoding is enabled).
diagnosticsDetailed diagnostic hints, indicating errors in the address input.
correctionsDetailed correction hints, indicating which parts of the address input have been fixed.
ratelimit_remainNumber of API requests remaining before the API rate limit is reached (default API rate limit allows 100 API requests in 300s).
ratelimit_secondsNumber of seconds remaining in the current rate limit interval.

Environment Variables

  • EV_TOKEN: Your Email Validator API Token
  • PV_TOKEN: Your Phone Validator API Token
  • AV_TOKEN: Your Address Validator API Token You may use only the tokens for the services you use (e.g. only Email Validator), in that case leave the others tokens empty.

Contact