> 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/pt/docs/ai-agents # Use o DomScan com agentes de IA Explore a documentação da API de Use o DomScan com agentes de IA, os parâmetros de solicitação, os campos de resposta, os exemplos de código e o tratamento de erros para integrações com o DomScan. Conecte o DomScan ao Claude, ChatGPT, Cursor, VS Code, Codex e Windsurf via MCP, dê aos agentes de programação as regras da API de que eles precisam e comece com prompts prontos para usar. ### MCP ou API REST? #### Use MCP quando o assistente decide Conecte o servidor MCP quando um assistente escolhe quais verificações executar durante uma conversa. Ele encontra sozinho as ferramentas do DomScan, entra com sua conta ou com uma chave de API e recebe resultados estruturados com a mesma classificação, os mesmos custos em créditos e os mesmos códigos de erro da API. #### Use REST quando o seu código decide Chame a API REST a partir de código que roda sem um assistente: tarefas agendadas, pipelines em lote, backends e verificações de CI. Quando um agente de programação escreve código que vai para o seu produto, peça que ele chame a API REST a partir da descrição OpenAPI. Muitas equipes usam os dois: MCP para explorar e prototipar em um chat ou editor, e a API REST no código que o agente escreve. Ambos usam a mesma chave de API e o mesmo saldo de créditos. ### Conecte sua ferramenta de IA Instale o servidor MCP do DomScan com um clique ou execute um único comando no terminal. Sua ferramenta pede que você entre no DomScan na primeira vez que executar uma verificação. [Adicionar ao Cursor](cursor://anysphere.cursor-deeplink/mcp/install?name=domscan&config=eyJ1cmwiOiJodHRwczovL2RvbXNjYW4ubmV0L21jcCJ9)[Adicionar ao 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)[Adicionar ao 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 com chave de API Codex Login no Codex `codex mcp login domscan` ### Configuração por ferramenta Todas as ferramentas se conectam ao mesmo servidor MCP em `https://domscan.net/mcp`. As que oferecem suporte a login abrem uma tela de login do DomScan na primeira vez que executam uma verificação. As demais enviam sua chave de API no cabeçalho X-API-Key. #### Claude Code Execute isto no terminal. O Claude Code pede que você entre na primeira vez que usar o DomScan. Adicione `--scope user` para disponibilizar o DomScan em todos os projetos. Claude Code `claude mcp add --transport http domscan https://domscan.net/mcp` Claude Code com chave de API `claude mcp add --transport http domscan https://domscan.net/mcp --header "X-API-Key: YOUR_API_KEY"` #### Cursor Use o botão Adicionar ao Cursor acima, ou adicione esta entrada a `~/.cursor/mcp.json` para todos os projetos ou a `.cursor/mcp.json` para um único projeto. mcp.json ```json { "mcpServers": { "domscan": { "url": "https://domscan.net/mcp" } } } ``` #### VS Code Use o botão Adicionar ao VS Code acima, ou adicione esta entrada a `.vscode/mcp.json` no seu workspace. O VS Code pede que você entre quando o servidor inicia. .vscode/mcp.json ```json { "servers": { "domscan": { "type": "http", "url": "https://domscan.net/mcp" } } } ``` #### Codex Adicione o servidor e depois faça login. Para usar uma chave de API em vez disso, adicione este bloco a `~/.codex/config.toml` e defina `DOMSCAN_API_KEY` no seu ambiente. Codex `codex mcp add domscan --url https://domscan.net/mcp` Login no 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 Ative o modo desenvolvedor no ChatGPT em Configurações, Conectores, Avançado. Depois crie um conector com esta URL e escolha OAuth. As instruções passo a passo estão na [página de configuração do MCP](https://domscan.net/pt/mcp-domain-checker). URL do servidor MCP `https://domscan.net/mcp` #### Claude No Claude na web ou no Claude Desktop, abra Configurações, depois Conectores, e adicione um conector personalizado chamado DomScan com esta URL. O Claude abre um login do DomScan para concluir. URL do servidor MCP `https://domscan.net/mcp` #### Windsurf Abra as configurações de MCP no Windsurf, veja a configuração bruta e adicione esta entrada a `mcp_config.json`. Substitua YOUR_API_KEY pela sua chave. mcp_config.json ```json { "mcpServers": { "domscan": { "serverUrl": "https://domscan.net/mcp", "headers": { "X-API-Key": "YOUR_API_KEY" } } } } ``` Estes links e comandos nunca contêm sua chave de API. As ferramentas que oferecem suporte a login se conectam diretamente à sua conta do DomScan. Para usar uma chave, substitua `YOUR_API_KEY` por uma chave de [suas chaves de API](https://domscan.net/pt/api-keys). ### Instruções para agentes de programação Cole isto em AGENTS.md, CLAUDE.md ou no arquivo de regras do seu editor para que os agentes de programação chamem o DomScan corretamente. AGENTS.md ```text ## DomScan API Use o DomScan (https://domscan.net) para verificar disponibilidade de domínios, DNS, WHOIS e RDAP, SSL, segurança de e-mail e avaliação. - URL base: `https://domscan.net`. Os endpoints ficam em `/v1`. - Autenticação: envie `X-API-Key: $DOMSCAN_API_KEY` (ou `Authorization: Bearer $DOMSCAN_API_KEY`). Leia a chave do ambiente. Nunca a deixe fixa no código, nem a registre em logs ou a coloque em uma URL. - Contrato: leia a descrição OpenAPI em https://domscan.net/v1/openapi.json antes de escolher um endpoint ou parâmetro, e não adivinhe nomes de parâmetros. Há um resumo do site para LLMs em https://domscan.net/llms.txt. - MCP: o servidor remoto é https://domscan.net/mcp (HTTP streamable, login ou os mesmos cabeçalhos de chave de API). - Créditos: a maioria dos endpoints consome créditos. Antes de trabalhos em lote ou repetidos, chame `POST /v1/estimate` com o `method`, o `path`, o `query` e o `body` da requisição, ou adicione `dry_run=true` aos endpoints de bulk, compare, recipe e preços. Os dois são gratuitos. Acompanhe os cabeçalhos de resposta `X-Credits-Charged` e `X-Credits-Remaining`. - Bulk: verifique até 50 nomes de domínio completos com uma única requisição `POST /v1/status/bulk` em vez de repetir verificações individuais em um loop. - Novas tentativas: envie um cabeçalho `Idempotency-Key` (por exemplo, um UUID) nas requisições POST que cobram créditos. Repetir a mesma requisição com a mesma chave em até 24 horas retorna a resposta armazenada sem cobrar novamente. Tente de novo apenas quando `error.retryable` for true e aguarde o `Retry-After` em um 429. - Erros: todo corpo de erro tem o formato `{"error": {"type", "code", "message", "status", "retryable", "request_id", ...}}`. Ramifique a lógica por `error.code`, como `INVALID_PARAMETER`, `INSUFFICIENT_CREDITS` ou `RATE_LIMITED`, e não pela mensagem. - Desconhecido não é ausente: os resultados incluem `classification.status` com o valor `present`, `absent` ou `unknown`. Trate `unknown` como "tente novamente mais tarde", nunca como disponível nem como inexistente, e nunca trate a ausência como prova de que um nome pode ser registrado ou reivindicado. - Atualidade: os endpoints que podem responder com dados recentes aceitam `max_age` em segundos (`max_age=0` pede uma verificação nova) e retornam `cache_age_s`. Isso não altera o custo. - Respostas menores: adicione `fields=a,b.c` ou `compact=true` à query string. Nenhum dos dois altera o custo. - Mais informações: https://domscan.net/AGENTS.md e https://domscan.net/docs. ``` ### Prompts para testar Copie um prompt ou abra-o no seu assistente. Conecte o DomScan primeiro para que o assistente possa executar as verificações. 1. Usando o DomScan, verifique se estes 50 nomes estão disponíveis como domínios .com: [cole os nomes]. Primeiro estime o custo em créditos e mostre para mim antes de executar qualquer coisa. Depois liste separadamente os resultados disponíveis, ocupados e desconhecidos, e não trate os resultados desconhecidos como disponíveis. 2. Use o DomScan para auditar a segurança de e-mail de example.com: SPF, DKIM, DMARC e status em listas de bloqueio. Explique cada problema em linguagem simples e sugira o registro DNS que o corrige. 3. Estou pensando em comprar example.com. Use o DomScan para verificar o WHOIS e as datas de registro, o DNS, o certificado SSL, a reputação e o valor estimado, e depois resuma os riscos e o que devo verificar antes de pagar. 4. Use o DomScan para encontrar domínios parecidos e de typosquatting de example.com que já estejam registrados. Classifique-os por risco e aponte os que têm site ou servidor de e-mail. 5. Adicione o DomScan a este projeto. Leia https://domscan.net/AGENTS.md e https://domscan.net/v1/openapi.json, e depois escreva um pequeno cliente tipado para POST /v1/status/bulk que leia DOMSCAN_API_KEY do ambiente, envie um cabeçalho Idempotency-Key e mantenha os resultados desconhecidos separados dos disponíveis. Adicione testes. ### Recursos legíveis por máquina Aponte os agentes para estes arquivos públicos em vez de copiar a documentação para os prompts. - [`/AGENTS.md`](https://domscan.net/AGENTS.md) Guia público para agentes - [`/llms.txt`](https://domscan.net/llms.txt) Resumo do site para LLMs - [`/v1/openapi.json`](https://domscan.net/v1/openapi.json) OpenAPI 3.0 - [`/mcp/tool-mapping.json`](https://domscan.net/mcp/tool-mapping.json) Nomes antigos e novos das ferramentas MCP