AI导哈

Magento 2 API集成工具

一个独立的HTTP服务器，提供Magento 2 API集成的模型上下文协议（MCP）工具，支持产品查询、订单和收入统计等功能。

  • by mo9rani
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 mo9rani/magento2-mcp-oauth-server

使用说明

Magento 2 MCP服务器

一个独立的HTTP服务器，为Magento 2 API集成提供模型上下文协议（MCP）工具。

备注：这是最初的Magento 2 MCP服务器项目的分支，经过优化和配置，支持OAuth 1.0a基于密钥的身份验证，以实现安全的API访问。

特性

产品特点

  • 按SKU查询产品信息
  • 搜索带页码的产品
  • 获取产品库存信息
  • 获取产品属性

订单和收入特征

  • 获取特定日期范围的订单计数
  • 通过税务选项获得特定日期范围的收入
  • 获取产品销售统计数据，包括销售量和畅销产品
  • 支持相对日期表达式，如“今天”、“昨天”、“上周”、“本月”、“年初至今”
  • 支持使用国家代码和国家名称进行国家过滤

先决条件

  • Node.js（v14或更高版本）
  • 具有REST API访问权限的Magento 2实例
  • Maged 2管理员API令牌

安装

npm install

配置

  1. 复制 .env.example 到 .env:
cp .env.example .env
  1. 更新 .env 使用您的Magento 2凭据：
MAGENTO_BASE_URL=https://your-magento-store.com
MAGENTO_ADMIN_TOKEN=your-admin-token-here
PORT=3000

从Magento获取管理员令牌

  1. 转到Magento管理员： 系统>扩展>集成
  2. 点击“添加新集成”
  3. 填写集成信息：
    • 名称：“MCP服务器”（或任何名称）
    • 您的密码：（您的管理员密码）
  4. 转到“API”选项卡，选择要授予访问权限的资源
  5. 保存并激活集成
  6. 复制“访问令牌”-这是您的MAGENTO_ADMIN_Token

用法

启动HTTP服务器：

npm start

服务器将在上运行 http://localhost:3000 （或您配置的端口）。

HTTP API终结点

健康检查

GET /health

返回服务器健康状态和Magento连接信息。

列出可用工具

GET /tools

返回所有可用的MCP工具及其模式。

执行工具

POST /tools/execute
Content-Type: application/json

{
  "tool": "tool_name",
  "arguments": {
    "arg1": "value1"
  }
}

可用工具

产品工具

  • get_product_by_sku：按SKU获取产品的详细信息
  • search_products：使用带分页的查询字符串搜索产品

订单和收入工具

  • get_order_count：获取给定日期范围内的订单数
  • get_revenue：获取给定日期范围内的总收入（含可选税）
  • get_product_sales：获取某个日期范围内销售产品的统计数据

示例用法

与HTTP客户端一起使用（curl）

# Health check
curl http://localhost:3000/health

# List tools
curl http://localhost:3000/tools

# Search products
curl -X POST http://localhost:3000/tools/execute \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "search_products",
    "arguments": {
      "query": "shirt",
      "page_size": 10,
      "current_page": 1
    }
  }'

# Get revenue
curl -X POST http://localhost:3000/tools/execute \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "get_revenue",
    "arguments": {
      "date_range": "last month",
      "include_tax": true
    }
  }'

使用Mastra框架

查看您的项目集成，网址为 packages/agents/src/mastra/config/mcp.ts 和 packages/agents/src/mastra/tools/magento-client.ts 用于TypeScript客户端实现示例。

发展

SSL证书验证

出于开发目的，服务器可以被配置为绕过SSL证书验证。在生产中，使用适当的SSL证书。

许可证

国际学生委员会

相关 MCP