AgentReady MCP

Torne qualquer site consultável por agentes de IA — indexe um site e faça perguntas com respostas citadas via RAG

Documentação

@agentreadyweb/mcp

O que é AgentReady?

AgentReady é uma camada de capacidade hospedada que torna qualquer site descobrível e utilizável por agentes por meio do MCP.

Cole uma URL → o AgentReady rastreia o site, gera um llms.txt compatível com a especificação e hospeda um endpoint RAG /ask ao vivo e um servidor MCP. Qualquer cliente de agente compatível com MCP pode então descobrir o site, fazer perguntas em linguagem natural, inspecionar capacidades e criar planos somente leitura fundamentados com citações.

O problema que resolve: agentes de IA usando web_fetch buscam uma página por vez, obtêm HTML vazio de SPAs JavaScript (React, Next.js, Vue) e alucinam quando a resposta abrange várias páginas. O AgentReady indexa o site inteiro, lida com renderização JS e recupera informações entre páginas — para que os agentes obtenham a resposta certa em vez de uma errada e confiante.

O que já está indexado: Navegue pelo diretório AgentReady → ao vivo ou indexe qualquer site público você mesmo.

Principais propriedades:

Funciona em qualquer URL pública — sites estáticos, SPAs React/Next.js, Docusaurus, GitBook, mecanismos personalizados
Nenhuma conta necessária para indexar seu primeiro site
Índice compartilhado — um membro da equipe envia um site, todos na equipe podem consultá-lo instantaneamente
Lida com páginas renderizadas por JS que web_fetch retorna vazio
Manifestos de capacidade expõem frescor, esquemas, endpoints e limites somente leitura
Planos fundamentados retornam evidências, riscos, requisitos de confirmação e recibos duráveis

CLI

O mesmo pacote funciona também como CLI — sem instalação, sem conta:

# Agent-readiness report card (llms.txt, sitemap, robots, JS-rendering, index status)
npx @agentreadyweb/mcp grade yourdocs.com

# Ask any site a question, get a cited answer (auto-indexes new sites in ~60s)
npx @agentreadyweb/mcp ask stripe.com "what is the test card number?"

# Index or re-crawl a site
npx @agentreadyweb/mcp index yourdocs.com
npx @agentreadyweb/mcp refresh yourdocs.com

Para CI, dashboards ou scripts, adicione --json para receber o relatório bruto na saída padrão (o progresso permanece na saída de erro):

npx @agentreadyweb/mcp grade yourdocs.com --json | jq '.grade, .score'

O comando ainda sai com 1 quando a nota está abaixo de B.

grade sai com código não zero abaixo de B, então você pode usá-lo como um portão de CI. refresh no seu pipeline de implantação de docs mantém o índice atualizado automaticamente:

# GitHub Actions — after your docs deploy step
- run: npx @agentreadyweb/mcp refresh yourdocs.com

Conecte qualquer cliente compatível com MCP ao AgentReady:

Ponte MCP local (stdio)

Para clientes que usam uma configuração mcpServers, adicione a ponte AgentReady:

{
  "mcpServers": {
    "agentready": {
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

Reinicie seu cliente. Você terá oito ferramentas disponíveis:

list_sites — veja todos os sites indexados
get_site_capabilities — indexe sob demanda e depois inspecione o manifesto do site, frescor, esquemas e endpoints
get_site_facts — fatos estruturados principais extraídos de um site
ask_site — consulte qualquer site com respostas citadas e de várias páginas
plan_site_action — indexe sob demanda e depois crie um plano fundamentado, somente leitura e recibo
submit_site — indexe qualquer site para que possa ser consultado
refresh_site — re-rastreie um site ou realize sua indexação inicial quando for novo
rate_answer — envie feedback de qualidade

Cursor

Adicione a ~/.cursor/mcp.json:

{
  "agentready": {
    "command": "npx",
    "args": ["-y", "@agentreadyweb/mcp"]
  }
}

Configuração de projeto ou terminal

npx @agentreadyweb/mcp

Ou adicione o mesmo servidor agentready à configuração do projeto do seu cliente para compartilhá-lo com sua equipe:

{
  "mcpServers": {
    "agentready": {
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

VS Code (modo agente do GitHub Copilot)

Requer VS Code 1.99+ com a extensão GitHub Copilot. Crie .vscode/mcp.json na raiz do seu projeto:

{
  "servers": {
    "agentready": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@agentreadyweb/mcp"]
    }
  }
}

As ferramentas MCP do Copilot estão disponíveis apenas no modo agente. Faça commit deste arquivo para compartilhar com sua equipe.

Windsurf / Zed / outros clientes

Qualquer cliente MCP que suporte transporte stdio funciona da mesma forma — use npx -y @agentreadyweb/mcp como comando.

WebMCP (sem instalação)

Se o seu cliente suporta transporte HTTP, conecte-se diretamente por URL — sem necessidade de npm:

https://www.agentready.it.com/api/mcp

Plugin Docusaurus

Se o seu site de documentação usa Docusaurus, indexe automaticamente a cada build:

npm install @agentreadyweb/docusaurus-plugin

// docusaurus.config.js
plugins: [
  ['@agentreadyweb/docusaurus-plugin', { domain: 'docs.yoursite.com' }]
]

Plugin MkDocs

Se o seu site de documentação usa MkDocs, indexe automaticamente a cada build:

pip install mkdocs-agentready

# mkdocs.yml
plugins:
  - search
  - agentready

Se site_url não estiver definido, especifique o domínio explicitamente:

plugins:
  - agentready:
      domain: docs.yoursite.com

Plugin Starlight

Se o seu site de documentação usa Starlight (Astro), indexe automaticamente a cada build:

npm install starlight-agentready

// astro.config.mjs
import agentready from 'starlight-agentready'

export default defineConfig({
  site: 'https://docs.yoursite.com',
  integrations: [
    starlight({
      plugins: [agentready()],
    }),
  ],
})

Extensão Sphinx

Se o seu site de documentação usa Sphinx, indexe automaticamente a cada build:

pip install sphinx-agentready

# conf.py
extensions = [
    "sphinx_agentready.extension",
]

# Domain is inferred from html_baseurl automatically, or set explicitly:
agentready_domain = "docs.yoursite.com"

Ferramentas disponíveis

list_sites

Lista todos os sites atualmente indexados pelo AgentReady com seus títulos e contagens de páginas. Use isso para verificar se um domínio já está disponível antes de enviá-lo.

get_site_capabilities

get_site_capabilities(domain: string)

Retorna o manifesto de capacidade do site, estado de frescor, esquemas e endpoints HTTP/MCP disponíveis.

get_site_facts

get_site_facts(domain: string)

Retorna fatos estruturados principais extraídos de um site — níveis de preço, listas de recursos, limites e outros pontos de dados de alto sinal que os agentes frequentemente precisam.

plan_site_action

plan_site_action(domain: string, request: string)

Cria um plano fundamentado, somente leitura, com evidências, riscos, requisitos de confirmação e um recibo durável. Não executa efeitos colaterais.

submit_site

submit_site(url: string)

Indexe qualquer site com AgentReady. Leva ~60 segundos. Lida com sites estáticos, páginas renderizadas no servidor e SPAs com muito JavaScript por meio de um pipeline de quatro camadas. Depois de concluído, consulte-o com ask_site.

Exemplo: submit_site("https://docs.example.com")

ask_site

ask_site(domain: string, query: string, url?: string)

Faça uma pergunta sobre qualquer site e obtenha uma resposta citada fundamentada no conteúdo. Sintetiza informações de várias páginas. Se o site ainda não estiver indexado, o AgentReady o rastreia e indexa automaticamente antes de responder (~60s).

Exemplo: ask_site("stripe.com", "What are the fees for card payments?")

refresh_site

refresh_site(domain: string)

Force um re-rastreamento completo de um site para capturar conteúdo novo ou alterado. Se o site for novo, o AgentReady realiza sua indexação inicial automaticamente. Leva ~60 segundos.

Exemplo: refresh_site("docs.example.com")

rate_answer

rate_answer(domain: string, rating: number, request_id?: string, comment?: string)

Envia feedback de qualidade de 1 a 5, opcionalmente vinculado à solicitação exata de ask_site.

Webhook de implantação

Re-indexe automaticamente sua documentação a cada implantação. Sem autenticação necessária — limitado a uma vez por hora por domínio.

curl -X POST https://www.agentready.it.com/api/webhook/refresh \
  -H "Content-Type: application/json" \
  -d '{"domain": "docs.yoursite.com"}'

Ou passe o domínio como parâmetro de consulta (funciona com payloads de webhook codificados em formulário do Vercel/Netlify):

https://www.agentready.it.com/api/webhook/refresh?domain=docs.yoursite.com

Como a indexação funciona

O AgentReady usa uma abordagem em camadas para lidar com qualquer site público:

llms.txt / llms-full.txt — se o site publicar um, ele é usado como fonte de conteúdo estruturado de alta qualidade
Rastreamento HTML padrão — busca até 10 páginas via sitemap ou rastreamento de links, extrai texto limpo
Extração __NEXT_DATA__ — para aplicativos Next.js, analisa dados renderizados no servidor embutidos no HTML
Fallback Jina Reader — para SPAs somente JS que retornam HTML vazio, usa um serviço de renderização remota para extrair conteúdo

Sites atrás de autenticação ou sem conteúdo HTML público não podem ser indexados.

Variáveis de ambiente

Variável	Padrão	Descrição
`AGENTREADY_MCP_URL`	`https://www.agentready.it.com/api/mcp`	Substitui o endpoint MCP (para auto-hospedado)
`AGENTREADY_TELEMETRY`	`1`	Defina como `0` para desativar a telemetria de uso anônimo

Telemetria

Este pacote envia um ping anônimo leve para agentready.it.com/api/telemetry cada vez que a ponte MCP inicia ou um comando CLI é executado. Ele contém: um ID de instalação aleatório (armazenado em ~/.agentready/install-id), versão do pacote, versão do Node, plataforma e qual modo/comando foi usado. Nenhum conteúdo de consulta, nenhum nome de domínio, nenhum dado pessoal. Defina AGENTREADY_TELEMETRY=0 para optar por não participar.