byteplant-mcp 0.1.0__tar.gz

byteplant_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: byteplant-mcp
+Version: 0.1.0
+Summary: Byteplant's Email Validator, Phone Validator and Address Validator MCP Server
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: mcp[cli]>=1.23.1
+Requires-Dist: requests>=2.32.5
+
+<!-- mcp-name: io.github.byteplant-dev/byteplant-mcp -->
+# 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 validation inside any MCP-compatible client.
+
+## Features
+- Email validation
+- Phone number validation
+- Postal address validation
+- Fast stdio MCP server
+- Local execution
+- Easy integration with Claude Desktop
+
+## Requirements
+- Python ≥ 3.12
+- Byteplant API key (one for each validator, depending which ones you use). [You can register to get one here](https://www.byteplant.com/account/)
+- MCP Client (e.g. Claude Desktop)
+
+
+## MCP Configuration (Claude Desktop)
+### 1. Installation
+First, install the python module. You can use local installation (like `venv`) or global.
+```bash
+pip install byteplant-mcp
+```
+### 2. Configuration
+Next, add the MCP server to Claude configuration.
+```json
+{
+	"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>"
+			}
+		}
+	}
+}	
+```
+
+## Tools
+### 1. `validate_email`
+Validates an email address.
+
+**Parameters:**
+- `email`: An email address to validate [required]
+- `timeout`: timeout in seconds [optional; default 10s, min 5s, max 300s]
+
+### 2. `validate_phone`
+Validates a phone number.
+**Parameters:**
+- `phone`: Phone number to validate [required]
+- `code`: Two letter ISO 3166-1 country code [optional; if phone number is in international format, empty string if not specified]
+- `locale`: IETF language tag for Geocoding (string) [optional; default 'en-US']
+- `mode`: express (static checks only)/extensive (full validation) [optional; default = extensive]
+- `timeout`: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+
+### 3 `validate_address`
+Validates a postal address.
+**Paraters:**
+- `code`: two-letter ISO 3166-1 country code (string), set to 'XX' for international [required]
+- `street_adr`: street/housenumber/building, may include unit/apt etc. (string)[required]
+- `street_num`: housenumber/building [optional] (string), housenumber/building can either be part of StreetAddress or be provided separately.
+- `additional_info`: building/unit/apt/floor etc. [optional] (string)
+- `city`: city or locality (city, district) [optional] (string)
+- `postal`: zip/postal code [optional] (string)
+- `State`: state/province [optional] (string)
+- `geocoding`: enable Geocoding [true|false]; default: false [optional] (bool)
+- `locale`: output language for countries with multiple postal languages - use only to translate addresses, always leave empty for address validation [IETF language tag]; default: local language [optional] (string)
+- `charset`: output character set [us-ascii|utf-8]; default: 'utf-8' [optional] (string)
+- `timeout`: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+
+## 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
+- Website: https://www.byteplant.com
+- Get your API key: https://www.byteplant.com/account/
+
+- Email: contact@byteplant.com

byteplant_mcp-0.1.0/README.md

@@ -0,0 +1,87 @@
+<!-- mcp-name: io.github.byteplant-dev/byteplant-mcp -->
+# 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 validation inside any MCP-compatible client.
+
+## Features
+- Email validation
+- Phone number validation
+- Postal address validation
+- Fast stdio MCP server
+- Local execution
+- Easy integration with Claude Desktop
+
+## Requirements
+- Python ≥ 3.12
+- Byteplant API key (one for each validator, depending which ones you use). [You can register to get one here](https://www.byteplant.com/account/)
+- MCP Client (e.g. Claude Desktop)
+
+
+## MCP Configuration (Claude Desktop)
+### 1. Installation
+First, install the python module. You can use local installation (like `venv`) or global.
+```bash
+pip install byteplant-mcp
+```
+### 2. Configuration
+Next, add the MCP server to Claude configuration.
+```json
+{
+	"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>"
+			}
+		}
+	}
+}	
+```
+
+## Tools
+### 1. `validate_email`
+Validates an email address.
+
+**Parameters:**
+- `email`: An email address to validate [required]
+- `timeout`: timeout in seconds [optional; default 10s, min 5s, max 300s]
+
+### 2. `validate_phone`
+Validates a phone number.
+**Parameters:**
+- `phone`: Phone number to validate [required]
+- `code`: Two letter ISO 3166-1 country code [optional; if phone number is in international format, empty string if not specified]
+- `locale`: IETF language tag for Geocoding (string) [optional; default 'en-US']
+- `mode`: express (static checks only)/extensive (full validation) [optional; default = extensive]
+- `timeout`: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+
+### 3 `validate_address`
+Validates a postal address.
+**Paraters:**
+- `code`: two-letter ISO 3166-1 country code (string), set to 'XX' for international [required]
+- `street_adr`: street/housenumber/building, may include unit/apt etc. (string)[required]
+- `street_num`: housenumber/building [optional] (string), housenumber/building can either be part of StreetAddress or be provided separately.
+- `additional_info`: building/unit/apt/floor etc. [optional] (string)
+- `city`: city or locality (city, district) [optional] (string)
+- `postal`: zip/postal code [optional] (string)
+- `State`: state/province [optional] (string)
+- `geocoding`: enable Geocoding [true|false]; default: false [optional] (bool)
+- `locale`: output language for countries with multiple postal languages - use only to translate addresses, always leave empty for address validation [IETF language tag]; default: local language [optional] (string)
+- `charset`: output character set [us-ascii|utf-8]; default: 'utf-8' [optional] (string)
+- `timeout`: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+
+## 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
+- Website: https://www.byteplant.com
+- Get your API key: https://www.byteplant.com/account/
+
+- Email: contact@byteplant.com

byteplant_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,10 @@
+[project]
+name = "byteplant-mcp"
+version = "0.1.0"
+description = "Byteplant's Email Validator, Phone Validator and Address Validator MCP Server"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "mcp[cli]>=1.23.1",
+    "requests>=2.32.5",
+]

byteplant_mcp-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

byteplant_mcp-0.1.0/src/byteplant-mcp/__main__.py

@@ -0,0 +1,4 @@
+from .server import main
+
+if __name__ == '__main__':
+    main()

byteplant_mcp-0.1.0/src/byteplant-mcp/server.py

@@ -0,0 +1,208 @@
+from mcp.server.fastmcp import FastMCP
+import os
+import json
+import requests
+
+mcp = FastMCP("Byteplant MCP")
+
+EV_TOKEN = os.environ.get("EV_TOKEN", "")
+PV_TOKEN = os.environ.get("PV_TOKEN", "")
+AV_TOKEN = os.environ.get("AV_TOKEN", "")
+
+
+def make_data(data, error=None):
+    out = {}
+    if error:
+        out["ok"] = False
+        out["error"] = error
+    else:
+        out["ok"] = True
+        out["data"] = data
+    return out
+
+def request_email(email, timeout):
+    params = {
+        "APIKey" : EV_TOKEN,
+        "EmailAddress" : email,
+        "Timeout" : timeout
+    }
+    try:
+        data = json.loads(requests.post("https://api.email-validator.net/api/verify", params=params).text)
+        return make_data(data)
+    except Exception as e:
+        return make_data(data=None, error=f"Error: {e}")
+
+
+@mcp.tool()
+def validate_email(email: str, timeout: int) -> str:
+    """Validate email address
+
+    Args:
+        email: An email address to validate [required]
+        timeout: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+    """
+    data = request_email(email, timeout)
+    if not data['ok']:
+        return data['error']
+    data = data['data']
+    res = "Byteplant Email Validation Report\n"
+    if data.get("status"):
+        res += f"Validation status code: {data.get('status')}\n"
+    if data.get("info"):
+        res += f"Validation info: {data.get('info')}\n"
+    if data.get("freemail"):
+        res += f"Is freemai: {data.get('freemail')}\n"
+    if data.get("ratelimit_remain"):
+        res += f"Number of API requests remaining before the API rate limit is reached: {data.get('ratelimit_remain')}\n"
+    if data.get("ratelimit_seconds"):
+        res += f"Number of seconds remaining in the current rate limit interval: {data.get('ratelimit_seconds')}\n"
+    return res
+
+def request_phone(phone, code, locale, mode, timeout):
+    params = {
+        "APIKey" : PV_TOKEN,
+        "PhoneNumber" : phone,
+        "CountryCode" : code, 
+        "Locale" : locale,
+        "Mode" : mode,
+        "Timeout": timeout
+    }
+    try:
+        data = json.loads(requests.post("https://api.phone-validator.net/api/v2/verify", params=params).text)
+        return make_data(data)
+    except Exception as e:
+        return make_data(data=None, error=f"Error: {e}")
+
+
+@mcp.tool()
+def validate_phone(phone: str, code: str, locale: str, mode: str, timeout: int) -> str:
+    """Validate phone number
+
+    Args:
+        phone: Phone number to validate [required]
+        code: Two letter ISO 3166-1 country code [optional; if phone number is in international format, empty string if not specified]
+        locale: IETF language tag for Geocoding (string) [optional; default 'en-US']
+        mode: express (static checks only)/extensive (full validation) [optional; default = extensive]
+        timeout: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+    """
+    data = request_phone(phone, code, locale, mode, timeout)
+    if not data['ok']:
+        return data['error']
+    data = data['data']
+    res = "Byteplant Phone Number Validation Report\n"
+    if data.get("status"):
+        res += f"Validation status code: {data.get('status')}\n"
+    if data.get("linetype"):
+        res += f"Line type: {data.get('linetype')}\n"
+    if data.get("location"):
+        res += f"Geographical location (city, county, state): {data.get('location')}\n"
+    if data.get("countrycode"):
+        res += f"Two letter ISO 3166-1 country code: {data.get('countrycode')}\n"
+    if data.get("formatnational"):
+        res += f"Phone number in national format: {data.get('formatnational')}\n"
+    if data.get("formatinternational"):
+        res += f"Phone number in international format: {data.get('formatinternational')}\n"
+    if data.get("mcc"):
+        res += f"Mobile country code to identify a mobile network operator (carrier) using the GSM (including GSM-R), UMTS, and LTE networks : {data.get('mcc')}\n"
+    if data.get("formatinternational"):
+        res += f"Mobile network code to identify a mobile network operator (carrier) using the GSM (including GSM-R), UMTS, and LTE networks : {data.get('mnc')}\n"
+    if data.get("ratelimit_remain"):
+        res += f"Number of API requests remaining before the API rate limit is reached: {data.get('ratelimit_remain')}\n"
+    if data.get("ratelimit_seconds"):
+        res += f"Number of seconds remaining in the current rate limit interval: {data.get('ratelimit_seconds')}\n"
+    return res
+
+def request_address(code, street_adr, street_num, additional_info, city, postal, state, geocoding, locale, charset, timeout):
+    params = {
+        "APIKey" : AV_TOKEN,
+        "CountryCode" : code,
+        "StreetAddress" : street_adr, 
+        "StreetNumber" : street_num,
+        "AdditionalAddressInfo" : additional_info,
+        "City": city,
+        "PostalCode" : postal,
+        "State" : state, 
+        "Geocoding" : "true" if geocoding == True else "false",
+        "Locale" : locale,
+        "OutputCharset": charset,
+        "Timeout": timeout
+    }
+    try:
+        data = json.loads(requests.post("https://api.address-validator.net/api/verify", params=params).text)
+        return make_data(data)
+    except Exception as e:
+        return make_data(data=None, error=f"Error: {e}")
+
+
+
+@mcp.tool()
+def validate_address(code: str, street_adr: str, street_num: str, additional_info: str, city: str, postal: str, state: str, geocoding: bool, locale: str, charset: str, timeout: int) -> str:
+    """Validate address
+
+    Args:
+        code: two-letter ISO 3166-1 country code (string), set to 'XX' for international [required]
+        street_adr: street/housenumber/building, may include unit/apt etc. (string)[required]
+        street_num: housenumber/building [optional] (string), housenumber/building can either be part of StreetAddress or be provided separately.
+        additional_info: building/unit/apt/floor etc. [optional] (string)
+        city: city or locality (city, district) [optional] (string)
+        postal: zip/postal code [optional] (string)
+        State: state/province [optional] (string)
+        geocoding: enable Geocoding [true|false]; default: false [optional] (bool)
+        locale: output language for countries with multiple postal languages - use only to translate addresses, always leave empty for address validation [IETF language tag]; default: local language [optional] (string)
+        charset: output character set [us-ascii|utf-8]; default: 'utf-8' [optional] (string)
+        timeout: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+    """
+    data = request_address(code, street_adr, street_num, additional_info, city, postal, state, geocoding, locale, charset, timeout)
+    if not data['ok']:
+        return data['error']
+    data = data['data']
+    res = "Byteplant Address Validation Report\n"
+    if data.get("status"):
+        res += "Validation status: "
+        if data.get('status') == "VALID":
+            res += "VALID: address is correct and deliverable.\n"
+        elif data.get('status') == "SUSPECT":
+            res += "SUSPECT: address is incorrect and needs corrections to be deliverable, a suggested correction is provided.\n"
+        elif data.get('status') == "INVALID":
+            res += "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 a lot of different matches. In these cases automatic correction suggestions are not available.\n"
+        else:
+            res += f"{data.get('status')}\n"
+    if data.get("formattedaddress"):
+        res += f"Full address in standardized format: {data.get('formattedaddress')}\n"
+    if data.get("supplement"):
+        res += f"Additional address details (building / unit / apt / suite etc.): {data.get('supplement')}\n"
+    if data.get("street"):
+        res += f"Street address in standardized format: {data.get('street')}\n"
+    if data.get("streetnumber"):
+        res += f"Street number in standardized format: {data.get('streetnumber')}\n"
+    if data.get("postalcode"):
+        res += f"Zip / postal code in standardized format: {data.get('postalcode')}\n"
+    if data.get("city"):
+        res += f"City in standardized format: {data.get('city')}\n"
+    if data.get("rdi"):
+        res += f"Residential Delivery Indicator (Commercial / Residential): {data.get('rdi')}\n"
+    if data.get("district"):
+        res += f"District in standardized format: {data.get('district')}\n"
+    if data.get("county"):
+        res += f"County in standardized format: {data.get('county')}\n"
+    if data.get("state"):
+        res += f"State / province in standardized format: {data.get('state')}\n"
+    if data.get("country"):
+        res += f"Two-letter ISO 3166-1 country code: {data.get('country')}\n"
+    if data.get("latitude"):
+        res += f"Latitude: {data.get('latitude')}\n"
+    if data.get("longitude"):
+        res += f"longitude: {data.get('longitude')}\n"
+    if data.get("diagnostics"):
+        res += f"Diagnostic hints, indicating errors in the address input: {data.get('diagnostics')}\n"
+    if data.get("corrections"):
+        res += f"Correction hints, indicating which parts of the address input have been fixed: {data.get('corrections')}\n"
+    if data.get("ratelimit_remain"):
+        res += f"Number of API requests remaining before the API rate limit is reached: {data.get('ratelimit_remain')}\n"
+    if data.get("ratelimit_seconds"):
+        res += f"Number of seconds remaining in the current rate limit interval: {data.get('ratelimit_seconds')}\n"
+
+    return res
+
+def main():
+    mcp.run(transport="stdio")

byteplant_mcp-0.1.0/src/byteplant_mcp.egg-info/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: byteplant-mcp
+Version: 0.1.0
+Summary: Byteplant's Email Validator, Phone Validator and Address Validator MCP Server
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: mcp[cli]>=1.23.1
+Requires-Dist: requests>=2.32.5
+
+<!-- mcp-name: io.github.byteplant-dev/byteplant-mcp -->
+# 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 validation inside any MCP-compatible client.
+
+## Features
+- Email validation
+- Phone number validation
+- Postal address validation
+- Fast stdio MCP server
+- Local execution
+- Easy integration with Claude Desktop
+
+## Requirements
+- Python ≥ 3.12
+- Byteplant API key (one for each validator, depending which ones you use). [You can register to get one here](https://www.byteplant.com/account/)
+- MCP Client (e.g. Claude Desktop)
+
+
+## MCP Configuration (Claude Desktop)
+### 1. Installation
+First, install the python module. You can use local installation (like `venv`) or global.
+```bash
+pip install byteplant-mcp
+```
+### 2. Configuration
+Next, add the MCP server to Claude configuration.
+```json
+{
+	"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>"
+			}
+		}
+	}
+}	
+```
+
+## Tools
+### 1. `validate_email`
+Validates an email address.
+
+**Parameters:**
+- `email`: An email address to validate [required]
+- `timeout`: timeout in seconds [optional; default 10s, min 5s, max 300s]
+
+### 2. `validate_phone`
+Validates a phone number.
+**Parameters:**
+- `phone`: Phone number to validate [required]
+- `code`: Two letter ISO 3166-1 country code [optional; if phone number is in international format, empty string if not specified]
+- `locale`: IETF language tag for Geocoding (string) [optional; default 'en-US']
+- `mode`: express (static checks only)/extensive (full validation) [optional; default = extensive]
+- `timeout`: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+
+### 3 `validate_address`
+Validates a postal address.
+**Paraters:**
+- `code`: two-letter ISO 3166-1 country code (string), set to 'XX' for international [required]
+- `street_adr`: street/housenumber/building, may include unit/apt etc. (string)[required]
+- `street_num`: housenumber/building [optional] (string), housenumber/building can either be part of StreetAddress or be provided separately.
+- `additional_info`: building/unit/apt/floor etc. [optional] (string)
+- `city`: city or locality (city, district) [optional] (string)
+- `postal`: zip/postal code [optional] (string)
+- `State`: state/province [optional] (string)
+- `geocoding`: enable Geocoding [true|false]; default: false [optional] (bool)
+- `locale`: output language for countries with multiple postal languages - use only to translate addresses, always leave empty for address validation [IETF language tag]; default: local language [optional] (string)
+- `charset`: output character set [us-ascii|utf-8]; default: 'utf-8' [optional] (string)
+- `timeout`: timeout in seconds (int) [optional; default 10s, min 5s, max 300s]
+
+## 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
+- Website: https://www.byteplant.com
+- Get your API key: https://www.byteplant.com/account/
+
+- Email: contact@byteplant.com

byteplant_mcp-0.1.0/src/byteplant_mcp.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/byteplant-mcp/__init__.py
+src/byteplant-mcp/__main__.py
+src/byteplant-mcp/server.py
+src/byteplant_mcp.egg-info/PKG-INFO
+src/byteplant_mcp.egg-info/SOURCES.txt
+src/byteplant_mcp.egg-info/dependency_links.txt
+src/byteplant_mcp.egg-info/requires.txt
+src/byteplant_mcp.egg-info/top_level.txt

byteplant_mcp-0.1.0/src/byteplant_mcp.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

byteplant_mcp-0.1.0/src/byteplant_mcp.egg-info/requires.txt

@@ -0,0 +1,2 @@
+mcp[cli]>=1.23.1
+requests>=2.32.5

byteplant_mcp-0.1.0/src/byteplant_mcp.egg-info/top_level.txt

@@ -0,0 +1 @@
+byteplant-mcp