Présentation détaillée du projet GitMCP

🚀 Aperçu du projet

GitMCP est un serveur distant gratuit et open-source basé sur le Model Context Protocol (MCP), capable de transformer n'importe quel projet GitHub (dépôt ou GitHub Pages) en un centre de documentation. Il permet aux outils d'IA comme Cursor d'accéder aux documents et au code les plus récents, même si le LLM n'a jamais rencontré ce contenu, éliminant ainsi de manière transparente les hallucinations de code.

Fonctionnalités clés

• 😎 Documentation à jour pour tout projet GitHub : Fournit aux assistants IA un accès transparent à la documentation et au code des projets GitHub, avec une fonction de recherche intelligente intégrée pour aider l'IA à trouver exactement ce dont elle a besoin.
• 🧠 Élimination des hallucinations : Avec GitMCP, les assistants IA peuvent fournir des réponses précises et pertinentes.
• ☁️ Zéro configuration : GitMCP fonctionne dans le cloud ; il suffit d'ajouter l'URL GitMCP comme serveur MCP dans votre IDE.
• 💬 Chat intégré : Discutez directement avec la documentation du dépôt via un chat intégré au navigateur.
• ✅ Ouvert, gratuit et privé : Entièrement open-source et gratuit à utiliser, ne collecte aucune information personnelle ni ne stocke les requêtes, et prend en charge l'auto-hébergement.

🛠️ Fonctionnement

GitMCP utilise le standard Model Context Protocol (MCP) pour connecter les assistants IA aux dépôts GitHub. Ce standard permet aux outils d'IA de demander des informations supplémentaires à des sources externes.

Flux de travail :

1. Fournissez l'URL GitMCP à votre assistant IA (par exemple : gitmcp.io/microsoft/typescript).
2. GitMCP expose des outils tels que la récupération de documentation, la recherche intelligente et la recherche de code.
3. Posez des questions liées à la documentation/au code à votre assistant IA.
4. L'assistant IA envoie une requête à GitMCP pour utiliser ses outils (nécessite votre approbation).
5. GitMCP exécute la requête de l'IA et renvoie les données nécessaires.
6. L'assistant IA reçoit les informations et génère une réponse plus précise et fondée, sans hallucination.

📋 Formats de documentation pris en charge

GitMCP prend actuellement en charge les documents suivants par ordre de priorité :

1. llms.txt - Version de la documentation du projet optimisée pour l'IA.
2. README.md
3. Autres documents dans le répertoire /root.

🔧 Configuration

Choix du format d'URL

Choisissez l'un des formats d'URL suivants en fonction du contenu auquel vous souhaitez vous connecter :

• Dépôt GitHub : gitmcp.io/{owner}/{repo}
• Site GitHub Pages : {owner}.gitmcp.io/{repo}
• Outil générique (prend en charge n'importe quel dépôt, dynamique) : gitmcp.io/docs

Exemples de configuration d'outils IA

Configuration de Cursor

Mettez à jour le fichier ~/.cursor/mcp.json :

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

Configuration de Claude Desktop

Remplacez la configuration dans Paramètres > Développeur > Modifier la configuration :

{
  "mcpServers": {
    "gitmcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://gitmcp.io/{owner}/{repo}"
      ]
    }
  }
}

Configuration de Windsurf

Mettez à jour le fichier ~/.codeium/windsurf/mcp_config.json :

{
  "mcpServers": {
    "gitmcp": {
      "serverUrl": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

🔨 Outils disponibles

1. Récupérer la documentation (fetch_documentation)

Récupère la documentation principale d'un dépôt GitHub, fournissant à l'IA un aperçu du projet en récupérant les documents pertinents (comme llms.txt).

Scénarios d'application : Questions générales sur l'objectif, les fonctionnalités ou les guides de démarrage du projet.

2. Rechercher dans la documentation (search_documentation)

Permet à l'IA de rechercher dans la documentation du dépôt via des requêtes de recherche spécifiques, en utilisant une recherche intelligente pour trouver les sections pertinentes au lieu de charger tous les documents.

Scénarios d'application : Questions spécifiques sur des fonctionnalités, fonctions ou concepts particuliers au sein du projet.

3. Récupérer le contenu des liens (fetch_link_content)

Aide l'IA à obtenir des informations à partir des liens mentionnés dans la documentation, en récupérant le contenu de ces liens et en le convertissant dans un format lisible par l'IA.

Scénarios d'application : Lorsque la documentation fait référence à des informations externes utiles pour répondre à une question.

4. Rechercher dans le code (search_code)

Utilise la fonction de recherche de code de GitHub pour rechercher dans le code réel du dépôt, aidant l'IA à trouver des exemples de code spécifiques ou des détails d'implémentation.

Scénarios d'application : Lorsque des exemples d'implémentation ou des détails techniques non couverts par la documentation sont nécessaires.

📊 Intégration de badges

GitMCP propose des badges de dépôt, permettant aux utilisateurs d'accéder rapidement à la documentation via leur IDE ou leur navigateur, et affichant le nombre de fois où la documentation a été consultée via GitMCP.

Ajouter un badge

Ajoutez le code suivant dans votre README.md :

[![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)

Paramètres de personnalisation du badge

Paramètre	Description	Valeur par défaut	Exemple
color	Couleur de la valeur du badge	aquamarine	?color=green
label	Libellé du badge	GitMCP	Documentation

🛡️ Confidentialité et sécurité

• Engagement de confidentialité : GitMCP accorde une grande importance à la confidentialité des utilisateurs, ne nécessite aucune authentification et ne peut ni accéder ni stocker d'informations personnelles identifiables.
• Requêtes non stockées : Aucune requête envoyée par le proxy n'est stockée.
• Transparence open-source : En tant que projet open-source, il peut être déployé indépendamment dans votre environnement.
• Accès à la demande : Accède uniquement au contenu publiquement disponible, et seulement lorsque l'utilisateur le demande.
• Respect des règles : Vérifie les règles robots.txt avant d'accéder aux sites GitHub Pages et suit les instructions définies par le propriétaire du site.

🚦 Limitations d'utilisation

GitMCP n'accède au contenu que lorsqu'il est interrogé et ne parcourt pas automatiquement les dépôts. Pour les sites GitHub Pages, il vérifie et respecte les règles robots.txt, permettant aux propriétaires de sites de se désengager. GitMCP ne stocke pas de manière permanente les données concernant les projets GitHub ou leur contenu.

💻 Développement et contribution

Exécution locale

# Cloner le dépôt
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# Installer les dépendances
pnpm install

# Exécuter en développement local
npm run dev # ou pnpm dev

Outil d'inspection MCP

# Installer l'outil d'inspection MCP
npx @modelcontextprotocol/inspector

Dans l'interface de l'inspecteur :

• Définissez le type de transport sur SSE.
• Saisissez l'URL GitMCP (par exemple : http://localhost:5173/docs).
• Cliquez sur "Connecter".

📄 Licence

Ce projet est sous licence Apache License 2.0.

⚠️ Clause de non-responsabilité

GitMCP est fourni "tel quel", sans aucune garantie d'aucune sorte. Bien que nous nous efforcions d'assurer la fiabilité et la sécurité du service, nous ne sommes pas responsables des dommages ou problèmes pouvant survenir lors de son utilisation. Les projets GitHub accessibles via GitMCP sont soumis aux termes et conditions de leurs propriétaires respectifs. GitMCP n'est affilié ni à GitHub ni à aucun des outils d'IA mentionnés.