Jamdesk Documentation logo

llms.txt

Todo site Jamdesk gera llms.txt e llms-full.txt automaticamente. Ferramentas de IA usam esses arquivos para entender sua documentação.

Ferramentas de IA como ChatGPT, Claude ou Copilot só dão respostas precisas sobre seu produto com acesso estruturado à sua documentação. Os dados de treinamento deles não bastam.

Todo site Jamdesk gera llms.txt e llms-full.txt seguindo a especificação do llmstxt.org. Ferramentas de IA leem esses arquivos em vez de rastrear páginas individualmente.

O Google agora audita o llms.txt como parte das verificações de navegação agêntica do Lighthouse. Sites que publicam um llms.txt válido são mais fáceis de descobrir por agentes de IA. O Google também o usa cada vez mais ao ranquear conteúdo para respostas com IA. A Jamdesk publica o arquivo gratuitamente.

Verifique sua pontuação. A ferramenta gratuita AI Score avalia o quão preparado para agentes está qualquer site de documentação. Um llms.txt válido é uma das primeiras coisas que ela verifica. A extensão AI Score para Chrome avalia sites enquanto você navega.

O que a Jamdesk gera

ArquivoConteúdo
llms.txtTítulos, descrições e URLs das páginas (um sumário estruturado)
llms-full.txtConteúdo completo da documentação em um único arquivo

A Jamdesk gera os arquivos no momento do build. Eles são servidos pela mesma CDN da sua documentação.

Verifique seus arquivos

Confirme que os arquivos existem após o primeiro build:

Se sua documentação estiver na raiz do domínio (por exemplo, docs.acme.com ou acme.jamdesk.app):

curl https://docs.acme.com/llms.txt
curl https://docs.acme.com/llms-full.txt

Formato do arquivo

O llms.txt lista cada página com título, descrição e URL, agrupadas em seções que espelham sua navegação:

# Your Project Documentation

> Documentation for Your Project

## Get Started

- [Getting Started](https://your-project.jamdesk.app/getting-started): Set up your first project in 5 minutes
- [Configuration](https://your-project.jamdesk.app/configuration): Configure your project settings

## API Reference

- [Authentication](https://your-project.jamdesk.app/authentication): How to authenticate API requests

O llms-full.txt contém o conteúdo Markdown completo de cada página, concatenado com limites de página marcados por títulos.

Estrutura

O llms.txt segue a proposta do llmstxt.org: um título H1, um resumo em blockquote e suas abas e grupos de navegação como seções ## de links Markdown.

Sites multilíngues

Sites com mais de um idioma recebem um conjunto separado de arquivos por idioma. Uma ferramenta de IA pode buscar apenas o idioma de que precisa. Para um site em inglês (padrão) e francês:

URLConteúdo
/llms.txtÍndice em inglês, com links para o índice de cada outro idioma no final
/en/llms.txtMesmo arquivo de /llms.txt
/fr/llms.txtÍndice em francês, com links de volta para os outros idiomas
/llms-full.txtConteúdo completo de todos os idiomas, um após o outro
/en/llms-full.txtConteúdo completo apenas das páginas em inglês
/fr/llms-full.txtConteúdo completo apenas das páginas em francês

O llms-full.txt raiz mantém todos os idiomas. Ferramentas que já o leem não notam mudança. Aponte um agente para o arquivo próprio de um idioma quando ele precisar apenas desse idioma:

curl https://jamdesk.com/docs/fr/llms-full.txt

Um idioma recebe arquivos próprios assim que tiver pelo menos uma página. Sites de idioma único mantêm apenas os arquivos raiz.

Sites protegidos por login

Em um site atrás de proteção por senha ou autenticação JWT, llms.txt e llms-full.txt redirecionam visitantes para a página de login, e URLs .md retornam 401. Uma chave de API do projeto abre os três para ferramentas que não conseguem fazer login. Crie uma em Project Settings > API Keys e envie como Authorization: Bearer <key>:

curl https://docs.example.com/llms.txt \
  -H "Authorization: Bearer jd_live_..."

curl https://docs.example.com/using/scope.md \
  -H "Authorization: Bearer jd_live_..."

Com uma chave, URLs .md retornam as páginas que aparecem na busca. Páginas restritas a grupos, páginas ocultas e páginas com search: false retornam 404. Uma chave que não é válida para o site recebe um erro JSON 401 com invalid_api_key. Sem chave, nada muda.

A chave nunca abre páginas HTML nem o chat de IA. Essas ainda exigem login. Requisições com chave compartilham um limite de 120 por minuto por chave com o servidor MCP. Acima do limite, você recebe um 429 com Retry-After: 60.

Diretiva para agentes em todas as páginas

Toda página traz uma nota invisível, silenciosa para leitores de tela, que aponta agentes de IA para o llms.txt. Toda exportação Markdown começa com um blockquote que linka o índice. Agentes que chegam ao seu HTML encontram o caminho Markdown sem precisar rastrear.

Como é construído

  • Gerado no momento do build, junto com seu HTML
  • Servido pela CDN com a mesma política de cache da sua documentação
  • Atualizado automaticamente a cada build
  • Sem configuração necessária. Todas as páginas são incluídas por padrão

Desativando o llms.txt

A Jamdesk publica llms.txt e llms-full.txt por padrão. Defina seo.ai.llmsTxt como false no docs.json para deixar de gerá-los, por exemplo, para impedir que ferramentas de IA ingiram seu conteúdo:

docs.json
{
  "seo": {
    "ai": {
      "llmsTxt": false
    }
  }
}

A Jamdesk ignora os arquivos no próximo build, incluindo cada cópia por idioma. As URLs ativas /llms.txt e /llms-full.txt passam a retornar 404.

Ingestão por IA e indexação de busca são controles separados. seo.ai.llmsTxt controla apenas os arquivos llms.txt/llms-full.txt que ferramentas de IA leem. Ele não altera como mecanismos de busca indexam seu site. Metadados robots e noindex por página controlam a indexação. Uma página pode ser indexada pelo Google e excluída da ingestão por IA, ou o contrário.

Rastreadores de IA

O robots.txt padrão da Jamdesk permite todos os principais rastreadores de IA (Claude, ChatGPT, Copilot, Gemini).

O sitemap.xml lista URLs para mecanismos de busca rastrearem e indexarem. Ele não tem conteúdo, apenas links e metadados como datas de última modificação.

O llms.txt é voltado para modelos de IA. Ele tem títulos e descrições das páginas e, no llms-full.txt, o conteúdo das páginas. Ferramentas de IA leem o arquivo completo em uma única requisição HTTP em vez de muitas.

Próximos passos

AI Score

Veja o quão preparada para agentes está sua documentação, pontuada a cada build

AI Chat

Assistente de chat integrado para perguntas dos visitantes

MCP Server

Permita que ferramentas de IA busquem e consultem sua documentação de forma interativa

Markdown Source

Busque o Markdown bruto de páginas individuais