[Alleen SaaS]{class="badge positive" title="Alleen van toepassing op Adobe Commerce as a Cloud Service- en Adobe Commerce Optimizer-projecten (door Adobe beheerde SaaS-infrastructuur)."}

Documentatie RAG-service (Beta)

NOTE
De documentatie-RAG-service bevindt zich momenteel in Beta en de ervaring kan worden gewijzigd.

De documentatie-RAG-service (Retrieval-Augmented Generation) biedt semantische zoekmogelijkheden van AI in alle relevante documentatie van Adobe Commerce en App Builder.

Deze RAG verstrekt een interface van winde voor het stellen van vragen over Adobe Commerce en kan u adviseren over beste praktijken voor het ontwikkelen van toepassingen en andere migratietaken.

De dienst van RAG maakt deel uit van de ​ de rekbaarheidshulpmiddelen van Commerce ​ MCP (ModelProtocol van de Context) server, die met Cursor en andere MCP-compatibele AI medewerkers integreert.

Beschikbare documentatie

De volgende lijst beschrijft welke documentatie momenteel door de dienst van RAG wordt geïndexeerd, en de sleutelwoorden u kunt gebruiken om het zoeken van de bijbehorende index teweeg te brengen. De bijgevoegde documentatie zal verder worden uitgebreid naarmate we de RAG-dienst ontwikkelen.

Categorie
Index
Inhoud inbegrepen
Trefwoorden
​ Storefront ​
commerce-storefront-doc
Edge Delivery Services, drop-ins, storefront componenten
winkel, drop-in, EDS, productaanbieding, kassa
​ Uitbreidbaarheid ​
handel-rekbaarheid-documenten
Webhaken, gebeurtenissen, extensies, integratie
webhaak, gebeurtenis, extensie, API-net, GraphQL
​ Commerce ​
commerce-core-docs
Core Commerce (catalogus, klanten, bestellingen)
catalogus, product, klant, bestelling, voorraad
​ App Builder ​
app-builder-docs
App Builder, handelingen bij uitvoering, UI-extensies
app builder, runtime actie, React Spectrum

Voor meer informatie over indexselectie, verwijs naar ​ Automatische indexselectie ​ en ​ Expliciete indexselectie ​.

Voor gedetailleerde informatie over de documentatie inbegrepen in elke index, verwijs naar ​ ingebedde bronlijst ​.

Veiligheid en privacy

  • IMS authentificatie - Alle API vraag gebruikt de tokens van Adobe IMS OAuth2.
  • Geen gegevensopslag - de server MCP slaat geen geloofsbrieven of gegevens op.
  • Lokale uitvoering - alle hulpmiddelen lopen plaatselijk op uw machine.
  • Veilige mededeling - het onderzoek van de Documentatie gebruikt HTTPS met symbolische bevestiging.

Het productieeindpunt wordt beschermd door ​ Azure Voorste Door ​, die de volgende bescherming omvat:

  • Web Application Firewall (WAF) met Microsoft Default RuleSet 2.1 en Bot Manager RuleSet 1.0
  • Geoblokkering voor door de VS verboden gebieden (Cuba, Iran, Noord-Korea, Syrië, Krim, Luhansk, Donetsk)
  • DoS-beveiliging aan de rand
  • API-beheerbackend vergrendeld om alleen verkeer van de voordeur te accepteren

Voor verschillende veiligheidseisen, kunt u een douaneeindpunt gebruiken. Zie ​ Eigen Voorste eindpunt van de Deur van de Douane ​ voor meer informatie.

Vereisten

Controleer voordat u gaat installeren of:

  • ​ Node.js ​ 18+ (Aanbevolen LTS)

  • ​ winde van de Curseur ​ (geadviseerd) of een andere MCP-compatibele winde

    note note
    NOTE
    Terwijl andere MCP-compatibele IDEs wordt gesteund, is de Cursor geadviseerde winde voor de beste ervaring. Als u een andere winde gebruikt, zult u de herinneringen en andere stappen in de documentatie moeten wijzigen om met uw geselecteerde winde te werken.

Installatie

  1. Installeer ​ CLI van Adobe I/O ​ globaal:

    code language-bash
    npm install -g @adobe/aio-cli
    
  2. Verifiëren met Adobe IMS:

    code language-bash
    aio auth login
    
  3. Clone the Commerce rekability tools repository and navigate to the directory:

    code language-bash
    git clone https://github.com/adobe-commerce/commerce-extensibility-tools.git
    cd commerce-extensibility-tools
    
  4. Afhankelijkheden installeren:

    code language-bash
    npm install
    
  5. Maak of werk .cursor/mcp.json bij in uw Commerce-projectmap (niet globaal) om de commerce-extensibility-tools MCP-server op te nemen:

    code language-json
    {
      "mcpServers": {
        "commerce-extensibility-tools": {
          "command": "node",
          "args": [
            "/<your-project-directory>/commerce-extensibility-tools/index.js"
          ],
          "env": {
            "NODE_ENV": "production"
          }
        }
      }
    }
    

    Vervang <your-project-directory> door het werkelijke pad waar u de opslagplaats hebt gekloond.

    note note
    NOTE
    Op Vensters, als u kwesties met het verstrekken van de weg aan uw projectfolder ontmoet, verwijs naar ​ de kwesties van de Weg oplossen van problemen ​.
  6. Start de IDE van de cursor opnieuw om de MCP-server te laden.

  7. Controleer de installatie door de AI-assistent te vragen:

    code language-shell-session
    Can you show me the available Adobe Commerce tools?
    

Gebruik

Zodra geïnstalleerd, kunt u de indexen ​ automatisch roepen ​ of ​ uitdrukkelijk ​. U kunt ook /search-commerce-docs bevel ​ gebruiken.

NOTE
De RAG-service retourneert de vijf belangrijkste resultaten.

Automatische indexselectie (aanbevolen)

Door vragen te stellen over de natuurlijke taal van uw Commerce-project, zoekt het programma automatisch naar de juiste documentatieindex en verstrekt het relevante informatie:

recommendation-more-help

Met de volgende prompt wordt automatisch de commerce-storefront-docs -index geselecteerd:

"How do I use Edge Delivery Services drop-ins for product listing?"

Met de volgende prompt wordt automatisch de commerce-extensibility-docs -index geselecteerd:

"How do I create a webhook in Adobe Commerce?"

Met de volgende prompt wordt automatisch de commerce-core-docs -index geselecteerd:

"How to configure product catalog settings?"

Met de volgende prompt wordt automatisch de app-builder-docs -index geselecteerd:

"What are App Builder runtime action best practices?"

Expliciete indexselectie

U kunt ook de index opgeven die u wilt gebruiken in de vraag.

Search commerce-storefront-docs for authentication drop-in
Using app-builder-docs, how do I deploy runtime actions?

Op opdrachten gebaseerde zoekopdracht

Als u er zeker van wilt zijn dat de RAG-service wordt gebruikt, kunt u de opdracht /search-commerce-docs Cursor handmatig aanroepen om de documentatie met uw vraag te doorzoeken:

/search-commerce-docs "How do I subscribe to Commerce events?"

Aangepast eindpunt voorzijde

Door gebrek, gebruikt het documentonderzoek het productie ​ Azure Front Door ​ eindpunt met de bescherming van WAF. Voor test- of ontwikkelingsdoeleinden kunt u dit overschrijven met de omgevingsvariabele FRONT_DOOR_URL .

Om een douaneeindpunt te gebruiken, voeg het aan uw Configuratie van de Curseur MCP toe:

{
  "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"
      }
    }
  }
}
NOTE
De meeste ontwikkelaars moeten het standaardeindpunt van de productie gebruiken en hoeven de variabele FRONT_DOOR_URL niet in te stellen.

Problemen oplossen

De volgende secties verstrekken het oplossen van problemenuiteinden voor gemeenschappelijke kwesties u kon ontmoeten wanneer het gebruiken van de documentatieRAG dienst.

Verificatiefouten

Voor het zoeken naar documentatie is Adobe IMS-verificatie vereist. Als u verificatiefouten tegenkomt, gebruikt u de volgende stappen om het probleem op te lossen en op te lossen.

  1. Controleren of u bent aangemeld:

    code language-bash
    aio where
    
  2. Controleer of u de IMS-token kunt zien:

    code language-bash
    aio auth login --bare
    
  3. Als de authentificatiefouten voortduren, probeer het programma openen en terug in:

    code language-bash
    aio auth logout
    aio auth login
    

MCP-server wordt niet geladen

Als de server MCP verbindt, of uw agent zegt het niet met RAG kan verbinden, gebruik de volgende stappen om de kwestie problemen op te lossen en op te lossen.

  1. Open de Montages van de Curseur gebruikend Cmd, (macOS) of CTRL, (Vensters en Linux).

  2. Zoek naar "MCP"en verifieer dat commerce-extensibility-tools vermeld en toegelaten is.

  3. Controleer op foutberichten in het MCP-instellingenvenster.

  4. Controleer of het bestand mcp.json bestaat in uw project:

    code language-bash
    cat .cursor/mcp.json
    
  5. Controleer of het pad juist en absoluut is:

    code language-bash
    ls -la /<your-project-directory>/commerce-extensibility-tools/index.js
    

Gereedschap niet gevonden

  1. Sluit de cursor en open deze opnieuw.

  2. Controleer de MCP serverlogboeken in de ontwikkelaarsconsole van de Cursor door Cmd+Shift+P (macOS) of Ctrl+Shift+P (Vensters/Linux) te gebruiken en het zoeken naar "Ontwikkelaar: Open Omslag van Logs".

  3. Controleer de installatie:

    code language-bash
    cd commerce-extensibility-tools
    npm install
    node index.js
    

    De server moet zonder fouten starten.

Padproblemen (Windows)

In Windows gebruikt u slashes / of backslashes met escape-teken \\ :

{
  "args": ["C:/Users/yourname/projects/commerce-extensibility-tools/index.js"]
}
{
  "args": ["C:\\Users\\yourname\\projects\\commerce-extensibility-tools\\index.js"]
}

Aanvullende bronnen

2824e4b9-25f8-4682-bbf4-e4304bd8facf