[Solo SaaS]{class="badge positive" title="Applicabile solo ai progetti Adobe Commerce as a Cloud Service e Adobe Commerce Optimizer (infrastruttura SaaS gestita da Adobe)."}

Servizio RAG documentazione (Beta)

NOTE
Il servizio di documentazione RAG è attualmente disponibile in Beta e l’esperienza è soggetta a modifiche.

Il servizio di documentazione RAG (Retrieval-Augmented Generation) fornisce funzionalità di ricerca semantica basate sull’intelligenza artificiale nella documentazione pertinente di Adobe Commerce e App Builder.

Questo RAG fornisce un’interfaccia IDE per porre domande su Adobe Commerce e può consigliarti sulle best practice per lo sviluppo di applicazioni e altre attività di migrazione.

Il servizio RAG fa parte del server Commerce extensibility tools MCP (Model Context Protocol), che si integra con Cursor e altri assistenti di IA compatibili con MCP.

Documentazione disponibile

Nella tabella seguente viene descritta la documentazione attualmente indicizzata dal servizio RAG e le parole chiave che è possibile utilizzare per attivare la ricerca nell'indice associato. La documentazione inclusa continuerà a crescere man mano che svilupperemo il servizio RAG.

Categoria
Indice
Contenuto incluso
Parole chiave
Vetrina
commerce-storefront-docs
Edge Delivery Services, drop-in, componenti storefront
vetrina, consegna, EDS, elenco prodotti, pagamento
Estensibilità
commerce-extensibility-docs
Webhook, eventi, estensioni, integrazioni
webhook, evento, estensione, mesh API, GraphQL
Commerce
commerce-core-docs
Commerce core (catalogo, clienti, ordini)
catalogo, prodotto, cliente, ordine, inventario
App Builder
app-builder-docs
App Builder, azioni di runtime, estensioni dell’interfaccia utente
app builder, azione runtime, React Spectrum

Per ulteriori informazioni sulla selezione dell'indice, consultare Selezione automatica dell'indice e Selezione esplicita dell'indice.

Per informazioni dettagliate sulla documentazione inclusa in ogni indice, consulta l'elenco di origini acquisite.

Sicurezza e privacy

  • Autenticazione IMS - Tutte le chiamate API utilizzano token Adobe IMS OAuth2.
  • Archiviazione dati assente - Il server MCP non memorizza credenziali o dati.
  • Esecuzione locale - Tutti gli strumenti vengono eseguiti localmente nel computer.
  • Comunicazione sicura - La ricerca nella documentazione utilizza HTTPS con convalida del token.

L'endpoint di produzione è protetto da Azure Front Door, che include le seguenti protezioni:

  • Firewall applicazione Web (WAF) con set di regole predefinito di Microsoft 2.1 e set di regole di gestione bot 1.0
  • Blocco geografico per le regioni soggette a embargo da parte degli Stati Uniti (Cuba, Iran, Corea del Nord, Siria, Crimea, Luhansk, Donetsk)
  • Protezione DDoS ai margini
  • Il backend di gestione API è bloccato per accettare solo il traffico da Front Door

Per diversi requisiti di sicurezza, puoi utilizzare un endpoint personalizzato. Per ulteriori informazioni, vedere Endpoint Front Door personalizzato.

Prerequisiti

Prima dell’installazione, assicurati di disporre di:

  • Node.js 18+ (consigliato)

  • IDE cursore (consigliato) o un altro IDE compatibile con MCP

    note note
    NOTE
    Sono supportati altri IDE compatibili con MCP, tuttavia l’IDE consigliato è Cursor. Se utilizzi un altro IDE, dovrai modificare i prompt e gli altri passaggi della documentazione per utilizzare l’IDE selezionato.

Installazione

  1. Installa Adobe I/O CLI a livello globale:

    code language-bash
    npm install -g @adobe/aio-cli
    
  2. Autenticazione con Adobe IMS:

    code language-bash
    aio auth login
    
  3. Clonare il repository degli strumenti di estensibilità di Commerce e passare alla directory:

    code language-bash
    git clone https://github.com/adobe-commerce/commerce-extensibility-tools.git
    cd commerce-extensibility-tools
    
  4. Installare le dipendenze:

    code language-bash
    npm install
    
  5. Crea o aggiorna .cursor/mcp.json nella directory del progetto Commerce (non globalmente) per includere il server MCP commerce-extensibility-tools:

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

    Assicurarsi di sostituire <your-project-directory> con il percorso effettivo in cui è stato clonato l'archivio.

    note note
    NOTE
    In Windows, in caso di problemi con la fornitura del percorso alla directory del progetto, consulta Risoluzione dei problemi del percorso.
  6. Riavvia IDE cursore per caricare il server MCP.

  7. Verifica l’installazione chiedendo all’assistente AI:

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

Utilizzo

Una volta installato, è possibile chiamare gli indici automaticamente o in modo esplicito. È inoltre possibile utilizzare il comando /search-commerce-docs.

NOTE
Il servizio RAG restituisce i primi 5 risultati più rilevanti.

Selezione automatica indice (scelta consigliata)

Facendo domande in linguaggio naturale sul progetto Commerce, lo strumento cercherà automaticamente l’indice della documentazione appropriato e fornirà informazioni pertinenti:

recommendation-more-help

Il seguente prompt seleziona automaticamente l'indice commerce-storefront-docs:

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

Il seguente prompt seleziona automaticamente l'indice commerce-extensibility-docs:

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

Il seguente prompt seleziona automaticamente l'indice commerce-core-docs:

"How to configure product catalog settings?"

Il seguente prompt seleziona automaticamente l'indice app-builder-docs:

"What are App Builder runtime action best practices?"

Selezione esplicita dell'indice

In alternativa, è possibile specificare l'indice da utilizzare nel prompt.

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

Ricerca basata su comandi

Se si desidera assicurarsi che venga utilizzato il servizio RAG, è possibile richiamare manualmente il comando Cursore /search-commerce-docs per eseguire ricerche nella documentazione al prompt:

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

Endpoint personalizzato porta anteriore

Per impostazione predefinita, la ricerca nella documentazione utilizza l'endpoint di produzione Azure Front Door con protezione WAF. A scopo di test o sviluppo, è possibile eseguire l'override con la variabile di ambiente FRONT_DOOR_URL.

Per utilizzare un endpoint personalizzato, aggiungilo alla configurazione MCP cursore:

{
  "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
La maggior parte degli sviluppatori deve utilizzare l'endpoint di produzione predefinito e non è necessario impostare la variabile FRONT_DOOR_URL.

Risoluzione dei problemi

Nelle sezioni seguenti vengono forniti suggerimenti per la risoluzione dei problemi comuni che possono verificarsi quando si utilizza il servizio RAG della documentazione.

Errori di autenticazione

Lo strumento di ricerca della documentazione richiede l’autenticazione Adobe IMS. Se riscontri errori di autenticazione, procedi come segue per risolvere il problema e risolverlo.

  1. Verifica di aver effettuato l’accesso:

    code language-bash
    aio where
    
  2. Verifica di poter visualizzare il token IMS:

    code language-bash
    aio auth login --bare
    
  3. Se gli errori di autenticazione persistono, disconnettersi e accedere di nuovo:

    code language-bash
    aio auth logout
    aio auth login
    

Impossibile caricare il server MCP

Se il server MCP non si connette o l'agente comunica che non è in grado di connettersi a RAG, attenersi alla procedura seguente per risolvere il problema.

  1. Apri Impostazioni cursore tramite Cmd , (macOS) o Ctrl , (Windows e Linux).

  2. Cercare "MCP" e verificare che commerce-extensibility-tools sia elencato e abilitato.

  3. Verifica la presenza di messaggi di errore nel pannello delle impostazioni MCP.

  4. Verificare che il file mcp.json esista nel progetto:

    code language-bash
    cat .cursor/mcp.json
    
  5. Verifica che il percorso sia corretto e assoluto:

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

Strumento non trovato

  1. Chiudere Cursore e riaprirlo.

  2. Controlla i registri del server MCP nella console per sviluppatori del cursore utilizzando Cmd+Shift+P (macOS) o Ctrl+Shift+P (Windows/Linux) e cercando "Sviluppatore: Apri cartella dei registri".

  3. Verificare l'installazione:

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

    Il server deve avviarsi senza errori.

Problemi di percorso (Windows)

In Windows, utilizzare le barre / o le barre rovesciate con escape \\:

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

Risorse aggiuntive

8562d99f-dbeb-485e-bae7-5e82fa87f463