Documentation RAG service (Beta)
The documentation RAG (Retrieval-Augmented Generation) service provides AI-powered semantic search capabilities across relevant Adobe Commerce and App Builder documentation.
This RAG provides an IDE interface for asking questions about Adobe Commerce and can advise you on best practices for developing applications and other migration tasks.
The RAG service is part of the Commerce extensibility tools MCP (Model Context Protocol) server, which integrates with Cursor and other MCP-compatible AI assistants.
Available documentation
The following table describes what documentation is currently indexed by the RAG service, and the keywords you can use to trigger searching the associated index. The documentation included will continue to expand as we develop the RAG service.
For more information on index selection, refer to Automatic index selection and Explicit index selection.
For detailed information on the documentation included in each index, refer to the ingested source list.
Security and privacy
- IMS authentication - All API calls use Adobe IMS OAuth2 tokens.
- No data storage - The MCP server does not store any credentials or data.
- Local execution - All tools run locally on your machine.
- Secure communication - Documentation search uses HTTPS with token validation.
The production endpoint is protected by Azure Front Door, which includes the following protections:
- Web Application Firewall (WAF) with Microsoft Default RuleSet 2.1 and Bot Manager RuleSet 1.0
- Geo-blocking for US embargoed regions (Cuba, Iran, North Korea, Syria, Crimea, Luhansk, Donetsk)
- DDoS protection at the edge
- API management backend locked down to only accept traffic from Front Door
For different security requirements, you can use a custom endpoint. See Custom Front Door endpoint for more information.
Prerequisites
Before installing, make sure you have:
-
Node.js 18+ (LTS recommended)
-
Cursor IDE (recommended) or another MCP-compatible IDE
note note NOTE While other MCP-compatible IDEs are supported, Cursor is the recommended IDE for the best experience. If you are using another IDE, you will need to modify the prompts and other steps in the documentation to work with your selected IDE.
Installation
-
Install the Adobe I/O CLI globally:
code language-bash npm install -g @adobe/aio-cli -
Authenticate with Adobe IMS:
code language-bash aio auth login -
Clone the Commerce extensibility 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 -
Install dependencies:
code language-bash npm install -
Create or update
.cursor/mcp.jsonin your Commerce project directory (not globally) to include thecommerce-extensibility-toolsMCP server:code language-json { "mcpServers": { "commerce-extensibility-tools": { "command": "node", "args": [ "/<your-project-directory>/commerce-extensibility-tools/index.js" ], "env": { "NODE_ENV": "production" } } } }Ensure that you replace
<your-project-directory>with the actual path where you cloned the repository.note note NOTE On Windows, if you encounter issues with providing the path to your project directory, refer to Path issues troubleshooting. -
Restart Cursor IDE to load the MCP server.
-
Verify the installation by asking the AI assistant:
code language-shell-session Can you show me the available Adobe Commerce tools?
Usage
Once installed, you can call the indexes automatically or explicitly. You can also use the /search-commerce-docs command.
Automatic index selection (recommended)
By asking natural language questions about your Commerce project, the tool will automatically search the appropriate documentation index and provide relevant information:
The following prompt automatically selects the commerce-storefront-docs index:
"How do I use Edge Delivery Services drop-ins for product listing?"
The following prompt automatically selects the commerce-extensibility-docs index:
"How do I create a webhook in Adobe Commerce?"
The following prompt automatically selects the commerce-core-docs index:
"How to configure product catalog settings?"
The following prompt automatically selects the app-builder-docs index:
"What are App Builder runtime action best practices?"
Explicit index selection
Alternatively, you can specify the index you want to use in your prompt.
Search commerce-storefront-docs for authentication drop-in
Using app-builder-docs, how do I deploy runtime actions?
Command-based search
If you want to ensure the RAG service is used, you can manually invoke the /search-commerce-docs Cursor command to search documentation with your prompt:
/search-commerce-docs "How do I subscribe to Commerce events?"
Custom Front Door endpoint
By default, the documentation search uses the production Azure Front Door endpoint with WAF protection. For testing or development purposes, you can override this with the FRONT_DOOR_URL environment variable.
To use a custom endpoint, add it to your Cursor MCP configuration:
{
"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 variable.Troubleshooting
The following sections provide troubleshooting tips for common issues you could encounter when using the documentation RAG service.
Authentication errors
The documentation search tool requires Adobe IMS authentication. If you encounter authentication errors, use the following steps to troubleshoot and resolve the issue.
-
Verify you are logged in:
code language-bash aio where -
Verify that you can see your IMS token:
code language-bash aio auth login --bare -
If authentication errors persist, try logging out and back in:
code language-bash aio auth logout aio auth login
MCP server not loading
If the MCP server is not connecting, or your agent says it cannot connect to the RAG, use the following steps to troubleshoot and resolve the issue.
-
Open Cursor Settings using Cmd , (macOS) or Ctrl , (Windows and Linux).
-
Search for “MCP” and verify that
commerce-extensibility-toolsis listed and enabled. -
Check for error messages in the MCP settings panel.
-
Verify the
mcp.jsonfile exists in your project:code language-bash cat .cursor/mcp.json -
Verify the path is correct and absolute:
code language-bash ls -la /<your-project-directory>/commerce-extensibility-tools/index.js
Tool not found
-
Quit Cursor and reopen it.
-
Check the MCP server logs in Cursor’s developer console by using Cmd+Shift+P (macOS) or Ctrl+Shift+P (Windows/Linux) and searching for “Developer: Open Logs Folder”.
-
Verify the installation:
code language-bash cd commerce-extensibility-tools npm install node index.jsThe server should start without errors.
Path issues (Windows)
On Windows, use forward slashes / or escaped backslashes \\:
{
"args": ["C:/Users/yourname/projects/commerce-extensibility-tools/index.js"]
}
{
"args": ["C:\\Users\\yourname\\projects\\commerce-extensibility-tools\\index.js"]
}