What is Magento2 Mcp Server

Magento 2 MCP Server is a Model Context Protocol (MCP) server implementation designed for Magento 2, allowing AI assistants to interact with Magento stores through a standardized interface.

Use cases

Use cases include automating order management, retrieving product information, managing customer data, and enabling AI-driven interactions with the Magento store.

How to use

To use the Magento 2 MCP Server, install it via npm, start the server with your Magento store URL and admin API token, and configure your MCP client to connect to the server.

Key features

Key features include REST API integration with Magento 2, secure authentication handling, resource and tool handlers for common Magento operations, TypeScript implementation for type safety, and it is built on the official MCP SDK.

Where to use

Magento 2 MCP Server is used in e-commerce environments where Magento 2 is deployed, particularly for integrating AI assistants and automating store management tasks.

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

npm install vasileuski/magento2-mcp-server

Usage

Starting the Server

magento <magento_url> <admin_api_token>

Example:

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:

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

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