Ref MCP

Ref MCP

Ref MCP ist ein Model Context Protocol (MCP) Server. Er bietet KI-Agenten und Code-Tools schnellen und aktuellen Zugriff auf technische Dokumentationen für APIs, Bibliotheken und Dienste. Das System ermöglicht eine präzise und token-effiziente Abfrage von Dokumentationskontexten, um das Verständnis und die Automatisierung von Code zu verbessern.

Author: ref-tools


Protokoll anzeigen

Was ist Ref MCP?

Ref MCP ist ein spezialisierter MCP-Server. Er verbindet Coding-Agenten und Entwicklertools mit einer kuratierten Sammlung technischer Dokumentationen. Die Agenten können relevante Teile der Dokumentation auf Anfrage suchen, abrufen und analysieren. Das minimiert den Tokenverbrauch und verbessert die Leistung von LLMs bei der Arbeit mit APIs und Bibliotheken.

So konfigurieren Sie Ref MCP

Es gibt zwei Hauptmethoden, um Ref MCP als MCP-Server einzurichten:

1. Streamable HTTP (Empfohlen):

  • Installieren Sie Ref MCP über unterstützte Clients (zum Beispiel Cursor) mit den bereitgestellten Installationslinks oder durch direkte Angabe der Serverkonfiguration:
    "Ref": {
      "type": "http",
      "url": "https://api.ref.tools/mcp?apiKey=YOUR_API_KEY"
    }
    
  • Sie müssen sich bei ref.tools anmelden, um einen API-Schlüssel zu erhalten.

2. Lokaler stdio Server (Legacy):

"Ref": {
  "command": "npx",
  "args": ["ref-tools-mcp@latest"],
  "env": {
    "REF_API_KEY": <your_api_key>
  }
}
  • Benötigt Node.js und npm.

Optional können Sie für die lokale Entwicklung und das Debugging das Ref MCP-Repo klonen, Abhängigkeiten mit npm install installieren und mit npm run dev ausführen.

So verwenden Sie Ref MCP

  1. Verbinden Sie Ihren MCP-fähigen Agenten oder Ihr Tool mit dem Ref MCP-Server anhand der oben beschriebenen Konfiguration.
  2. Nutzen Sie verfügbare Werkzeuge wie ref_search_documentation, um API-Dokumentationen zu durchsuchen oder ref_read_url, um relevante Dokumenteninhalte abzurufen und zusammenzufassen.
  3. Agenten können iterativ suchen und lesen, um den Kontext intelligent auf das Notwendige für die Code-Generierung oder das Verständnis zu reduzieren.
  4. Bei OpenAI-Integrationen passt Ref MCP automatisch seine Werkzeuge an die kompatiblen Funktionsnamen von OpenAI an.

Zur Entwicklung und Überprüfung nutzen Sie den MCP Inspector, um Interaktionen visuell zu testen und zu überwachen.

Hauptmerkmale

  • Token-effiziente Dokumentenretrieval: Gibt nur die kontextrelevanten Abschnitte zurück und vermeidet übermäßige Token-Kosten sowie Leistungseinbußen.
  • Iterativer, agentenfreundlicher Suchprozess: Passt Suchergebnisse innerhalb einer Sitzung an und wiederholt Ergebnisse für ähnliche Eingaben nicht.
  • Kontextanreicherung auf Anfrage: Ermöglicht LLMs, Dokumentationen genau dann abzurufen, wenn und wo sie benötigt werden.
  • Unterstützt öffentliche und private Quellen: Durchsuchen Sie öffentliche Dokumente, Webseiten, GitHub und private Ressourcen wie interne Repos oder PDFs.
  • Integrierte Sitzungsverwaltung: Verfolgt Such- und Leseverlauf innerhalb einer Agentensitzung für eine optimale Kontext-Kuration.
  • Kompatibilität mit OpenAI: Passt automatisch die Benennung von Werkzeugen für eine nahtlose Nutzung mit OpenAIs Forschungs- und Codierungsagenten an.

Anwendungsfälle

  • KI-gesteuerte Code-Assistenten: Erweitern Sie Coding-Agenten (wie Claude Desktop oder Cursor) mit präzisem Zugriff auf technische Dokumentationen.
  • Automatisierte API-Integration: Helfen Sie Agenten, API-Endpunkte zu verstehen, umzusetzen und Fehler zu beheben, indem Sie die relevantesten Dokumentationen bereitstellen.
  • Code-Überprüfungs- und Audit-Bots: Statten Sie Agenten mit der Fähigkeit aus, autoritative Dokumente während der Code-Überprüfung abzurufen und zu zitieren.
  • Entwickler-Onboarding-Tools: Beantworten Sie dynamisch häufige Entwicklerfragen, indem Sie Informationen aus Unternehmens- oder öffentlichen Dokumenten suchen und extrahieren.
  • Tiefgehende technische Recherchen: Abfragen mehrerer Quellen effizient durchführen und sich auf den kleinsten möglichen Kontext konzentrieren, um genaue Antworten zu erhalten.

FAQ

Q1: Warum ist die Minimierung von Token im Dokumentationskontext wichtig?
A1: LLMs neigen dazu, schlechter mit großen, unübersichtlichen Kontextfenstern abzuschneiden, und tokens kosten Geld. Durch das Abrufen nur relevanter Teile der Dokumentation verbessert Ref MCP die Leistung von LLM und verringert unnötige API-Ausgaben.

Q2: Welche Arten von Dokumentationen kann Ref MCP durchsuchen?
A2: Ref MCP durchsucht eine breite Palette öffentlicher Dokumentationen (APIs, Bibliotheken, Web-Dokumente) und kann auch private/internen Ressourcen indexieren, einschließlich GitHub-Repos und PDFs.

Q3: Wie stellt Ref MCP sicher, dass LLM-Agenten nicht dieselben Inhalte wiederholt lesen?
A3: Innerhalb einer aktiven Sitzung verfolgt Ref MCP vorherige Suchen und zurückgegebene Ergebnisse, um sicherzustellen, dass jede ähnliche Suche neue, nicht duplizierte Dokumente liefert. Dies fördert eine effiziente Eingabeaufforderung.

Q4: Kann ich Ref MCP mit meinem eigenen Agenten oder Tool verwenden?
A4: Ja, jeder Agent oder jede Anwendung, die das MCP-Protokoll unterstützt, kann sich über HTTP- oder stdio-Modi mit Ref MCP verbinden.

Q5: Was ist der Unterschied zwischen ref_search_documentation und ref_read_url?
A5: ref_search_documentation findet relevante Dokumentationslinks und -kontexte durch Abfragen; ref_read_url ruft die Zielseite ab und wandelt sie in eine Markdown-Zusammenfassung für eine einfache Nutzung durch Agenten um.