Shopware MCP

🚀 shopware-mcp

shopware-mcp 是一个基于 mcp-framework 构建的模型上下文协议（MCP）服务器，能够为相关应用提供强大的模型上下文处理能力，助力开发者高效构建相关功能。

🚀 快速开始

按照以下步骤安装依赖并构建项目：

# 安装依赖
npm install

# 构建项目
npm run build

✨ 主要特性

• 基于 mcp-framework 构建，具备良好的扩展性和稳定性。
• 提供 CLI 工具，方便开发者添加和管理组件。
• 支持在 Claude Desktop 中使用，便于与其他应用集成。

📦 安装指南

上述“快速开始”中的步骤即为安装指南，通过执行以下命令完成安装和构建：

# 安装依赖
npm install

# 构建项目
npm run build

💻 使用示例

基础用法

项目附带了一个示例工具在 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;

📚 详细文档

项目结构

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

发布到 npm

按照以下步骤将项目发布到 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 文档