Adobe Commerce + GitHub Copilot (VS Code): Complete MCP Integration
Adobe Commerce is a MCP server that Adobe Commerce MCP server.
When integrated with GitHub Copilot (VS Code), you can:
- Analyze and explore Adobe Commerce GraphQL schema structure
- Write and test GraphQL queries and mutations for Adobe Commerce
- Interact with Adobe Commerce business logic through GraphQL
This guide provides step-by-step instructions to set up Adobe Commerce in GitHub Copilot (VS Code), including configuration, examples, and troubleshooting.
What You'll Achieve
After completing this setup:
- Adobe Commerce will be fully integrated and operational
- You can use Adobe Commerce tools directly in GitHub Copilot (VS Code)
- All Adobe Commerce capabilities will be available for your workflows
- Access to 4 different tools
Prerequisites
Before starting, ensure you have:
- Node.js
- npm
- Adobe Commerce environment
- GitHub Copilot (VS Code) installed and configured
- Compatible operating system (Windows, macOS, Linux)
Installation
Step 1: Install Adobe Commerce
Install using npm:
npx -y @rafaelcg/adobe-commerce-dev-mcp@latest
Verify installation:
npx @rafaelcg/adobe-commerce-dev-mcp@latest --help
Configuration
Step 2: Configure GitHub Copilot (VS Code)
-
Locate your configuration file:
- Windows:
.vscode\\mcp.json in your project directory - macOS:
.vscode/mcp.json in your project directory - Linux:
.vscode/mcp.json in your project directory
- Windows:
-
Add server configuration:
{
"mcpServers": {
"adobe-commerce": {
"command": "npx",
"args": ["-y", "@rafaelcg/adobe-commerce-dev-mcp@latest"],
"env": {
}
}
}
}
- Restart GitHub Copilot (VS Code)
Completely quit and restart GitHub Copilot (VS Code) to load the new configuration.
Examples
Once configured, you can use Adobe Commerce in GitHub Copilot (VS Code):
Explore GraphQL Schema
Introspect Adobe Commerce admin GraphQL schema
Ask GitHub Copilot (VS Code): "Show me the available GraphQL schema for product management in Adobe Commerce"
Expected Result: Detailed schema information including product types, fields, and available operations
Create Product Query
Build GraphQL query to retrieve product information
Ask GitHub Copilot (VS Code): "Help me write a GraphQL query to get product details including name, price, and inventory status"
Expected Result: Well-formed GraphQL query with proper field selection and structure
Customer Management Operation
Develop customer-related GraphQL operations
Ask GitHub Copilot (VS Code): "Create a GraphQL mutation to update customer profile information"
Expected Result: GraphQL mutation with proper input types and customer field updates
Order Processing Query
Build order management GraphQL operations
Ask GitHub Copilot (VS Code): "Write a GraphQL query to retrieve order history with product details and shipping information"
Expected Result: Complex GraphQL query with nested relationships and order data structure
Testing Your Setup
- Start a new conversation in GitHub Copilot (VS Code)
- Ask GitHub Copilot (VS Code) to list available tools
- Try using Adobe Commerce functionality
Test prompts:
- "What MCP tools are available?"
- "Use Adobe Commerce to help with my code"
- "Show me what Adobe Commerce can do"
Troubleshooting
Common Issues
Schema Introspection Failed
Symptoms: Schema not accessible, GraphQL endpoint errors, Authentication failures
Cause: Invalid GraphQL endpoint URL or authentication token
Solution:
- Verify Adobe Commerce GraphQL endpoint is accessible
- Check admin integration token has proper permissions
- Test endpoint manually with GraphQL client
- Ensure Adobe Commerce instance is running and configured
NPM Package Installation Error
Symptoms: Package not found, Installation timeouts, Version conflicts
Cause: Network issues, package registry problems, or dependency conflicts
Solution:
- Clear npm cache: npm cache clean --force
- Try alternative registry: npm install --registry https://registry.npmjs.org/
- Check network connectivity and proxy settings
- Update npm to latest version: npm install -g npm@latest
GraphQL Operation Syntax Error
Symptoms: Syntax validation errors, Malformed query messages, Parser errors
Cause: Invalid GraphQL syntax or schema incompatibility
Solution:
- Validate GraphQL syntax with online validator
- Check field names match schema definitions
- Ensure proper query structure and formatting
- Use introspect_admin_schema to verify available fields
Windows Command Execution Error
Symptoms: Command not recognized, Execution policy errors, Path issues
Cause: Windows-specific command execution or security policy restrictions
Solution:
- Use cmd configuration: "command": "cmd", "args": ["/c", "npx", ...]
- Check PowerShell execution policy: Set-ExecutionPolicy RemoteSigned
- Verify Node.js and npm are in system PATH
- Run terminal as administrator if needed
MCP Configuration Not Loaded
Symptoms: MCP tools not appearing, Copilot does not recognize MCP server
Cause: Configuration file not in correct location or invalid JSON
Solution:
- Verify .vscode/mcp.json exists in project root directory
- Check JSON syntax is valid (no trailing commas, proper quotes)
- Reload VS Code window after making configuration changes
- Check VS Code Developer Tools (Help > Toggle Developer Tools) for errors
MCP Server Not Starting
Symptoms: Tools listed but not responding, Server connection errors
Cause: Server command path incorrect or dependencies missing
Solution:
- Test the MCP server command independently in terminal
- Verify all server prerequisites are installed
- Check that command path is correct (use absolute paths if needed)
- Ensure required environment variables are set in mcp.json
- Review VS Code Output panel for MCP server error messages
GitHub Copilot Subscription Required
Symptoms: Copilot features grayed out, Unable to access Copilot Chat
Cause: No active GitHub Copilot subscription
Solution:
- Sign up for GitHub Copilot subscription (Individual, Business, or Enterprise)
- Verify subscription is active in GitHub account settings
- Re-authenticate GitHub Copilot in VS Code
- Check that VS Code is using correct GitHub account
VS Code Version Too Old
Symptoms: MCP configuration ignored, No mcp.json recognition
Cause: VS Code version below 1.99 does not have native MCP support
Solution:
- Update VS Code to version 1.99 or later
- Check current version: Help > About
- Download latest version from code.visualstudio.com
- After updating, reload window and verify MCP support
{server_name} Tools Not Working
Symptoms: Server connected but tools fail, Error messages when invoking tools
Cause: Server-specific configuration or authentication issues
Solution:
- Verify all required environment variables for {server_name} are set
- Check {server_name} documentation for specific prerequisites
- Test {server_name} with another MCP client to isolate issue
- Review error messages in VS Code Output panel for specific failures
Adobe Commerce not appearing in GitHub Copilot (VS Code)
Symptoms: Server not listed, Tools not available
Cause: Configuration or installation issue
Solution:
- Verify configuration syntax
- Check Adobe Commerce installation
- Restart GitHub Copilot (VS Code)
- Check logs for error messages
Next Steps
Now that Adobe Commerce is integrated with GitHub Copilot (VS Code):
- Explore all Adobe Commerce capabilities through GitHub Copilot (VS Code)
- Check out other MCP servers that work with GitHub Copilot (VS Code)
- Join the MCP community for tips and support
- Consider contributing to Adobe Commerce development
Need Help?
- Search for Adobe Commerce documentation
- Check the GitHub Copilot (VS Code) MCP guide
- Join the MCP community discussions