Vex

Your vendure admin-api graphql query executor. CLI tool and MCP server for the Vendure Admin GraphQL API.

Use vex from your terminal to manage products, customers, and orders — or connect it as an MCP server so Claude can do it for you.

Features

• Environment management — add, switch, and configure multiple Vendure instances
• Typed resource commands — CRUD operations for customers, products, and orders out of the box
• Raw GraphQL — run any query or mutation directly from the terminal
• Schema caching — fetch and cache your Vendure schema for offline reference
• MCP server — expose all commands as tools so Claude can chain them via natural language

Installation

npm install -g @spaceparrots/vex

This puts the vex command on your PATH.

Requirements

Vendure 3.6+ is required. Vex uses the API key authentication method introduced in Vendure 3.6.

To set up your Vendure instance:

1. Enable API key auth in your Vendure config:

   authOptions: {
       tokenMethod: ['cookie', 'bearer', 'api-key'],
   }
   

2. Go to Settings > API Keys in the Vendure dashboard
3. Create a new key, assign the roles/permissions it needs, and copy the key (it's shown only once)

The key is sent via the vendure-api-key header on every request.

Quick start

# Add an environment
vex env add dev --url http://localhost:3000/admin-api --api-key sk-123456

# List products
vex product list

# Create a customer
vex customer create --email john@example.com --first-name John --last-name Doe

# Run any GraphQL query
vex query '{ products { items { id name } totalItems } }'

# Fetch and cache the schema
vex schema fetch

CLI reference

Environment management

vex env add <name> --url <url> --api-key <key>   # Add environment
                   [--schema-type endpoint|file]   # Schema source type
                   [--schema-value <value>]         # Introspection URL or file path
                   [--fetch-schema]                 # Fetch schema immediately
vex env list                                       # List all environments
vex env switch <name>                              # Switch active environment
vex env set <name> [--url <url>] [--api-key <key>] # Update environment fields
vex env remove <name>                              # Remove environment
vex env show [name]                                # Show environment details

Schema

vex schema fetch [--env <name>]     # Fetch and cache GraphQL schema

Generic GraphQL

vex query '<graphql>' [--variables '<json>']    # Run any query
vex mutate '<graphql>' [--variables '<json>']   # Run any mutation

Customers, Products & Orders

Each resource supports list, get, create, update, and delete plus resource-specific actions (e.g. customer add-note, product add-variants, order transition). Run vex <resource> --help for full options.

MCP setup (Claude Code)

Add to your project's .mcp.json or global ~/.claude.json:

{
  "mcpServers": {
    "vex": {
      "command": "npx",
      "args": ["-y", "@spaceparrots/vex"]
    }
  }
}

Windows might require to run it via cmd /c "npx -y @spaceparrots/vex"

Running vex with no arguments starts the MCP server on stdio — this is what MCP clients expect.

Once connected, ask Claude:

Add my Vendure dev server at http://localhost:3000/admin-api with API key sk-1234

Then you can use natural language:

Create me a dummy order for product "shoes"

Claude will check if the product exists, create it if nee

... View full README on GitHub