Dokumentations-RAG-Service (Beta)
Der Dokumentations-RAG-Service (Retrieval-Augmented Generation) bietet KI-gestützte semantische Suchfunktionen für die entsprechende Dokumentation zu Adobe Commerce und App Builder.
Dieses ARG bietet eine IDE-Oberfläche für Fragen zu Adobe Commerce und kann Sie bei Best Practices für die Entwicklung von Anwendungen und anderen Migrationsaufgaben beraten.
Der RAG-Service ist Teil des MCP-Servers (Model Context Protocol) Commerce-Erweiterungstools, der mit Cursor und anderen MCP-kompatiblen KI-Assistenten integriert wird.
Verfügbare Dokumentation
In der folgenden Tabelle wird beschrieben, welche Dokumentation derzeit vom RAG-Service indiziert wird, und welche Keywords Sie verwenden können, um den zugehörigen Trigger zu durchsuchen. Die enthaltene Dokumentation wird mit der Entwicklung des RAG-Service weiter erweitert.
Weitere Informationen zur Indexauswahl finden Sie unter Automatische Indexauswahl und Explizite Indexauswahl.
Ausführliche Informationen zur Dokumentation, die in den einzelnen Indizes enthalten ist, finden Sie in der Liste der aufgenommenen Quellen.
Sicherheit und Datenschutz
- IMS-Authentifizierung - Alle API-Aufrufe verwenden Adobe IMS OAuth2-Token.
- Kein Datenspeicher - Der MCP-Server speichert keine Anmeldeinformationen oder Daten.
- Lokale Ausführung - Alle Tools werden lokal auf Ihrem Computer ausgeführt.
- Sichere Kommunikation - Die Dokumentationssuche verwendet HTTPS mit Token-Validierung.
Der Produktions-Endpunkt ist durch Azure Front Door geschützt, die die folgenden Schutzmaßnahmen umfasst:
- Web Application Firewall (WAF) mit Microsoft Standard RuleSet 2.1 und Bot Manager RuleSet 1.0
- Geoblocking für die von den USA blockierten Regionen (Kuba, Iran, Nordkorea, Syrien, Krim, Luhansk, Donezk)
- DDoS-Schutz am Edge
- API-Management-Backend gesperrt, um nur Traffic von der Haustür zu akzeptieren
Für verschiedene Sicherheitsanforderungen können Sie einen benutzerdefinierten Endpunkt verwenden. Weitere Informationen Sie unter -Endpunkt für benutzerdefinierte Fronttüren .
Voraussetzungen
Stellen Sie vor der Installation Folgendes sicher:
-
Node.js 18+ (LTS empfohlen)
-
Cursor-IDE (empfohlen) oder eine andere MCP-kompatible IDE
note note NOTE Es werden zwar andere MCP-kompatible IDEs unterstützt, für ein optimales Benutzererlebnis wird jedoch Cursor als IDE empfohlen. Wenn Sie eine andere IDE verwenden, müssen Sie die Eingabeaufforderungen und anderen Schritte in der Dokumentation ändern, um mit der ausgewählten IDE zu arbeiten.
Installation
-
Installieren Sie Adobe I/O CLI global:
code language-bash npm install -g @adobe/aio-cli -
Authentifizierung bei Adobe IMS:
code language-bash aio auth login -
Klonen Sie das Repository der Commerce-Erweiterbarkeits-Tools und navigieren Sie zum Verzeichnis :
code language-bash git clone https://github.com/adobe-commerce/commerce-extensibility-tools.git cd commerce-extensibility-tools -
Installieren von Abhängigkeiten:
code language-bash npm install -
Erstellen oder aktualisieren Sie
.cursor/mcp.jsonin Ihrem Commerce-Projektverzeichnis (nicht global), um dencommerce-extensibility-toolsMCP-Server einzuschließen:code language-json { "mcpServers": { "commerce-extensibility-tools": { "command": "node", "args": [ "/<your-project-directory>/commerce-extensibility-tools/index.js" ], "env": { "NODE_ENV": "production" } } } }Ersetzen Sie
<your-project-directory>durch den tatsächlichen Pfad, unter dem Sie das Repository geklont haben.note note NOTE Wenn unter Windows Probleme beim Bereitstellen des Pfads zu Ihrem Projektverzeichnis auftreten, lesen Sie den Abschnitt Fehlerbehebung bei Pfadproblemen. -
Starten Sie die Cursor-IDE zum Laden des MCP-Servers neu.
-
Überprüfen Sie die Installation, indem Sie den KI-Assistenten fragen:
code language-shell-session Can you show me the available Adobe Commerce tools?
Nutzung
Nach der Installation können Sie die Indizes () explizit aufrufen. Sie können auch den Befehl /search-commerce-docs verwenden.
Automatische Indexauswahl (empfohlen)
Indem Sie Fragen in natürlicher Sprache zu Ihrem Commerce-Projekt stellen, durchsucht das Tool automatisch den entsprechenden Dokumentationsindex und stellt relevante Informationen bereit:
Die folgende Eingabeaufforderung wählt automatisch den commerce-storefront-docs aus:
"How do I use Edge Delivery Services drop-ins for product listing?"
Die folgende Eingabeaufforderung wählt automatisch den commerce-extensibility-docs aus:
"How do I create a webhook in Adobe Commerce?"
Die folgende Eingabeaufforderung wählt automatisch den commerce-core-docs aus:
"How to configure product catalog settings?"
Die folgende Eingabeaufforderung wählt automatisch den app-builder-docs aus:
"What are App Builder runtime action best practices?"
Explizite Indexauswahl
Sie können auch den Index angeben, den Sie in der Eingabeaufforderung verwenden möchten.
Search commerce-storefront-docs for authentication drop-in
Using app-builder-docs, how do I deploy runtime actions?
Befehlsbasierte Suche
Wenn Sie sicherstellen möchten, dass der RAG-Service verwendet wird, können Sie den /search-commerce-docs Cursor-Befehl manuell aufrufen, um die Dokumentation an Ihrer Eingabeaufforderung zu durchsuchen:
/search-commerce-docs "How do I subscribe to Commerce events?"
Benutzerdefinierter Endpunkt der Fronttür
Standardmäßig verwendet die Dokumentationssuche den Produktions-Endpunkt Azure Front Door mit WAF-Schutz. Zu Test- oder Entwicklungszwecken können Sie dies mit der Umgebungsvariablen FRONT_DOOR_URL überschreiben.
Um einen benutzerdefinierten Endpunkt zu verwenden, fügen Sie ihn Ihrer Cursor-MCP-Konfiguration hinzu:
{
"mcpServers": {
"commerce-extensibility-tools": {
"command": "node",
"args": ["/<your-project-directory>/commerce-extensibility-tools/index.js"],
"env": {
"NODE_ENV": "production",
"FRONT_DOOR_URL": "https://<custom-endpoint>.azurefd.net"
}
}
}
}
FRONT_DOOR_URL nicht festlegen.Fehlerbehebung
In den folgenden Abschnitten finden Sie Tipps zur Fehlerbehebung bei häufigen Problemen, die bei der Verwendung des Dokumentations-RAG-Service auftreten können.
Authentifizierungsfehler
Das Dokumentationssuch-Tool erfordert die Adobe IMS-Authentifizierung. Wenn Authentifizierungsfehler auftreten, führen Sie die folgenden Schritte aus, um das Problem zu beheben.
-
Vergewissern Sie sich, dass Sie angemeldet sind:
code language-bash aio where -
Vergewissern Sie sich, dass Ihr IMS-Token angezeigt wird:
code language-bash aio auth login --bare -
Wenn die Authentifizierungsfehler weiterhin bestehen, versuchen Sie, sich abzumelden und wieder anzumelden:
code language-bash aio auth logout aio auth login
MCP-Server wird nicht geladen
Wenn der MCP-Server keine Verbindung herstellt oder Ihr Agent sagt, dass er keine Verbindung zum RAG herstellen kann, führen Sie die folgenden Schritte aus, um das Problem zu beheben.
-
Öffnen Sie die Cursoreinstellungen mit Befehl , (macOS) oder Strg , (Windows und Linux).
-
Suchen Sie nach „MCP“ und stellen Sie sicher, dass
commerce-extensibility-toolsaufgeführt und aktiviert ist. -
Prüfen Sie das Bedienfeld MCP-Einstellungen auf Fehlermeldungen.
-
Überprüfen Sie, ob die
mcp.jsonDatei in Ihrem Projekt vorhanden ist:code language-bash cat .cursor/mcp.json -
Überprüfen Sie, ob der Pfad korrekt und absolut ist:
code language-bash ls -la /<your-project-directory>/commerce-extensibility-tools/index.js
Tool nicht gefunden
-
Beenden Sie den Cursor und öffnen Sie ihn erneut.
-
Überprüfen Sie die MCP-Serverprotokolle in der Cursor-Entwicklerkonsole, indem Sie Befehlstaste+Umschalt+P (macOS) oder Strg+Umschalt+P (Windows/Linux) verwenden und nach „Entwickler: Ordner „Protokolle öffnen“ suchen.
-
Überprüfen Sie die Installation:
code language-bash cd commerce-extensibility-tools npm install node index.jsDer Server sollte fehlerfrei starten.
Pfadprobleme (Windows)
Verwenden Sie unter Windows Schrägstriche / oder umgekehrte Schrägstriche mit Escape-Zeichen \\:
{
"args": ["C:/Users/yourname/projects/commerce-extensibility-tools/index.js"]
}
{
"args": ["C:\\Users\\yourname\\projects\\commerce-extensibility-tools\\index.js"]
}