> ## Documentation Index
> Fetch the complete documentation index at: https://chariow.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Supported tools

> All available MCP tools for querying your Chariow store

The Chariow MCP server provides 21 read-only tools for accessing your store data. All tools are idempotent and cannot modify your store.

## Tools reference

| Tool                            | Description                                                          | Sample prompt                             |
| ------------------------------- | -------------------------------------------------------------------- | ----------------------------------------- |
| `global_search`                 | Search across all store data (products, customers, sales, discounts) | "Search for 'premium' in my store"        |
| `get_store`                     | Get store profile, settings, and sales summary                       | "Show me my store information"            |
| `list_products`                 | List products with optional filters (status, category, type)         | "List my published products"              |
| `get_product`                   | Get full details for a specific product                              | "Show me details for product prd\_abc123" |
| `list_customers`                | List customers with optional search                                  | "Find customers named Marie"              |
| `get_customer`                  | Get full profile for a specific customer                             | "Show me customer cus\_abc123"            |
| `list_sales`                    | List sales with filters (status, date range, customer)               | "Show me today's completed sales"         |
| `get_sale`                      | Get complete details for a specific sale                             | "Get details for sale sal\_xyz789"        |
| `list_discounts`                | List discount codes with optional filters                            | "List my active discount codes"           |
| `get_discount`                  | Get full details for a specific discount                             | "How many times has SUMMER20 been used?"  |
| `list_licenses`                 | List issued licenses with filters (status, customer, product)        | "List all active licenses"                |
| `get_license`                   | Get details for a specific license key                               | "Check license ABC-123-XYZ-789"           |
| `get_license_activations`       | View activation history for a license                                | "Show activations for license ABC-123"    |
| `list_pulses`                   | List webhook configurations                                          | "List my webhooks"                        |
| `get_pulse`                     | Get details for a specific webhook                                   | "Show me pulse pulse\_abc123"             |
| `get_store_analytics`           | Get store performance overview (visits, conversions, sales)          | "Show me store analytics for this month"  |
| `get_sales_analytics`           | Get detailed revenue and sales analysis                              | "What's my revenue this month?"           |
| `get_customer_analytics`        | Get customer insights (new vs returning, geography)                  | "Who are my top 5 customers?"             |
| `get_visits_analytics`          | Get traffic analysis (sources, devices, locations)                   | "Where is my traffic coming from?"        |
| `get_conversion_rate_analytics` | Get conversion rates by device, country, product                     | "What's my conversion rate?"              |

***

## Tool details

### global\_search

Search across all your store data at once.

| Parameter | Type    | Required | Description                             |
| --------- | ------- | -------- | --------------------------------------- |
| `query`   | string  | Yes      | Search term                             |
| `limit`   | integer | No       | Results per category (1-10). Default: 5 |
| `from`    | string  | No       | Start date (YYYY-MM-DD)                 |
| `to`      | string  | No       | End date (YYYY-MM-DD)                   |

***

### get\_store

Get your store profile, settings, and sales summary. No parameters required.

***

### list\_products

List products with filtering and pagination.

| Parameter  | Type    | Required | Description                                                                  |
| ---------- | ------- | -------- | ---------------------------------------------------------------------------- |
| `search`   | string  | No       | Search by name or slug                                                       |
| `status`   | string  | No       | Filter: `draft`, `published`, `archived`                                     |
| `category` | string  | No       | Filter by category                                                           |
| `type`     | string  | No       | Filter: `downloadable`, `service`, `course`, `license`, `bundle`, `coaching` |
| `per_page` | integer | No       | Results per page (1-100). Default: 20                                        |
| `cursor`   | string  | No       | Pagination cursor                                                            |

***

### get\_product

Get full details for a specific product.

| Parameter    | Type   | Required | Description                    |
| ------------ | ------ | -------- | ------------------------------ |
| `product_id` | string | Yes      | Product ID (`prd_xxx`) or slug |

***

### list\_customers

List customers with optional search.

| Parameter  | Type    | Required | Description                           |
| ---------- | ------- | -------- | ------------------------------------- |
| `search`   | string  | No       | Search by name or email               |
| `per_page` | integer | No       | Results per page (1-100). Default: 20 |
| `cursor`   | string  | No       | Pagination cursor                     |

***

### get\_customer

Get full profile for a specific customer.

| Parameter     | Type   | Required | Description             |
| ------------- | ------ | -------- | ----------------------- |
| `customer_id` | string | Yes      | Customer ID (`cus_xxx`) |

***

### list\_sales

List sales with filtering options.

| Parameter     | Type    | Required | Description                                           |
| ------------- | ------- | -------- | ----------------------------------------------------- |
| `status`      | string  | No       | Filter: `completed`, `failed`, `pending`, `abandoned` |
| `customer_id` | string  | No       | Filter by customer                                    |
| `start_date`  | string  | No       | From date (YYYY-MM-DD)                                |
| `end_date`    | string  | No       | To date (YYYY-MM-DD)                                  |
| `per_page`    | integer | No       | Results per page (1-100). Default: 10                 |
| `cursor`      | string  | No       | Pagination cursor                                     |

***

### get\_sale

Get complete details for a specific sale.

| Parameter | Type   | Required | Description         |
| --------- | ------ | -------- | ------------------- |
| `sale_id` | string | Yes      | Sale ID (`sal_xxx`) |

***

### list\_discounts

List discount codes with optional filters.

| Parameter  | Type    | Required | Description                             |
| ---------- | ------- | -------- | --------------------------------------- |
| `status`   | string  | No       | Filter: `active`, `expired`, `disabled` |
| `search`   | string  | No       | Search by code or name                  |
| `per_page` | integer | No       | Results per page (1-100). Default: 20   |
| `cursor`   | string  | No       | Pagination cursor                       |

***

### get\_discount

Get full details for a specific discount.

| Parameter     | Type   | Required | Description             |
| ------------- | ------ | -------- | ----------------------- |
| `discount_id` | string | Yes      | Discount ID (`dis_xxx`) |

***

### list\_licenses

List issued licenses with filters.

| Parameter     | Type    | Required | Description                            |
| ------------- | ------- | -------- | -------------------------------------- |
| `status`      | string  | No       | Filter: `active`, `expired`, `revoked` |
| `customer_id` | string  | No       | Filter by customer                     |
| `product_id`  | string  | No       | Filter by product                      |
| `per_page`    | integer | No       | Results per page (1-100). Default: 20  |
| `cursor`      | string  | No       | Pagination cursor                      |

***

### get\_license

Get details for a specific license key.

| Parameter     | Type   | Required | Description                           |
| ------------- | ------ | -------- | ------------------------------------- |
| `license_key` | string | Yes      | License key (e.g., `ABC-123-XYZ-789`) |

***

### get\_license\_activations

View activation history for a license.

| Parameter     | Type   | Required | Description |
| ------------- | ------ | -------- | ----------- |
| `license_key` | string | Yes      | License key |

***

### list\_pulses

List webhook configurations.

| Parameter  | Type    | Required | Description                           |
| ---------- | ------- | -------- | ------------------------------------- |
| `search`   | string  | No       | Search webhooks                       |
| `per_page` | integer | No       | Results per page (1-100). Default: 20 |
| `cursor`   | string  | No       | Pagination cursor                     |

***

### get\_pulse

Get details for a specific webhook.

| Parameter  | Type   | Required | Description            |
| ---------- | ------ | -------- | ---------------------- |
| `pulse_id` | string | Yes      | Pulse ID (`pulse_xxx`) |

***

### get\_store\_analytics

Get store performance overview.

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| `from`    | string | Yes      | Start date (YYYY-MM-DD) |
| `to`      | string | Yes      | End date (YYYY-MM-DD)   |

***

### get\_sales\_analytics

Get detailed revenue and sales analysis.

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| `from`    | string | Yes      | Start date (YYYY-MM-DD) |
| `to`      | string | Yes      | End date (YYYY-MM-DD)   |

***

### get\_customer\_analytics

Get customer insights and top customers.

| Parameter             | Type    | Required | Description                          |
| --------------------- | ------- | -------- | ------------------------------------ |
| `from`                | string  | Yes      | Start date (YYYY-MM-DD)              |
| `to`                  | string  | Yes      | End date (YYYY-MM-DD)                |
| `top_customers_limit` | integer | No       | Number of top customers. Default: 10 |

***

### get\_visits\_analytics

Get traffic analysis.

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| `from`    | string | Yes      | Start date (YYYY-MM-DD) |
| `to`      | string | Yes      | End date (YYYY-MM-DD)   |

***

### get\_conversion\_rate\_analytics

Get conversion rates by device, country, and product.

| Parameter | Type   | Required | Description             |
| --------- | ------ | -------- | ----------------------- |
| `from`    | string | Yes      | Start date (YYYY-MM-DD) |
| `to`      | string | Yes      | End date (YYYY-MM-DD)   |

***

## Rate limits

The MCP server allows an average of **60 requests per minute** per connection. If you hit rate limits, wait a moment before continuing.

***

## Next steps

<CardGroup cols={2}>
  <Card title="Setup guide" icon="plug" href="/en/mcp/setup">
    Connect your AI tool
  </Card>

  <Card title="Security" icon="shield" href="/en/mcp/security">
    Learn about data sharing
  </Card>
</CardGroup>
