@anton.andrusenko/shopify-mcp-admin 1.1.1 → 1.1.2

package/README.md

@@ -191,6 +191,198 @@ Quit and reopen Claude Desktop. You should see "shopify" in the MCP servers list
 
 ---
 
+## 💬 LibreChat Integration
+
+[LibreChat](https://www.librechat.ai/) is an open-source AI chat interface that supports MCP servers natively. This section provides a complete guide to set up LibreChat with the Shopify MCP server.
+
+### Prerequisites
+
+- **Docker Desktop** — [Download](https://www.docker.com/products/docker-desktop) and ensure it's running
+- **Git** — For cloning repositories
+- **LLM API Key** — OpenAI or Anthropic API key for the chat functionality
+
+### Quick Setup (Recommended)
+
+Use the included setup script for automated installation:
+
+```bash
+# Clone this repo (if you haven't already)
+git clone https://github.com/AntonAndrusenko/shopify-mcp-admin.git
+cd shopify-mcp-admin
+
+# Run the setup script
+./scripts/setup-librechat.sh
+```
+
+The script will:
+1. Check Docker is installed and running
+2. Clone LibreChat to `~/LibreChat`
+3. Prompt for your Shopify credentials (store URL, access token or OAuth)
+4. Create `librechat.yaml` with MCP server configuration
+5. Create `docker-compose.override.yml` to mount the config
+6. Pull Docker images and start all containers
+7. Verify the Shopify MCP server loads successfully
+
+**Script Options:**
+```bash
+# Install to a custom directory
+./scripts/setup-librechat.sh --install-dir /path/to/librechat
+
+# Use local development build instead of npm package
+./scripts/setup-librechat.sh --use-local
+
+# Show help
+./scripts/setup-librechat.sh --help
+```
+
+### Manual Setup
+
+<details>
+<summary>Click to expand manual installation steps</summary>
+
+#### Step 1: Clone and Configure LibreChat
+
+```bash
+# Clone LibreChat
+git clone https://github.com/danny-avila/LibreChat.git
+cd LibreChat
+
+# Create environment file
+cp .env.example .env
+```
+
+#### Step 2: Create MCP Server Configuration
+
+Create `librechat.yaml` in the LibreChat directory:
+
+```yaml
+version: 1.2.1
+
+mcpServers:
+  shopify:
+    type: stdio
+    command: npx
+    args:
+      - -y
+      - "@anton.andrusenko/shopify-mcp-admin"
+    env:
+      SHOPIFY_STORE_URL: "your-store.myshopify.com"
+      # Option 1: Access Token
+      SHOPIFY_ACCESS_TOKEN: "shpat_xxxxx"
+      # Option 2: OAuth (comment out ACCESS_TOKEN, uncomment these)
+      # SHOPIFY_CLIENT_ID: "your_client_id"
+      # SHOPIFY_CLIENT_SECRET: "your_client_secret"
+      LOG_LEVEL: "info"
+    serverInstructions: true
+    timeout: 30000
+    initTimeout: 15000
+```
+
+#### Step 3: Mount Configuration in Docker
+
+Create `docker-compose.override.yml`:
+
+```yaml
+services:
+  api:
+    volumes:
+      - type: bind
+        source: ./librechat.yaml
+        target: /app/librechat.yaml
+```
+
+#### Step 4: Start LibreChat
+
+```bash
+# Pull the latest images
+docker compose pull
+
+# Start all services
+docker compose up -d
+
+# Verify containers are running
+docker compose ps
+```
+
+#### Step 5: Verify MCP Server Loaded
+
+```bash
+# Check logs for MCP initialization
+docker compose logs api | grep -i "mcp"
+
+# You should see:
+# [MCP][shopify] Initialized in: XXXXms
+# MCP servers initialized successfully. Added 79 MCP tools.
+```
+
+</details>
+
+### After Installation: Enable MCP in LibreChat
+
+Once LibreChat is running, follow these steps to use the Shopify MCP server:
+
+#### 1. Create an Account
+- Open http://localhost:3080 in your browser
+- Click "Sign up" and create an account
+- Log in with your new credentials
+
+#### 2. Add an LLM API Key
+- Click your **profile avatar** (bottom-left)
+- Select **Settings**
+- Go to **User Provider Keys**
+- Add your API key:
+  - **OpenAI**: Paste your `sk-...` key
+  - **Anthropic**: Paste your `sk-ant-...` key
+- Click **Save**
+
+#### 3. Select the Shopify MCP Server
+- Start a **New Chat**
+- Look for the **MCP Servers** dropdown in the chat input area (shows a plug icon)
+- Click it and select **"shopify"**
+- You should see a "shopify" badge appear, indicating the MCP server is active
+
+#### 4. Test the Integration
+Try these prompts to verify everything works:
+
+```
+"What's my store name and what plan am I on?"
+"List my products"
+"Show me products with low inventory"
+```
+
+### Troubleshooting
+
+| Issue | Solution |
+|-------|----------|
+| MCP server not appearing | Check logs: `docker compose logs api \| grep -i mcp` |
+| "shopify" badge not visible | Refresh the page, or restart: `docker compose restart` |
+| Tools not working | Verify Shopify credentials in `librechat.yaml` |
+| Docker won't start | Ensure Docker Desktop is running |
+| Permission denied on script | Run: `chmod +x ./scripts/setup-librechat.sh` |
+
+### Useful Commands
+
+```bash
+# View LibreChat logs
+cd ~/LibreChat && docker compose logs api -f
+
+# View only MCP-related logs
+cd ~/LibreChat && docker compose logs api | grep -i "mcp\|shopify"
+
+# Restart LibreChat (after config changes)
+cd ~/LibreChat && docker compose restart
+
+# Stop LibreChat
+cd ~/LibreChat && docker compose down
+
+# Update LibreChat
+cd ~/LibreChat && git pull && docker compose pull && docker compose up -d
+```
+
+> 📄 **Advanced Configuration:** See `librechat.yaml.example` for multi-store setups, role presets, and HTTP/SSE transport modes.
+
+---
+
 ## 🌐 OpenAI/ChatGPT Integration
 
 For OpenAI function calling or ChatGPT plugins, use HTTP transport mode.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anton.andrusenko/shopify-mcp-admin",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "MCP server for Shopify Admin API - enables AI agents to manage Shopify stores with 79 tools for products, inventory, collections, content, SEO, metafields, markets & translations",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,10 +24,8 @@
     "inspect": "npx @modelcontextprotocol/inspector node dist/index.js",
     "inspect:dev": "npx @modelcontextprotocol/inspector npx tsx src/index.ts",
     "inspect:config": "npx @modelcontextprotocol/inspector --config mcp-inspector.json",
-    "fast-agent": "fast-agent",
-    "fast-agent:check": "fast-agent check",
-    "fast-agent:chat": "fast-agent go --servers shopify-mcp-admin",
-    "fast-agent:dev": "fast-agent go --servers shopify-mcp-admin-dev",
+    "librechat:setup": "./scripts/setup-librechat.sh",
+    "librechat:setup:local": "./scripts/setup-librechat.sh --use-local",
     "ci": "npm run lint && npm run typecheck && npm run test && npm run build",
     "version:patch": "npm version patch --no-git-tag-version",
     "version:minor": "npm version minor --no-git-tag-version",