article
README
🚀 MCP域名可用性服务器
这是一个基于模型上下文协议(MCP)的服务器,可借助GoDaddy OTE(运营测试环境)API来检查域名可用性和价格。
✨ 主要特性
- 通过GoDaddy OTE沙箱检查域名可用性和价格
- 支持多种顶级域名(TLD)后缀
- 提供快速和全面两种检查模式
- 支持批量域名检查
- 有速率限制(每分钟60次调用)
- 以美元为单位进行标准化定价,保留两位小数
- 统一的字段命名和数据结构
- 周期标准化(存储为月,显示为年)
📦 安装指南
使用uv(推荐)
# 安装依赖
uv add "mcp[cli]"
# 使用MCP Inspector进行测试
DOMAIN_API_KEY="your-key:your-secret" mcp dev domain_availability/server.py
手动安装
pip install -e .
🛠️ 配置说明
环境变量
DOMAIN_API_KEY:你的GoDaddy OTE API凭证,格式为"key:secret"(必需)
注意:服务器默认使用GoDaddy OTE(沙箱)API:https://api.ote-godaddy.com
GoDaddy OTE设置
- 注册GoDaddy开发者账户
- 获取OTE(沙箱)API凭证
- 设置环境变量:
DOMAIN_API_KEY="your-ote-key:your-ote-secret"
MCP配置
将以下内容添加到你的MCP客户端配置中(例如,Claude Desktop的 claude_desktop_config.json):
{
"mcpServers": {
"domain-availability": {
"command": "uv",
"args": ["run", "mcp-domain-availability"],
"env": {
"DOMAIN_API_KEY": "your-ote-key:your-ote-secret"
}
}
}
}
💻 使用示例
开发与测试
# 启动MCP Inspector进行测试
DOMAIN_API_KEY="your-key:your-secret" mcp dev domain_availability/server.py
这将在 http://localhost:6274 启动MCP Inspector,用于交互式测试。
可用工具
服务器提供一个工具:check_domain_availability
参数
选项1:直接传入域名列表
domains:要检查的域名数组(例如["example.com", "example.org"])
选项2:传入基础域名和TLD后缀
base_name:基础域名(例如"example")tld_suffixes:TLD后缀数组(例如[".com", ".org", ".net", ".io"])
可选参数
checkType:"FAST"或"FULL"(默认:"FAST")FAST:以速度优化FULL:以准确性优化
示例
检查特定域名
{
"domains": ["example.com", "example.org", "example.net"],
"checkType": "FAST"
}
检查带多个TLD的基础域名
{
"base_name": "myawesomesite",
"tld_suffixes": [".com", ".org", ".net", ".io", ".dev", ".app"],
"checkType": "FULL"
}
响应格式
文本响应:
Domain Availability Check Results:
✅ AVAILABLE DOMAINS:
• example.com - $12.99 USD for 1 year (Definitive)
• example.org - $8.99 USD for 2 years (Preliminary)
❌ UNAVAILABLE DOMAINS:
• example.net - Not available - Domain already registered
JSON响应(标准化字段):
{
"domains": [
{
"domain_name": "example.com",
"is_available": true,
"price_dollars": 12.99,
"currency_code": "USD",
"is_definitive": true,
"registration_period_months": 12
},
{
"domain_name": "example.net",
"is_available": false,
"price_dollars": 0.00,
"currency_code": "USD",
"is_definitive": true,
"registration_period_months": 12,
"error_message": "Domain already registered"
}
],
"errors": []
}
📊 数据标准化
价格标准化
- 输入:GoDaddy API返回的价格以微单位(货币的1/1,000,000)表示
- 输出:转换为美元,保留两位小数
- 示例:
12000000微单位 →$12.00 USD
周期标准化
- 存储:周期以月为单位存储,保证一致性
- 显示:转换为年,方便用户查看
- 示例:
12 months→"1 year",24 months→"2 years"
字段命名
统一、明确的字段名称:
domain_name(而非domain)is_available(而非available)price_dollars(而非price)currency_code(而非currency)is_definitive(而非definitive)registration_period_months(而非period)error_message(而非error)
🔌 API集成
此服务器与GoDaddy OTE API集成:
- 基础URL:
https://api.ote-godaddy.com - 端点:
GET /v1/domains/available?domain={domain} - 请求头:
Authorization: sso-key {key}:{secret} - 速率限制:每分钟60次请求
认证格式
Authorization: sso-key your-key:your-secret
⚠️ 错误处理
服务器处理各种错误情况:
- 缺少API密钥
- 无效域名
- API速率限制(429) - 提供重试指导
- 部分响应(203)
- 认证错误(401, 403)
- 服务器错误(500)
- 网络超时
🛠️ 开发指南
设置开发环境
# 克隆并设置
git clone <repository>
cd mcp-free-domain
uv add "mcp[cli]"
# 运行测试
pytest
# 启动开发服务器
DOMAIN_API_KEY="test-key:test-secret" mcp dev domain_availability/server.py
使用MCP Inspector进行测试
- 设置你的OTE凭证:
DOMAIN_API_KEY="your-key:your-secret" - 运行:
mcp dev domain_availability/server.py - 在浏览器中打开
http://localhost:6274 - 如果提示,使用终端中显示的会话令牌
- 测试
check_domain_availability工具
📄 许可证
本项目采用MIT许可证。
🆘 支持
如有问题或疑问,请在仓库中创建一个issue。
微信扫一扫