What is Shopware Mcp

shopware-mcp is a Model Context Protocol (MCP) server designed specifically for Shopware, built using the mcp-framework. It facilitates the development and integration of tools that can process and manage data within the Shopware ecosystem.

Use cases

Use cases for shopware-mcp include developing data processing tools, API clients for external services, and file handling utilities that integrate seamlessly with Shopware, improving overall operational efficiency.

How to use

To use shopware-mcp, first install the dependencies with ‘npm install’. Then, build the project using ‘npm run build’. You can add new tools using the CLI command ‘mcp add tool ’. Each tool can be developed by extending the MCPTool class and implementing the required logic.

Key features

Key features of shopware-mcp include a modular architecture allowing for easy addition of tools, a clear project structure for organization, and the ability to publish tools to npm for wider distribution and use.

Where to use

shopware-mcp is primarily used in e-commerce environments, particularly those utilizing Shopware as their platform. It is suitable for developers looking to create custom tools that enhance the functionality of Shopware.

shopware-mcp

A Model Context Protocol (MCP) server built with mcp-framework.

Quick Start

# Install dependencies
npm install

# Build the project
npm run build

Project Structure

shopware-mcp/
├── src/
│   ├── tools/        # MCP Tools
│   │   └── ExampleTool.ts
│   └── index.ts      # Server entry point
├── package.json
└── tsconfig.json

Adding Components

The project comes with an example tool in src/tools/ExampleTool.ts. You can add more tools using the CLI:

# Add a new tool
mcp add tool my-tool

# Example tools you might create:
mcp add tool data-processor
mcp add tool api-client
mcp add tool file-handler

Tool Development

Example tool structure:

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

interface MyToolInput {
  message: string;
}

class MyTool extends MCPTool<MyToolInput> {
  name = "my_tool";
  description = "Describes what your tool does";

  schema = {
    message: {
      type: z.string(),
      description: "Description of this input parameter",
    },
  };

  async execute(input: MyToolInput) {
    // Your tool logic here
    return `Processed: ${input.message}`;
  }
}

export default MyTool;

Publishing to npm

1. Update your package.json:

   • Ensure name is unique and follows npm naming conventions
   • Set appropriate version
   • Add description, author, license, etc.
   • Check bin points to the correct entry file

2. Build and test locally:

   npm run build
   npm link
   shopware-mcp  # Test your CLI locally
   

3. Login to npm (create account if necessary):

   npm login
   

4. Publish your package:

   npm publish
   

After publishing, users can add it to their claude desktop client (read below) or run it with npx

## Using with Claude Desktop

### Local Development

Add this configuration to your Claude Desktop config file:

**MacOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows**: `%APPDATA%/Claude/claude_desktop_config.json`

```json
{
  "mcpServers": {
    "shopware-mcp": {
      "command": "node",
      "args":["/absolute/path/to/shopware-mcp/dist/index.js"]
    }
  }
}

After Publishing

Add this configuration to your Claude Desktop config file:

MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
Windows: %APPDATA%/Claude/claude_desktop_config.json

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

Building and Testing

1. Make changes to your tools
2. Run npm run build to compile
3. The server will automatically load your tools on startup

Learn More

• MCP Framework Github
• MCP Framework Docs