Magento 2 MCP Server

by boldcommerce
Verified

remote-capable server

The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.

Integrations

  • Requires Node.js v14 or higher as the runtime environment for the MCP server.

  • Uses Zod for input parameter validation when defining tools for the MCP server.

Servidor MCP de Magento 2

Este es un servidor de Protocolo de contexto de modelo (MCP) que se conecta a una API REST de Magento 2, lo que permite a Claude y otros clientes de MCP consultar información de productos de una tienda Magento.

Características

Características del producto

  • Consultar información del producto por SKU o ID
  • Busque productos utilizando varios criterios
  • Obtener categorías de productos
  • Obtenga productos relacionados
  • Obtener información sobre el stock de productos
  • Obtener atributos del producto
  • Actualice los atributos del producto especificando el código y el valor del atributo
  • Búsqueda avanzada de productos con filtrado y clasificación

Características del cliente

  • Obtenga todos los productos pedidos para un cliente por dirección de correo electrónico

Funciones de pedidos e ingresos

  • Obtener el recuento de pedidos para rangos de fechas específicos
  • Obtenga ingresos para rangos de fechas específicos
  • Obtenga ingresos filtrados por país para rangos de fechas específicos
  • Obtenga estadísticas de ventas de productos, incluidas la cantidad vendida y los productos más vendidos.
  • Compatibilidad con expresiones de fecha relativa como "hoy", "ayer", "la semana pasada", "este mes", "YTD"
  • Soporte para filtrado de países utilizando códigos y nombres de países

Prerrequisitos

  • Node.js (v14 o superior)
  • Una instancia de Magento 2 con acceso a la API REST
  • Token API para la instancia de Magento 2

Instalación

  1. Clonar este repositorio
  2. Instalar dependencias:
npm install

Uso

Ejecutar el servidor directamente

node mcp-server.js

Pruebas con el cliente de prueba

node test-mcp-server.js

Uso con Claude Desktop

  1. Comprueba tu nodo de ruta con which node
  2. Vaya a la configuración del desarrollador y haga clic en "Editar configuración". Se abrirá un archivo JSON.
  3. Agregue el siguiente fragmento dentro de mcpServers :
"magento2": { "command": "/path/to/your/node", "args": ["/path/to/mcp-server.js"], "env": { "MAGENTO_BASE_URL": "https://YOUR_DOMAIN/rest/V1", "MAGENTO_API_TOKEN": "your-api-token" } }
  1. Reemplace /path/to/your/node con la ruta que marcó en el paso 1
  2. Reemplace /path/to/mcp-server.js con la ruta donde clonó este repositorio
  3. Puede obtener un token API desde Sistema > Integraciones en el administrador de Magento
  4. Reinicie Claude Desktop.
  5. Ahora deberías poder hacerle preguntas a Claude sobre los productos en tu tienda Magento.

Herramientas disponibles

El servidor expone las siguientes herramientas:

Herramientas de producto

  • get_product_by_sku : Obtenga información detallada sobre un producto por su SKU
  • search_products : busca productos utilizando los criterios de búsqueda de Magento
  • get_product_categories : Obtener categorías para un producto específico por SKU
  • get_related_products : Obtener productos relacionados con un producto específico por SKU
  • get_product_stock : Obtener información de stock de un producto por SKU
  • get_product_attributes : Obtener todos los atributos de un producto por SKU
  • get_product_by_id : Obtenga información detallada sobre un producto por su ID
  • advanced_product_search : Busque productos con opciones de filtrado avanzadas
  • update_product_attribute : Actualizar un atributo específico de un producto por SKU

Herramientas para el cliente

  • get_customer_ordered_products_by_email : Obtener todos los productos pedidos por un cliente por dirección de correo electrónico

Herramientas de pedidos e ingresos

  • get_order_count : obtiene el número de pedidos para un rango de fechas determinado
  • get_revenue : obtiene los ingresos totales para un rango de fechas determinado
  • get_revenue_by_country : Obtener ingresos filtrados por país para un rango de fechas determinado
  • get_product_sales : Obtener estadísticas sobre la cantidad de productos vendidos en un rango de fechas determinado

Ejemplos de consultas para Claude

Una vez que el servidor MCP esté conectado a Claude Desktop, puede hacer preguntas como:

Consultas de productos

  • "¿Qué productos tenéis que sean camisetas?"
  • "Infórmeme sobre el producto con SKU SKU-xxx"
  • "¿A qué categorías pertenece el producto SKU-xxx?"
  • "¿Hay algún producto relacionado con SKU-SKU-xxx?"
  • "¿Cuál es el estado del stock del producto SKU-xxx?"
  • "Muéstrame todos los productos ordenados por precio"
  • Actualizar el precio del producto SKU-xxx a $49.99
  • "Cambiar la descripción del producto ABC-123 para describirlo como resistente al agua"
  • "Establecer el estado del producto XYZ-456 en 'habilitado'"

Consultas de clientes

Consultas de pedidos e ingresos

  • "¿Cuántos pedidos tenemos hoy?"
  • "¿Cuál fue nuestro número de pedidos de la semana pasada?"
  • "¿Cuántos ingresos generamos ayer?"
  • "¿Cuáles fueron nuestros ingresos totales el mes pasado?"
  • ¿Cuántos ingresos hemos obtenido en los Países Bajos este año hasta la fecha?
  • "¿Cuáles fueron nuestros ingresos en Alemania durante la última semana?"
  • Compare nuestros ingresos entre EE. UU. y Canadá este mes.
  • "¿Cuál es nuestro valor promedio de pedido para los pedidos completados este mes?"
  • ¿Cuántos productos vendimos el mes pasado?
  • "¿Cuáles son nuestros productos más vendidos este año?"
  • "¿Cuál es el número promedio de productos por pedido?"
  • "¿Cuántas unidades del producto XYZ-123 vendimos en Alemania el último trimestre?"
  • "¿Qué productos generaron más ingresos en EE. UU. este mes?"

Desarrollo

Verificación del certificado SSL

Para fines de desarrollo, el servidor está configurado para omitir la verificación del certificado SSL. En un entorno de producción, se recomienda usar certificados SSL adecuados y eliminar la configuración httpsAgent de la función callMagentoApi .

Agregar nuevas herramientas

Para agregar nuevas herramientas, siga el patrón del código existente. Cada herramienta se define con:

  1. Un nombre único
  2. Una descripción
  3. Parámetros de entrada con validación mediante Zod
  4. Una función de controlador asíncrono que procesa la solicitud y devuelve una respuesta

Licencia

ISC

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

Un servidor de protocolo de contexto de modelo que se conecta a una API REST de Magento 2, lo que permite a Claude y otros clientes de MCP consultar información de productos, datos de clientes y estadísticas de pedidos de una tienda Magento.

  1. Features
    1. Product Features
    2. Customer Features
    3. Order and Revenue Features
  2. Prerequisites
    1. Installation
      1. Usage
        1. Running the server directly
        2. Testing with the test client
        3. Using with Claude Desktop
      2. Available Tools
        1. Product Tools
        2. Customer Tools
        3. Order and Revenue Tools
      3. Example Queries for Claude
        1. Product Queries
        2. Customer Queries
        3. Order and Revenue Queries
      4. Development
        1. SSL Certificate Verification
        2. Adding New Tools
      5. License
        ID: tfobomjjwd