Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-bdd272a9.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

À propos des serveurs MCP

Le Model Context Protocol (MCP) est un protocole ouvert qui crée des connexions standardisées entre les applications d’IA et des services externes, comme la documentation. Mintlify génère un serveur Search MCP pour votre site, en préparant votre contenu pour un écosystème d’IA plus vaste. N’importe quel client MCP comme Claude, Cursor, Goose ou ChatGPT peut se connecter à votre contenu. Votre serveur Search MCP expose des outils permettant aux applications d’IA de rechercher et de récupérer votre contenu. Vos utilisateurs doivent connecter votre serveur Search MCP à leurs outils.
Vous souhaitez plutôt permettre aux agents de modifier votre contenu au lieu de simplement le lire ? Utilisez le serveur Admin MCP pour un serveur MCP authentifié qui expose des outils de branching, d’édition de pages, de navigation et de docs.json aux agents de confiance.

Fonctionnement des serveurs MCP

Lorsqu’une application d’IA se connecte à votre serveur Search MCP, elle peut rechercher dans votre contenu et récupérer des pages complètes en réponse à la requête d’un utilisateur. Cela évite de s’appuyer sur des informations issues des données d’entraînement ou de recherches web génériques. Votre serveur Search MCP donne accès à tout le contenu indexé de votre site Mintlify.
  • Les applications d’IA peuvent rechercher de manière proactive dans votre contenu pendant qu’elles génèrent une réponse, même s’il ne leur a pas été explicitement demandé d’y rechercher une réponse.
  • Les applications d’IA déterminent quand utiliser les outils disponibles en fonction du contexte de la conversation et de la pertinence de votre contenu.
  • Chaque appel d’outil a lieu pendant le processus de génération, de sorte que l’application d’IA utilise des informations à jour de votre site pour générer sa réponse.
Certains outils d’IA comme Claude prennent en charge à la fois MCP et les skills. MCP donne accès à votre contenu, tandis que les skills indiquent aux agents comment utiliser ce contenu efficacement. Ils sont complémentaires et la connexion de votre serveur MCP donne aux agents accès aux deux.

Outils MCP

Votre serveur Search MCP fournit deux outils que les agents peuvent utiliser :
  • Search : Recherche sur votre site pour trouver du contenu pertinent, en renvoyant des extraits avec des titres et des liens. Utilisez cet outil pour découvrir des informations ou trouver des pages correspondant à une requête.
  • Query docs filesystem : Lit et parcourt le système de fichiers virtuel de votre site à l’aide de commandes de type shell. Utilisez cet outil pour parcourir et récupérer du contenu, ou extraire des sections spécifiques — y compris des lectures par lots sur plusieurs pages en un seul appel.
Les agents déterminent quand utiliser chaque outil en fonction du contexte de la conversation. Par exemple, un agent peut d’abord rechercher sur votre site pour trouver des pages pertinentes, puis utiliser l’outil query docs filesystem pour lire le contenu complet des résultats les plus pertinents.

Ressources MCP

Votre serveur Search MCP expose également vos fichiers skill.md en tant que ressources MCP. Les agents connectés à votre serveur Search MCP peuvent découvrir et accéder à vos fichiers de skill sans les installer séparément. Les ressources Skill.md apparaissent dans la liste des ressources du serveur Search MCP et contiennent les descriptions de capacités que Mintlify génère ou que vous définissez dans vos fichiers de skill personnalisés.

Paramètres de recherche

L’outil de recherche MCP prend en charge des paramètres facultatifs que les applications d’IA utilisent pour contrôler et affiner les résultats de recherche.
  • version : Filtre les résultats pour une version spécifique du site. Par exemple, 'v0.7'. Disponible uniquement lorsque votre site comporte plusieurs versions. Ne renvoie que le contenu balisé avec la version spécifiée ou le contenu disponible dans toutes les versions.
  • language : Filtre les résultats pour un code de langue spécifique. Par exemple, 'en', 'zh' ou 'es'. Disponible uniquement lorsque votre site comporte plusieurs langues. Ne renvoie que le contenu dans la langue spécifiée ou le contenu disponible dans toutes les langues.
Les applications d’IA déterminent quand appliquer ces paramètres en fonction du contexte de la requête de l’utilisateur. Par exemple, si un utilisateur pose une question sur une version spécifique d’une API, l’application d’IA peut appliquer automatiquement le filtre approprié pour fournir des résultats plus pertinents. Les outils d’IA peuvent rechercher sur le web, mais le Search MCP offre des avantages spécifiques.
  • Accès direct à la source : La recherche sur le web dépend de ce que les moteurs de recherche ont indexé, ce qui peut être obsolète ou incomplet. Le Search MCP interroge directement votre contenu indexé le plus à jour.
  • Flux de travail intégré : MCP permet à l’IA de rechercher pendant la génération de la réponse plutôt que d’effectuer une recherche web séparée.
  • Aucun bruit de recherche : Les algorithmes de référencement (SEO) et de classement influencent les résultats de la recherche sur le web. MCP accède directement à votre contenu.

Accéder à votre serveur Search MCP

Mintlify génère un serveur Search MCP pour votre site et l’héberge au chemin /mcp de l’URL de votre site. Par exemple, le serveur Search MCP de Mintlify est disponible à l’adresse https://mintlify.com/docs/mcp.
  • Pour un contenu public, votre serveur Search MCP est accessible à tous. Il recherche dans toutes les pages publiques indexées.
  • Pour un contenu avec authentification partielle, où certaines pages sont publiques et d’autres nécessitent une connexion, vous devez activer votre serveur Search MCP avant que les utilisateurs puissent y accéder. Les utilisateurs non authentifiés peuvent rechercher dans le contenu public. Les utilisateurs qui s’authentifient peuvent rechercher dans tout le contenu auquel ils ont l’autorisation d’accéder en fonction de leurs groupes d’utilisateurs.
  • Pour un contenu où toutes les pages requièrent une authentification, vous devez activer votre serveur Search MCP avant qu’il soit accessible aux utilisateurs. Les utilisateurs doivent s’authentifier avant de se connecter à votre serveur Search MCP. Votre serveur Search MCP recherche uniquement dans le contenu auquel chaque utilisateur a accès en fonction de ses groupes d’utilisateurs.
Vous pouvez afficher et copier l’URL de votre serveur Search MCP sur la page du serveur MCP dans votre Dashboard.
Page du serveur MCP dans le Dashboard.
Les serveurs Search MCP utilisent les chemins /mcp et /authed/mcp. Les autres éléments de navigation ne peuvent pas utiliser ces chemins.

Point de terminaison de découverte

Mintlify héberge un document de découverte à l’adresse /.well-known/mcp pour permettre aux agents et aux outils de localiser votre serveur Search MCP sans configuration préalable. GET /.well-known/mcp renvoie un document JSON décrivant votre serveur Search MCP :
{
  "version": "1.0.0",
  "transport": "http",
  "url": "https://your-docs.com/mcp",
  "servers": [
    {
      "name": "public",
      "url": "https://your-docs.com/mcp",
      "transport": "http",
      "authentication": "none"
    },
    {
      "name": "authenticated",
      "url": "https://your-docs.com/authed/mcp",
      "transport": "http",
      "authentication": "oauth2"
    }
  ]
}
ChampDescription
versionLa version du serveur MCP.
transportLe protocole de transport. Toujours http.
urlL’URL publique par défaut du serveur MCP.
serversServeurs MCP disponibles. Inclut toujours une entrée public. Lorsque l’authentification est activée sur votre site, inclut également une entrée authenticated.
servers[].nameIdentifiant de l’entrée du serveur.
servers[].authenticationMéthode d’authentification de l’entrée du serveur.
Pour la compatibilité avec les agents, le même document de découverte est également disponible à l’adresse /.well-known/mcp.json. Mintlify expose en plus une carte de serveur MCP à /.well-known/mcp/server-card.json et une liste de cartes de serveur à /.well-known/mcp/server-cards.json. Tous les endpoints de découverte sont servis automatiquement et ne nécessitent aucune configuration.

Activer le MCP avec authentification

Si votre site nécessite une authentification, votre serveur Search MCP demande aux utilisateurs de s’authentifier avant de se connecter. Lorsqu’un utilisateur ajoute l’URL de votre serveur MCP à son outil d’IA, il doit se connecter avec ses identifiants existants. Après l’authentification, une redirection le renvoie vers son outil. Le serveur MCP ne renvoie que le contenu auquel chaque utilisateur est autorisé à accéder en fonction de ses groupes d’utilisateurs. Si votre site utilise une authentification partielle avec des pages publiques et des pages protégées, vous disposez de deux endpoints de serveur Search MCP :
  • /mcp : Ne nécessite pas d’authentification. Renvoie uniquement le contenu public. Partagez-le avec les utilisateurs qui ont besoin d’accéder au contenu public.
  • /authed/mcp : Nécessite toujours une authentification. Renvoie le contenu en fonction des permissions de chaque utilisateur selon ses groupes d’utilisateurs. Partagez-le avec les utilisateurs qui ont besoin d’accéder au contenu protégé.
L’endpoint /authed/mcp utilise son propre flux OAuth à /authed/mcp/oauth/*. Les domaines de redirection configurés pour votre serveur MCP s’appliquent à la fois à /mcp et à /authed/mcp. Par défaut, votre serveur MCP est uniquement disponible pour les outils localhost. Pour autoriser les outils web à se connecter, ajoutez les domaines de redirection des outils d’IA. Un domaine de redirection est le nom d’hôte qu’un outil d’IA utilise une fois l’authentification terminée, comme claude.ai ou app.cursor.ai. Les outils d’IA de vos utilisateurs ne peuvent pas finaliser l’authentification si leur domaine de redirection ne figure pas dans cette liste.
1

Activer le MCP avec authentification dans votre Dashboard

  1. Accédez à la page du serveur MCP dans votre Dashboard.
  2. Cliquez sur le bouton bascule Enable MCP Server.
2

Ajouter des domaines de redirection

Ajoutez les domaines de redirection des outils d’IA auxquels vous souhaitez donner accès à vos utilisateurs. Les outils d’IA de vos utilisateurs ne peuvent pas finaliser l’authentification si leur domaine de redirection ne figure pas dans cette liste. Les domaines de redirection courants incluent claude.ai et vscode.dev/redirect.Par défaut, les domaines de redirection utilisent https://. Pour autoriser un schéma de protocole personnalisé, incluez le protocole complet dans l’entrée du domaine. Par exemple, un callback d’application native comme myapp://callback. Mintlify bloque toujours les protocoles dangereux tels que javascript:, data: et file:.Les adresses loopback (localhost, 127.0.0.1) sont toujours approuvées et n’ont pas besoin d’être ajoutées.

Identifiants client

Les identifiants client vous permettent de vous connecter à votre serveur MCP authentifié de manière programmatique, sans connexion via un navigateur. Utilisez les identifiants client pour les intégrations côté serveur, les pipelines CI/CD, les workflows automatisés et tout environnement dans lequel un utilisateur ne peut pas effectuer un flux OAuth interactif. Les identifiants client s’authentifient auprès de l’endpoint /authed/mcp et renvoient l’ensemble du contenu des pages publiques et des pages authentifiées qui ne sont pas restreintes à des groupes spécifiques.
1

Créer un identifiant client

  1. Accédez à la page du serveur MCP dans votre Dashboard.
  2. Dans la section Client Credentials, sélectionnez Create credential.
  3. Saisissez un libellé pour l’identifiant afin d’en identifier l’usage.
  4. Copiez le client ID et le client secret. Le client secret n’est affiché qu’une seule fois. Vous ne pourrez pas le récupérer ultérieurement.
2

Échanger les identifiants contre un jeton d'accès

Envoyez une requête POST à l’endpoint de jeton de votre serveur MCP avec votre client ID et votre secret. Votre endpoint de jeton se trouve au chemin /authed/mcp/oauth/token de l’URL de votre site.
curl -X POST https://your-docs.com/authed/mcp/oauth/token \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=client_credentials&client_id=CLIENT_ID&client_secret=CLIENT_SECRET'
La réponse inclut un jeton d’accès et un jeton de rafraîchissement :
{
  "access_token": "eyJhbGciOi...",
  "token_type": "Bearer",
  "expires_in": 1209600,
  "refresh_token": "eyJhbGciOi...",
  "scope": "mcp:search"
}
Les jetons d’accès expirent au bout du nombre de secondes spécifié dans expires_in. Utilisez le refresh_token pour obtenir un nouveau jeton d’accès lorsque le jeton actuel expire.
3

Se connecter au serveur MCP

Utilisez le jeton d’accès comme bearer token lors de la connexion à l’endpoint /authed/mcp.
curl -X POST https://your-docs.com/authed/mcp \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "initialize",
    "params": {
      "protocolVersion": "2025-03-26",
      "capabilities": {},
      "clientInfo": {"name": "my-integration", "version": "1.0.0"}
    }
  }'

Gestion des identifiants client

Vous pouvez gérer vos identifiants client depuis la page du serveur MCP dans votre Dashboard.
  • Supprimer un identifiant pour révoquer définitivement l’accès. Cette action est irréversible.
Traitez les client secrets comme des mots de passe. Ne les intégrez pas dans le contrôle de version et ne les exposez pas dans du code côté client. Utilisez des variables d’environnement ou un gestionnaire de secrets pour les stocker.

Limites de débit

Pour protéger la disponibilité, Mintlify applique des limites de débit aux serveurs MCP.
PortéeLimiteDescription
Par utilisateur (adresse IP)5 000 requêtes par heureLimite la fréquence à laquelle un même utilisateur peut interroger la configuration de votre serveur MCP.
Search par site (domain)10 000 requêtes par heureLimite le nombre total d’appels à l’outil de recherche effectués par tous les utilisateurs de votre serveur MCP.
Query docs filesystem par site (domain)10 000 requêtes par heureLimite le nombre total d’appels à l’outil query docs filesystem effectués par tous les utilisateurs de votre serveur MCP.
Search authentifié par site (domain)5 000 requêtes par heureLimite le nombre total d’appels authentifiés à l’outil de recherche effectués par tous les utilisateurs de votre serveur MCP.
Query docs filesystem authentifié par site (domain)5 000 requêtes par heureLimite le nombre total d’appels authentifiés à l’outil query docs filesystem effectués par tous les utilisateurs de votre serveur MCP.

Filtrage du contenu et indexation

Votre serveur MCP recherche le contenu que Mintlify indexe à partir du référentiel de votre projet. Le traitement des fichiers et l’indexation pour la recherche déterminent quel contenu est disponible via votre serveur MCP. Pour les sites nécessitant une authentification, votre serveur MCP indexe les pages publiques ainsi que toutes les pages auxquelles un utilisateur authentifié a l’autorisation d’accéder en fonction de ses groupes d’utilisateurs. Pour les sites avec authentification partielle, les utilisateurs non authentifiés peuvent rechercher dans les pages publiques. Les utilisateurs authentifiés peuvent rechercher dans les pages publiques ainsi que dans toutes les pages auxquelles ils ont l’autorisation d’accéder en fonction de leurs groupes d’utilisateurs.

Traitement des fichiers avec .mintignore

Si des fichiers correspondent aux modèles définis dans .mintignore, Mintlify ne les traite pas et ne les indexe pas. Ces fichiers ne sont pas disponibles via votre serveur MCP.

Indexation pour la recherche avec docs.json

Par défaut, Mintlify n’indexe, pour la recherche via votre serveur MCP, que les pages incluses dans la navigation de votre docs.json. Mintlify exclut les pages masquées (pages qui ne figurent pas dans votre navigation) de l’index de recherche, sauf si vous choisissez d’indexer toutes les pages. Pour inclure les pages masquées dans les résultats de recherche de votre serveur MCP, ajoutez la propriété seo.indexing à votre docs.json.
"seo": {
    "indexation": "all"
}
Pour exclure une page donnée de l’indexation par les moteurs de recherche, ajoutez noindex: true à son frontmatter.
---
title: "Page cachée"
description: "Cette page ne figure pas dans la navigation et n'est pas accessible via la recherche."
noindex: true
---

Utiliser votre serveur MCP

Vos utilisateurs doivent connecter votre serveur MCP à leurs outils d’IA préférés.
  1. Rendez l’URL de votre serveur MCP publique.
  2. Les utilisateurs copient l’URL de votre serveur MCP et l’ajoutent à leurs outils.
  3. Les utilisateurs accèdent à votre contenu depuis leurs outils.
Voici quelques façons d’aider vos utilisateurs à se connecter à votre serveur MCP :

Exemple : connexion au serveur MCP de Mintlify

Connectez-vous au serveur MCP de Mintlify pour rechercher sur ce site de documentation depuis votre outil d’IA préféré. Vous obtiendrez ainsi des réponses plus précises sur l’utilisation de Mintlify dans votre environnement local, et vous verrez comment aider vos utilisateurs à se connecter à votre serveur MCP.

Utiliser plusieurs serveurs MCP

Les utilisateurs peuvent connecter plusieurs serveurs MCP à leurs outils d’IA. Les serveurs MCP connectés ne consomment pas de contexte tant que l’IA n’appelle pas un outil de recherche. L’IA décide quand effectuer une recherche en fonction de la pertinence de la requête ; elle ne recherche donc pas sur chaque serveur connecté pour chaque question. Lorsque l’IA effectue une recherche, chaque requête renvoie plusieurs résultats qui s’ajoutent au contexte de la conversation. Si l’IA interroge plusieurs serveurs pour une seule question, cela peut consommer une quantité importante de contexte. Bonnes pratiques pour utiliser plusieurs serveurs MCP :
  • Connectez uniquement les serveurs MCP pertinents pour votre travail actuel.
  • Soyez précis dans vos prompts afin que l’IA interroge le serveur le plus pertinent.
  • Déconnectez les serveurs que vous n’utilisez pas activement pour réduire l’utilisation potentielle du contexte.