Medusa Mcp

by SGFGOV

290 downloads
Not rated
GitHub

About

Medusa Mcp is a Model Context Protocol (MCP) server designed for integration with the Medusa JavaScript SDK. It provides a scalable backend layer for managing and interacting with Medusa’s data models, enabling automation, orchestration, and intelligent service extensions. It is…

Details

Author
SGFGOV
Downloads
290
Categories
Other

- Model Context Protocol (MCP) support
- Scalable infrastructure
- Extensible plugin architecture
- Integrated with Medusa JS SDK

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Medusa Mcp
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Clone the repository, run npm install, then npm run build to compile, and start the server with npm start. Test the server using the MCP Inspector with npx @modelcontextprotocol/inspector ./dist/index.js. Configuration requires setting environment variables: MEDUSA_BACKEND_URL, PUBLISHABLE_KEY, MEDUSA_USERNAME, and MEDUSA_PASSWORD. For customization, replace the OpenAPI schema files in the oas/ folder with your own admin and store definitions.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "medusa mcp": {
            "medusa-mcp": {
                "command": "npx",
                "args": [
                    "@modelcontextprotocol/inspector",
                    "./dist/index.js"
                ]
            }
        }
    }
}

McpServers

{
    "medusa-mcp": {
        "command": "npx",
        "args": [
            "@modelcontextprotocol/inspector",
            "./dist/index.js"
        ]
    }
}

medusa-mcp

Overview

medusa-mcp is a Model Context Protocol (MCP) server designed for integration with the Medusa JavaScript SDK. It provides a scalable backend layer for managing and interacting with Medusa’s data models, enabling automation, orchestration, and intelligent service extensions.

---

🧩 What is an MCP Server?

An MCP server is a modular, extensible backend that:

- Enables real-time service orchestration
- Supports standardized, high-throughput communication
- Acts as a bridge between AI/automation tools and real-world systems

These servers are used in areas like AI, IoT, and enterprise software to connect various services and automate tasks using standardized protocols like JSON-RPC.

🔑 Key Features

- Modular Architecture – Composable services for flexibility
- High Efficiency – Optimized for speed and scale
- Extensible Design – Add new capabilities easily
- Cross-Environment Deployment – Cloud, on-prem, or hybrid
- AI-Ready Interfaces – Integrate LLMs and tools seamlessly

🧠 Role in AI Systems

MCP servers allow AI agents to:

- Access real-time data from APIs, files, or databases
- Automate business processes (e.g., order fulfillment, pricing updates)
- Interact with external services in a secure and controlled way

---

---

🚀 Medusa JS + MCP

Using medusa-mcp, Medusa JS can:

- Automate workflows (e.g., inventory or pricing adjustments)
- Connect with external tools (email, analytics, etc.)
- Use AI agents to analyze trends and trigger actions
- Enable scalable, modular architecture for commerce platforms

---

✨ Features

- ✅ Model Context Protocol (MCP) support
- 📈 Scalable infrastructure
- 🧱 Extensible plugin architecture
- 🔗 Integrated with Medusa JS SDK

---

🛠️ Installation

Clone the repository and install dependencies:

npm install

Build the project:

npm run build

---

▶️ Usage

Start the server:

npm start

Test using the MCP Inspector:

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

> Note: Restart the Inspector and your browser after each rebuild.

---

🌍 Environment Variables

| Variable | Description |
|-----------------------|--------------------------------------|
| MEDUSA_BACKEND_URL | Your Medusa backend URL |
| PUBLISHABLE_KEY | Your Medusa publishable API key |
| MEDUSA_USERNAME | Medusa admin username (for admin) |
| MEDUSA_PASSWORD | Medusa admin password (for admin) |

Server runs at: http://localhost:3000

---

🧠 Architecture Diagram

Here's how the medusa-mcp server fits into a typical setup with Medusa JS and external systems:


       +-------------------------+
       |     AI Assistant /      |
       |     LLM / Automation    |
       +-----------+-------------+
                   |
                   v
    +--------------+--------------+
    |     MCP Server (medusa-mcp) |
    |-----------------------------|
    | - JSON-RPC Communication    |
    | - AI-Ready Interface        |
    | - Plugin Support            |
    +------+----------------------+
                   |                             
                   +
                   |                                                         
                   v                                                         
         +-------------------+
         | Medusa Backend    |
         | (Products, Orders)|
         +-------------------+
                   |
                   |
                   v
           +--------------+
           | Medusa Store |
           | Frontend     |
           +--------------+
                   |
                   |
                   v
      +-------------------------+
      | External Services / API |
      | (e.g., Payments, Email) |
      +-------------------------+

🧪 Customization

To tailor the server to your Medusa setup:

> Replace admin.json and store.json with your own OAS definitions for fine-grained control.

- Replace the OpenAPI schemas in the oas/ folder:
- admin.json – Admin endpoints
- store.json – Storefront endpoints

Use the @medusajs/medusa-oas-cli to regenerate these files.

You can also fork this project to build your own custom MCP-powered Medusa integration.

---

🤝 Contributing

We welcome contributions! Please see our CONTRIBUTING.md guide.

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.