内容
# Hope Domain MCP Server
[中文版文档](./README_ZH.md) | [English Doc](./README.md)
[](https://www.npmjs.com/package/hopedomain-mcp)
[](https://www.npmjs.com/package/hopedomain-mcp)
[](https://github.com/HopeDomain/whois-mcp/blob/main/LICENSE)
一个提供 Hope Domain API 服务的模型上下文协议 (MCP) 服务器，包括域名 WHOIS 查询和基于 AI 的域名推荐。
## ✨ 特性
🔍 **域名 WHOIS 查询**
- 单个域名 WHOIS 查询（免费）
- 批量域名 WHOIS 查询（最多 1000 个域名，≤50 免费）
🤖 **AI 域名推荐**
- 基于项目描述的 AI 驱动域名建议
- 每个请求生成 1-50 个域名推荐
💰 **信用管理**
- 查看当前信用余额和账户状态
- 跟踪使用情况和充值历史
🚀 **零警告**
- 使用 Node.js 原生 fetch API
- 零依赖警告，干净的安装体验
## 📦 安装方法
### ⚡ 方法 1：一键安装（推荐给 Cursor 用户）
[](https://cursor.com/install-mcp?name=hopedomain-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJob3BlZG9tYWluLW1jcEBsYXRlc3QiXSwiZW52Ijp7IkhPUEVfRE9NQUlOX0FQSV9LRVkiOiJzay15b3VyX2FwaV9rZXlfaGVyZSAoZ2V0IGl0IGZyb20gaHR0cHM6Ly9ob3BlZG9tYWluLmNvbS9hcGkta2V5cykifX0K)
**🎯 特性：**
- ⚡ **零配置** - 点击使用，无需手动设置
- 🔄 **自动更新** - 始终使用最新版本
- 🚀 **即时部署** - 无需本地安装
- ✨ **完全无警告** - 干净的运行环境
### ⚙️ 方法 2：标准配置（通用）
#### NPX 方法（推荐）
```json
{
"mcpServers": {
"hopedomain-mcp": {
"command": "npx",
"args": ["hopedomain-mcp@latest"],
"env": {
"HOPE_DOMAIN_API_KEY": "sk-your_api_key_here"
}
}
}
}
```
**🎯 特性：**
- 📦 **无需安装** - 直接通过 npx 运行
- 🔄 **自动更新** - `@latest` 确保使用最新版本
- 🌐 **跨平台兼容** - 支持所有 MCP 客户端
- ⚡ **轻量快速** - 仅需配置 API 密钥
- ✨ **零警告输出** - 完全干净的运行体验
#### 本地开发安装
1. **克隆仓库：**
```bash
git clone https://github.com/HopeDomain/whois-mcp.git
cd whois-mcp
```
2. **安装依赖：**
```bash
npm install
```
3. **构建项目：**
```bash
npm run build
```
### 📁 配置文件模板
我们在 `configs/` 目录中提供多个预配置模板：
- 📄 **`configs/claude-desktop.json`** - Claude Desktop 标准配置
- 📄 **`configs/cursor-mcp.json`** - Cursor MCP 配置
- 📄 **`configs/local-dev.json`** - 本地开发配置
只需将相应的配置复制到您的 MCP 客户端配置文件中即可！
## 🚀 快速开始
### 🎯 步骤 1：选择安装方法
- **Cursor 用户** → 点击一键安装按钮 ⚡
- **其他用户** → 使用 NPX 标准配置 ⚙️
### 🔑 步骤 2：获取 API 密钥
1. 访问 [Hope Domain 官方网站](https://hopedomain.com) 注册/登录
2. 前往 [控制台](https://hopedomain.com/api-keys) → **API 密钥** 页面
3. 点击 **"创建 API 密钥"** 按钮
4. 复制生成的 API 密钥（格式：`sk-xxxxxxxxxx`）
### ⚙️ 步骤 3：配置 API 密钥
**环境变量方法：**
```bash
export HOPE_DOMAIN_API_KEY="sk-your_actual_api_key_here"
```
**或直接在配置文件中设置：**
```json
{
"env": {
"HOPE_DOMAIN_API_KEY": "sk-your_actual_api_key_here"
}
}
```
### ✨ 步骤 4：开始使用！
现在您可以使用这些强大的工具：
- 🔍 `whois_single` - 单个域名 WHOIS 查询
- 📊 `whois_batch` - 批量域名查询（最多 1000 个）
- 🤖 `ai_domain_recommend` - AI 域名推荐
- 💰 `get_user_credits` - 账户信用查询
## ⚙️ 配置指南
### 🔐 环境变量配置
**方法 1：系统环境变量**
```bash
export HOPE_DOMAIN_API_KEY="sk-your_actual_api_key_here"
export HOPE_DOMAIN_BASE_URL="https://hopedomain.com/api" # 可选，默认为生产 API
```
**方法 2：项目 .env 文件**
```env
HOPE_DOMAIN_API_KEY=sk-your_actual_api_key_here
HOPE_DOMAIN_BASE_URL=https://hopedomain.com/api
```
### 📋 不同客户端配置示例
#### Claude Desktop
**📁 配置文件：** `~/.config/claude/claude_desktop_config.json` (Linux/Mac)
**📁 配置文件：** `%APPDATA%\Claude\claude_desktop_config.json` (Windows)
```json
{
"mcpServers": {
"hopedomain-mcp": {
"command": "npx",
"args": ["hopedomain-mcp@latest"],
"env": {
"HOPE_DOMAIN_API_KEY": "sk-your_actual_api_key_here"
}
}
}
}
```
#### Cursor IDE
**📁 配置位置：** 设置 → 扩展 → MCP
```json
{
"mcpServers": {
"hopedomain-mcp": {
"command": "npx",
"args": ["hopedomain-mcp@latest"],
"env": {
"HOPE_DOMAIN_API_KEY": "${HOPE_DOMAIN_API_KEY}"
}
}
}
}
```
#### 本地开发
**用例：** 源代码开发、调试、自定义修改
```json
{
"mcpServers": {
"hopedomain-mcp": {
"command": "node",
"args": ["./dist/index.js"],
"cwd": "/path/to/whois-mcp",
"env": {
"HOPE_DOMAIN_API_KEY": "sk-your_actual_api_key_here",
"HOPE_DOMAIN_BASE_URL": "https://hopedomain.com/api"
}
}
}
}
```
## 🔧 API 参考
### WHOIS 查询
#### 单个域名 WHOIS 查询
```typescript
whois_single(domain: string)
```
查询单个域名的 WHOIS 信息（免费）。
#### 批量域名 WHOIS 查询
```typescript
whois_batch(domains: string[], format?: "json")
```
一次查询多个域名的 WHOIS 信息（最多 1000 个域名，≤50 免费）。
### AI 域名推荐
#### AI 驱动的域名推荐
```typescript
ai_domain_recommend(description: string, count?: number)
```
根据项目描述获取 AI 驱动的域名推荐（1-50 个推荐）。
### 账户管理
#### 获取用户信用
```typescript
get_user_credits()
```
获取当前用户的信用余额和状态。
## 📝 示例
### 基本 WHOIS 查询
```typescript
// 查询单个域名
const result = await whois_single("example.com");
console.log(result);
```
### 批量 WHOIS 查询
```typescript
// 查询多个域名
const domains = ["example.com", "google.com", "github.com"];
const results = await whois_batch(domains);
console.log(results);
```
### AI 域名推荐
```typescript
// 获取项目的域名推荐
const recommendations = await ai_domain_recommend(
"一个现代的可持续产品电子商务平台",
10
);
console.log(recommendations);
```
### 检查账户信用
```typescript
// 检查您的账户余额
const credits = await get_user_credits();
console.log(credits);
```
## 🤝 贡献
我们欢迎贡献！请随时提交 Pull Request。对于重大更改，请先打开一个问题以讨论您想要更改的内容。
## 📄 许可证
该项目根据 MIT 许可证授权 - 详细信息请参见 [LICENSE](LICENSE) 文件。
## 🔗 链接
- 🌐 [官方网站](https://hopedomain.com)
- 📚 [API 文档](https://hopedomain.com/docs)
- 🔑 [API 密钥](https://hopedomain.com/api-keys)
- 💬 [支持](https://hopedomain.com/support)
## ⭐ 支持
如果您觉得这个项目有帮助，请在 GitHub 上给它一个星星！您的支持激励我们继续改进和添加新功能。
MCP 市场