关键词

Medusa电商平台电商API工具JSON-RPC数据访问功能扩展

使用说明

项目简介

medusa-mcp 是一个 Model Context Protocol (MCP) 服务器，专为与 Medusa JavaScript SDK 集成而设计。它为 Medusa 的数据模型提供可扩展的后端层，实现自动化、编排和智能服务扩展。作为一个 MCP 服务器，它充当 AI/自动化工具与 Medusa 电商系统之间的桥梁，支持实时服务编排和高吞吐量通信。

主要功能点

  • Medusa 数据模型访问: 通过 MCP 协议，允许 LLM 客户端安全访问 Medusa 电商平台的商品、订单、客户等数据资源。
  • Medusa 功能扩展: 将 Medusa 的各项电商功能（如创建订单、更新库存等）注册为 MCP 工具，供 LLM 客户端调用，实现业务流程自动化。
  • 可扩展插件架构: 采用模块化架构，易于扩展新的功能和服务，例如集成邮件、分析工具或更多 Medusa Admin API。
  • JSON-RPC 通信: 使用标准的 JSON-RPC 协议与 MCP 客户端进行高效通信。
  • 多种部署环境: 支持云、本地部署或混合环境部署。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/SGFGOV/medusa-mcp.git
cd medusa-mcp

  2. 安装依赖:

    npm install

  3. 构建项目:

    npm run build

服务器配置

MCP 服务器需要以下配置信息才能启动并连接到 Medusa 后端。MCP 客户端需要配置以下 'server' 字段以连接到该服务器：

{
  "server": {
    "name": "Medusa MCP Server",
    "command": "npm",
    "args": ["start"],
    "env": {
      "MEDUSA_BACKEND_URL": "YOUR_MEDUSA_BACKEND_URL", // 替换为您的 Medusa 后端 URL，例如 "http://localhost:9000"
      "PUBLISHABLE_KEY": "YOUR_MEDUSA_PUBLISHABLE_API_KEY", // 替换为您的 Medusa Publishable API Key
      "MEDUSA_USERNAME": "MEDUSA_ADMIN_USERNAME", // 可选，Medusa Admin 用户名 (用于 Admin API 工具)
      "MEDUSA_PASSWORD": "MEDUSA_ADMIN_PASSWORD"  // 可选，Medusa Admin 密码 (用于 Admin API 工具)
    }
  }
}

注意:

  • 请将 'YOUR_MEDUSA_BACKEND_URL'、'YOUR_MEDUSA_PUBLISHABLE_API_KEY' 替换为您的 Medusa 后端实际配置。
  • 'MEDUSA_USERNAME' 和 'MEDUSA_PASSWORD' 为可选配置，仅当您需要使用 Admin API 工具时才需要配置。

基本使用方法

  1. 启动 MCP 服务器:

    npm start

    服务器默认运行在 'stdio' 传输协议上。

  2. 使用 MCP Inspector 测试 (可选):

    npx @modelcontextprotocol/inspector ./dist/index.js

    按照提示操作，即可通过 MCP Inspector 连接到服务器并测试其功能。

  3. 集成到 MCP 客户端: 配置 MCP 客户端，使其连接到运行中的 'medusa-mcp' 服务器。客户端即可通过 MCP 协议调用服务器提供的 Medusa 数据访问和功能工具。

信息

分类

商业系统

访问项目