> For the complete documentation index see https://domscan.net/llms.txt. Markdown versions of every docs page are available by appending .md to the page URL.

Source: https://domscan.net/zh/docs/ai-agents

# 在 AI 智能体中使用 DomScan

通过 MCP 将 DomScan 连接到 Claude、ChatGPT、Cursor、VS Code、Codex 和 Windsurf,为编码智能体提供所需的 API 规则,并从现成的提示词开始。

### MCP 还是 REST API?

#### 由助手决策时使用 MCP

当助手在对话中自行选择要运行哪些检查时,请连接 MCP 服务器。它会自动发现 DomScan 工具,使用你的账户或 API 密钥登录,并获得结构化结果,其分类、积分费用和错误代码与 API 完全一致。

#### 由代码决策时使用 REST

在没有助手参与的代码中调用 REST API,例如定时任务、批量流水线、后端服务和 CI 检查。当编码智能体编写要随产品发布的代码时,请让它根据 OpenAPI 描述调用 REST API。

许多团队两者并用:在聊天或编辑器中使用 MCP 进行探索和原型设计,在智能体编写的代码中使用 REST API。两者使用同一个 API 密钥和积分余额。

### 连接到你的 AI 工具

一键安装 DomScan MCP 服务器,或在终端中运行一条命令。工具首次运行检查时,会要求你登录 DomScan。

[添加到 Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=domscan&config=eyJ1cmwiOiJodHRwczovL2RvbXNjYW4ubmV0L21jcCJ9)[添加到 VS Code](vscode:mcp/install?%7B%22name%22%3A%22domscan%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fdomscan.net%2Fmcp%22%7D)[添加到 VS Code Insiders](vscode-insiders:mcp/install?%7B%22name%22%3A%22domscan%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fdomscan.net%2Fmcp%22%7D)

Claude Code

Claude Code(使用 API 密钥)

Codex

Codex 登录

`codex mcp login domscan`

### 按工具设置

所有工具都连接到位于 `https://domscan.net/mcp` 的同一个 MCP 服务器。支持登录的工具会在首次运行检查时打开 DomScan 登录页面。其他工具通过 X-API-Key 请求头发送你的 API 密钥。

#### Claude Code

在终端中运行以下命令。Claude Code 会在首次使用 DomScan 时要求你登录。添加 `--scope user` 可让 DomScan 在所有项目中可用。

Claude Code

`claude mcp add --transport http domscan https://domscan.net/mcp`

Claude Code(使用 API 密钥)

`claude mcp add --transport http domscan https://domscan.net/mcp --header "X-API-Key: YOUR_API_KEY"`

#### Cursor

使用上方的 Add to Cursor 按钮,或将以下条目添加到 `~/.cursor/mcp.json`(适用于所有项目)或 `.cursor/mcp.json`(仅适用于单个项目)。

mcp.json

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

#### VS Code

使用上方的 Add to VS Code 按钮,或将以下条目添加到工作区的 `.vscode/mcp.json`。服务器启动时,VS Code 会要求你登录。

.vscode/mcp.json

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

#### Codex

先添加服务器,然后登录。如需改用 API 密钥,请将以下配置块添加到 `~/.codex/config.toml`,并在环境中设置 `DOMSCAN_API_KEY`。

Codex

`codex mcp add domscan --url https://domscan.net/mcp`

Codex 登录

`codex mcp login domscan`

~/.codex/config.toml

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

#### ChatGPT

在 ChatGPT 的设置、连接器、高级中开启开发者模式。然后使用此 URL 创建连接器并选择 OAuth。详细步骤见[MCP 设置页面](https://domscan.net/zh/mcp-domain-checker)。

MCP 服务器 URL

`https://domscan.net/mcp`

#### Claude

在网页版 Claude 或 Claude Desktop 中,依次打开设置、连接器,使用此 URL 添加名为 DomScan 的自定义连接器。Claude 会打开 DomScan 登录页面以完成连接。

MCP 服务器 URL

`https://domscan.net/mcp`

#### Windsurf

打开 Windsurf 中的 MCP 设置,查看原始配置,并将以下条目添加到 `mcp_config.json`。将 YOUR_API_KEY 替换为你的密钥。

mcp_config.json

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

这些链接和命令不包含你的 API 密钥。支持登录的工具会直接连接到你的 DomScan 账户。如需改用密钥,请将 `YOUR_API_KEY` 替换为来自[你的 API 密钥](https://domscan.net/zh/api-keys)的密钥。

### 面向编码智能体的说明

将此内容粘贴到 AGENTS.md、CLAUDE.md 或编辑器规则文件中,让编码智能体正确调用 DomScan。

AGENTS.md

```text
## DomScan API

域名可注册性、DNS、WHOIS 与 RDAP、SSL、邮件安全和估值检查,请使用 DomScan (https://domscan.net)。

- 基础 URL:`https://domscan.net`。端点位于 `/v1` 下。
- 认证:发送 `X-API-Key: $DOMSCAN_API_KEY`(或 `Authorization: Bearer $DOMSCAN_API_KEY`)。从环境变量中读取密钥。切勿硬编码、记录到日志或放入 URL。
- 契约:选择端点或参数之前,请先阅读 https://domscan.net/v1/openapi.json 上的 OpenAPI 描述,不要猜测参数名。面向 LLM 的站点摘要见 https://domscan.net/llms.txt 。
- MCP:远程服务器为 https://domscan.net/mcp (可流式 HTTP,支持登录或相同的 API 密钥请求头)。
- 积分:大多数端点会消耗积分。在批量或重复操作之前,请使用请求的 `method`、`path`、`query` 和 `body` 调用 `POST /v1/estimate`,或在 bulk、compare、recipe 和 pricing 端点上添加 `dry_run=true`。两者均免费。请跟踪响应头 `X-Credits-Charged` 和 `X-Credits-Remaining`。
- 批量:使用一次 `POST /v1/status/bulk` 请求最多检查 50 个完整域名,而不是循环调用单个检查。
- 重试:对会消耗积分的 POST 请求,发送 `Idempotency-Key` 请求头(例如 UUID)。在 24 小时内使用相同密钥重试相同请求,会返回已存储的响应且不会再次扣费。仅在 `error.retryable` 为 true 时重试,遇到 429 时请等待 `Retry-After`。
- 错误:每个错误响应体的格式为 `{"error": {"type", "code", "message", "status", "retryable", "request_id", ...}}`。请根据 `error.code` 判断,例如 `INVALID_PARAMETER`、`INSUFFICIENT_CREDITS` 或 `RATE_LIMITED`,不要根据 message 判断。
- 未知不等于不存在:结果包含 `classification.status`,取值为 `present`、`absent` 或 `unknown`。请将 `unknown` 视为“稍后重试”,绝不当作可注册或不存在,也绝不要把不存在当作该名称可以被注册或占用的证据。
- 新鲜度:可以使用近期数据作答的端点接受以秒为单位的 `max_age`(`max_age=0` 表示要求重新检查),并返回 `cache_age_s`。它不会改变费用。
- 更小的响应:在查询字符串中添加 `fields=a,b.c` 或 `compact=true`。两者都不会改变费用。
- 更多:https://domscan.net/AGENTS.md 和 https://domscan.net/docs 。
```

### 试试这些提示词

复制提示词,或在你的助手中打开。请先连接 DomScan,助手才能运行检查。

1.

使用 DomScan 检查这 50 个名称是否可注册为 .com 域名:[粘贴名称]。运行任何检查之前,请先估算积分费用并告诉我。然后分别列出可注册、已被注册和未知的结果,不要把未知结果当作可注册。

2.

使用 DomScan 审计 example.com 的邮件安全:SPF、DKIM、DMARC 和黑名单状态。用通俗的语言解释每个问题,并建议可修复问题的 DNS 记录。

3.

我正在考虑购买 example.com。请使用 DomScan 检查它的 WHOIS 和注册日期、DNS、SSL 证书、信誉和估值,然后总结风险,以及付款前我应该核实的事项。

4.

使用 DomScan 查找 example.com 已被注册的相似域名和抢注域名(typosquatting)。按风险排序,并指出哪些拥有网站或邮件服务器。

5.

把 DomScan 添加到这个项目中。阅读 https://domscan.net/AGENTS.md 和 https://domscan.net/v1/openapi.json ,然后为 POST /v1/status/bulk 编写一个带类型的小型客户端:从环境变量读取 DOMSCAN_API_KEY,发送 Idempotency-Key 请求头,并将未知结果与可注册结果分开处理。并添加测试。

### 机器可读资源

请让智能体直接读取这些公开文件,而不是把文档复制到提示词中。

- [`/AGENTS.md`](https://domscan.net/AGENTS.md) 公开智能体指南
- [`/llms.txt`](https://domscan.net/llms.txt) 面向 LLM 的站点摘要
- [`/v1/openapi.json`](https://domscan.net/v1/openapi.json) OpenAPI 3.0
- [`/mcp/tool-mapping.json`](https://domscan.net/mcp/tool-mapping.json) 新旧 MCP 工具名称对照