# @whoisjson/mcp-server

MCP (Model Context Protocol) server for the [WhoisJSON API](https://whoisjson.com). Exposes WHOIS, DNS, SSL, and domain availability lookups as tools for AI assistants.

## Tools

| Tool | Description |
|------|-------------|
| `whois_lookup` | WHOIS registration data for a domain (registrar, dates, contacts, nameservers…) |
| `dns_lookup` | All DNS records for a domain (A, AAAA, MX, NS, TXT, CNAME, SOA, CAA, DMARC…) |
| `ssl_check` | SSL/TLS certificate details and validity for a domain |
| `domain_availability` | Check if a domain is available for registration |

## Prerequisites

1. Sign up at [whoisjson.com](https://whoisjson.com) and copy your API key from the dashboard.
2. Node.js ≥ 18.

## Installation

```bash
npm install -g @whoisjson/mcp-server
# or run directly with npx (no install needed):
npx @whoisjson/mcp-server
```

---

## Configuration

### Claude Desktop

Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or  
`%APPDATA%\Claude\claude_desktop_config.json` (Windows):

```json
{
  "mcpServers": {
    "whoisjson": {
      "command": "npx",
      "args": ["-y", "@whoisjson/mcp-server"],
      "env": {
        "WHOISJSON_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

### Cursor

Edit `~/.cursor/mcp.json`:

```json
{
  "mcpServers": {
    "whoisjson": {
      "command": "npx",
      "args": ["-y", "@whoisjson/mcp-server"],
      "env": {
        "WHOISJSON_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

### Windsurf

Edit `~/.codeium/windsurf/mcp_config.json`:

```json
{
  "mcpServers": {
    "whoisjson": {
      "command": "npx",
      "args": ["-y", "@whoisjson/mcp-server"],
      "env": {
        "WHOISJSON_API_KEY": "your_api_key_here"
      }
    }
  }
}
```

---

## Running locally (development)

```bash
cd mcp-server
npm install
npm run build
WHOISJSON_API_KEY=your_key npm start
```

## Publishing

```bash
npm run build
npm publish --access public
```

## API reference

Full API documentation: [whoisjson.com/documentation](https://whoisjson.com/documentation)