GitMCP Projektdetailbeschreibung

🚀 Projektübersicht

GitMCP ist ein kostenloser, quelloffener Remote Model Context Protocol (MCP)-Server, der jedes GitHub-Projekt (Repository oder GitHub Pages) in ein Dokumentationszentrum verwandeln kann. Er ermöglicht KI-Tools wie Cursor den Zugriff auf die aktuellste Dokumentation und den Code, selbst wenn das LLM diese Inhalte noch nie zuvor gesehen hat, wodurch Code-Halluzinationen nahtlos eliminiert werden.

Kernfunktionen

• 😎 Aktuellste Dokumentation für jedes GitHub-Projekt: Bietet KI-Assistenten nahtlosen Zugriff auf GitHub-Projektdokumentation und -Code, mit integrierter intelligenter Suchfunktion, die der KI hilft, genau das zu finden, was sie benötigt.
• 🧠 Halluzinationen eliminieren: Mit GitMCP können KI-Assistenten genaue und relevante Antworten liefern.
• ☁️ Null-Konfiguration: GitMCP läuft in der Cloud; fügen Sie einfach die GitMCP-URL in Ihrer IDE als MCP-Server hinzu.
• 💬 Eingebetteter Chat: Chatten Sie direkt mit der Repository-Dokumentation über den Browser.
• ✅ Offen, kostenlos und privat: Vollständig quelloffen und kostenlos nutzbar, sammelt keine persönlichen Informationen oder speichert Abfragen, unterstützt Selbst-Hosting.

🛠️ Funktionsweise

GitMCP verwendet den Model Context Protocol (MCP)-Standard, um KI-Assistenten und GitHub-Repositories zu verbinden. Dieser Standard ermöglicht es KI-Tools, zusätzliche Informationen von externen Quellen anzufordern.

Arbeitsablauf:

1. Stellen Sie dem KI-Assistenten die GitMCP-URL zur Verfügung (z.B. gitmcp.io/microsoft/typescript).
2. GitMCP stellt Tools für Dokumentenabruf, intelligente Suche, Codesuche usw. bereit.
3. Stellen Sie dem KI-Assistenten Fragen zur Dokumentation/zum Code.
4. Der KI-Assistent sendet eine Anfrage an GitMCP, um dessen Tools zu verwenden (erfordert Ihre Genehmigung).
5. GitMCP führt die Anfrage der KI aus und gibt die benötigten Daten zurück.
6. Der KI-Assistent empfängt die Informationen und generiert eine genauere, fundiertere Antwort ohne Halluzinationen.

📋 Unterstützte Dokumentformate

GitMCP unterstützt derzeit die folgenden Dokumente in absteigender Prioritätsreihenfolge:

1. llms.txt - Eine für KI optimierte Version der Projektdokumentation
2. README.md
3. Andere Dokumente im /root-Verzeichnis

🔧 Konfiguration

URL-Format-Auswahl

Wählen Sie je nach dem Inhalt, mit dem Sie sich verbinden möchten, eines der folgenden URL-Formate:

• GitHub Repository: gitmcp.io/{owner}/{repo}
• GitHub Pages Website: {owner}.gitmcp.io/{repo}
• Allgemeines Tool (unterstützt jedes Repository, dynamisch): gitmcp.io/docs

KI-Tool-Konfigurationsbeispiele

Cursor-Konfiguration

Aktualisieren Sie die Datei ~/.cursor/mcp.json:

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

Claude Desktop-Konfiguration

Ersetzen Sie die Konfiguration unter Einstellungen > Entwickler > Konfiguration bearbeiten:

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

Windsurf-Konfiguration

Aktualisieren Sie die Datei ~/.codeium/windsurf/mcp_config.json:

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

🔨 Verfügbare Tools

1. Dokumentation abrufen (fetch_documentation)

Ruft die Hauptdokumentation aus einem GitHub-Repository ab, indem relevante Dokumente (wie llms.txt) abgerufen werden, um der KI einen Projektüberblick zu geben.

Anwendungsfälle: Allgemeine Fragen zum Projektzweck, zu Funktionen oder zu den ersten Schritten.

2. Dokumentation durchsuchen (search_documentation)

Ermöglicht der KI, die Repository-Dokumentation anhand spezifischer Suchanfragen zu durchsuchen, wobei eine intelligente Suche verwendet wird, um relevante Abschnitte zu finden, anstatt die gesamte Dokumentation zu laden.

Anwendungsfälle: Spezifische Fragen zu bestimmten Funktionen, Methoden oder Konzepten innerhalb des Projekts.

3. Link-Inhalt abrufen (fetch_link_content)

Hilft der KI, Informationen von in der Dokumentation erwähnten Links abzurufen, indem der Inhalt dieser Links abgerufen und in ein für die KI lesbares Format umgewandelt wird.

Anwendungsfälle: Wenn die Dokumentation auf externe Informationen verweist, die zur Beantwortung einer Frage beitragen.

4. Code durchsuchen (search_code)

Verwendet die GitHub-Codesuchfunktion, um den tatsächlichen Code im Repository zu durchsuchen, was der KI hilft, spezifische Codebeispiele oder Implementierungsdetails zu finden.

Anwendungsfälle: Wenn Implementierungsbeispiele oder technische Details benötigt werden, die nicht in der Dokumentation behandelt werden.

📊 Badge-Integration

GitMCP bietet Repository-Badges, die Benutzern den schnellen Zugriff auf die Dokumentation über die IDE oder den Browser ermöglichen und die Anzahl der Zugriffe auf die Dokumentation über GitMCP anzeigen.

Badge hinzufügen

Fügen Sie den folgenden Code in Ihre README.md ein:

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

Badge-Anpassungsparameter

Parameter	Beschreibung	Standardwert	Beispiel
color	Farbe des Badge-Wertes	aquamarine	?color=green
label	Badge-Beschriftung	GitMCP	Documentation

🛡️ Datenschutz und Sicherheit

• Datenschutzversprechen: GitMCP legt großen Wert auf die Privatsphäre der Benutzer, erfordert keine Authentifizierung und kann keine persönlich identifizierbaren Informationen zugreifen oder speichern.
• Abfragen werden nicht gespeichert: Es werden keine Abfragen gespeichert, die vom Proxy gesendet werden.
• Quelloffene Transparenz: Als quelloffenes Projekt kann es unabhängig in Ihrer Umgebung bereitgestellt werden.
• On-Demand-Zugriff: Greift nur auf öffentlich verfügbare Inhalte zu und dies nur, wenn der Benutzer eine Abfrage stellt.
• Regelkonformität: Überprüft robots.txt-Regeln vor dem Zugriff auf GitHub Pages-Websites und befolgt die vom Website-Besitzer festgelegten Anweisungen.

🚦 Nutzungsbeschränkungen

GitMCP greift nur auf Inhalte zu, wenn es abgefragt wird, und crawlt Repositories nicht automatisch. Für GitHub Pages-Websites werden die robots.txt-Regeln überprüft und befolgt, was Website-Besitzern die Möglichkeit gibt, sich abzumelden. GitMCP speichert keine dauerhaften Daten über GitHub-Projekte oder deren Inhalte.

💻 Entwicklung und Mitwirkung

Lokal ausführen

# Repository klonen
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# Abhängigkeiten installieren
pnpm install

# Lokal für die Entwicklung ausführen
npm run dev # oder pnpm dev

MCP-Inspektor-Tool

# MCP-Inspektor-Tool installieren
npx @modelcontextprotocol/inspector

Im Inspektor-Interface:

• Stellen Sie den Übertragungstyp auf SSE ein.
• Geben Sie die GitMCP-URL ein (z.B. http://localhost:5173/docs).
• Klicken Sie auf "Verbinden".

📄 Lizenz

Dieses Projekt ist unter der Apache License 2.0 lizenziert.

⚠️ Haftungsausschluss

GitMCP wird "wie besehen" und ohne jegliche Gewährleistung bereitgestellt. Obwohl wir uns bemühen, die Zuverlässigkeit und Sicherheit des Dienstes zu gewährleisten, übernehmen wir keine Verantwortung für Schäden oder Probleme, die bei der Nutzung auftreten können. Die über GitMCP zugänglichen GitHub-Projekte unterliegen den jeweiligen Geschäftsbedingungen ihrer Eigentümer. GitMCP ist nicht mit GitHub oder den genannten KI-Tools verbunden.