Aperçu

Sources

Une source Docsbook est un dépôt, un site web ou une page unique que l’assistant et les agents de ce projet sont autorisés à récupérer. Connectez-en une, et « mettre à jour la documentation » ou « cette page est-elle toujours exacte ? » commence par une lecture plutôt que par un souvenir.

Ouvrez la section Sources du panneau d’administration de votre projet, directement sous MCP et Agents.

Ce que vous obtenez#

  • Une adresse où l’assistant peut se rendre. Demandez combien coûte votre produit, et il récupère votre page de tarifs pour répondre à cette question au lieu de répondre à partir de ce qu’il a assimilé pendant son entraînement.
  • Le même enregistrement dans vos propres outils. Les deux outils qui constituent la fonctionnalité, list_sources et read_source, sont fournis via l’point de terminaison MCP de votre projet. Ainsi, une source que vous connectez ici signifie la même chose dans Claude Code ou Cursor.
  • Une phrase de votre choix associée à chacun d’eux. La note que vous rédigez (« le serveur API décrit par les pages de référence ») est interprétée comme une instruction par tout ce qui consultera ensuite cette source.
  • Une lecture qui échoue de manière explicite. Un dépôt inaccessible renvoie une erreur accompagnée d’un indice, jamais une liste vide qui donnerait l’impression que le dépôt est vide.
  • Aucune restriction liée au forfait. Les sources sont disponibles avec tous les forfaits, délibérément : instaurer un péage ici reviendrait à vendre la capacité de dire la vérité.

Que puis-je connecter comme source ?#

Quatre types existent en coulisses — Site web, Page, Dépôt et Dossier de dépôt — et le tableau les présente comme un catalogue des éléments nommés auxquels les propriétaires s’intéressent réellement, répartis en cinq groupes : Votre projet, Plateformes de documentation, Bases de connaissances, Code et API et Communauté. Un site de documentation publié est un site web, quel que soit son créateur : Mintlify, GitBook, ReadMe, Docusaurus, Read the Docs, MkDocs, Nextra, VitePress, Starlight, Redocly, Stoplight, Scalar et tous les autres ne nécessitent rien de spécifique à chaque fournisseur.

Le tableau répertorie tous les types connus de Docsbook, qu’ils soient connectés ou non, filtrés via un menu Filtres plutôt que répartis en sections. Chaque connexion occupe sa propre ligne : deux sites web connectés correspondent à deux lignes.

Le gris peut signifier deux choses différentes, et la ligne indique laquelle :

  • Non connecté — la ligne propose un bouton Connecter. Sa lecture fonctionne dès aujourd’hui, via la même récupération publique que celle utilisée par chaque autre ligne url.
  • Pas encore disponible — la ligne ne propose aucun bouton et indique ce dont elle aurait besoin : une autorisation accordée une seule fois (espace de travail Notion, Confluence, Coda), un jeton de bot (Telegram, Discord, Slack), ou un lecteur pour un hébergeur de dépôts que Docsbook ne prend pas encore en charge (GitLab, Bitbucket). Lorsqu’une solution de contournement existe, la ligne la précise : un centre d’aide public peut être connecté comme site web dès aujourd’hui.

L’absence de bouton sur une ligne est délibérée. Une ligne n’est autorisée à proposer Connecter que si read_source peut réellement la lire telle quelle ; un bouton Connecter qui ne permet pas de se connecter rend toutes les autres lignes de l’écran peu fiables.

Comment connecter une source ?#

Appuyez sur Connecter dans une ligne, ou sur Nouvelle source au-dessus du tableau. Dans les deux cas, il n’y a qu’un seul champ, et c’est l’adresse qui détermine la source — pas la ligne sur laquelle vous avez appuyé. La ligne sur laquelle vous avez cliqué définit uniquement l’espace réservé et le titre, et lorsque les deux ne correspondent pas, la boîte de dialogue vous le signale avant la validation.

Ce que vous collez Ce que cela devient Ce qu’une lecture renvoie
github.com/acme/api Dépôt Ses fichiers lisibles, le README et la documentation en premier ; n’importe quel chemin par son nom
github.com/acme/api/tree/main/docs Dossier du dépôt Uniquement ce sous-arbre — et uniquement les commits qu’il contient
acme.com ou acme.com/docs Site web Plusieurs de ses pages, trouvées à partir de son propre sitemap.xml
acme.com/pricing.html Page Cette page unique, lue intégralement
acme.mintlify.app, acme.gitbook.io, acme.notion.site Classé sous la ligne de ce fournisseur La même chose qu’un site web, classée à l’endroit où vous la chercheriez

La présence d’une extension de fichier dans le chemin distingue une page d’un site web. Un lien collé depuis une issue ou une pull request connecte le dépôt, et non l’issue — enregistrer /issues comme sous-arbre produirait une source qui resterait vide à chaque lecture. Les paramètres de suivi (utm_*, fbclid, gclid, ref, si…) sont supprimés : la même page collée depuis un tweet et depuis votre barre d’adresse constitue donc une seule source, et non deux. Un hôte seul reçoit https:// ; un http:// que vous avez saisi volontairement est conservé tel quel, car une mise à niveau silencieuse produirait une source qui renvoie une erreur 404 pour un site sans TLS, sans qu’il soit possible de comprendre pourquoi depuis la ligne.

Un dépôt privé nécessite le sélecteur, pas un collage. GitHub renvoie le même 404 pour « privé » et pour « n’existe pas » : une adresse collée ne permet donc pas à Docsbook de distinguer les deux, et une adresse privée saisie manuellement est connectée comme publique et ne renvoie rien. Utilisez Ou choisissez l’un de vos dépôts GitHub dans la boîte de dialogue : le sélecteur le sait, et une source marquée comme privée conserve l’autorisation GitHub du compte connecté, chiffrée au repos, afin qu’une exécution planifiée sans session de navigateur puisse tout de même lire le dépôt. Cette autorisation ne quitte jamais le serveur — l’API renvoie has_token, jamais le jeton — et un jeton que GitHub a depuis rejeté est signalé comme « reconnectez ce dépôt » au lieu d’être réessayé en silence.

Deux entrées apparaissent sans que vous les ajoutiez, et aucune des deux ne peut être renommée, mise en pause ou supprimée ici :

  • Dépôt de ce site — le dépôt à partir duquel votre documentation est générée. Il est déjà en cours de lecture ; vous demander de le « connecter » laisserait entendre que ce n’est pas le cas.
  • Depuis Branding — l’URL de la source du site, si votre espace de travail en a défini une. Elle se trouve toujours sur la carte Branding.

Recoller une adresse que vous avez déjà connectée met à jour cette ligne au lieu d’échouer ou de créer un doublon, et un nouveau collage sans note n’efface pas la note que vous aviez saisie la première fois.

Qu'est-ce qui lit une source connectée ?#

Trois choses, et rien d'autre. Une source connectée n'est pas explorée selon un calendrier, n'est pas ajoutée à votre documentation publiée et n'est pas recherchée par le chat destiné aux lecteurs sur votre site de documentation — celui-ci répond uniquement à partir de vos propres pages (Qualité des réponses est le pipeline qu'il utilise).

L'assistant de votre panneau d'administration. list_sources et read_source font partie de sa boîte à outils de base plutôt que d'être accessibles via une recherche, car une capacité dont la découverte nécessite un aller-retour supplémentaire est une capacité à laquelle le modèle répond plutôt de mémoire — précisément le type d'échec que ces sources sont censées empêcher.

Vos propres agents MCP. Les deux mêmes outils via le point de terminaison MCP de votre projet, ainsi que connect_source et configure_source pour en configurer un sans ouvrir de navigateur. Ces deux derniers nécessitent un jeton MCP en lecture-écriture.

Les exécutions en arrière-plan. Les invites planifiées et les exécutions d'agents les lisent également, et c'est là que cela compte le plus : personne n'est là pour coller un lien.

Toutes les exécutions automatisées n'atteignent pas une source, le panneau indique donc lesquelles le font plutôt que de laisser entendre qu'elles le peuvent toutes. Partout où les exécutions sont répertoriées, les indicateurs apparaissent dans trois états :

  • Activé — cette exécution récupère la source : les pages de votre site, les fichiers de votre dépôt.
  • Désactivé — cette exécution sait que la source est connectée et la nommera, mais n'a jamais déclaré qu'elle quittait l'environnement, elle ne la récupérera donc pas. Demandez plutôt à l'assistant ; il n'a pas cette restriction.
  • Rien du tout — cette exécution n'atteint aucune source. Une modification des paramètres n'a aucune raison de lire votre dépôt, et un indicateur à cet endroit dirait le contraire.

Comment une source est-elle récupérée, et quelle est la fraîcheur du contenu renvoyé ?#

Rien n'est récupéré à l'avance et rien n'est mis en miroir. Une lecture a lieu lorsqu'un outil la demande, depuis l'adresse active, et voici ses limites :

Dépôt Site web / page
Lecture sans chemin La liste des fichiers lisibles, classés dans l'ordre README → prose sous docs/, guides/, specs/ → autre prose → configuration à la racine → tout le reste, les 300 premiers chemins Jusqu'à 10 pages, découvertes à partir de sitemap.xml
Lecture avec un chemin Ce fichier, depuis la branche par défaut Cette page, résolue par rapport à l'URL propre à la source
Limite de taille 25 000 caractères par fichier, troncature signalée 25 000 caractères pour une seule page ; 8 000 par page dans une lecture multipage
Également disponible Les 10 derniers commits — sha, sujet, auteur, date et branche par défaut du dépôt ; limité au chemin pour un dossier de dépôt
Fraîcheur Branche par défaut mise en cache pendant 1 heure, arborescence des fichiers pendant 5 minutes ; le contenu des fichiers et les commits sont récupérés sans cache Récupéré en direct, à chaque appel
Délai d'expiration Celui de GitHub 15 s par page, 8 s pour le sitemap

Le code, les fichiers de verrouillage et les sorties de compilation sont exclus de la liste (node_modules, dist, build, .next, coverage et autres fichiers similaires), mais pas des lectures : read_source avec un chemin récupère n'importe quel fichier, le filtre détermine uniquement ce qui est nommé sans avoir été demandé.

La portée du sitemap est déterminée à une limite de chemin, et non comme un préfixe de chaîne. Connect acme.com/docs et /docs-for-fintech en est exclu. Lorsqu'une section répertoriée par le sitemap ne contient rien, la lecture revient uniquement à la page d'entrée — jamais à l'ensemble du site — et le résultat indique lequel des trois cas s'est produit : les pages provenaient du sitemap, le site possède un sitemap mais rien sous votre section, ou il n'y a aucun sitemap. Une lecture limitée n'est jamais autorisée à être interprétée comme un site limité.

Chaque récupération sortante passe par la même protection que celle utilisée par le reste de la lecture web de Docsbook : robots.txt est respecté, les redirections sont suivies manuellement, l'adresse étant revalidée à chaque étape parmi cinq sauts au maximum, et les plages privées et link-local sont refusées, afin qu'une URL publique ne puisse pas aboutir à un endpoint de métadonnées cloud. Les pages qui affichent leur contenu avec JavaScript renvoient une note indiquant qu'aucun texte lisible n'a été trouvé, plutôt qu'une page vide.

En ligne, en pause et ce que signifie le point vert#

Chaque source connectée affiche un point vert et le mot En ligne. Une source en pause affiche un point gris et En pause.

En ligne signifie que la source est connectée et que vos agents peuvent la lire. Ce n’est pas une vérification de l’état de santé. Rien n’envoie de requête à l’hôte et rien ne vérifie que le dépôt existe toujours. Le signal fiable est la colonne Dernière utilisation, renseignée uniquement lorsqu’un outil a effectivement récupéré la source avec succès — un échec de récupération ne la renseigne jamais.

Déconnecter conserve la ligne et empêche toute lecture de la source ; appuyez à nouveau dessus (le bouton affiche Connecter) pour reprendre. Supprimer supprime entièrement la connexion, ainsi que toute autorisation GitHub qui lui est associée. Ouvrir ouvre l’adresse. Les deux façons d’empêcher la lecture d’une source sont volontairement différentes : « arrêter de lire cette source pour l’instant » ne doit pas vous obliger à saisir à nouveau l’adresse plus tard.

Que se passe-t-il lorsqu’une source ne peut pas être lue#

Chaque échec s’accompagne d’une étape suivante, et aucun ne se traduit par un résultat vide :

Situation Ce que l’outil renvoie
La source est suspendue Nomme la source et indique qu’elle est désactivée dans l’onglet Sources de cet espace de travail
L’arborescence d’un dépôt ne se charge pas "Le dépôt est peut-être privé, renommé ou supprimé. Dites-le clairement plutôt que de répondre de mémoire sur son contenu."
Le chemin d’un fichier est incorrect Suggère de lister d’abord le dépôt — le fichier se trouve peut-être dans un autre dossier
L’autorisation enregistrée d’un dépôt privé a cessé de fonctionner "GitHub a refusé … avec l’autorisation enregistrée pour ce dépôt. Reconnectez le dépôt depuis Sources." — jamais une liste de commits vide
Un site est hors service, bloque les récupérations côté serveur ou interdit le chemin dans robots.txt Indique lequel de ces cas s’applique et demande de le signaler plutôt que de décrire le site de mémoire
Rien n’est connecté NO_SOURCES, avec "N’en inventez pas"

Cette dernière ligne est le cœur de toute la conception. Le mode d’échec qu’une source permet d’éviter n’est pas un message d’erreur — c’est un paragraphe affirmatif sur un dépôt que personne n’a consulté.

Combien coûte la lecture d’une source ?#

Les sources elles-mêmes sont gratuites à connecter et à conserver. Deux des quatre outils sont décomptés lorsqu’ils sont appelés via MCP, et leur tarif dépend de ce que leur utilisation coûte réellement :

  • list_sources lit les lignes que Docsbook stocke déjà et est facturé comme une lecture ordinaire.
  • read_source sort du réseau Docsbook pour accéder à GitHub ou au site web de quelqu’un — et une source web récupère plusieurs pages en un seul appel —, il est donc facturé comme un appel sortant, dans la même catégorie que fetch_url.

Les deux montants sont déduits du solde du projet concerné par l’appel. Les montants sont indiqués sur la page des tarifs.

Pourquoi c'est la bonne méthode (preuves)#

Règle dans Docsbook Pourquoi cela fonctionne Source
Récupérer la source plutôt que demander au modèle de s'en souvenir Dans un benchmark conçu pour les questions portant sur les connaissances du monde actuel, « tous les modèles (quelle que soit leur taille) ont des difficultés avec les questions qui impliquent des connaissances qui évoluent rapidement et des prémisses fausses » — vos prix, limites et points de terminaison appartiennent exactement à cette catégorie de faits Vu et al., 2023 — FreshLLMs (Findings of ACL 2024)
Considérer les propres connaissances de l'assistant comme obsolètes, quel que soit le modèle Le modèle qui sous-tend l'assistant d'administration de Docsbook publie une « date limite des connaissances » de « févr. 2026 ». Tout ce que votre produit a modifié après la date limite de son fournisseur n'existe pour lui que si quelque chose l'a récupéré OpenRouter — page du modèle gpt-5.6-luna (déclaré par le fournisseur)
Découvrir les pages d'un site à partir de son propre plan du site plutôt que de deviner les chemins <loc> contient « l'URL de la page », et le protocole existe afin qu'un site puisse « fournir des informations sur vos pages aux moteurs de recherche » — c'est la propre réponse du site à la question « quelles pages ai-je ? » protocole sitemaps.org (spécification)
Respecter robots.txt lors de chaque récupération de source La RFC 9309 normalise la manière dont les « propriétaires de services [peuvent] contrôler la façon dont le contenu fourni par leurs services peut être consulté… par des clients automatiques appelés robots d'exploration » RFC 9309 (norme de l'IETF)
Étiqueter une source récupérée comme des données à citer, jamais comme des instructions à suivre « Les injections indirectes de prompts se produisent lorsqu'un LLM accepte des données provenant de sources externes, telles que des sites web ou des fichiers » — le contenu lu par le modèle peut contenir des instructions destinées au modèle OWASP GenAI — LLM01:2025 Prompt Injection (norme du secteur)
Revalider l'adresse à chaque étape de redirection et refuser les plages d'adresses locales au lien Les métadonnées d'instance cloud sont fournies sur une adresse locale au lien — AWS documente http://169.254.169.254/latest/meta-data/, « valide uniquement depuis l'instance » — ainsi, une redirection qui y aboutit transforme la récupération d'une page en lecture d'identifiants AWS — Accéder aux métadonnées d'instance d'une instance EC2 (documentation du fournisseur)

Limites#

  • Une source est lue à la demande, et non indexée. Il n’y a ni exploration en arrière-plan, ni copie stockée, ni garantie de fraîcheur entre les appels. Ce qu’un outil a vu correspond à ce que l’adresse a fourni à ce moment-là.
  • Le point vert ne vérifie pas l’accessibilité. Voir ci-dessus. Un dépôt supprimé ce matin affiche En ligne jusqu’à ce que quelque chose tente de le lire.
  • Un dépôt privé saisi manuellement se connecte comme public et ne lit rien. Docsbook ne peut pas distinguer un dépôt privé d’un dépôt manquant à partir de son adresse. Utilisez le sélecteur de dépôts, qui le peut.
  • Seuls les dépôts GitHub sont lus comme des dépôts. Les lignes GitLab et Bitbucket existent et ne proposent aucune option de connexion ; une page de projet publique sur l’une ou l’autre de ces plateformes peut être connectée comme site web, ce qui lit les pages rendues et non l’arborescence.
  • Une source de site web n’est pas un robot d’exploration. Au maximum dix pages par appel, uniquement à partir du sitemap, sans récursion ni suivi de liens. Un grand site de documentation est mieux connecté comme dépôt.
  • Les pages rendues en JavaScript reviennent vides. Le récupérateur n’exécute pas les scripts. Le résultat le précise, de sorte que le vide n’est jamais signalé comme une absence de contenu — mais vous n’avez toujours aucun contenu.
  • Les notes sont des instructions, et c’est à vous de veiller à leur exactitude. Tout ce qui lit une source lit votre note comme une indication. Une note obsolète (« l’API v1, obsolète ») oriente un agent aussi efficacement qu’une note correcte.
  • Nous ne publions aucune mesure de la réduction des mauvaises réponses attribuable aux sources. Le mécanisme est décrit ci-dessus et les preuves en sa faveur sont externes ; Docsbook n’a pas réalisé de comparaison avant-après sur les corpus des clients. Considérez « les sources améliorent la précision sur vos documents » comme une attente bien étayée, et non comme un chiffre que nous avons mesuré.
  • Chat IA — l’assistant de votre site de documentation et ce à partir de quoi il peut répondre.
  • Qualité des réponses — le pipeline complet de récupération et d’ancrage.
  • Hooks de chat — l’autre façon de transmettre à un modèle un fait qu’il ne peut pas lire.
  • Serveur MCP — les mêmes outils pour vos propres agents.
  • Référence des outils MCPlist_sources, read_source, connect_source, configure_source en détail.
  • Source de vérité — une autre fonctionnalité au nom similaire : un graphe local de pages qui vous appartiennent, construit sur la machine de l’agent.
  • Tarifs — ce sur quoi s’appuie la lecture d’une source.

Updated

Cette page vous a-t-elle été utile ?