域名管理API客户端

一个用于与RealtimeRegister API交互的Node.js库和MCP服务器,提供域名可用性检查、API连接测试等功能。

  • by zenjoy
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 zenjoy/realtime-register-mcp

使用说明

实时注册MCP服务器和客户端

Node.js库和模型上下文协议(MCP)服务器,用于与RealtimeRegister API交互以进行域管理操作。

概述

该软件包为RealtimeRegister API提供了一个强大的客户端和一个符合MCP的服务器,使应用程序和人工智能助手能够:

  • 检查域名可用性。
  • 测试API连接。
  • 执行其他与域相关的操作(未来)。

它具有一个缓存层,用于性能、类型化响应和全面的错误处理。

特性

  • RealtimeRegister API客户端:用于核心API函数的强类型客户端。
  • 缓存层:内置LRU缓存 checkDomainAvailability 以及其他请求,以减少API调用并改进响应时间。
  • MCP服务器:通过模型上下文协议公开功能,以便与MCP兼容系统集成。
  • 环境配置:使用环境变量轻松设置。
  • 错误处理:API和网络问题的自定义错误类型。
  • TypeScript支持:使用TypeScript编写,并带有声明文件,以获得更好的开发体验。

先决条件

  • Node.js 18.0.0或更高版本/或Docker
  • RealtimeRegister API密钥(用于大多数功能)

安装

使用Claude Desktop

将此添加到您的 claude_desktop_config.json:

新巴拿马型船舶

{
  "mcpServers": {
    "realtime-register": {
      "command": "npx",
      "args": ["-y", "realtime-register-mcp"],
      "env": {
        "REALTIME_REGISTER_API_KEY": "your-api-key-here"
      }
    }
  }
}

可用工具

这 realtime-register-mcp 提供以下工具:

  • check_domain_availability (参数: domain: string)
  • check_bulk_domains (参数: domains: string[])
  • test_api_connection (参数: random_string: string (虚拟参数)

环境变量

使用环境变量配置服务器和客户端:

  • REALTIME_REGISTER_API_KEY (必需):您的RealtimeRegister API密钥。
  • REALTIME_REGISTER_BASE_URL (可选):API基本URL(默认值: https://api.yoursrs.com).
  • REALTIME_REGISTER_TIMEOUT (可选):请求超时(毫秒)(默认值: 30000).
  • REALTIME_REGISTER_DEBUG (可选):设置为 true 启用详细的调试日志记录(默认值: false).
  • LOG_LEVEL (可选):设置日志记录级别(例如。, error, warn, info, debug).默认值为 info.

贡献

欢迎投稿!请随时在GitHub上打开问题或提交拉取请求。

请确保您的贡献符合现有的代码风格,并且所有测试都通过。

许可证

该项目根据MIT许可证获得许可。请参阅 许可证 文件以获取详细信息。