JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 42
  • Score
    100M100P100Q59538F
  • License MIT

A command line tool for setting up commercetools MCP server

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@commercetools-demo/mcp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Commercetools Model Context Protocol

    Setup

    To run the commercetools MCP server using npx, use the following command:

    # To set up all available tools
    npx -y @commercetools-demo/mcp --tools=all --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL
    
    # To set up specific tools
    npx -y @commercetools-demo/mcp --tools=products.read --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL
    
    
    Make sure to replace `CLIENT_ID`, `CLIENT_SECRET`, `PROJECT_KEY`, `AUTH_URL`, and `API_URL` with your actual values. Alternatively, you could set the API_KEY in your environment variables.
    
    ### Usage with Claude Desktop
    
    Add the following to your `claude_desktop_config.json`. See [here](https://modelcontextprotocol.io/quickstart/user) for more details.
    
    ```json
    {
      "mcpServers": {
        "commercetools": {
          "command": "npx",
          "args": [
            "-y",
            "@commercetools-demo/mcp",
            "--tools=all",
            "--clientId=CLIENT_ID",
            "--clientSecret=CLIENT_SECRET",
            "--authUrl=AUTH_URL",
            "--projectKey=PROJECT_KEY",
            "--apiUrl=API_URL"
          ]
        }
      }
    }

    Available tools

    Tool Description
    products.read Read product information
    products.create Create product information
    products.update Update product information
    project.read Read project information
    product-search.read Read product search information
    category.read Read category information
    category.create Create category information
    category.update Update category information
    product-selection.read Read product selection information
    product-selection.create Create product selection information
    product-selection.update Update product selection information
    order.read Read order information
    order.create Create order (from cart, quote, import)
    order.update Update order information
    cart.read Read cart information
    cart.create Create cart
    cart.update Update cart information

    Debugging locally

    #  navigate to ../typescript
    pnpm run build
    # navigate to ../modelcontextprotocol
    
    # link the local package
    pnpm add link:../typescript
    
    # run the server in terminal
    npx ts-node src/index.ts --tools=products.read --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --authUrl=AUTH_URL --projectKey=PROJECT_KEY --apiUrl=API_URL
    
    # test using mcptools : Install mcptools from https://github.com/f/mcptools
    mcp call list_products --params '{"limit": 2}' npx ts-node /<absolute-path>/ct-agent-toolkit/modelcontextprotocol/src/index.ts --tools=all \
    --projectKey="PROJECT_KEY" \
    --clientSecret="CLIENT_SECRET" \
    --clientId="CLIENT_ID" \
    --authUrl="AUTH_URL" \
    --apiUrl="API_URL"
    

    Do not commit the linked package in package.json to the repo

    Testing Using Claude Desktop

    #  navigate to ../typescript
    pnpm run build
    
    # navigate to ../modelcontextprotocol
    
    # link the local package
    pnpm add link:../typescript

    Configure MCP servers in Claude Desktop

    {
      "mcpServers": {
        "commercetools": {
          "command": "npx",
          "args": [
            "ts-node",
            "/<absolute-path>/ct-agent-toolkit/modelcontextprotocol/src/index.ts",
            "--tools=all",
            "--projectKey=PROJECT_KEY",
            "--clientSecret=CLIENT_SECRET",
            "--clientId=CLIENT_ID",
            "--authUrl=AUTH_URL",
            "--apiUrl=API_URL"
          ]
        }
      }
    }

    Debugging the Server

    To debug your server, you can use the MCP Inspector.

    First build the server

    npm run build

    Run the following command in your terminal:

    # Start MCP Inspector and server with all tools
    npx @modelcontextprotocol/inspector node dist/index.js --tools=all --clientId=CLIENT_ID --clientSecret=CLIENT_SECRET --projectKey=PROJECT_KEY --authUrl=AUTH_URL --apiUrl=API_URL

    Instructions

    1. Replace CLIENT_ID, CLIENT_SECRET, PROJECT_KEY, AUTH_URL, and API_URL with your actual values.
    2. Run the command to start the MCP Inspector.
    3. Open the MCP Inspector UI in your browser and click Connect to start the MCP server.
    4. You can see the list of tools you selected and test each tool individually.