magento2-mcp-server

# Magento 2 MCP Server A Model Context Protocol (MCP) server implementation for Magento 2, enabling AI assistants to interact with your Magento store through a standardized interface. ## Features - REST API integration with Magento 2 - Secure authentication handling - Resource and tool handlers for common Magento operations - TypeScript implementation for type safety - Built on the official MCP SDK ## Prerequisites - Node.js (v18 or higher) - npm (v8 or higher) - Magento 2 instance with REST API access - Admin API access token from Magento ## Installation ```bash npm install vasileuski/magento2-mcp-server ``` ## Usage ### Starting the Server ```bash magento <magento_url> <admin_api_token> ``` Example: ```bash magento https://your-magento-store.com eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9... ``` ### Integration with MCP Client To use this server with your MCP client (like Cursor), add the following configuration to your client settings: ```json { "tools": [ { "name": "mcp_magento_magento_rest_api", "command": "magento https://your-magento-store.com your-admin-api-token" } ] } ``` This will enable the following capabilities: - REST API access to your Magento instance - Schema introspection - Resource listing and reading - Tool execution for common Magento operations ## Available Tools ### magento_rest_api Makes REST API calls to your Magento instance. Parameters: - `path`: API endpoint path - `method`: HTTP method (GET, POST, PUT, DELETE) - `body`: Request body (JSON string) - `query`: Query parameters Example usage in MCP client: ```typescript const response = await mcp.magento_rest_api({ path: "rest/V1/orders", method: "GET", body: "", query: "searchCriteria[pageSize]=3&searchCriteria[currentPage]=1" }); ``` ## Development 1. Clone the repository 2. Install dependencies: `npm install` 3. Start development server: `npm run dev` 4. Make your changes 5. Run tests: `npm test` 6. Build for production: `npm run build` ## Security - Never commit your Magento admin token - Use environment variables for sensitive information - Keep your Node.js and npm versions up to date - Regularly update dependencies ## License MIT