Servicio de documentación de RAG (Beta)
El servicio de documentación RAG (Retrieval-Augmented Generation) proporciona funciones de búsqueda semánticas basadas en IA para la documentación de Adobe Commerce y App Builder.
Este RAG proporciona una interfaz IDE para hacer preguntas sobre Adobe Commerce y puede aconsejarle sobre las prácticas recomendadas para desarrollar aplicaciones y otras tareas de migración.
El servicio RAG forma parte del servidor Commerce extensibility tools MCP (Model Context Protocol), que se integra con el cursor y otros asistentes de IA compatibles con MCP.
Documentación disponible
En la tabla siguiente se describe qué documentación está indexada actualmente por el servicio RAG y las palabras clave que puede utilizar para almacenar en déclencheur la búsqueda en el índice asociado. La documentación incluida seguirá ampliándose a medida que desarrollemos el servicio RAG.
Para obtener más información sobre la selección de índices, consulte Selección automática de índices y Selección explícita de índices.
Para obtener información detallada sobre la documentación incluida en cada índice, consulte la lista de fuentes ingeridas.
Seguridad y privacidad
- Autenticación IMS: todas las llamadas a la API utilizan tokens OAuth2 de Adobe IMS.
- Sin almacenamiento de datos: el servidor MCP no almacena credenciales ni datos.
- Ejecución local: todas las herramientas se ejecutan localmente en el equipo.
- Comunicación segura: la búsqueda en la documentación usa HTTPS con validación de tokens.
El extremo de producción está protegido por Azure Front Door, que incluye las siguientes protecciones:
- Firewall de aplicaciones web (WAF) con conjunto de reglas predeterminado de Microsoft 2.1 y conjunto de reglas de Bot Manager 1.0
- Bloqueo geográfico para regiones sujetas a embargo por Estados Unidos (Cuba, Irán, Corea del Norte, Siria, Crimea, Luhansk, Donetsk)
- Protección DDoS en el borde
- Servidor de administración de API bloqueado para aceptar solo el tráfico de la puerta principal
Para diferentes requisitos de seguridad, puede utilizar un punto de conexión personalizado. Consulte Extremo personalizado de la puerta principal para obtener más información.
Requisitos previos
Antes de instalar, asegúrese de que dispone de lo siguiente:
-
Node.js 18+ (se recomienda LTS)
-
IDE de cursor (recomendado) u otro IDE compatible con MCP
note note NOTE Aunque se admiten otros IDE compatibles con MCP, Cursor es el IDE recomendado para obtener la mejor experiencia. Si está utilizando otro IDE, deberá modificar las solicitudes y otros pasos de la documentación para que funcionen con el IDE seleccionado.
Instalación
-
Instalar Adobe I/O CLI globalmente:
code language-bash npm install -g @adobe/aio-cli -
Autenticar con Adobe IMS:
code language-bash aio auth login -
Clone el repositorio de herramientas de extensibilidad de Commerce y vaya al directorio:
code language-bash git clone https://github.com/adobe-commerce/commerce-extensibility-tools.git cd commerce-extensibility-tools -
Instalar dependencias:
code language-bash npm install -
Cree o actualice
.cursor/mcp.jsonen el directorio de proyectos de Commerce (no globalmente) para incluir el servidor MCPcommerce-extensibility-tools:code language-json { "mcpServers": { "commerce-extensibility-tools": { "command": "node", "args": [ "/<your-project-directory>/commerce-extensibility-tools/index.js" ], "env": { "NODE_ENV": "production" } } } }Asegúrese de reemplazar
<your-project-directory>con la ruta real donde clonó el repositorio.note note NOTE En Windows, si encuentra problemas al proporcionar la ruta al directorio del proyecto, consulte Resolución de problemas de ruta. -
Reinicie el IDE del cursor para cargar el servidor MCP.
-
Compruebe la instalación preguntando al asistente de IA:
code language-shell-session Can you show me the available Adobe Commerce tools?
Uso
Una vez instalado, puede llamar a los índices automáticamente o explícitamente. También puede usar el comando /search-commerce-docs .
Selección automática de índices (recomendado)
Al hacer preguntas en lenguaje natural sobre su proyecto de Commerce, la herramienta buscará automáticamente el índice de documentación adecuado y proporcionará información relevante:
El siguiente mensaje selecciona automáticamente el índice commerce-storefront-docs:
"How do I use Edge Delivery Services drop-ins for product listing?"
El siguiente mensaje selecciona automáticamente el índice commerce-extensibility-docs:
"How do I create a webhook in Adobe Commerce?"
El siguiente mensaje selecciona automáticamente el índice commerce-core-docs:
"How to configure product catalog settings?"
El siguiente mensaje selecciona automáticamente el índice app-builder-docs:
"What are App Builder runtime action best practices?"
Selección de índice explícita
También puede especificar el índice que desee utilizar en el mensaje.
Search commerce-storefront-docs for authentication drop-in
Using app-builder-docs, how do I deploy runtime actions?
Búsqueda basada en comandos
Si desea asegurarse de que se utiliza el servicio RAG, puede invocar manualmente el comando Cursor /search-commerce-docs para buscar documentación con el símbolo del sistema:
/search-commerce-docs "How do I subscribe to Commerce events?"
Extremo personalizado de la puerta delantera
De manera predeterminada, la búsqueda de documentación usa el extremo de producción Azure Front Door con protección WAF. Para fines de prueba o desarrollo, puede anular esto con la variable de entorno FRONT_DOOR_URL.
Para utilizar un punto de conexión personalizado, agréguelo a la configuración de MCP de 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"
}
}
}
}
FRONT_DOOR_URL.Resolución de problemas
En las siguientes secciones se proporcionan sugerencias para la resolución de problemas comunes que podrían producirse al utilizar el servicio RAG de documentación.
Errores de autenticación
La herramienta de búsqueda de documentación requiere la autenticación IMS de Adobe. Si encuentra errores de autenticación, siga los siguientes pasos para solucionar el problema.
-
Compruebe que ha iniciado sesión:
code language-bash aio where -
Compruebe que puede ver el token de IMS:
code language-bash aio auth login --bare -
Si persisten los errores de autenticación, intente cerrar la sesión y volver a iniciarla:
code language-bash aio auth logout aio auth login
El servidor MCP no se carga
Si el servidor MCP no se está conectando, o si el agente indica que no se puede conectar al RAG, siga los siguientes pasos para solucionar el problema.
-
Abra la configuración del cursor usando Cmd , (macOS) o Ctrl , (Windows y Linux).
-
Busque "MCP" y verifique que
commerce-extensibility-toolsesté en la lista y habilitado. -
Compruebe si hay mensajes de error en el panel de configuración de MCP.
-
Compruebe que el archivo
mcp.jsonexiste en el proyecto:code language-bash cat .cursor/mcp.json -
Compruebe que la ruta sea correcta y absoluta:
code language-bash ls -la /<your-project-directory>/commerce-extensibility-tools/index.js
Herramienta no encontrada
-
Salga del cursor y vuelva a abrirlo.
-
Compruebe los registros del servidor MCP en la consola del desarrollador del cursor usando Cmd+Shift+P (macOS) o Ctrl+Mayús+P (Windows/Linux) y buscando "Desarrollador: Abrir carpeta de registros".
-
Compruebe la instalación:
code language-bash cd commerce-extensibility-tools npm install node index.jsEl servidor debe iniciarse sin errores.
Problemas de ruta (Windows)
En Windows, use las barras diagonales / o las barras invertidas de escape \\:
{
"args": ["C:/Users/yourname/projects/commerce-extensibility-tools/index.js"]
}
{
"args": ["C:\\Users\\yourname\\projects\\commerce-extensibility-tools\\index.js"]
}