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

# Tools

> The PeakMetrics MCP server provides the following tools for accessing your narrative intelligence data.

## Core Tools

### get\_workspaces

<Note>
  Always call `get_workspaces` when you are required to provide a `workspace_id` and only have a workspace name.
</Note>

Retrieves workspace information including id, title, and configuration.

Parameters:

* workspace\_ids (array of integers, optional)
* global (boolean, optional)

### get\_fields

<Note>
  Always call `get_fields` when you need filter expressions.
</Note>

Retrieves field metadata for workspaces including filter options, sort options, and field types.

Parameters:

* workspace\_ids (array of integers, optional)

## Workspace Data

### get\_workspace\_analytics

Retrieves analytics for workspaces including volume over time, tags, authors, domains, and narratives.

Parameters:

* workspace\_id (integer, required)
* since (float, optional, defaults to 90 days ago)
* to (float, optional, defaults to now)
* filters (object, optional)

### search\_workspace\_mentions

Searches mentions within a workspace with filtering, sorting, and pagination. Supports an optional `randomization_key` for randomized sampling — when provided, returns a shuffled pool of up to 500 mentions with stable pagination (cached for 5 minutes).

Parameters:

* workspace\_id (integer, required)
* offset (integer, optional, defaults to 0)
* limit (integer, optional, defaults to 20)
* sort (object, optional)
* filters (object, optional)
* randomization\_key (string, optional) — reuse across pages for stable randomized ordering

### get\_top\_social\_accounts

Retrieves top social accounts by mention count for a workspace.

Parameters:

* workspace\_id (integer, required)
* sort (enum, optional)
* sort\_direction (enum, optional)
* from (integer, optional)
* filters (object, optional)
* since (float, optional, defaults to 90 days ago)
* to (float, optional, defaults to now)
* size (integer, optional)

### get\_social\_account

Retrieves detailed information about a social account including analytics and mentions.

Parameters:

* account\_id (string, required)

### get\_top\_journalists

Retrieves top journalists by mention count for a workspace.

Parameters:

* workspace\_id (integer, required)
* filters (object, optional)
* since (float, optional, defaults to 90 days ago)
* to (float, optional, defaults to now)

### get\_custom\_summary\_prompts

Retrieves custom summary prompts configured for workspaces.

Parameters:

* workspace\_id (integer, required)

## Narratives

### search\_narratives

Searches narratives within workspaces with filtering, sorting, and threat scoring.

Parameters:

* workspace\_ids (array of integers, optional)
* offset (integer, optional, defaults to 0)
* limit (integer, optional, defaults to 20)
* sort (string, optional)
* narrative\_sort (string, optional)
* layer (integer, optional)
* analytics (array, optional)

### get\_narrative\_volume\_over\_time

Retrieves volume over time data for narratives within a workspace.

### get\_narrative\_mentions

Retrieves mentions associated with specific narratives.

Parameters:

* workspace\_ids (array of integers, optional)
* narrative\_ids (array of integers, optional)
* filters (object, optional)
* sort (string, optional)
* offset (integer, optional, defaults to 0)
* limit (integer, optional, defaults to 20)
* since (float, optional, defaults to 90 days ago)
* to (float, optional, defaults to now)