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

# Vortex IQ MCP tool reference: all 30 read-only tools

> Every tool exposed by the Vortex IQ MCP connector — parameters, example prompts and what each returns — grouped by area: Store Audit, Nerve Centre, Brand DNA, Ask Viq, Kanban, Reports, Inventory and Deployments.

The Vortex IQ MCP connector exposes 30 tools, all read-only. Every tool runs as the signed-in user and only returns data your account can access; none of them can change anything in your workspace. Large list results are capped (first 50 items / roughly 40k characters) — request a specific id to drill into full detail.

You don't call these tools directly: describe what you want in plain English and Claude picks the right tools, chaining them where one tool's output (an id or guid) feeds another.

| Area                                          | Tools |
| --------------------------------------------- | ----- |
| [Store Audit](#store-audit)                   | 3     |
| [Nerve Centre & KPIs](#nerve-centre-and-kpis) | 12    |
| [Brand DNA](#brand-dna)                       | 3     |
| [Ask Viq](#ask-viq)                           | 2     |
| [Kanban health-fix](#kanban-health-fix)       | 3     |
| [Reports & Insights](#reports-and-insights)   | 3     |
| [Inventory & Memory](#inventory-and-memory)   | 3     |
| [Deployments](#deployments)                   | 1     |

## Store Audit

Tools for the [Store Audit](/actions/store-audit) module: audit runs, findings reports and run progress.

### list\_store\_audit\_runs

Lists recent Store Audit runs with id, guid, integration, health score and completion time. Takes no parameters. Usually the first call — its ids and guids feed the two tools below.

> *"List my store audit runs."*

### get\_store\_audit\_report

Gets the latest Store Audit findings report for one integration, including the health score and detailed findings.

| Parameter       | Type    | Required | Description                                                                         |
| --------------- | ------- | -------- | ----------------------------------------------------------------------------------- |
| `integrationId` | integer | Yes      | The integration to fetch the audit report for — find it via `list_store_audit_runs` |

> *"Show the audit findings report for integration 42."*

### get\_store\_audit\_status

Gets the status and progress of one Store Audit run — useful while an audit is still running.

| Parameter | Type   | Required | Description                                     |
| --------- | ------ | -------- | ----------------------------------------------- |
| `guid`    | string | Yes      | The audit run guid from `list_store_audit_runs` |

> *"What's the status of my latest store audit?"*

## Nerve Centre and KPIs

Tools for [Nerve Centre](/nerve-centre/overview): KPI cards and trends, alerts, monitors, dashboard activity and the connector graph.

### list\_nerve\_centre\_alerts

Lists active Nerve Centre KPI alerts, optionally filtered by severity or status.

| Parameter  | Type                                       | Required | Description              |
| ---------- | ------------------------------------------ | -------- | ------------------------ |
| `severity` | `critical` \| `high` \| `medium`           | No       | Filter by alert severity |
| `status`   | `active` \| `investigating` \| `dismissed` | No       | Filter by alert status   |

> *"List my critical Nerve Centre alerts."*

### get\_alert\_summary

Gets a 24-hour alert and incident summary count for the organisation. Takes no parameters.

> *"Give me the 24h incident summary."*

### list\_alert\_activity

Lists paginated alert activity across the organisation, including agency partner organisations. Takes no parameters.

> *"Show my recent alert activity."*

### get\_integration\_kpis

Gets KPI cards plus trend data (today / 7 days / 30 days / 90 days) for one specific integration.

| Parameter       | Type    | Required | Description                                                                                        |
| --------------- | ------- | -------- | -------------------------------------------------------------------------------------------------- |
| `integrationId` | integer | Yes      | The integration to fetch KPIs for — find it via `list_dashboard_stores` or `list_store_audit_runs` |

> *"Show the 30-day KPIs for my Shopify integration."*

### list\_kpi\_library

Lists the full catalogue of KPI definitions Vortex IQ tracks across all platforms. Takes no parameters.

> *"What KPIs does Vortex IQ track?"*

### get\_nerve\_integration\_counts

Gets connected-integration counts for the organisation. Takes no parameters.

> *"How many integrations do I have connected?"*

### list\_nerve\_centre\_profiles

Lists saved Nerve Centre dashboard KPI profiles — both templates and the organisation's custom profiles. Takes no parameters.

> *"List my Nerve Centre dashboard profiles."*

### list\_nerve\_configurations

Lists the metric and KPI definitions Vortex IQ can track per platform. Takes no parameters.

> *"What metrics can Vortex IQ track for Stripe?"*

### list\_connector\_catalog

Lists the full catalogue of connector types Vortex IQ supports — the same catalogue as the [connector catalogue](/integrations/connector-catalogue) page. Takes no parameters.

> *"What connectors does Vortex IQ support?"*

### list\_monitors\_by\_type

Lists the organisation's monitors of a given platform type, with alert-configuration counts.

| Parameter | Type   | Required | Description                                        |
| --------- | ------ | -------- | -------------------------------------------------- |
| `type`    | string | Yes      | Platform type, e.g. `shopify`, `website`, `stripe` |

> *"List my website monitors."*

### get\_dashboard\_activity\_feed

Gets a recent cross-source activity feed — audit findings, Kanban activity and other workspace events. Takes no parameters.

> *"What's happened in my workspace recently?"*

### list\_dashboard\_stores

Lists the stores available on the organisation's dashboard. Takes no parameters.

> *"List my connected stores."*

## Brand DNA

Tools for Brand DNA: voice and tone profiles and the stores they link to.

### list\_brand\_profiles

Lists the organisation's Brand DNA profiles. Takes no parameters. Its ids feed `get_brand_profile`.

> *"List my brand profiles."*

### get\_brand\_profile

Gets one Brand DNA profile by id — voice, tone and brand guidelines, handy while drafting content elsewhere.

| Parameter   | Type    | Required | Description                                 |
| ----------- | ------- | -------- | ------------------------------------------- |
| `profileId` | integer | Yes      | Brand profile id from `list_brand_profiles` |

> *"Show my Brand DNA voice and tone guidelines."*

### list\_brand\_ecommerce\_stores

Lists connected ecommerce stores eligible for Brand DNA profile linking. Takes no parameters.

> *"Which stores can I link a brand profile to?"*

## Ask Viq

Tools for [Ask Viq](/ask-viq/overview) chat history.

### list\_ask\_viq\_conversations

Lists your recent Ask Viq chat conversations, most recent first.

| Parameter | Type    | Required | Description                     |
| --------- | ------- | -------- | ------------------------------- |
| `limit`   | integer | No       | Maximum conversations to return |

> *"List my recent Ask Viq conversations."*

### get\_ask\_viq\_conversation

Gets the full message thread for one Ask Viq conversation.

| Parameter        | Type   | Required | Description                                       |
| ---------------- | ------ | -------- | ------------------------------------------------- |
| `conversationId` | string | Yes      | Conversation ID from `list_ask_viq_conversations` |

> *"Show me my last Ask Viq conversation about revenue."*

## Kanban health-fix

Tools for the health-fix Kanban board and its automated fix runs.

### get\_kanban\_board

Gets the organisation's Kanban board state — health-fix backlog cards per column. Takes no parameters.

> *"Show my Kanban health-fix backlog."*

### get\_kanban\_fix\_status

Gets the plan, rollback and approval status of one automated fix run.

| Parameter | Type    | Required | Description                      |
| --------- | ------- | -------- | -------------------------------- |
| `fixId`   | integer | Yes      | Fix run id from the Kanban board |

> *"What's the status of fix run 17?"*

### get\_kanban\_fix\_items

Gets the paginated before/after change records for one automated fix run.

| Parameter | Type    | Required | Description                      |
| --------- | ------- | -------- | -------------------------------- |
| `fixId`   | integer | Yes      | Fix run id from the Kanban board |

> *"Show the before/after changes for fix run 17."*

## Reports and Insights

Tools for generated insight reports, report configuration and schedules.

### list\_insights\_reports

Lists generated insight reports (status, platform, title) for a given user. The API requires an explicit user id — if Claude doesn't know it, it reads the `user_id` field from `list_ask_viq_conversations` first.

| Parameter | Type    | Required | Description                           |
| --------- | ------- | -------- | ------------------------------------- |
| `userId`  | integer | Yes      | Vortex IQ user id to list reports for |

> *"List my insights reports."*

### list\_report\_profiles

Lists saved report configuration profiles. Takes no parameters.

> *"List my report profiles."*

### list\_report\_schedules

Lists recurring report schedules with their status. Takes no parameters.

> *"Which reports are scheduled to run?"*

## Inventory and Memory

Tools for CloudHub multichannel inventory and the [Vortex Memory](/vortex-memory/overview) archive.

### list\_cloudhub\_inventory\_tabs

Lists CloudHub multichannel inventory tabs — marketplace channels like FBA, inventory images and so on. Takes no parameters.

> *"List my CloudHub inventory tabs."*

### list\_vortex\_memory\_files

Lists files in Vortex Memory's Knowledge Base — uploaded documents plus auto-saved reports. Takes no parameters.

> *"What's in my Vortex Memory knowledge base?"*

### list\_vortex\_memory\_reports

Lists archived Vortex Mind reports — daily briefings, audits and revenue intelligence reports. Takes no parameters.

> *"List my archived Vortex Mind reports."*

## Deployments

### get\_deployment\_history

Gets a deployment's revision and rollback history.

| Parameter      | Type    | Required | Description   |
| -------------- | ------- | -------- | ------------- |
| `deploymentId` | integer | Yes      | Deployment id |

> *"Show the rollback history for deployment 8."*