Apex MCP tool reference
Reference for the nine tools exposed by the Apex MCP server.
The MCP server exposes nine tools over stdio. Each tool calls the Apex public API with the configured API key and returns text content to the MCP client. Failed API calls return an error text block and mark the tool result as an error.
Experiment tools
| Tool | Purpose | Inputs | Output |
|---|---|---|---|
list_experiments | List experiments, optionally filtered by status. | status: optional draft, running, paused, or completed; limit: optional number from 1 to 100. | Markdown list of experiments with name, ID, slug, status, traffic allocation, store URL, creation date, and variations. Adds "More results available" when the API page has more rows. |
get_experiment | Fetch one experiment by UUID or slug. | id_or_slug: experiment UUID or slug. | Markdown experiment summary with the same formatted fields as list_experiments. |
create_experiment | Create a draft A/B test. | name: required string; slug: optional string; description: optional string; traffic_allocation: optional percentage from 0 to 100, defaulting to 100. | Markdown confirmation with the created experiment summary. |
start_experiment | Start a draft or paused experiment. | id: experiment UUID. | Text confirmation that the named experiment is now running. |
pause_experiment | Pause a running experiment. | id: experiment UUID. | Text confirmation that the named experiment is now paused. |
complete_experiment | Complete or stop an experiment. | id: experiment UUID. | Text confirmation that the named experiment is now completed. |
Goal and brand tools
| Tool | Purpose | Inputs | Output |
|---|---|---|---|
list_goals | List conversion goals for the active shop behind the API key. | None. | Markdown bullet list with goal name, type, and ID, or "No goals found." |
get_brand_context | Read the shop brand context before writing customer-facing copy. | None. | Pretty-printed JSON containing the brand context returned by /api/v1/brand-context, including voice, rules, proof requirements, guardrails, and compiled guidelines where available. |
Preview tool
| Tool | Purpose | Inputs | Output |
|---|---|---|---|
generate_preview_url | Build a forced QA URL for a variation. | experiment_id_or_slug: required UUID or slug; store_url: optional absolute storefront URL override; variation_name: optional exact variation name. | Markdown block with experiment name, selected variation, and a URL containing drip_force, drip_experiment_id, drip_variation_id, drip_qa=1, and drip_debug=1. |
When variation_name is omitted, the tool selects the first non-control variation and falls back to the first variation. The experiment must have a store_url or the caller must pass store_url.