Shopware MCP

🚀 shopware-mcp

shopware-mcp 是一個基於 mcp-framework 構建的模型上下文協議（MCP）服務器，能夠為相關應用提供強大的模型上下文處理能力，助力開發人員高效構建應用。

🚀 快速開始

# 安裝依賴
npm install

# 構建項目
npm run build

✨ 主要特性

• 支持使用 CLI 添加更多工具，方便擴展功能。
• 提供示例工具結構，便於開發人員進行工具開發。
• 可發佈到 npm，方便用戶在 Claude 桌面客戶端中使用。

📦 安裝指南

# 安裝依賴
npm install

# 構建項目
npm run build

💻 使用示例

基礎用法

項目結構

shopware-mcp/
├── src/
│   ├── tools/        # MCP 工具
│   │   └── ExampleTool.ts
│   └── index.ts      # 服務器入口文件
├── package.json
└── tsconfig.json

添加組件

項目附帶了一個示例工具在 src/tools/ExampleTool.ts。你可以使用 CLI 添加更多工具：

# 添加一個新的工具
mcp add tool my-tool

# 你可能會創建的示例工具：
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

高級用法

工具開發

示例工具結構：

import { MCPTool } from "mcp-framework";
import { z } from "zod";

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "描述你的工具的功能";

  schema = {
    message: {
      type: z.string(),
      description: "此輸入參數的描述",
    },
  };

  async execute(input: MyToolInput) {
    // 在此處編寫你的工具邏輯
    return `處理後的消息：${input.message}`;
  }
}

export default MyTool;

📚 詳細文檔

發佈到 npm

1. 更新你的 package.json：

   • 確保 name 唯一且符合 npm 命名規範
   • 設置適當的 version
   • 添加 description、author、license 等信息
   • 檢查 bin 是否指向正確的入口文件

2. 本地構建和測試：

   npm run build
   npm link
   shopware-mcp  # 在本地測試你的 CLI
   

3. 登錄到 npm（如需，創建賬戶）：

   npm login
   

4. 發佈你的包：

   npm publish
   

發佈後，用戶可以在其 Claude 桌面客戶端中添加它（如下所述）或使用 npx 運行。

與 Claude Desktop 配合使用

本地開發

將以下配置添加到你的 Claude Desktop 配置文件中： MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "shopware-mcp": {
      "command": "node",
      "args":["/絕對路徑/to/shopware-mcp/dist/index.js"]
    }
  }
}

發佈後

將以下配置添加到你的 Claude Desktop 配置文件中： MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "shopware-mcp": {
      "command": "npx",
      "args": ["shopware-mcp"]
    }
  }
}

構建和測試

1. 修改你的工具代碼
2. 運行 npm run build 進行構建
3. 服務器在啟動時會自動加載你的工具

更多信息

• MCP Framework Github
• MCP Framework 文檔