使用说明

项目简介

本项目 'MCP Email Verify' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 提供电子邮件地址验证功能。通过集成 AbstractAPI 提供的电子邮件验证服务,该服务器能够帮助 LLM 客户端(如 Claude Desktop)实时检测邮箱地址的格式、域名有效性和可达性,从而提升基于 LLM 的应用在处理邮件相关任务时的准确性和可靠性。

主要功能点

  • 电子邮件验证: 利用 AbstractAPI 接口,验证邮箱地址的有效性,包括格式校验、域名有效性检查和SMTP服务器连通性测试。
  • MCP 协议集成: 遵循 MCP 协议标准,能够与任何兼容 MCP 协议的 LLM 客户端无缝连接和通信。
  • 易于部署: 使用 Python 和 FastMCP 框架开发,配置简单,易于安装和运行。

安装步骤

  1. 克隆仓库

    git clone https://github.com/Abhi5h3k/MCP-Email-Verify.git
    cd MCP-Email-Verify
  2. 安装 UV

    如果尚未安装 UV,请根据仓库 'README.md' 提供的命令进行安装。UV 是一个快速的 Python 包安装和运行工具,用于管理项目依赖和运行服务器。

  3. 创建并激活虚拟环境

    uv venv
    .venv\Scripts\activate  # Windows
    # source .venv/bin/activate # Linux/macOS
  4. 安装依赖

    uv install

    此命令将根据 'pyproject.toml' 文件安装项目所需的所有 Python 依赖包。

服务器配置

为了让 MCP 客户端(例如 Claude Desktop)连接到 'MCP Email Verify' 服务器,您需要在客户端的配置文件中添加服务器信息。以 'claude_desktop_config.json' 为例,您需要配置 'mcpServers' 部分,指定服务器的启动命令和参数。

以下是一个配置示例,您只需将这段 JSON 配置添加到您的 MCP 客户端配置文件中,无需修改路径

{
    "mcpServers": {
        "verify_mail": {
            "command": "uv",
            "args": [
                "run",
                "server.py"
            ]
        }
    }
}
  • '"verify_mail"': 服务器的名称,您可以自定义,用于在客户端中引用该服务器。
  • '"command": "uv"': 启动服务器的命令。这里使用 'uv run' 来运行 Python 脚本。
  • '"args": ["run", "server.py"]': 传递给 'uv run' 命令的参数。 '"run server.py"' 指示 UV 运行当前目录下的 'server.py' 文件。

重要提示: 请确保您的 MCP 客户端在启动 'MCP Email Verify' 服务器时,其工作目录位于克隆的 'MCP-Email-Verify' 仓库根目录下。通常情况下,MCP 客户端会负责在正确的目录下启动您配置的 MCP 服务器。

基本使用方法

  1. 设置 AbstractAPI 密钥

    在 'MCP-Email-Verify' 仓库根目录下创建 '.env' 文件,并添加您的 AbstractAPI 密钥。您可以在 AbstractAPI 官网 注册并获取免费 API 密钥。

    ABSTRACT_API_KEY=your_api_key_here
  2. 启动服务器

    在 'MCP-Email-Verify' 仓库根目录下,运行以下命令启动 MCP 服务器:

    uv run server.py
  3. 在 LLM 客户端中使用

    配置完成后,您可以在支持 MCP 协议的 LLM 客户端(如 Claude Desktop)中使用自然语言提示来调用 'verify_email' 工具。例如,您可以向 Claude Desktop 提问:

    请帮我验证一下 [email protected] 这个邮箱地址是否有效?

    LLM 客户端将解析您的请求,并调用 'MCP Email Verify' 服务器来验证邮箱地址,然后将验证结果返回给您。

开发说明

仓库 'README.md' 提供了关于代码格式化、代码检查和设置 pre-commit hooks 的开发指南,供开发者参考。

信息

分类

网页与API