Whodis MCP Server

Whodis MCP 服务

本项目提供一个专为使用 WHOIS 查询检查域名可用性而设计的 Model Context Protocol（MCP）服务。它允许 AI 助手或其他工具将域名可用性检查集成到工作流中。

---

概述

什么是 MCP？

Model Context Protocol（MCP）是一种开放标准，允许 AI 系统安全地、结合上下文地连接外部工具和数据源。本服务实现了 MCP 标准，可提供域名可用性信息。

功能

• 域名可用性检查：使用 whoiser 库执行 WHOIS 查询，并确定域名是否看起来可用或已注册。
• MCP 工具集成：向 MCP 客户端（如 AI 助手）提供 check-domain-availability 工具。
• CLI 界面：包含一个命令行界面（whodis-mcp-server check-domain-availability ...），可直接使用和测试。
• 结构化日志：提供详细日志，便于调试和监控。
• 可配置：支持通过环境变量或 .env 文件进行配置。

---

开始使用

先决条件

• Node.js（>=18.x）：下载
• Git：用于版本控制

---

步骤 1：克隆并安装

# Clone the repository
git clone https://github.com/vinsidious/whodis-mcp-server.git
cd whodis-mcp-server

# Install dependencies
npm install

---

步骤 2：运行开发服务

在开发模式下启动服务，以便通过 MCP Inspector 与其交互：

npm run dev:server

这会启动 MCP 服务，并在 http://localhost:5173 启用 MCP Inspector，你可以在其中测试 check-domain-availability 工具。

---

步骤 3：通过 CLI 测试工具

直接从命令行运行域名可用性检查器：

# Using CLI in development mode
npm run dev:cli -- check-domain-availability example.com non-existent-domain-12345.org

# Or run the built version
npm run start:cli -- check-domain-availability google.com my-unique-idea.dev

CLI 将输出一个 JSON 对象，其中包含 available 和 unavailable 数组。

---

架构

本服务采用分层架构：

src/
├── cli/              # Command-line interface logic
├── controllers/      # Business logic for domain checks
├── services/         # Interaction with the whoiser library
├── tools/            # MCP tool definition and argument validation
├── types/            # Shared type definitions
├── utils/            # Shared utilities (logging, errors, etc.)
└── index.ts          # Main entry point for server and CLI

---

开发指南

开发脚本

# Start MCP server in development mode (with MCP Inspector)
npm run dev:server

# Run CLI commands in development mode
npm run dev:cli -- check-domain-availability <domains...>

# Build the project for production
npm run build

# Start MCP server in production mode (requires MCP client)
npm run start:server

# Run CLI commands using the production build
npm run start:cli -- check-domain-availability <domains...>

测试

# Run all tests
npm test

# Generate test coverage report
npm run test:coverage

代码质量

# Lint code
npm run lint

# Format code with Prettier
npm run format

---

MCP 工具：check-domain-availability

• 用途：检查一个或多个域名的可用性。
• 输入：域名数组。

  {
  	"domains": ["example.com", "another-domain.net"]
  }
  

• 输出：一个 JSON 对象，包含两个数组：available（看起来尚未注册的域名）和 unavailable（看起来已注册的域名）。

  {
  	"available": ["likely-available-domain123.xyz"],
  	"unavailable": ["google.com"]
  }
  

  注意：可用性检查取决于 WHOIS 服务的响应，对于所有 TLD 或因临时网络问题，结果可能并非 100% 准确。查询失败的域名会被省略。
• 适用场景：需要确定特定域名是否可能可以注册时，使用此工具。

---

调试

MCP Inspector

访问可视化 MCP Inspector，以测试工具并查看请求/响应详情：

1. 运行 npm run dev:server
2. 在浏览器中打开 http://localhost:5173
3. 使用 UI 调用 check-domain-availability 工具。

服务日志

启用调试日志以查看详细输出：

# Set environment variable
DEBUG=true npm run dev:server

# Or set DEBUG=true in your .env file

日志也会保存到 ~/.mcp/data/whodis-mcp-server.*.log 中。

---

发布

要将更新发布到 npm：

1. 确保更改已提交，并遵循约定式提交消息格式（例如 feat:、fix:、chore:）。
2. 将更改推送到 main 分支。
3. ci-semantic-release.yml 工作流将自动构建、测试、确定版本并将软件包发布到 npm。

---

许可证

ISC 许可证