RealtimeRegister MCP Server & Client

by zenjoy

299 downloads
Not rated
GitHub

About

An MCP server for interacting with the RealtimeRegister API

Details

Author
zenjoy
Downloads
299
Categories
Other

- Strongly-typed API client with caching (LRU)
- MCP server exposing domain availability and connectivity checks
- Environment-based configuration (API key, base URL, timeout, debug)
- Custom error handling and TypeScript support
- Works with Node.js 18+ or Docker

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name RealtimeRegister MCP Server & Client
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install via npm or use directly with npx. Configure the REALTIME_REGISTER_API_KEY environment variable and add the server to claude_desktop_config.json. Invoke tools like check_domain_availability, check_bulk_domains, and test_api_connection from any MCP host.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

RealtimeRegister MCP Server & Client

npm version
License: MIT

A Node.js library and Model Context Protocol (MCP) server for interacting with the RealtimeRegister API for domain management operations.

Overview

This package provides a robust client for the RealtimeRegister API and an MCP-compliant server, enabling applications and AI assistants to:

- Check domain name availability.
- Test API connectivity.
- Perform other domain-related operations (future).

It features a caching layer for performance, typed responses, and comprehensive error handling.

Features

- RealtimeRegister API Client: Strongly-typed client for core API functions.
- Caching Layer: Built-in LRU caching for checkDomainAvailability and other requests to reduce API calls and improve response times.
- MCP Server: Exposes functionality via the Model Context Protocol for integration with MCP-compatible systems.
- Environment Configuration: Easy setup using environment variables.
- Error Handling: Custom error types for API and network issues.
- TypeScript Support: Written in TypeScript with declaration files for a better development experience.

Prerequisites

- Node.js 18.0.0 or higher / or Docker
- RealtimeRegister API key (for most functionality)

Installation

Usage with Claude Desktop

Add this to your claude_desktop_config.json:

npx

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

Available Tools

The realtime-register-mcp provides the following tools:

- check_domain_availability (params: domain: string)
- check_bulk_domains (params: domains: string[])
- test_api_connection (params: random_string: string (dummy parameter))

Environment Variables

The server and client are configured using environment variables:

- REALTIME_REGISTER_API_KEY (Required): Your RealtimeRegister API key.
- REALTIME_REGISTER_BASE_URL (Optional): API base URL (default: https://api.yoursrs.com).
- REALTIME_REGISTER_TIMEOUT (Optional): Request timeout in milliseconds (default: 30000).
- REALTIME_REGISTER_DEBUG (Optional): Set to true to enable detailed debug logging (default: false).
- LOG_LEVEL (Optional): Set the logging level (e.g., error, warn, info, debug). Default is info.

Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request on GitHub.

- Issue Tracker
- Source Code

Please ensure your contributions adhere to the existing code style and that all tests pass.

License

This project is licensed under the MIT License. See the LICENSE file for details.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.