Scandomain

中文说明

SCANDOMAIN MCP 让 OpenClaw、Hermes、Cursor 等支持 MCP 的 AI Agent 能够调用 SCANDOMAIN 进行域名、IP、端口、服务、标题、ICP、Server Header 和组件等资产 检索。项目同时提供 MCP 服务和可复制的 Agent Skill： skills/scandomain/SKILL.md。

获取 API Key

请访问 SCANDOMAIN 官网，注册并登录后进入 个人中心获取 API Key。每位用户应使用自己的 Key；不要将 Key 提交到 GitHub、 粘贴到公开对话或共享日志中。

从零开始

本项目无需发布到 npm。它会通过 GitHub 下载并运行，因此请先安装 Node.js 20+ 和 Git。

Windows PowerShell：

winget install OpenJS.NodeJS.LTS --accept-package-agreements --accept-source-agreements
winget install Git.Git --accept-package-agreements --accept-source-agreements
node --version
git --version

macOS：

brew install node git
node --version
git --version

Ubuntu/Debian：

sudo apt update
sudo apt install -y nodejs npm git
node --version
git --version

获取 Key 后，可用以下命令单独启动 MCP 服务进行排查。服务启动后会等待 MCP 客户端连接，这是正常行为；用 Ctrl+C 停止。

Windows PowerShell：

$env:SCANDOMAIN_API_TOKEN = "在 https://scandomain.cyayaa.com/ 个人中心获取的 Key"
npx --yes github:Batman0506/scandomain-mcp

macOS/Linux：

SCANDOMAIN_API_TOKEN="在 https://scandomain.cyayaa.com/ 个人中心获取的 Key" \
  npx --yes github:Batman0506/scandomain-mcp

OpenClaw 安装

在终端执行以下命令。将 YOUR_SCANDOMAIN_API_KEY 替换为你从官网获取的 Key：

openclaw mcp add scandomain \
  --command npx \
  --arg -y \
  --arg github:Batman0506/scandomain-mcp \
  --env SCANDOMAIN_API_TOKEN=YOUR_SCANDOMAIN_API_KEY

openclaw mcp doctor scandomain --probe
openclaw mcp tools scandomain

出现 scandomain_search 即表示连接成功。之后可直接向 OpenClaw 发送：

使用 SCANDOMAIN 查询 domain:"baidu.com"，汇总资产数量、IP、端口和服务。

Hermes 安装

将下面内容合并到 ~/.hermes/config.yaml。不要把实际 Key 提交到任何仓库：

mcp_servers:
  scandomain:
    command: npx
    args: ["-y", "github:Batman0506/scandomain-mcp"]
    env:
      SCANDOMAIN_API_TOKEN: "YOUR_SCANDOMAIN_API_KEY"

然后运行：

hermes chat

在 Hermes 对话中输入 /reload-mcp，或重新启动 Hermes。可用下面的提示词确认：

告诉我当前可用的 MCP 工具；然后使用 SCANDOMAIN 查询 ip:"8.8.8.8"。

通用 MCP 配置

需要 Node.js 20 或更高版本。在 OpenClaw、Hermes 或其他支持本地 stdio MCP 的 客户端中添加以下配置：

{
  "mcpServers": {
    "scandomain": {
      "command": "npx",
      "args": ["-y", "github:Batman0506/scandomain-mcp"],
      "env": {
        "SCANDOMAIN_API_TOKEN": "从 https://scandomain.cyayaa.com/ 获取的 API Key",
        "SCANDOMAIN_API_BASE_URL": "https://api.scandomain.cyayaa.com"
      }
    }
  }
}

如果客户端支持 Skill，将 skills/scandomain/SKILL.md 复制到该客户端的 Skill 目录。配置完成后，Agent 可以调用 scandomain_search，例如查询 domain:"baidu.com" 或 port:443 AND country:CN。

工具参数

scandomain_search 使用 Quake 风格 DSL 查询资产：

参数	必填	说明
query	是	查询语句；裸域名和 IPv4 会自动转换为 DSL。
start	否	页码起始值，默认 1。
start_time	否	UTC 开始时间。
end_time	否	UTC 结束时间。

请仅将 SCANDOMAIN 用于已授权的资产梳理、防御性安全分析与风险修复工作。

English

Use SCANDOMAIN from MCP-compatible AI agents with an API key created in the SCANDOMAIN account center. The package provides a local stdio MCP server and a portable agent skill at skills/scandomain/SKILL.md.

The server calls the public SCANDOMAIN API:

POST https://api.scandomain.cyayaa.com/api/getDomain
Content-Type: application/json
api-token: <SCANDOMAIN_API_TOKEN>

Install

The package requires Node.js 20 or newer. Add this MCP configuration to a client such as OpenClaw, Hermes, Cursor, or another stdio MCP client:

{
  "mcpServers": {
    "scandomain": {
      "command": "npx",
      "args": ["-y", "github:Batman0506/scandomain-mcp"],
      "env": {
        "SCANDOMAIN_API_TOKEN": "your-api-key",
        "SCANDOMAIN_API_BASE_URL": "https://api.scandomain.cyayaa.com"
      }
    }
  }
}

Copy skills/scandomain/SKILL.md into the agent's skill directory when the client supports skills. It tells the agent when to call scandomain_search and how to present authorized asset-search results.

Tool

scandomain_search queries assets using Quake-style DSL.

{
  "query": "domain:\"baidu.com\"",
  "start": 1,
  "start_time": "2026-01-01T00:00:00Z",
  "end_time": "2026-01-31T23:59:59Z"
}

Bare domains and IPs are normalized automatically:

baidu.com                 -> domain:"baidu.com"
8.8.8.8                   -> ip:"8.8.8.8"
port:443 AND country:CN    -> unchanged

start defaults to 1. The public SCANDOMAIN endpoint controls page size.

Environment variables

Name	Required	Default
SCANDOMAIN_API_TOKEN	Yes
SCANDOMAIN_API_BASE_URL	No	https://api.scandomain.cyayaa.com
SCANDOMAIN_TIMEOUT_MS	No	20000

SCANDOMAIN_API_KEY is accepted as a compatibility alias for the token.

Development

npm install
npm run check
npm test

Run the server locally:

SCANDOMAIN_API_TOKEN="your-api-key" npm start

Security

Keep API keys out of prompts, repositories, and shared logs. Use SCANDOMAIN only for authorized asset discovery and defensive security work.

License

MIT