Visão geral

Fontes

Uma fonte do Docsbook é um repositório, um site ou uma única página que o assistente e os agentes deste projeto têm permissão para consultar. Conecte uma, e "atualizar a documentação" ou "esta página ainda está correta" começará com uma leitura em vez de uma lembrança.

Abra a seção Fontes do painel de administração do seu projeto, diretamente abaixo de MCP e Agentes.

O que você obtém#

  • Um endereço que o assistente pode acessar. Pergunte quanto custa seu produto, e ele busca sua página de preços para responder a essa pergunta, em vez de responder com base no que absorveu durante o treinamento.
  • O mesmo registro em suas próprias ferramentas. As duas ferramentas que são o recurso, list_sources e read_source, são disponibilizadas pelo endpoint MCP do seu projeto, portanto uma fonte que você conecta aqui significa a mesma coisa no Claude Code ou no Cursor.
  • Uma frase sua anexada a cada uma. A observação que você escreve ("o servidor de API que as páginas de referência descrevem") é lida como instrução por tudo que posteriormente lê essa fonte.
  • Uma leitura que falha de forma explícita. Um repositório inacessível retorna um erro com uma dica, nunca uma lista vazia que pareça indicar um repositório vazio.
  • Sem barreira de plano. As fontes estão disponíveis em todos os planos, deliberadamente: colocar um acesso pago aqui seria vender a capacidade de dizer a verdade.

O que posso conectar como fonte?#

Existem quatro tipos nos bastidores — Website, Página, Repositório e Pasta do repositório — e a tabela os apresenta como um catálogo dos itens nomeados sobre os quais os proprietários realmente perguntam, em cinco grupos: Seu projeto, Plataformas de documentação, Bases de conhecimento, Código e APIs e Comunidade. Um site de documentação publicado é um website, independentemente de quem o criou, portanto Mintlify, GitBook, ReadMe, Docusaurus, Read the Docs, MkDocs, Nextra, VitePress, Starlight, Redocly, Stoplight, Scalar e os demais não exigem nada específico por fornecedor.

A tabela lista todos os tipos que o Docsbook conhece, conectados ou não, filtrados por meio de um menu de Filtros, em vez de divididos em seções. Cada conexão ocupa sua própria linha: dois websites conectados correspondem a duas linhas.

Cinza significa duas coisas diferentes, e a linha informa qual delas:

  • Não conectado — a linha oferece um Conectar. A leitura funciona hoje, por meio da mesma busca pública que todas as outras linhas url usam.
  • Ainda não disponível — a linha não oferece nenhum botão e informa o que seria necessário: uma autorização concedida uma única vez (workspace do Notion, Confluence, Coda), um token de bot (Telegram, Discord, Slack) ou um leitor para um host de repositório que o Docsbook ainda não consegue ler (GitLab, Bitbucket). Quando existe uma solução alternativa, a linha a indica — uma central de ajuda pública pode ser conectada como Website hoje.

Uma linha sem botão é intencional. Uma linha só pode oferecer Conectar se read_source puder realmente lê-la como está; um Conectar que não consegue conectar torna todas as outras linhas da tela pouco confiáveis.

Como conecto uma fonte?#

Pressione Conectar em uma linha ou Nova fonte acima da tabela. De qualquer forma, há um campo, e o endereço determina o que é a fonte — não a linha que você pressionou. A linha em que você clicou apenas define o espaço reservado e o título, e, quando os dois discordam, a caixa de diálogo informa isso antes de você confirmar.

O que você cola No que isso se transforma O que uma leitura retorna
github.com/acme/api Repositório Seus arquivos legíveis, README e documentação primeiro; qualquer caminho pelo nome
github.com/acme/api/tree/main/docs Pasta do repositório Apenas essa subárvore — e apenas commits dentro dela
acme.com ou acme.com/docs Site Várias de suas páginas, encontradas a partir do próprio sitemap.xml
acme.com/pricing.html Página Aquela única página, lida por inteiro
acme.mintlify.app, acme.gitbook.io, acme.notion.site Arquivado na linha desse fornecedor O mesmo que um site, arquivado onde você procuraria por ele

Uma extensão de arquivo no caminho é o que separa uma página de um site. Um link colado de uma issue ou de uma pull request conecta o repositório, não a issue — armazenar /issues como uma subárvore produziria uma fonte que retornaria vazio para sempre. Os parâmetros de rastreamento (utm_*, fbclid, gclid, ref, si…) são removidos, portanto a mesma página colada de um tweet e da barra de endereço é uma única fonte, e não duas. Um host sem caminho recebe https://; um http:// que você digitou de propósito é mantido como está, pois atualizá-lo silenciosamente produziria uma fonte que retorna 404 para um site sem TLS, sem que fosse possível saber o motivo pela linha.

Um repositório privado precisa do seletor, não de uma colagem. O GitHub responde com o mesmo 404 para "privado" e para "não existe", portanto um endereço colado não informa ao Docsbook qual dos dois casos é, e um endereço privado digitado manualmente é conectado como público e não retorna nada. Use Ou selecione um dos seus repositórios do GitHub na caixa de diálogo: o seletor sabe qual é o caso, e uma fonte marcada como privada armazena a autorização do GitHub da conta que faz a conexão, criptografada em repouso, para que uma execução agendada sem uma sessão do navegador por trás ainda possa ler o repositório. Essa autorização nunca sai do servidor — a API responde has_token, nunca o token — e um token que o GitHub rejeitou desde então é relatado como "reconecte este repositório", em vez de ser tentado novamente em silêncio.

Duas entradas aparecem sem que você as adicione, e nenhuma delas pode ser renomeada, pausada ou removida aqui:

  • Repositório deste site — o repositório a partir do qual sua documentação é criada. Ele já está sendo lido; fazer você "conectá-lo" daria a entender que ele não estava.
  • Do Branding — a URL da fonte do site, caso seu espaço de trabalho tenha definido uma. Ela continua no cartão Branding.

Colar novamente um endereço que você já conectou atualiza essa linha, em vez de falhar ou duplicá-la, e colar novamente sem uma observação não apaga a observação que você digitou na primeira vez.

O que lê uma fonte conectada?#

Três coisas, e nada mais. Uma fonte conectada não é rastreada por um temporizador, não é adicionada à sua documentação publicada e não é pesquisada pelo chat voltado para leitores no seu site de documentação — esse responde apenas com base nas suas próprias páginas (Qualidade das respostas é o pipeline que ele utiliza).

O assistente no seu painel de administração. list_sources e read_source ficam na caixa de ferramentas base dele, em vez de atrás de uma consulta, porque uma capacidade que exige uma ida e volta extra para ser descoberta é uma capacidade que o modelo responde com base na memória — exatamente o tipo de falha que as fontes existem para evitar.

Os seus próprios agentes MCP. As mesmas duas ferramentas no endpoint MCP do seu projeto, além de connect_source e configure_source para configurar um sem abrir um navegador. Esses dois requerem um token MCP de leitura e escrita.

Execuções em segundo plano. Os prompts agendados e as execuções de agentes também os leem, e é aí que isso é mais importante: não há ninguém presente para colar um link.

Nem todas as execuções automatizadas chegam a uma fonte, por isso o painel indica quais chegam, em vez de dar a entender que todas podem fazê-lo. Onde quer que as execuções sejam listadas, os chips aparecem em três estados:

  • Ativo — esta execução obtém a fonte: as páginas do seu site, os ficheiros do seu repositório.
  • Inativo — esta execução sabe que a fonte está conectada e irá indicá-la, mas nunca declarou que sai da propriedade, por isso não a obterá. Pergunte antes ao assistente; ele não tem essa limitação.
  • Nada — esta execução não chega a nenhuma fonte. Uma gravação de definições não tem motivo para ler o seu repositório, e um chip nesse local diria o contrário.

Como uma fonte é obtida e quão atual é o que retorna?#

Nada é obtido previamente e nada é espelhado. Uma leitura acontece quando uma ferramenta a solicita, diretamente no endereço ativo, e estas são suas características:

Repositório Site / página
Leitura sem um caminho A lista de arquivos legíveis, ordenada por README → prosa em docs/, guides/, specs/ → outra prosa → configuração no nível raiz → todo o restante, nos primeiros 300 caminhos Até 10 páginas, descobertas a partir de sitemap.xml
Leitura com um caminho Esse arquivo, a partir do ramo padrão Essa página, resolvida em relação ao próprio URL da fonte
Limite de tamanho 25.000 caracteres por arquivo, com truncamento informado 25.000 caracteres para uma única página; 8.000 por página em uma leitura de várias páginas
Também disponível Os últimos 10 commits — sha, assunto, autor, data e o ramo padrão do repositório; limitado ao caminho para uma pasta de repositório
Atualidade Ramo padrão armazenado em cache por 1 hora, árvore de arquivos por 5 minutos; conteúdos de arquivos e commits são obtidos sem cache Obtido ao vivo, a cada chamada
Tempo limite O próprio do GitHub 15s por página, 8s para o sitemap

Código, arquivos de bloqueio e saída de compilação são filtrados da listagem (node_modules, dist, build, .next, coverage e semelhantes), não das leituras: read_source com um caminho obtém qualquer arquivo; o filtro apenas decide o que será nomeado sem ser solicitado.

O escopo do sitemap é correspondido em um limite de caminho, não como um prefixo de string. Connect acme.com/docs e /docs-for-fintech permanece fora dele. Uma seção para a qual o sitemap não lista nada recorre apenas à página de entrada — nunca ao site inteiro — e o resultado informa qual das três situações ocorreu: as páginas vieram do sitemap, o site tem um sitemap, mas não há nada sob sua seção, ou não há sitemap algum. Uma leitura limitada nunca pode ser interpretada como um site limitado.

Cada obtenção externa passa pela mesma proteção usada pelo restante da leitura da web do Docsbook: robots.txt é respeitado, os redirecionamentos são seguidos manualmente com o endereço revalidado a cada um dos no máximo cinco saltos, e intervalos privados e link-local são recusados, para que um URL público não possa redirecionar para um endpoint de metadados de nuvem. Páginas que renderizam seu conteúdo com JavaScript retornam uma observação informando que nenhum texto legível foi encontrado, em vez de uma página vazia.

Online, pausado e o significado do ponto verde#

Cada fonte conectada mostra um ponto verde e a palavra Online. Uma fonte pausada mostra um ponto cinzento e Paused.

Online significa que a fonte está conectada e os seus agentes podem lê-la. Não é uma verificação de integridade. Nada faz uma solicitação ao host e nada verifica se o repositório ainda existe. O indicador fiável é a coluna Last used, preenchida apenas quando uma ferramenta realmente obtém a fonte com sucesso — uma obtenção falhada nunca atualiza esse campo.

Disconnect mantém a linha e impede que qualquer coisa a leia; prima novamente (o texto passa a ser Connect) para retomar. Remove elimina totalmente a ligação, juntamente com qualquer autorização do GitHub associada a ela. Open visita o endereço. As duas formas de deixar de ler uma fonte são diferentes de propósito: "parar de ler isto por enquanto" não deve obrigá-lo a escrever o endereço novamente mais tarde.

O que acontece quando uma fonte não pode ser lida#

Cada falha é uma frase com um próximo passo, e nenhuma delas resulta em uma resposta vazia:

Situação O que a ferramenta retorna
A fonte está pausada Identifica a fonte e informa que ela está desativada na aba Sources deste espaço de trabalho
Uma árvore de repositório não carrega "O repositório pode ser privado, ter sido renomeado ou excluído. Diga isso claramente em vez de responder de memória sobre o que ele contém."
Um caminho de arquivo está incorreto Sugere listar primeiro o repositório — o arquivo pode estar em uma pasta diferente
A autorização armazenada de um repositório privado deixou de funcionar "O GitHub recusou … com a autorização armazenada para ele. Reconecte o repositório em Sources." — nunca uma lista de commits vazia
Um site está fora do ar, bloqueia buscas do lado do servidor ou não permite o caminho em robots.txt Informa qual dessas situações ocorreu e diz para relatar isso em vez de descrever o site de memória
Nada está conectado NO_SOURCES, com "Não invente uma"

Essa última linha é o objetivo de todo o design. O modo de falha que uma fonte evita não é uma mensagem de erro — é um parágrafo confiante sobre um repositório que ninguém leu.

Quanto custa ler uma fonte?#

As próprias fontes são gratuitas para conectar e manter. Duas das quatro ferramentas são cobradas quando chamadas pelo MCP, e têm preços definidos pelo custo real de disponibilizá-las:

  • list_sources lê linhas que o Docsbook já armazena e é cobrada como uma leitura comum.
  • read_source sai da rede do Docsbook para o GitHub ou para o site de alguém — e uma fonte de site busca várias páginas em uma única chamada —, por isso é cobrada como uma chamada externa, da mesma categoria que fetch_url.

Ambas são descontadas do saldo do projeto ao qual a chamada se refere. Os valores estão na página de preços.

Por que esta é a maneira correta (evidências)#

Regra no Docsbook Por que funciona Fonte
Buscar a fonte em vez de pedir ao modelo para lembrá-la Em um benchmark criado para perguntas sobre conhecimento do mundo atual, "todos os modelos (independentemente do tamanho do modelo) têm dificuldade com perguntas que envolvem conhecimento que muda rapidamente e premissas falsas" — seus preços, limites e endpoints são exatamente esse tipo de informação Vu et al., 2023 — FreshLLMs (Resultados da ACL 2024)
Considerar desatualizado o próprio conhecimento do assistente, qualquer que seja o modelo O modelo por trás do assistente administrativo do Docsbook publica um "Limite de conhecimento" de "fev. de 2026". Qualquer coisa que seu produto tenha alterado após o limite de conhecimento do provedor só existe para ele se algo a tiver buscado OpenRouter — página do modelo gpt-5.6-luna (informado pelo fornecedor)
Descobrir as páginas de um site a partir do próprio sitemap, em vez de adivinhar caminhos <loc> contém a "URL da página", e o protocolo existe para que um site possa "fornecer detalhes sobre suas páginas aos mecanismos de pesquisa" — é a própria resposta do site à pergunta "quais páginas eu tenho?" protocolo sitemaps.org (especificação)
Respeitar robots.txt em cada busca de fonte A RFC 9309 padroniza como "os proprietários de serviços [podem] controlar como o conteúdo fornecido por seus serviços pode ser acessado… por clientes automáticos conhecidos como rastreadores" RFC 9309 (padrão da IETF)
Rotular uma fonte buscada como dados a serem citados, nunca como instruções a serem seguidas "Injeções indiretas de prompt ocorrem quando um LLM aceita entradas de fontes externas, como sites ou arquivos" — o conteúdo lido pelo modelo pode conter instruções direcionadas ao modelo OWASP GenAI — LLM01:2025 Prompt Injection (padrão do setor)
Revalidar o endereço a cada etapa de redirecionamento e recusar intervalos de link-local Os metadados de instância na nuvem são fornecidos em um endereço de link-local — a AWS documenta http://169.254.169.254/latest/meta-data/, "válido somente a partir da instância" — portanto, um redirecionamento que chega lá transforma a busca de uma página em uma leitura de credenciais AWS — Acessar metadados de instância de uma instância do EC2 (documentação do fornecedor)

Limites#

  • Uma fonte é lida sob demanda, não indexada. Não há rastreamento em segundo plano, cópia armazenada nem garantia de atualização entre chamadas. O que uma ferramenta viu é o que o endereço forneceu naquele momento.
  • O ponto verde não é uma verificação de acessibilidade. Veja acima. Um repositório excluído esta manhã continua mostrando Online até que algo tente lê-lo.
  • Um repositório privado digitado manualmente é conectado como público e não lê nada. O Docsbook não consegue distinguir um repositório privado de um inexistente apenas pelo endereço. Use o seletor de repositórios, que consegue.
  • Apenas repositórios do GitHub são lidos como repositórios. As linhas do GitLab e do Bitbucket existem e não oferecem a opção Conectar; uma página pública de projeto em qualquer um deles pode ser conectada como um Website, que lê as páginas renderizadas, e não a árvore.
  • Uma fonte de website não é um rastreador. No máximo dez páginas por chamada, apenas do mapa do site, sem recursão nem seguimento de links. Um site grande de documentação é melhor conectado como seu repositório.
  • Páginas renderizadas com JavaScript retornam vazias. O buscador não executa scripts. O resultado informa isso, portanto o vazio nunca é relatado como ausência de conteúdo — mas você ainda não tem conteúdo.
  • As notas são instruções, e cabe a você mantê-las corretas. Tudo que lê uma fonte lê sua nota como orientação. Uma nota desatualizada ("a API v1, obsoleta") orienta um agente com a mesma eficácia que uma correta.
  • Não publicamos nenhuma medição de quanto as fontes reduzem respostas erradas. O mecanismo está descrito acima e as evidências sobre ele são externas; um número de antes e depois usando corpora de clientes não é algo que o Docsbook tenha realizado. Trate "as fontes melhoram a precisão na sua documentação" como uma expectativa bem fundamentada, não como um número que medimos.
  • Chat de IA — o assistente no seu site de documentação e o que ele pode responder a partir dele.
  • Qualidade das respostas — o pipeline completo de recuperação e fundamentação.
  • Hooks de chat — a outra forma de fornecer a um modelo um fato que ele não consegue ler.
  • Servidor MCP — as mesmas ferramentas, para seus próprios agentes.
  • Referência das ferramentas MCPlist_sources, read_source, connect_source, configure_source na íntegra.
  • Fonte da verdade — um recurso diferente com um nome semelhante: um grafo local das suas próprias páginas, criado na máquina do agente.
  • Preços — em que uma leitura de fonte se baseia.

Updated

Esta página foi útil?