GitMCP

GitMCP

🤔 Was ist GitMCP?

Hören Sie auf, Stimmungshalluzinationen zu haben, und beginnen Sie mit der Stimmungscodierung!

GitMCP ist ein kostenloser, Open-Source-Remote -MCP-Server (Model Context Protocol) , der jedes GitHub-Projekt (Repositories oder GitHub-Seiten) in einen Dokumentations-Hub verwandelt. Er ermöglicht KI-Tools wie Cursor den Zugriff auf aktuelle Dokumentation und Code, selbst wenn der LLM diese noch nie zuvor verwendet hat. Dadurch werden Code-Halluzinationen nahtlos eliminiert.

GitMCP unterstützt zwei Varianten -

• Spezifisches Repository ( gitmcp.io/{owner}/{repo} oder {owner}.gitmcp.io/{repo} ): Verwenden Sie diese Option, wenn Sie hauptsächlich mit einer ausgewählten Anzahl von Bibliotheken arbeiten. Dadurch wird sichergestellt, dass Ihr KI-Assistent immer das richtige Projekt anvisiert. Dies erhöht die Sicherheit und Relevanz, indem der Zugriff auf unbeabsichtigte Repositorys verhindert wird.
• Generischer Server ( gitmcp.io/docs ): Nutzen Sie diesen für maximale Flexibilität, wenn Sie häufig zwischen verschiedenen Repositorys wechseln müssen. Der KI-Assistent fragt Sie (oder entscheidet kontextbezogen), auf welches Repository bei jeder Anfrage zugegriffen werden soll. Beachten Sie, dass dies jedes Mal die korrekte Identifizierung des Ziel-Repositorys voraussetzt.

Mit GitMCP:

• KI-Assistenten greifen direkt von der Quelle auf die neueste Dokumentation und den neuesten Code zu.
• Erhalten Sie genaue API-Nutzung und zuverlässige Codebeispiele.
• Arbeiten Sie effektiv, auch mit Nischenbibliotheken, neuen Bibliotheken oder Bibliotheken, die sich schnell verändern.
• Deutlich reduzierte Halluzinationen und verbesserte Codekorrektheit.

Dieser Nebeneinandervergleich zeigt beispielsweise das Ergebnis für dieselbe einmalige Eingabeaufforderung im Cursor beim Erstellen einer Three.js- Szene -

https://github.com/user-attachments/assets/fbf1b4a7-f9f0-4c0e-831c-4d64faae2c45

✨ Funktionen

• 😎 Aktuelle Dokumentation zu JEDEM GitHub-Projekt : Gewähren Sie Ihrem KI-Assistenten nahtlosen Zugriff auf die Dokumentation und den Code des GitHub-Projekts. Die integrierten intelligenten Suchfunktionen helfen dabei, genau das zu finden, was die KI benötigt, ohne zu viele Token zu verwenden!
• 🧠 Keine Halluzinationen mehr : Mit GitMCP kann Ihr KI-Assistent genaue und relevante Antworten auf Ihre Fragen geben.
• ☁️ Keine Einrichtung : GitMCP läuft in der Cloud. Fügen Sie einfach die gewählte GitMCP-URL als MCP-Server in Ihre IDE ein – es sind keine Downloads, Installationen, Anmeldungen oder Änderungen erforderlich.
• 💬 Eingebetteter Chat : Beginnen Sie schnell, indem Sie über unseren In-Browser-Chat direkt mit der Dokumentation des Repositorys chatten!
• ✅ Offen, kostenlos und privat : GitMCP ist Open Source und völlig kostenlos nutzbar. Es sammelt keine persönlichen Daten und speichert keine Abfragen. Sie können es sogar selbst hosten!

🚀 Erste Schritte

Die Verwendung von GitMCP ist ganz einfach! Folgen Sie einfach diesen Schritten:

Schritt 1: Wählen Sie den gewünschten Servertyp

Wählen Sie eines dieser URL-Formate, je nachdem, womit Sie eine Verbindung herstellen möchten:

• Für GitHub-Repositorys: gitmcp.io/{owner}/{repo}
• Für GitHub Pages-Sites: {owner}.gitmcp.io/{repo}
• Für ein generisches Tool, das jedes Repository unterstützt (dynamisch): gitmcp.io/docs

Ersetzen Sie {owner} durch den GitHub-Benutzernamen oder den Organisationsnamen und {repo} durch den Repository-Namen.

Sie können der Einfachheit halber auch das Konvertierungstool auf der Zielseite verwenden, um die GitHub-URL in eine MCP-URL zu formatieren!

Schritt 2: Verbinden Sie Ihren KI-Assistenten

Wählen Sie Ihren KI-Assistenten aus den folgenden Optionen aus und folgen Sie den Konfigurationsanweisungen:

Verbindungscursor

Aktualisieren Sie Ihre Cursor-Konfigurationsdatei unter ~/.cursor/mcp.json :

Claude Desktop verbinden

1. Gehen Sie in Claude Desktop zu Einstellungen > Entwickler > Konfiguration bearbeiten
2. Ersetzen Sie die Konfiguration durch:
   { "mcpServers": { "gitmcp": { "command": "npx", "args": [ "mcp-remote", "https://gitmcp.io/{owner}/{repo}" ] } } }

Connecting Windsurf

Aktualisieren Sie Ihre Windsurf-Konfigurationsdatei unter ~/.codeium/windsurf/mcp_config.json :

VSCode verbinden

Aktualisieren Sie Ihre VSCode-Konfigurationsdatei unter .vscode/mcp.json :

Cline verbinden

Aktualisieren Sie Ihre Cline-Konfigurationsdatei unter ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json :

Hervorheben von KI verbinden

1. Öffnen Sie Highlight AI und klicken Sie in der Seitenleiste auf das Plugin-Symbol (@-Symbol)
2. Klicken Sie oben in der Seitenleiste auf Installierte Plugins
3. Benutzerdefiniertes Plugin auswählen
4. Klicken Sie auf „Plugin mit einer benutzerdefinierten SSE-URL hinzufügen“.

Plugin-Name: gitmcp SSE-URL: https://gitmcp.io/{owner}/{repo}

Weitere Einzelheiten zum Hinzufügen benutzerdefinierter MCP-Server zu HighlightAI finden Sie in der Dokumentation .

Hinweis: Denken Sie daran, {owner} und {repo} durch den tatsächlichen GitHub-Benutzernamen/die Organisation und den Repository-Namen zu ersetzen. Sie können auch den dynamischen Endpunkt https://gitmcp.io/docs verwenden, um Ihrer KI bei Bedarf Zugriff auf jedes Repository zu ermöglichen.

⚙ So funktioniert es

GitMCP verbindet Ihren KI-Assistenten mit GitHub-Repositorys mithilfe des Model Context Protocol (MCP), einem Standard, der es KI-Tools ermöglicht, zusätzliche Informationen von externen Quellen anzufordern.

Was passiert, wenn Sie GitMCP verwenden:

1. Sie geben Ihrem KI-Assistenten die GitMCP-URL (z. B. gitmcp.io/microsoft/typescript ) an. GitMCP stellt Tools wie das Abrufen von Dokumentation, die intelligente Suche, die Codesuche usw. bereit.
2. Geben Sie dem KI-Assistenten Fragen zur Dokumentation/zum Code.
3. Ihre KI sendet Anfragen an GitMCP, um deren Tools zu verwenden (mit Ihrer Zustimmung).
4. GitMCP führt die Anfrage der KI aus und gibt die angeforderten Daten zurück.
5. Ihre KI empfängt die Informationen und generiert eine genauere, fundiertere Antwort ohne Halluzinationen.

Unterstützte Dokumentation

GitMCP unterstützt derzeit die folgenden Dokumente (in der Reihenfolge ihrer Priorität):

1. llms.txt
2. KI-optimierte Version der Projektdokumentation
3. README.md /root

💡 Beispiele

Hier sind einige Beispiele für die Verwendung von GitMCP mit verschiedenen KI-Assistenten und Repositories:

Beispiel 1: Windsurf mit einem bestimmten Repository verwenden

Fügen Sie für das GitHub-Repository https://github.com/microsoft/playwright-mcp https://gitmcp.io/microsoft/playwright-mcp als MCP-Server zu Windsurf hinzu.

Aufforderung an Claude:

„Wie verwende ich das Playwright MCP?“

Windsurf wird die relevante Dokumentation von GitMCP abrufen, um die Speicherfunktion korrekt zu implementieren.

Beispiel 2: Verwenden von Cursor mit einer GitHub Pages-Site

Fügen Sie für die GitHub Pages-Site langchain-ai.github.io/langgraph https://langchain-ai.gitmcp.io/langgraph als MCP-Server zu Cursor hinzu.

Eingabeaufforderung zum Cursor:

„Speicher zu meinem LangGraph-Agenten hinzufügen“

Cursor ruft die relevante Dokumentation und den Code von GitMCP ab, um die Speicherfunktion korrekt zu implementieren.

Beispiel 3: Verwenden von Claude Desktop mit dem dynamischen Endpunkt

Sie müssen keine bestimmten Repositories auswählen. Der generische Endpunkt gitmcp.io/docs ermöglicht es der KI, das GitHub-Projekt spontan auszuwählen!

Aufforderung an jeden KI-Assistenten:

„Ich möchte mehr über das Spracherkennungsmodell OpenAI Whisper erfahren. Erklären Sie, wie es funktioniert.“

Claude wird die Daten von GitMCP abrufen und die Frage beantworten.

🛠️ Werkzeuge

GitMCP stellt KI-Assistenten mehrere wertvolle Tools zur Verfügung, die ihnen beim Zugriff auf GitHub-Repositorys, beim Verstehen und Abfragen helfen.

fetch_<repo-name>_documentation

Dieses Tool ruft die Primärdokumentation aus einem GitHub-Repository ab. Es ruft relevante Dokumentation ab (z. B. llms.txt ). Dies gibt der KI einen guten Überblick über das Projekt.

Wann es nützlich ist: Bei allgemeinen Fragen zum Zweck, den Funktionen oder zum Einstieg eines Projekts

search_<repo-name>_documentation

Mit diesem Tool kann die KI die Dokumentation eines Repositorys mithilfe einer spezifischen Suchanfrage durchsuchen. Anstatt die gesamte Dokumentation (die sehr umfangreich sein kann) zu laden, nutzt sie eine intelligente Suche, um nur die relevanten Teile zu finden.

Wann es nützlich ist: Für spezifische Fragen zu bestimmten Features, Funktionen oder Konzepten innerhalb eines Projekts

fetch_url_content

Dieses Tool hilft der KI, Informationen aus den in der Dokumentation genannten Links abzurufen. Es ruft den Inhalt dieser Links ab und konvertiert ihn in ein für die KI leicht lesbares Format.

Wann es nützlich ist: Wenn die Dokumentation auf externe Informationen verweist, die bei der Beantwortung Ihrer Frage helfen könnten

search_<repo-name>_code

Dieses Tool durchsucht den eigentlichen Code im Repository mithilfe der Codesuche von GitHub. Es hilft der KI, spezifische Codebeispiele oder Implementierungsdetails zu finden.

Wann es nützlich ist: Wenn Sie Beispiele für die Implementierung benötigen oder technische Details, die in der Dokumentation nicht behandelt werden

Hinweis: Bei Verwendung des dynamischen Endpunkts ( gitmcp.io/docs ) werden diese Tools etwas anders benannt ( fetch_generic_documentation , search_generic_code und search_generic_documentation ) und benötigen zusätzliche Informationen darüber, auf welches Repository zugegriffen werden soll.

📊 Abzeichen

GitMCP verfügt über ein Badge für die README-Datei Ihres Repositorys. Damit können Benutzer über ihre IDE oder ihren Browser (über den eingebetteten Chat) schnell auf Ihre Dokumentation zugreifen. Außerdem wird angezeigt, wie oft Ihre Dokumentation über GitMCP aufgerufen wurde.

Beispiel ( idosal/git-mcp ):

Hinzufügen des Badges zu Ihrem Repository

Fügen Sie Ihrer README.md Folgendes hinzu:

Ersetzen Sie OWNER durch Ihren GitHub-Benutzernamen oder Ihre GitHub-Organisation und REPO durch Ihren Repository-Namen.

So zählen wir Aufrufe

Inkrement für jeden Tool-Aufruf im jeweiligen Repository.

Anpassen des Abzeichens

Sie können das Erscheinungsbild des Abzeichens mit Parametern anpassen:

Bitte melden Sie sich!

❓ Häufig gestellte Fragen

Was ist das Model Context Protocol?

Das Model Context Protocol ist ein Standard, der es KI-Assistenten ermöglicht, zusätzlichen Kontext von externen Quellen auf strukturierte Weise anzufordern und zu empfangen, wodurch ihr Verständnis und ihre Leistung verbessert werden.

Funktioniert GitMCP mit jedem KI-Assistenten?

Ja, GitMCP ist mit jedem KI-Assistenten kompatibel, der das Model Context Protocol unterstützt, einschließlich Tools wie Cursor, VSCode, Claude usw.

Ist GitMCP mit allen GitHub-Projekten kompatibel?

Absolut! GitMCP funktioniert mit jedem öffentlichen GitHub-Repository, ohne dass Änderungen erforderlich sind. Es priorisiert die Datei llms.txt und greift auf README.md oder andere Seiten zurück, falls diese nicht verfügbar ist. Zukünftige Updates zielen darauf ab, zusätzliche Dokumentationsmethoden zu unterstützen und sogar Inhalte dynamisch zu generieren.

Kostet GitMCP Geld?

Nein, GitMCP ist ein kostenloser Dienst für die Community ohne damit verbundene Kosten.

🔒 Datenschutz

GitMCP legt größten Wert auf die Privatsphäre seiner Nutzer. Der Dienst greift nicht auf personenbezogene Daten zu und speichert diese auch nicht, da keine Authentifizierung erforderlich ist. Darüber hinaus speichert er keine von den Agenten gesendeten Anfragen. Da GitMCP ein Open-Source-Projekt ist, kann es unabhängig in Ihrer Umgebung eingesetzt werden.

GitMCP greift nur auf öffentlich verfügbare Inhalte zu und nur auf Anfrage eines Benutzers. GitMCP durchsucht Repositories nicht automatisch. Vor dem Zugriff auf eine GitHub Pages-Site prüft der Code die robots.txt -Regeln und befolgt die Anweisungen der Site-Inhaber, sodass diese sich abmelden können. Bitte beachten Sie, dass GitMCP keine Daten zu den GitHub-Projekten oder deren Inhalten dauerhaft speichert.

👥 Beitragen

Wir freuen uns über Beiträge, Feedback und Ideen! Bitte beachten Sie unsere Beitragsrichtlinien .

Lokales Entwicklungs-Setup

1. Klonen Sie das Repository
   git clone https://github.com/idosal/git-mcp.git cd git-mcp
2. Abhängigkeiten installieren
   pnpm install
3. Für die Entwicklung lokal ausführen
   npm run dev # or pnpm dev

Verwenden von MCP Inspector zum Testen

1. Installieren Sie das MCP Inspector-Tool:
   npx @modelcontextprotocol/inspector
2. In der Inspektorschnittstelle:
   • Transporttyp auf SSE einstellen
   • Geben Sie Ihre GitMCP-URL ein (z. http://localhost:5173/docs ).
   • Klicken Sie auf „Verbinden“

📄 Lizenz

Dieses Projekt ist unter der Apache-Lizenz 2.0 lizenziert.

Haftungsausschluss

GitMCP wird „wie besehen“ und ohne jegliche Gewährleistung bereitgestellt. Obwohl wir die Zuverlässigkeit und Sicherheit unseres Dienstes gewährleisten, haften wir nicht für Schäden oder Probleme, die sich aus seiner Nutzung ergeben. Für GitHub-Projekte, auf die über GitMCP zugegriffen wird, gelten die Geschäftsbedingungen der jeweiligen Eigentümer. GitMCP steht in keiner Verbindung zu GitHub oder den genannten KI-Tools.

Sternengeschichte