GitMCP: Der MCP-Dienst zur Erstellung von Wissensdatenbanken aus GitHub-Projekten

Allgemeine Einführung

GitMCP ist ein kostenloses Open-Source-Tool, das speziell für öffentliche Projekte auf GitHub entwickelt wurde. Es kann jedes GitHub-Repository oder jede GitHub Pages-Website schnell in einen MCP-Dienst (Model Context Protocol) verwandeln, der eine Wissensdatenbank für ein Projekt erstellt. Diese Wissensdatenbank enthält Dokumentation und Codeinhalte, auf die KI-Assistenten direkt zugreifen und sie verstehen können. Benutzer ersetzen einfach "github.com" durch "gitmcp.io" oder "username.github.io" durch "username.gitmcp.io" im Link, um die Wissensdatenbank zu generieren, die es der KI ermöglicht, Fragen zu beantworten, den Code zu analysieren und nach Informationen zu suchen, ohne dass eine komplexe Einrichtung erforderlich ist.

Funktionsliste

• Schnelle Erzeugung MCP Server: Erstellen Sie einen MCP-Server für jedes öffentliche GitHub-Repository oder jede GitHub Pages-Website.
• Unterstützung für den KI-Dokumentenzugriff: Lassen Sie KI die Dokumente des Repositorys lesen llms.txtundREADME.md und andere Dokumente, um das Verständnis des Kontextes zu verbessern.
• Keine Einrichtung erforderlich: Ersetzen Sie einfach den URL-Domainnamen, und schon können Sie loslegen, ohne dass eine zusätzliche Konfiguration erforderlich ist.
• Semantische Suchoptimierung: Bietet eine Dokumentensuchfunktion, mit der KI schnell relevante Inhalte finden kann.
• Unterstützung für mehrere KI-Tools: Kompatibel mit Tools, die das MCP-Protokoll unterstützen, wie Claude, Cursor, VSCode, und so weiter.
• Open Source und kostenlos: Die Nutzer können den Dienst selbst nutzen und einsetzen.
• Unterstützung dynamischer Endpunkte: über gitmcp.io/docs Dynamischer Zugriff auf jedes Repository.

Hilfe verwenden

GitMCP ist einfach zu bedienen und wurde für Entwickler entwickelt, damit KI GitHub-Projekte effizienter verstehen kann. Hier finden Sie eine detaillierte Beschreibung der Verwendung, einschließlich spezifischer Schritte und Funktionsabläufe.

Wie man anfängt

GitMCP erfordert keine Software-Installation, sondern lediglich eine URL-Anpassung, um AI Zugriff auf Ihr Projekt zu geben. Die Schritte sind wie folgt:

1. Holen Sie sich den GitHub-Link
   • Für Lagerhäuser: zum Beispiel https://github.com/octocat/Hello-World.
   • Für GitHub-Seiten: zum Beispiel https://octocat.github.io/Hello-World.
2. Ersetzung des Domänennamens
   • Lagerhaus-Link: put github.com Anpassung (einer Geschichte an ein anderes Medium) gitmcp.iowerden. https://gitmcp.io/octocat/Hello-World.
   • GitHub Pages Link: put username.github.io Anpassung (einer Geschichte an ein anderes Medium) username.gitmcp.iowerden. https://octocat.gitmcp.io/Hello-World.
3. AI-Tools konfigurieren
   Hinzufügen neuer Links zu MCP-fähigen AI-Tools (z. B. Claude oder Cursor). Siehe unten für Details zur Konfiguration.
4. Testwirkung
   Einmal konfiguriert, ist die KI in der Lage, den Inhalt des Projekts zu lesen und relevante Fragen direkt zu beantworten.

Konfigurieren eines AI-Tools Beispiel

Am Beispiel von Claude sehen die Konfigurationsschritte wie folgt aus:

• Öffnen Sie die Konfigurationsdatei von Claude (normalerweise die claude_config.json).
• Fügen Sie die Adresse des GitMCP-Servers hinzu:

  {
  "mcpServers": {
  "gitmcp": {
  "command": "https://gitmcp.io/{owner}/{repo}",
  "args": [],
  "env": {}
  }
  }
  }
  

• Oberbefehlshaber (Militär) {owner} im Gesang antworten {repo} Ersetzen Sie ihn durch Ihren GitHub-Benutzernamen und den Namen des Repositorys, z. B. octocat im Gesang antworten Hello-World.
• Speichern Sie die Konfiguration und Claude kann nun über GitMCP auf das Projekt zugreifen.

Im Falle von Cursor ist die Vorgehensweise ähnlich:

• zeigen (eine Eintrittskarte) Cursor Die Einstellungsseite des
• In den MCP-Server-Optionen geben Sie ein https://gitmcp.io/octocat/Hello-World.
• Nach dem Speichern lädt der Cursor automatisch den Inhalt des Projekts.

Dynamische Endpunktverwendung

GitMCP bietet einen dynamischen Endpunkt https://gitmcp.io/docsEs ist nicht erforderlich, Lagerhäuser im Voraus zu benennen.

• Konfigurieren Sie diesen Endpunkt im AI-Tool.
• Wenn sie verwendet wird, gibt die KI dynamisch {owner} im Gesang antworten {repo}Zum Beispiel mit dem Befehl fetch_generic_documentation("octocat", "Hello-World") Holen Sie sich das Dokument.
• Dies eignet sich für Szenarien, die einen vorübergehenden Zugriff auf mehrere Repositories erfordern.

Hauptfunktionen

1. die Generation der MCP-Server

• Geben Sie einen neuen Link ein (z.B. https://gitmcp.io/octocat/Hello-World), erzeugt GitMCP automatisch einen MCP-Server für das Repository.
• Für GitHub Pages verwenden Sie die https://octocat.gitmcp.io/Hello-World Gleichermaßen wirksam.
• Ein Browser-Besuch des Links bestätigt, dass er korrekt generiert wird.

2. der Zugang von AI zu Dokumenten

• Sobald sie konfiguriert ist, priorisiert die KI das Lesen llms.txtWenn nicht, lesen Sie README.md oder andere Dokumente.
• So funktioniert es: Stellen Sie dem KI-Tool eine Frage, z. B. "Was ist die Hauptfunktion dieses Projekts?" Die KI wird die Frage anhand der Dokumentation beantworten.
• Stellen Sie sicher, dass das Repository klar dokumentiert ist, damit die KI es besser verstehen kann.

3. semantische Suchfunktion

• ausnutzen search_<repo-name>_documentation geben Sie eine Abfrage ein (z. B. query: "如何安装").
• Die KI gibt die relevantesten Dokumentausschnitte im Repository zurück.
• Für dynamische Endpunkte verwenden Sie die search_generic_documentation("octocat", "Hello-World", "如何安装").
• Dies kann die Kosten der KI für die Verarbeitung irrelevanter Informationen verringern.

Praktische Werkzeugbeschreibungen

• fetch_<repo-name>_documentation
  Holen Sie sich die Dokumentation für das gesamte Projekt, um Fragen wie "Wozu dient dieses Repository" zu beantworten.
  Beispiel:fetch_hello-world_documentation zurückkommen (oder gehen) README.md Inhalt.
• search_<repo-name>_documentation
  Die Suche nach einer Dokumentation für ein bestimmtes Problem eignet sich gut, um Fragen wie "Wie verwende ich diese Funktion" zu stellen.
  Beispiel:search_hello-world_documentation("安装步骤") Geben Sie die entsprechende Beschreibung zurück.

caveat

• Nur öffentliche ProjekteGitMCP unterstützt nur öffentliche Repositories und GitHub Pages, nicht aber private Projekte.
• robots.txt prüfenGitHub Pages: Für GitHub Pages hält sich GitMCP an die robots.txt Regeln, die nicht verwendet werden können, wenn der Zugriff deaktiviert ist.
• Werkzeug-KompatibilitätVergewissern Sie sich, dass Ihr AI-Tool das MCP-Protokoll unterstützt, andernfalls müssen Sie das Tool wechseln.
• Qualität der DokumenteJe ausführlicher die Repository-Dokumentation ist, desto genauer ist die KI-Antwort.

Tipp

• Fügen Sie im Stammverzeichnis des Repositorys die Datei llms.txtdie auf Kontext für KI spezialisiert sind, können die Ergebnisse verbessern.
• Um den Link zu testen, geben Sie die neue URL direkt in Ihren Browser ein und prüfen Sie, ob Sie darauf zugreifen können.
• Wenn Sie mehrere Projekte bearbeiten müssen, können Sie sie mit dynamischen Endpunkten in großen Mengen konfigurieren.

Mit diesen Schritten macht GitMCP Ihren KI-Assistenten in Minutenschnelle mit GitHub-Projekten vertraut und konfiguriert.

Anwendungsszenario

1. Optimierter Code für Entwickler
   Sie haben ein GitHub-Repository und möchten, dass KI Sie beim Einchecken des Codes unterstützt. Wenn GitMCP konfiguriert ist, kann KI Code und Dokumentation direkt lesen und Verbesserungen vorschlagen.
2. Anfrage zur Teamdokumentation
   Teams haben komplexe Projektdokumentationen, die neue Mitglieder nicht verstehen können. Mit GitMCP kann AI schnell die Frage beantworten: "Wie funktioniert dieses Modul?
3. Lernen von Open-Source-Code
   Sie recherchieren im öffentlichen Repository eines anderen und möchten die Funktionen verstehen. GitMCP lässt KI wichtige Informationen extrahieren, um Ihren Lernprozess zu beschleunigen.
4. Dynamische Projektverwaltung
   Wenn Sie vorübergehend mehrere Lager analysieren müssen, verwenden Sie die gitmcp.io/docs Dynamische Endpunkte, bei denen die KI die Zielobjekte jederzeit wechseln kann.

QA

1. Welche Dateien werden von GitMCP unterstützt?
   Sie gibt dem Lesen Vorrang llms.txtWenn nicht, lesen Sie README.md oder andere Seiten, und möglicherweise werden in Zukunft weitere Formate unterstützt.
2. Kann ich es in einem privaten Repository verwenden?
   Nein. GitMCP unterstützt nur öffentliche Projekte, private Repositories sind nicht zugänglich.
3. AI-Tools unterstützen MCP nicht, was soll ich tun?
   Sie müssen zu einem Tool wechseln, das MCP unterstützt, z. B. Claude, Cursor, oder prüfen, ob es ein Plugin dafür gibt.
4. Was ist, wenn sich der Link nicht öffnen lässt?
   Vergewissern Sie sich, dass das Repository öffentlich ist, dass das Netzwerk funktioniert oder dass der Zugriff auf das https://github.com/idosal/git-mcp Eine Frage einreichen.