Magento2 MCP Server

🚀 Magento 2 MCP Server

A Model Context Protocol (MCP) server implemented for Magento 2, enabling AI assistants to interact with your Magento store through a standardized interface.

✨ Features

• Integration with Magento 2's REST API.
• Secure authentication handling.
• Resource and tool processors for common Magento operations.
• Type safety implemented using TypeScript.
• Developed based on the official MCP SDK.

📦 Installation

Prerequisites

• Node.js (v18 or higher)
• npm (v8 or higher)
• A Magento 2 instance with REST API access
• Magento administrator API token

Installation Steps

npm install vasileuski/magento2-mcp-server

💻 Usage Examples

Starting the Server

magento <magento_url> <admin_api_token>

Example:

magento https://your-magento-store.com eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...

Integrating with an MCP Client

To use this server with your MCP client (such as Cursor), add the following configuration to the client settings:

{
  "tools": [
    {
      "name": "mcp_magento_magento_rest_api",
      "command": "magento https://your-magento-store.com your-admin-api-token"
    }
  ]
}

This enables the following features:

• REST API access to your Magento instance
• Schema introspection
• Resource listing and reading
• Tool execution for common Magento operations

Available Tools

magento_rest_api

Send REST API requests 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 an 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 the development server: npm run dev
4. Make your changes.
5. Run tests: npm test
6. Build the production version: npm run build

🔒 Security

• Never commit your Magento administrator token.
• Use environment variables to store sensitive information.
• Keep your Node.js and npm versions up to date.
• Regularly update dependencies.

📄 License

MIT