Use DomScan with AI agents

Use DomScan with AI agents

Connect DomScan to Claude, ChatGPT, Cursor, VS Code, Codex and Windsurf over MCP, give coding agents the API rules they need, and start from ready-made prompts.

MCP or REST API?

Many teams use both: MCP to explore and prototype in a chat or editor, and the REST API in the code the agent writes. Both use the same API key and credit balance.

Connect to your AI tool

Setup by tool

Every tool connects to the same MCP server at https://domscan.net/mcp. Tools that support sign-in open a DomScan login the first time they run a check. The others send your API key in the X-API-Key header.

{
  "mcpServers": {
    "domscan": {
      "url": "https://domscan.net/mcp"
    }
  }
}

{
  "servers": {
    "domscan": {
      "type": "http",
      "url": "https://domscan.net/mcp"
    }
  }
}

[mcp_servers.domscan]
url = "https://domscan.net/mcp"
env_http_headers = { "X-API-Key" = "DOMSCAN_API_KEY" }

{
  "mcpServers": {
    "domscan": {
      "serverUrl": "https://domscan.net/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

These links and commands never contain your API key. Tools that support sign-in connect to your DomScan account directly. To use a key instead, replace YOUR_API_KEY with a key from your API keys.

Instructions for coding agents

Paste this into AGENTS.md, CLAUDE.md or your editor rules file so coding agents call DomScan correctly.

## DomScan API

Use DomScan (https://domscan.net) for domain availability, DNS, WHOIS and RDAP, SSL, email security and valuation checks.

- Base URL: `https://domscan.net`. Endpoints are under `/v1`.
- Auth: send `X-API-Key: $DOMSCAN_API_KEY` (or `Authorization: Bearer $DOMSCAN_API_KEY`). Read the key from the environment. Never hardcode it, log it or put it in a URL.
- Contract: read the OpenAPI description at https://domscan.net/v1/openapi.json before choosing an endpoint or parameter, and do not guess parameter names. A site summary for LLMs is at https://domscan.net/llms.txt.
- MCP: the remote server is https://domscan.net/mcp (streamable HTTP, sign-in or the same API key headers).
- Credits: most endpoints cost credits. Before bulk or repeated work, call `POST /v1/estimate` with the `method`, `path`, `query` and `body` of the request, or add `dry_run=true` to bulk, compare, recipe and pricing endpoints. Both are free. Track the `X-Credits-Charged` and `X-Credits-Remaining` response headers.
- Bulk: check up to 50 full domain names with one `POST /v1/status/bulk` request instead of looping over single checks.
- Retries: send an `Idempotency-Key` header (for example a UUID) on POST requests that charge credits. Retrying the same request with the same key within 24 hours returns the stored response without charging again. Retry only when `error.retryable` is true, and wait for `Retry-After` on 429.
- Errors: every error body is `{"error": {"type", "code", "message", "status", "retryable", "request_id", ...}}`. Branch on `error.code`, such as `INVALID_PARAMETER`, `INSUFFICIENT_CREDITS` or `RATE_LIMITED`, not on the message.
- Unknown is not absent: results include `classification.status` of `present`, `absent` or `unknown`. Treat `unknown` as "try again later", never as available or missing, and never treat absence as proof that a name can be registered or claimed.
- Freshness: endpoints that can answer from recent data accept `max_age` in seconds (`max_age=0` asks for a fresh check) and return `cache_age_s`. It does not change the cost.
- Smaller responses: add `fields=a,b.c` or `compact=true` to the query string. Neither changes the cost.
- More: https://domscan.net/AGENTS.md and https://domscan.net/docs.

Prompts to try

Copy a prompt or open it in your assistant. Connect DomScan first so the assistant can run the checks.

1. Using DomScan, check whether these 50 names are available as .com domains: [paste names]. First estimate the credit cost and show it to me before running anything. Then list available, taken and unknown results separately, and do not treat unknown results as available.

   Open in ClaudeOpen in ChatGPTOpen in Cursor

2. Use DomScan to audit the email security of example.com: SPF, DKIM, DMARC and blacklist status. Explain each problem in plain language and suggest the DNS record that fixes it.

   Open in ClaudeOpen in ChatGPTOpen in Cursor

3. I am thinking about buying example.com. Use DomScan to check its WHOIS and registration dates, DNS, SSL certificate, reputation and estimated value, then summarize the risks and what I should verify before paying.

   Open in ClaudeOpen in ChatGPTOpen in Cursor

4. Use DomScan to find lookalike and typosquatting domains of example.com that are already registered. Rank them by risk and point out any that have a website or mail server.

   Open in ClaudeOpen in ChatGPTOpen in Cursor

5. Add DomScan to this project. Read https://domscan.net/AGENTS.md and https://domscan.net/v1/openapi.json, then write a small typed client for POST /v1/status/bulk that reads DOMSCAN_API_KEY from the environment, sends an Idempotency-Key header and keeps unknown results separate from available ones. Add tests.

   Open in ClaudeOpen in ChatGPTOpen in Cursor

Machine-readable resources

Point agents at these public files instead of copying documentation into prompts.

• /AGENTS.md Public agent guide
• /llms.txt Site summary for LLMs
• /v1/openapi.json OpenAPI 3.0
• /mcp/tool-mapping.json Old and new MCP tool names