To connect an AI agent to your Quickshops store, you need a headless API key and the MCP server URL. Once connected, your AI client can call tools to browse your catalog, manage carts, and generate checkout links in real time.Documentation Index
Fetch the complete documentation index at: https://docs.quickshops.app/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
Before connecting, retrieve your headless API key from Dashboard → Settings → API Keys. Keys prefixed withqk_ are your headless keys. If you want your agent to create carts, initiate checkouts, or access the subscription portal, you need a secret key — not a public/read-only key.
Connection details
| Setting | Value |
|---|---|
| URL | https://mcp.quickshops.dev/mcp |
| Header | x-api-key: qk_your_key_here |
| Transport | Streamable HTTP (MCP over HTTP + SSE) |
Connect your client
- Claude Desktop
- Cursor
- Custom client
Open your Claude Desktop configuration file (Save the file and restart Claude Desktop. Quickshops tools will appear in the tool list when you start a new conversation.
claude_desktop_config.json) and add the quickshops entry under mcpServers:claude_desktop_config.json
Available tools
Every tool maps directly to a REST API route. Tool names are derived from the HTTP method and path.Tools that access cart, checkout, and subscription data require a secret key. Connecting with a public or read-only key means those tools will return an error when called. Read product tools (
get_products, get_products_productId, get_products_store) work with any key type.Store & products
| Tool | Description |
|---|---|
get_products_store | Get your store details and metadata |
get_products | List all products in your store |
get_products_productId | Get a single product by ID |
Cart (secret key required)
| Tool | Description |
|---|---|
post_cart | Create a new cart |
get_cart_cartId | Get cart contents including lines and totals |
post_cart_cartId_lines | Add a product to the cart |
patch_cart_cartId_lines_productId | Update an item’s quantity |
delete_cart_cartId_lines_productId | Remove a specific item from the cart |
delete_cart_cartId | Clear the entire cart |
Checkout & subscriptions (secret key required)
| Tool | Description |
|---|---|
post_checkout_session | Create a Stripe checkout URL for a cart |
post_subscription_portal | Get a Stripe billing portal URL for a member |
Get your API key
Go to Dashboard → Settings → API Keys and copy your headless API key. Use a secret key if you want your agent to manage carts and checkouts.
Add the MCP server to your client
Use the configuration examples above for your client. Set the URL to
https://mcp.quickshops.dev/mcp and add your key as the x-api-key header.