Supported tools - Chariow Developers

The Chariow MCP server provides 46 read-only tools for accessing your store data. All tools are idempotent and cannot modify your store. The tools an AI assistant can see depend on the role of the team member who approved the connection. A tool outside that role is neither listed nor callable, and returns “Tool not found” if the assistant calls it anyway. The Requires column shows the team permission each tool needs; “view” means view-only or full access.

Tools reference

Store and search

Tool	Description	Requires	Sample prompt
`get_store`	Get the store profile, settings, social links and sales totals	Any team member	”Show me my store information”
`global_search`	Search products, discounts, customers, pulses, sales and workflows at once	At least one of Products, Discounts, Customers, Pulses, Sales or Workflows (view); sections the role cannot view are left empty	”Search for ‘premium’ in my store”

Products

Tool	Description	Requires	Sample prompt
`list_products`	List products with filters (search, status, category, type)	Products (view)	“List my published products”
`get_product`	Get full details for a product	Products (view)	“Show me details for product prd_abc123”
`get_product_details`	Get one sub-entity of a product: FAQs, price variants, files, custom fields, bundle products, SEO or licence settings	Products (view)	“Show the FAQs of my ebook”

Customers

Tool	Description	Requires	Sample prompt
`list_customers`	List customers with optional search	Customers (view)	“Find customers named Marie”
`get_customer`	Get a customer profile by ID or email address	Customers (view)	“Show me customer marie@example.com”

Sales

Tool	Description	Requires	Sample prompt
`list_sales`	List sales with filters (status, customer, date range)	Sales (view)	“Show me today’s completed sales”
`get_sale`	Get complete details for a sale, including payment and shipping	Sales (view)	“Get details for sale sal_xyz789”

Discounts

Tool	Description	Requires	Sample prompt
`list_discounts`	List discount codes with optional filters	Discounts (view)	“List my active discount codes”
`get_discount`	Get a discount configuration and usage stats	Discounts (view)	“How many times has SUMMER20 been used?”

Licences

Tool	Description	Requires	Sample prompt
`list_licenses`	List issued licences with filters (status, customer, product)	Products (view)	“List all active licences”
`get_license`	Get details for a licence key	Products (view)	“Check licence ABC-123-XYZ-789”
`get_license_activations`	View the activation history of a licence	Products (view)	“Show activations for licence ABC-123”

Pulses (webhooks)

Tool	Description	Requires	Sample prompt
`list_pulses`	List webhook configurations	Pulses (view)	“List my webhooks”
`get_pulse`	Get a webhook and its trigger configuration	Pulses (view)	“Show me pulse pulse_abc123”

Workflows

Tool	Description	Requires	Sample prompt
`list_workflows`	List automation workflows	Workflows (view)	“List my workflows”
`get_workflow`	Get a workflow with its triggers, actions and products	Workflows (view)	“Show me workflow wflow_abc123”
`list_workflow_runs`	List the runs of a workflow, or get one run	Workflows (view)	“Why did my last workflow run fail?”

Ratings and settlements

Tool	Description	Requires	Sample prompt
`get_ratings`	List ratings, get one rating, or get aggregate stats	Ratings (view)	“What do customers say about my course?”
`get_settlements`	List settlements, or get one settlement with its sales	Settlements (view)	“When is my next payout?”

Courses and coaching

Tool	Description	Requires	Sample prompt
`get_course_content`	Get the chapters of a course, or the lessons of a chapter	Products (view)	“List the chapters of my course”
`get_course_progress`	Get enrolments, one student’s progress, or course analytics	Products (view)	“How many students finished my course?”
`list_coaching_sessions`	List coaching sessions, or get one session	Products (view)	“What coaching sessions do I have this week?”
`get_coaching_product_config`	Get the coaching settings and weekly availability of a coaching product	Products (view)	“When am I available for coaching?”

Marketing and store pages

Tool	Description	Requires	Sample prompt
`get_banners`	List banners, or get one banner	Banners (view)	“Which banners are published?”
`get_popups`	List popups, or get one popup	Popups (view)	“List my popups”
`get_store_pages`	List store pages, or get the full content of one page type	Appearance settings (view)	“Show my terms of service”

Affiliate programme

Tool	Description	Requires	Sample prompt
`list_affiliates`	List affiliates with performance metrics	Affiliates (view)	“Who are my best affiliates?”
`get_affiliate`	Get an affiliate with performance stats	Affiliates (view)	“Show affiliate aff_abc123”
`list_affiliation_offers`	List products offered to affiliates	Affiliates (view)	“Which products can affiliates promote?”
`list_affiliate_commissions`	List affiliate commissions	Affiliates (view)	“Which commissions are still pending?”
`get_affiliate_analytics`	Get aggregate affiliate programme analytics	Analytics (view)	“How much did affiliates sell this month?”

Integrations and team

Tool	Description	Requires	Sample prompt
`get_integrations`	List integrations, or get one integration. Credentials are never returned	Integrations (view)	“Which integrations are connected?”
`list_team_members`	List team members or pending invitations	Team (full access)	“Who is on my team?”
`list_team_member_activities`	List the team activity log, or get one activity	Team (full access)	“Who changed my product prices yesterday?”

Analytics

Tool	Description	Requires	Sample prompt
`get_store_analytics`	Get a store performance overview (visits, sales, products, customers)	Analytics (view)	“Show me store analytics for this month”
`get_sales_analytics`	Get revenue and sales analysis	Analytics (view)	“What’s my revenue this month?”
`get_customer_analytics`	Get customer insights and top customers	Analytics (view)	“Who are my top 5 customers?”
`get_visits_analytics`	Get traffic analysis (sources, referrers, devices, locations)	Analytics (view)	“Where is my traffic coming from?”
`get_conversion_rate_analytics`	Get conversion rates by device, country and product	Analytics (view)	“What’s my conversion rate?”

Help and documentation

Tool	Description	Requires	Sample prompt
`list_doc_pages`	List the Chariow developer documentation pages	Any team member	”Which docs pages cover checkout?”
`get_doc_page`	Get the full Markdown content of a documentation page	Any team member	”Explain how licence activation works”
`list_help_center_articles`	List help centre articles (EN/FR)	Any team member	”Is there a help article about payouts?”
`get_help_center_article`	Get the full content of a help centre article	Any team member	”Read me the article about custom domains”
`read_skill`	Load a Chariow skill: a ready-made playbook for recurring questions (payments, integrations, sales lifecycle, growth, refunds)	Any team member	”Why are my sales failing?”

Tool details

List tools use cursor-based pagination: each response includes next_cursor, prev_cursor and has_more. Pass next_cursor as cursor to get the next page.

get_store

Get the store profile, settings, social links and sales totals. No parameters required.

global_search

Search products, discounts, customers, pulses, sales and workflows at once.

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

list_products

List products with filters (search, status, category, type).

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`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 by product type (e.g. `downloadable`, `course`)

get_product

Get full details for a product.

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

get_product_details

Get one sub-entity of a product: FAQs, price variants, files, custom fields, bundle products, SEO or licence settings.

Parameter	Type	Required	Description
`product_id`	string	Yes	Product ID (`prd_xxx`) or slug
`include`	string	Yes	`faqs`, `price_variants`, `files`, `custom_fields`, `bundle_products`, `seo_settings` or `license_settings`
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response

list_customers

List customers with optional search.

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

get_customer

Get a customer profile by ID or email address.

Parameter	Type	Required	Description
`customer_id`	string	Yes	Customer ID (`cus_xxx`) or email address (case-insensitive)

list_sales

List sales with filters (status, customer, date range).

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 10
`cursor`	string	No	Pagination cursor from the previous response
`status`	string	No	Filter by sale status (e.g. `completed`, `failed`)
`customer_id`	string	No	Filter by customer ID
`start_date`	string	No	From date (YYYY-MM-DD)
`end_date`	string	No	To date (YYYY-MM-DD)

get_sale

Get complete details for a sale, including payment and shipping.

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

list_discounts

List discount codes with optional filters.

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

get_discount

Get a discount configuration and usage stats.

Parameter	Type	Required	Description
`discount_id`	string	Yes	Discount ID

list_licenses

List issued licences with filters (status, customer, product).

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

get_license

Get details for a licence key.

Parameter	Type	Required	Description
`license_key`	string	Yes	Licence key

get_license_activations

View the activation history of a licence.

Parameter	Type	Required	Description
`license_key`	string	Yes	Licence key

list_pulses

List webhook configurations.

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by URL or trigger

get_pulse

Get a webhook and its trigger configuration.

Parameter	Type	Required	Description
`pulse_id`	string	Yes	Pulse ID

list_workflows

List automation workflows.

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by name or trigger type

get_workflow

Get a workflow with its triggers, actions and products.

Parameter	Type	Required	Description
`workflow_id`	string	Yes	Workflow ID (`wflow_xxx`)

list_workflow_runs

List the runs of a workflow, or get one run.

Parameter	Type	Required	Description
`workflow_id`	string	Yes	Workflow ID (`wflow_xxx`)
`run_id`	string	No	Run ID (`wfrun_xxx`) to get a single run
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`status`	string	No	Filter: `pending`, `running`, `completed`, `failed`
`start_date`	string	No	From date (YYYY-MM-DD)
`end_date`	string	No	To date (YYYY-MM-DD)

get_ratings

List ratings, get one rating, or get aggregate stats.

Parameter	Type	Required	Description
`rating_id`	string	No	Rating ID (`slr_xxx`) to get a single rating
`summary_only`	boolean	No	Return only aggregate statistics
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search in comments
`product_id`	string	No	Filter by product ID
`is_thumbs_up`	boolean	No	`true` for positive, `false` for negative ratings
`from`	string	No	From date (YYYY-MM-DD)
`to`	string	No	To date (YYYY-MM-DD)

get_settlements

List settlements, or get one settlement with its sales.

Parameter	Type	Required	Description
`settlement_id`	string	No	Settlement ID (`stl_xxx`) to get one settlement with its sales
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search settlements
`status`	string	No	Filter: `pending`, `paid`
`start_date`	string	No	From date (YYYY-MM-DD)
`end_date`	string	No	To date (YYYY-MM-DD)

get_course_content

Get the chapters of a course, or the lessons of a chapter.

Parameter	Type	Required	Description
`product_id`	string	Yes	Course product ID (`prd_xxx`)
`chapter_id`	string	No	Chapter ID (`chp_xxx`) to list its lessons
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by title or description

get_course_progress

Get enrolments, one student’s progress, or course analytics.

Parameter	Type	Required	Description
`product_id`	string	Yes	Course product ID (`prd_xxx`)
`customer_id`	string	No	Customer ID for one student’s detailed progress
`summary_only`	boolean	No	Return only aggregate analytics
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search enrolments by student name or email
`status`	string	No	Filter: `not_started`, `in_progress`, `completed`

list_coaching_sessions

List coaching sessions, or get one session.

Parameter	Type	Required	Description
`session_id`	string	No	Session ID to get a single session
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search in session notes
`status`	string	No	Filter: `pending`, `confirmed`, `completed`, `cancelled`, `no_show`
`product_id`	string	No	Filter by product ID
`customer_id`	string	No	Filter by customer ID
`from`	string	No	From date (YYYY-MM-DD)
`to`	string	No	To date (YYYY-MM-DD)
`upcoming`	boolean	No	Only upcoming sessions
`past`	boolean	No	Only past sessions

get_coaching_product_config

Get the coaching settings and weekly availability of a coaching product.

Parameter	Type	Required	Description
`product_id`	string	Yes	Coaching product ID (`prd_xxx`)

get_banners

List banners, or get one banner.

Parameter	Type	Required	Description
`banner_id`	string	No	Banner ID to get a single banner
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by name
`status`	string	No	Filter: `draft`, `published`

get_popups

List popups, or get one popup.

Parameter	Type	Required	Description
`popup_id`	string	No	Popup ID to get a single popup
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by name
`status`	string	No	Filter: `draft`, `published`

get_store_pages

List store pages, or get the full content of one page type.

Parameter	Type	Required	Description
`page_type`	string	No	Page type to get its full content (e.g. `terms_of_service`, `privacy_policy`)
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response

list_affiliates

List affiliates with performance metrics.

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by name or email
`status`	string	No	Filter: `active`, `suspended`

get_affiliate

Get an affiliate with performance stats.

Parameter	Type	Required	Description
`affiliate_id`	string	Yes	Affiliate ID

list_affiliation_offers

List products offered to affiliates.

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`status`	string	No	Filter: `active`, `paused`, `removed`

list_affiliate_commissions

List affiliate commissions.

Parameter	Type	Required	Description
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search commissions
`status`	string	No	Filter: `pending`, `settled`
`affiliate_id`	string	No	Filter by affiliate ID
`start_date`	string	No	From date (YYYY-MM-DD)
`end_date`	string	No	To date (YYYY-MM-DD)

get_affiliate_analytics

Get aggregate affiliate programme analytics.

Parameter	Type	Required	Description
`start_date`	string	Yes	Start date (YYYY-MM-DD)
`end_date`	string	Yes	End date (YYYY-MM-DD)

get_integrations

List integrations, or get one integration. Credentials are never returned.

Parameter	Type	Required	Description
`integration_id`	string	No	Integration ID (`int_xxx`) to get a single integration
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by provider or account name

list_team_members

List team members or pending invitations.

Parameter	Type	Required	Description
`type`	string	No	Set to `invitations` to list pending invitations
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response
`search`	string	No	Search by name or email (members), email or role (invitations)
`status`	string	No	Filter members by status (`active`)

list_team_member_activities

List the team activity log, or get one activity.

Parameter	Type	Required	Description
`activity_id`	string	No	Activity ID to get a single activity
`team_member_id`	string	No	Filter by team member ID (`mem_xxx`)
`action`	string	No	Filter by action (e.g. `product_updated`)
`search`	string	No	Search across action, IP address and user agent
`per_page`	integer	No	Results per page (1-100). Default: 20
`cursor`	string	No	Pagination cursor from the previous response

get_store_analytics

Get a store performance overview (visits, sales, products, customers).

Parameter	Type	Required	Description
`from`	string	Yes	Start date (YYYY-MM-DD)
`to`	string	Yes	End date (YYYY-MM-DD)
`sections`	array	No	Sections to include: `visits`, `sales`, `products`, `customers`. Default: every section

get_sales_analytics

Get revenue and sales analysis.

Parameter	Type	Required	Description
`from`	string	Yes	Start date (YYYY-MM-DD)
`to`	string	Yes	End date (YYYY-MM-DD)
`sections`	array	No	Sections to include: `summary`, `daily_trend`, `by_country`, `by_product`, `peak_purchase_days`, `peak_purchase_hours`. Default: `summary` only

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 when `top_customers` is requested. Default: 10
`sections`	array	No	Sections to include: `summary`, `by_country`, `daily_trend`, `top_customers`. Default: `summary` only

get_visits_analytics

Get traffic analysis (sources, referrers, devices, locations).

Parameter	Type	Required	Description
`from`	string	Yes	Start date (YYYY-MM-DD)
`to`	string	Yes	End date (YYYY-MM-DD)
`sections`	array	No	Sections to include: `summary`, `daily_trend`, `by_product`, `referrers`, `locations`, `devices`, `mediums`, `sources`. Default: `summary` only

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)
`sections`	array	No	Sections to include: `summary`, `by_device`, `by_country`, `by_product`. Default: `summary` only

list_doc_pages

List the Chariow developer documentation pages.

Parameter	Type	Required	Description
`section`	string	No	Filter by section: `introduction`, `api-reference`, `guides`, `mcp`, `n8n`, `resources`

get_doc_page

Get the full Markdown content of a documentation page.

Parameter	Type	Required	Description
`slug`	string	Yes	Page slug from `list_doc_pages` (e.g. `guides-checkout`)

list_help_center_articles

List help centre articles (EN/FR). No parameters required.

get_help_center_article

Get the full content of a help centre article.

Parameter	Type	Required	Description
`article_id`	string	Yes	Article ID from `list_help_center_articles`
`collection_id`	string	Yes	Collection ID from `list_help_center_articles`
`language`	string	No	`en` or `fr`. Default: `en`

read_skill

Load a Chariow skill: a ready-made playbook for recurring questions (payments, integrations, sales lifecycle, growth, refunds).

Parameter	Type	Required	Description
`name`	string	Yes	Skill slug (e.g. `payments-and-checkout`, `sales-diagnostic`)

Resources

Resources provide reference data the AI assistant can read for context. They are available to every connection.

URI	Content
`chariow://resources/currencies`	Supported currencies (codes, symbols, names)
`chariow://resources/countries`	Supported countries (codes, names, flags, dial codes)
`chariow://resources/payment-methods`	Available payment methods
`chariow://resources/product-categories`	Product category taxonomy
`chariow://resources/product-types`	Product types
`chariow://resources/platform`	About Chariow, its audience and benefits
`chariow://resources/features`	Platform features by category
`chariow://resources/help`	Help centre, developer docs and API links
`chariow://resources/api-docs`	Index of the developer documentation pages and their slugs
`chariow://docs/{slug}`	Full Markdown content of a documentation page

Prompts

Prompt	Description	Requires	Arguments
`analyse_product`	Analyse a product’s description, pricing and custom checkout fields, and recommend conversion improvements	Products (view)	`product_id` (required)

Rate limits

Each MCP connection can send up to 60 requests per minute. Requests that do not carry a valid connection token are limited to 10 per minute per IP address. If you hit the limit, wait a moment before continuing.

​Tools reference

​Store and search

​Products

​Customers

​Sales

​Discounts

​Licences

​Pulses (webhooks)

​Workflows

​Ratings and settlements

​Courses and coaching

​Marketing and store pages

​Affiliate programme

​Integrations and team

​Analytics

​Help and documentation

​Tool details

​get_store

​global_search

​list_products

​get_product

​get_product_details

​list_customers

​get_customer

​list_sales

​get_sale

​list_discounts

​get_discount

​list_licenses

​get_license

​get_license_activations

​list_pulses

​get_pulse

​list_workflows

​get_workflow

​list_workflow_runs

​get_ratings

​get_settlements

​get_course_content

​get_course_progress

​list_coaching_sessions

​get_coaching_product_config

​get_banners

​get_popups

​get_store_pages

​list_affiliates

​get_affiliate

​list_affiliation_offers

​list_affiliate_commissions

​get_affiliate_analytics

​get_integrations

​list_team_members

​list_team_member_activities

​get_store_analytics

​get_sales_analytics

​get_customer_analytics

​get_visits_analytics

​get_conversion_rate_analytics

​list_doc_pages

​get_doc_page

​list_help_center_articles

​get_help_center_article

​read_skill

​Resources

​Prompts

​Rate limits

​Next steps

Setup guide

Security