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

# Discovery tools

> Tools to discover monitored brands and their configured topics and tags in Qwairy.

<Note>
  See [Filter Compatibility](/mcp/tools/filters) for the authoritative filter contract and the coverage of every MCP tool.
</Note>

## list\_brands

List all monitored brands for your account. **Use this first** to get brand IDs needed for other tools.

### Parameters

This tool takes no parameters.

### Returns

| Field | Type | Description |
| - | - | - |
| `id` | string | Unique brand identifier |
| `name` | string | Brand display name |
| `domain` | string | Brand's primary domain |
| `team` | object | Workspace ID and name |
| `countryCode` / `languageCode` | string | Configured market and language |
| `monitoring` | object | Enabled state, frequency, model codes, and last analysis date |
| `counts` | object | Configured prompt, topic, and tag counts |

### Example output

```markdown theme={null}
## Your monitored brands

1. **Acme Corp** (ID: abc-123-def)
   Domain: acme.example
   Workspace: Agency workspace (ID: team-123)
   Market: en / US
   Monitoring: enabled, weekly
   Models: openai-chatgpt-core, google-gemini-core
   Last analysis: 2026-07-19T12:00:00.000Z
   Configuration: 156 prompts, 12 topics, 8 tags
```

### Example prompts

```
What brands am I monitoring?
```

```
List my Qwairy brands
```

```
Show me my monitored brands
```

### OAuth scope

Requires: `read:brands`

***

## list\_topics

List every topic configured for a brand, including topics without recent answers. Use this tool to discover stable topic IDs before applying topic filters elsewhere.

### Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `brandId` | string | Yes | The brand ID from `list_brands` |
| `search` | string | No | Case-insensitive topic label search |
| `limit` | number | No | Max topics (default: 50, max: 100) |
| `offset` | number | No | Pagination offset (default: 0) |

### Returns

| Field | Type | Description |
| - | - | - |
| `id` | string | Topic ID used by topic filters |
| `text` | string | Topic label |
| `promptsCount` | number | Active monitored prompts assigned to the topic |

### OAuth scope

Requires: `read:topics`

***

## list\_tags

List every prompt tag configured for a brand. Use this tool to discover stable tag IDs before applying tag filters elsewhere.

### Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `brandId` | string | Yes | The brand ID from `list_brands` |
| `search` | string | No | Case-insensitive tag label search |
| `limit` | number | No | Max tags (default: 50, max: 100) |
| `offset` | number | No | Pagination offset (default: 0) |

### Returns

| Field | Type | Description |
| - | - | - |
| `id` | string | Tag ID used by tag filters |
| `name` | string | Tag label |
| `color` | string | Configured color, or `null` |
| `promptsCount` | number | Active monitored prompts carrying the tag |

### OAuth scope

Requires: `read:topics`

***

## get\_overview

Get a quick cockpit overview of a brand: key counts, performance scores with trend vs previous period, and last monitoring date.

**Use this as the second call** after `list_brands` to get a snapshot before diving into specifics.

### Parameters

| Parameter | Type | Required | Description |
| - | - | - | - |
| `brandId` | string | Yes | The brand ID from `list_brands` |
| `period` | integer or string | No | Global evidence window; defaults to 30 days |

### Returns

| Field | Description |
| - | - |
| `counts` | questions, answers, competitors, sources, selfMentions, socialCitations, shoppingInsights, localBusinesses |
| `scores` | mentionRate, sourceRate, shareOfVoice, sentiment (current period) |
| `previousPeriodScores` | Same metrics for previous period (trend comparison) |
| `lastMonitoringDate` | Most recent AI response date |

### OAuth scope

Requires: `read:brands`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.