Vendure

You can run a Vendure MCP Server inside your project to orchestrate Vendure CLI commands, analyze your project, and connect local or remote clients through STDIO or HTTP. This guide shows practical steps to use, install, and configure the MCP server for seamless programmatic access to your Vendure CLI.

How to use

Connect your MCP client to the Vendure MCP Server to access context-aware tooling and Vendure CLI commands from your local project. Use STDIO for local clients like Cursor or Claude Code, or run in HTTP mode to connect over a network. The server automatically reflects your project’s installed CLI commands and options, ensuring you always operate with the latest capabilities. You can analyze your project structure, list plugins, entities, and services, and perform CLI actions such as adding or migrating within the context of your Vendure project.

How to install

Prerequisites you need before installing the MCP server:
- Node.js (recommended LTS version)
- npm (comes with Node.js) or Yarn
- A Vendure project with @vendure/cli installed (version > 3.4.0 is recommended for CLI orchestration features)

1. Install and set up the MCP server to run inside your Vendure project in STDIO mode. This creates a direct, local connection to your Vendure CLI commands.

{
  "mcpServers": {
    "vendure_stdio": {
      "command": "npx",
      "args": ["@vendure/mcp-server@latest", "--projectPath", "/path/to/your/vendure-project"]
    }
  }
}

2. If you prefer HTTP connection, start the server in HTTP mode from your Vendure project root.

npx @vendure/mcp-server@latest --transport http --projectPath .

3. Configure your MCP client to connect to the running HTTP server by pointing it to the server URL.

{
  "mcpServers": {
    "vendure": {
      "url": "http://localhost:8000/mcp"
    }
  }
}

4. If you want to run via Docker, execute the Docker-based stdio configuration shown below.

{
  "mcpServers": {
    "vendure-docker": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "--env",
        "PROJECT_PATH=/workspace",
        "--volume",
        "/absolute/path/to-your-vendure-project:/workspace",
        "vendure/mcp:latest",
        "--projectPath",
        "/workspace"
      ]
    }
  }
}

Additional setup notes

The MCP server adapts to your project’s Vendure CLI definitions at runtime. This means new CLI commands or options become available automatically without manual updates to the MCP itself.

Troubleshooting and tips

If you encounter issues, collect MCP logs from your client (for example, in Cursor you can access MCP Logs) and share them when reporting the problem. Ensure the target Vendure project path is correct and that the Vendure CLI is installed in that project.

Notes on usage in development

In development, you can run the MCP server directly from your source tree and point it at a test Vendure project to validate both STDIO and HTTP modes. The same principles apply: use STDIO for local workflows and HTTP for networked clients.

Available tools

analyzeProject

Analyze the Vendure project structure to list plugins, entities, and services available within the current project.

listCliCommands

List available Vendure CLI commands detected from the local project, enabling dynamic tool generation.

checkEnvironment

Verify Vendure installation and dependencies inside the project to ensure the MCP can operate correctly.

fetchDocs

Fetch official Vendure documentation to use as context during command execution.

generateToolsFromCli

Dynamically generate MCP tools based on the installed Vendure CLI command definitions.

startMCPServer

Start or manage the MCP server process for the connected Vendure project.