项目简介
这是一个为Cursor AI编辑器设计的MCP服务器,集成了Namecheap域名API,使用户可以直接在Cursor编辑器内通过自然语言指令完成域名查询、价格获取和注册等操作。
主要功能点
- 域名可用性查询: 快速检查域名是否可以注册。
- 域名后缀 (TLD) 价格信息查询: 获取域名注册、续费和转移的详细价格。
- 域名注册: 通过您的Namecheap账户直接注册域名。
- WhoisGuard 支持: 启用或禁用WhoisGuard隐私保护。
- 自定义 Nameserver: 在注册时指定自定义域名服务器。
安装步骤
-
克隆仓库
git clone https://github.com/dalton-cole/mcp-namecheap-registrat.git cd mcp-namecheap-registrat -
安装依赖
npm install -
配置环境变量 复制 '.env.example' 文件并重命名为 '.env',然后编辑 '.env' 文件,填入您的 Namecheap API 密钥和用户名。
NAMECHEAP_USERNAME=your_username NAMECHEAP_API_KEY=your_api_key NODE_ENV=production # 生产环境,会真实购买域名;测试环境请设置为 sandbox注意:如果 'NODE_ENV' 设置为 'sandbox',将使用 Namecheap 的沙盒 API 进行测试,不会产生真实购买行为。沙盒环境需要单独的 API 密钥。
-
配置注册人信息 复制 'registrant-profile.example.json' 文件并重命名为 'registrant-profile.json',然后编辑 'registrant-profile.json' 文件,填入域名注册所需的个人联系信息。
-
构建项目
npm run build -
启动服务器
./start-mcp.sh
服务器配置
为了在 MCP 客户端(如 Cursor AI)中使用此 MCP 服务器,您需要配置服务器连接信息。以下是一个示例配置,请根据实际情况调整:
{ "serverName": "namecheap-domains", "command": "./start-mcp.sh", "args": [], "language": "javascript" }
- 'serverName': 服务器名称,可以自定义,例如 "namecheap-domains"。
- 'command': 启动 MCP 服务器的命令,这里是执行 'start-mcp.sh' 脚本。请确保脚本路径正确。
- 'args': 启动命令的参数,此例中没有参数,所以为空数组 '[]'。
- 'language': 可选字段,表明服务器端使用的编程语言,这里是 "javascript"。
基本使用方法
在 Cursor AI 编辑器中,您可以使用自然语言命令来调用 MCP 服务器的功能。以下是一些使用示例:
-
检查域名可用性:
check domain example.com -
获取域名后缀 (TLD) 价格:
get pricing for com -
注册域名: 域名注册是一个两步过程,为了安全起见,需要先确认信息再购买。
-
检查域名信息和价格:
register_domain domain=yourdomain.com years=1 -
确认购买域名: 如果您确认要购买,再次运行相同的命令,并添加 'confirmPurchase=true' 参数:
register_domain domain=yourdomain.com years=1 confirmPurchase=true
可选参数:
- 'nameservers': 自定义域名服务器,多个 Nameserver 用逗号分隔。 例如:'nameservers=ns1.example.com,ns2.example.com'
- 'enableWhoisPrivacy': 是否启用 WhoisGuard 隐私保护,'true' 为启用,'false' 为禁用。 默认为启用。
-
信息
分类
商业系统