[Somente SaaS]{class="badge positive" title="Aplicável somente a projetos do Adobe Commerce as a Cloud Service e do Adobe Commerce Optimizer (infraestrutura SaaS gerenciada pela Adobe)."}

Serviço de documentação RAG (Beta)

O serviço de documentação RAG (Retrieval-Augmented Generation) fornece recursos de pesquisa semântica alimentados por IA em toda a documentação relevante do Adobe Commerce e do App Builder.

Este RAG fornece uma interface IDE para fazer perguntas sobre o Adobe Commerce e pode aconselhá-lo sobre as práticas recomendadas para o desenvolvimento de aplicativos e outras tarefas de migração.

O serviço RAG faz parte do servidor MCP (Model Context Protocol) das ferramentas de extensibilidade do Commerce, que se integra ao Cursor e a outros assistentes de IA compatíveis com MCP.

Documentação disponível

A tabela a seguir descreve qual documentação está atualmente indexada pelo serviço RAG e as palavras-chave que você pode usar para acionar a pesquisa no índice associado. A documentação incluída continuará a expandir à medida que desenvolvemos o serviço RAG.

Para obter mais informações sobre a seleção de índice, consulte Seleção automática de índice e Seleção explícita de índice.

Para obter informações detalhadas sobre a documentação incluída em cada índice, consulte a lista de origens assimiladas.

Segurança e privacidade

O ponto de extremidade de produção é protegido pela Porta Frontal do Azure, que inclui as seguintes proteções:

Para diferentes requisitos de segurança, você pode usar um terminal personalizado. Consulte Ponto de extremidade personalizado do Front Door para obter mais informações.

Pré-requisitos

Antes de instalar, verifique se você tem:

Instalação

Uso

Depois de instalado, você pode chamar os índices automaticamente ou explicitamente. Você também pode usar o comando /search-commerce-docs ​.

Seleção automática de índice (recomendado)

Ao fazer perguntas em linguagem natural sobre o seu projeto do Commerce, a ferramenta pesquisará automaticamente no índice de documentação apropriado e fornecerá informações relevantes:

O prompt a seguir seleciona automaticamente o índice commerce-storefront-docs:

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

O prompt a seguir seleciona automaticamente o índice commerce-extensibility-docs:

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

O prompt a seguir seleciona automaticamente o índice commerce-core-docs:

"How to configure product catalog settings?"

O prompt a seguir seleciona automaticamente o índice app-builder-docs:

"What are App Builder runtime action best practices?"

Seleção de índice explícita

Como alternativa, você pode especificar o índice que deseja usar no prompt.

Search commerce-storefront-docs for authentication drop-in

Using app-builder-docs, how do I deploy runtime actions?

Pesquisa baseada em comandos

Se quiser garantir que o serviço RAG seja usado, chame manualmente o comando de Cursor /search-commerce-docs para pesquisar a documentação com seu prompt:

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

Ponto de extremidade personalizado da porta frontal

Por padrão, a pesquisa de documentação usa o ponto de extremidade de produção Azure Front Door com proteção de WAF. Para fins de teste ou desenvolvimento, é possível substituir isso pela variável de ambiente FRONT_DOOR_URL.

Para usar um endpoint personalizado, adicione-o à configuração de MCP do cursor:

{
  "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"
      }
    }
  }
}

Solução de problemas

As seções a seguir fornecem dicas de solução de problemas comuns que você pode encontrar ao usar o serviço de documentação RAG.

Erros de autenticação

A ferramenta de pesquisa de documentação exige autenticação do Adobe IMS. Se encontrar erros de autenticação, use as seguintes etapas para solucionar e resolver o problema.

O servidor MCP não está carregando

Se o servidor MCP não estiver se conectando ou se o seu agente informar que não pode se conectar ao RAG, use as seguintes etapas para solucionar o problema.

Ferramenta não encontrada

Problemas de caminho (Windows)

No Windows, use barras / ou barras invertidas com escape \\:

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

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

Recursos adicionais