本项目是一个实现了 Model Context Protocol (MCP) 的服务器,专注于通过 WHOIS 查询提供域名可用性检查。它允许与支持MCP协议的AI助手或其他客户端集成,以便在其工作流程中调用域名可用性检查能力。

主要功能点

  • 域名可用性检查: 使用WHOIS查询库检查域名是否已注册。
  • MCP工具集成: 将域名检查能力封装为 'check-domain-availability' MCP工具,供MCP客户端调用。
  • 命令行接口 (CLI): 提供独立的命令行工具,方便直接测试和使用域名检查功能。
  • 结构化日志: 提供详细的日志输出,便于调试和监控。
  • 灵活配置: 支持通过环境变量或 '.env' 文件进行配置。

安装步骤

  1. 环境准备: 确保您的系统已安装 Node.js (推荐 >=18.x) 和 Git。
  2. 克隆仓库:
    git clone https://github.com/vinsidious/whodis-mcp-server.git
    cd whodis-mcp-server
  3. 安装依赖:
    npm install
  4. 构建项目: 在运行生产版本之前,需要构建项目。
    npm run build

服务器配置

MCP客户端需要知道如何启动此MCP服务器进程。您需要将以下信息配置在您的MCP客户端中(具体的配置方式取决于您的客户端应用,通常是一个JSON对象):

  • 服务器名称 (serverName): 'whodis-mcp-server' (用于客户端识别此服务器)
  • 启动命令 (command): 'node' (用于执行Node.js脚本)
  • 命令参数 (args): '["dist/index.js"]' (指定要运行的编译后的服务器入口文件。当不带其他参数执行 'dist/index.js' 时,它会启动MCP服务器模式。)
  • 传输协议 (transport): 'stdio' (此服务器默认使用标准输入输出进行通信,通常客户端默认也支持此协议,无需额外指定。)

示例配置信息 (供客户端开发者参考,用户无需关心此JSON内容):

{
  "serverName": "whodis-mcp-server",
  "command": "node",
  "args": ["dist/index.js"],
  "transport": "stdio"
}

基本使用方法

当您在MCP客户端(如AI助手)中配置并连接此服务器后,AI助手即可发现并调用该服务器提供的 'check-domain-availability' 工具。

  • 工具名称: 'check-domain-availability'
  • 调用方式: 通过MCP客户端以JSON-RPC请求调用此工具。
  • 输入参数: 一个JSON对象,包含一个 'domains' 字段,其值为要检查的域名字符串数组。
    {
      "domains": ["example.com", "another-domain.net"]
    }
  • 输出结果: 一个JSON对象,包含两个数组 'available' 和 'unavailable',分别列出看起来可用和不可用的域名。
    {
      "available": ["likely-available-domain123.xyz"],
      "unavailable": ["google.com"]
    }
    请注意: WHOIS查询结果可能因各种因素(如WHOIS服务器限制、缓存、不同注册局规则)而存在不准确性,结果仅供参考。

用户通常通过MCP客户端的应用界面与此服务器交互,无需直接运行命令行或手动调用工具。

您也可以直接使用命令行测试功能(不通过MCP协议):

# 运行生产版本CLI
npm run start:cli -- check-domain-availability google.com my-unique-idea.dev

这将直接输出检查结果的JSON字符串。

信息

分类

网页与API