Getting started
      Back to home
      1. Help Centre
      2. Getting started

      Getting Started with the MerchantSpring MCP Server & Claude Desktop (Beta)

      This guide will walk you through the setup process for using MerchantSpring’s MCP server with Claude Desktop.

      1. What You’ll Need

      Before starting, make sure you have:

      • An active Claude Desktop subscription.

      • The MCP configuration file (attached to your email).

      • An API key:

        • The configuration file includes a demo store API key to get you started.

        • Once you have your own API Gateway access, replace the demo key with your own API key.

      2. Update the MCP Configuration File

      1. Open the configuration file you received (e.g., Claude_desktop_config.json) in a text editor.

        1. {
            "globalShortcut": "",
            "mcpServers": {
              "merchantspring": {
                "command": "npx",
                "args": [
                  "-y",
                  "--package", "node@22",
                  "--package", "mcp-remote@latest",
                  "mcp-remote",
                  "https://mcp.merchantspring.io/sse",
                  "--header", "Authorization:${AUTH_HEADER}"
                ],
                "env": {
                  "AUTH_HEADER": "Bearer xkEl4VQlVma2pDK12puFh8hbz1vxjlHY4tnpaSTI"
                }
              }
              
            }
          }

      2. Locate the section containing:

         "AUTH_HEADER": "Bearer XXX"

      3. Replace XXX with your API key:

        • Start with the demo store key provided. xkEl4VQlVma2pDK12puFh8hbz1vxjlHY4tnpaSTI

        • Later, replace it with your own API key once you have access.

        • ⚠️ Important: Keep the word Bearer in front of your key.

      3. Apply the Configuration in Claude Desktop

      1. Open Claude Desktop.

      2. Go to Settings → Manage Connectors (scroll to the bottom).

      3. Select Developer → Edit Config.

      4. Open the Claude_desktop_config.json file.

      5. Copy and paste your updated configuration into this file.

      6. Save the file.

      4. Restart Claude Desktop

      • Quit Claude Desktop completely.

      • Reopen it.

      • The updated configuration will be picked up automatically, establishing a connection with the MerchantSpring MCP server.

      5. Enable MCP in Settings

      • After restart, go back to Settings.

      • Ensure that MerchantSpring MCP is listed and toggled on.

      • You now have access to all MCP-enabled tools and API calls.

      6. Test the Connection

      1. Start a new chat in Claude Desktop.

      2. Try a simple request, such as:

        “How many channels do I have connected?”

      3. The MCP server will fetch data using the connected APIs.

      7. Example Use Cases

      • Channel overview: Quickly see connected stores and channels.

      • Performance reports: Request traffic, conversion, and sales insights.

      • Custom analysis: Ask for tailored insights, e.g., “What are my highest-traffic SKUs in the US Amazon store?”

      • Visual dashboards: Ask Claude to generate dashboards from data.

      8. Permissions

      • Claude Desktop may prompt you to allow tool access.

      • We recommend selecting “Always Allow” for smoother workflows.

      9. FAQ & Support

      • Please refer to the Frequently Asked Questions document for common setup issues and troubleshooting.

      • Remember: the MCP server requires a valid MerchantSpring API key to connect to your own data.

      10. Feedback

      This feature is currently in beta. We’d love to hear your thoughts:

      • What works well?

      • What could be improved?

      • What additional features would you like to see?