Source: https://datafa.st/docs/mcp-tools
Markdown source: https://datafa.st/docs/mcp-tools.md
Description: Every DataFast MCP tool, grouped by resource, with what each one does and which token type it needs.

# DataFast MCP — Tool reference

**New here?** [Get started](/docs/mcp-introduction) explains when to use OAuth and when to use an API token, with setup instructions for both.

This page lists the shared DataFast tool catalog, available through OAuth or API tokens. OAuth uses [explicit permissions listed in the OAuth reference](/docs/mcp-oauth#oauth-tool-reference), with additional privacy and confirmation controls. Labels such as **dft_ only** below compare account tokens with website API keys; OAuth supports those tools with the corresponding consent. All OAuth writes require explicit confirmation and an idempotency key.

Custom goal parameter breakdowns are available through `datafast_analytics_goal_properties`; see [arguments and response examples](/docs/api/website/goals/properties).

All tools are prefixed `datafast_` and mirror the [Account API](/docs/api/account) and [CLI](/docs/cli-introduction) 1:1 — same fields, same validation, same permissions. Read-only tools work with either a `df_` website key or a `dft_` account token; tools marked **dft_ only** need an account token because they touch account-level or owner-only resources. See [authentication and scopes](/docs/api/authentication) for the difference.

Tools marked **⚠️ confirm** are irreversible or credential-issuing and require `confirm: true` in the arguments — otherwise they return a dry-run preview instead of executing. See [safety](/docs/mcp-introduction#safety).

## Analytics

Mirrors [Account API — analytics](/docs/api/account) and `datafast analytics` / [CLI analytics](/docs/cli-analytics).

| Tool | Description |
|---|---|
| `datafast_analytics_overview` | Visitors, sessions, pageviews, bounce rate, revenue, conversion rate for a date range |
| `datafast_analytics_timeseries` | Same metrics bucketed by hour/day/week/month |
| `datafast_analytics_realtime` | Current live visitor count |
| `datafast_analytics_realtime_map` | Active visitors in the last ~10 min with location, current page, recent payments |
| `datafast_analytics_metadata` | Website display metadata: domain, timezone, name, currency, KPI |
| `datafast_analytics_pages` | Top pages by visitors, with revenue |
| `datafast_analytics_exit_clicks` | External destinations by unique visitors and total clicks |
| `datafast_analytics_referrers` | Traffic sources breakdown |
| `datafast_analytics_countries` / `_regions` / `_cities` | Geography breakdown |
| `datafast_analytics_browsers` / `_devices` / `_operating_systems` | Device breakdown |
| `datafast_analytics_campaigns` | UTM campaign breakdown |
| `datafast_analytics_goals_breakdown` | Completions and visitors per goal |
| `datafast_analytics_hostnames` | Breakdown by hostname (multi-domain websites) |
| `datafast_analytics_funnel` | Step-by-step drop-off and conversion for one funnel |

## Bot traffic

Mirrors the [Bot traffic API](/docs/api/website/bot-traffic). Analytics can use an owner `df_` or `dft_` token; allowance and controls are owner `dft_` only.

| Tool | Description |
|---|---|
| `datafast_bot_traffic_summary` | AI answer, indexing, training, other crawler, verification, exact agent, and timeseries totals |
| `datafast_bot_traffic_pages` | Requested pages with status-code and crawler breakdowns |
| `datafast_bot_traffic_usage` | Account allowance, consumed and dropped requests, reset date, paid packs, and website usage |
| `datafast_bot_traffic_settings_get` | Current settings plus every company and exact user agent enabled state |
| `datafast_bot_traffic_settings_update` | ⚠️ confirm for ingestion/auth changes — update verification, auth, display, companies, or individual agents |
| `datafast_bot_traffic_token_get` | Masked request-auth token status; never returns the secret |
| `datafast_bot_traffic_token_create` | ⚠️ confirm — create a `dfbot_` token; full value returned once |
| `datafast_bot_traffic_token_rotate` | ⚠️ confirm — replace the token; previous value stops working immediately |
| `datafast_bot_traffic_token_delete` | ⚠️ confirm — revoke the token and turn auth enforcement off |

Changing paid capacity stays in the Billing dashboard; MCP reports the state but never charges the saved card.

## Social mentions and manual notes

Use the [Mentions API](/docs/api/website/mentions) and [Notes API](/docs/api/account/notes) through your agent. Both accept website keys or account tokens and enforce website access.

| Tool | Description | Account-token permission |
|---|---|---|
| `datafast_mentions_list` | Search X/Reddit mentions by date, text/author/URL, and platform | `analytics:read` |
| `datafast_notes_list` | List/search manual notes; defaults to the last 30 days | `notes:read` |
| `datafast_notes_create` | Add a timestamped note; optional stable `idempotencyKey` prevents duplicate retries | `notes:write` |
| `datafast_notes_update` | Edit a note's text or timestamp | `notes:write` |
| `datafast_notes_delete` | ⚠️ confirm — permanently delete one manual note | `notes:write` |

Ask “Who mentioned my brand in the last 30 days?” or “Add a note that we launched the new landing page today.” An external agent/CI automation can also add a note after significant marketing commits.

Starter returns up to **3 sampled mentions across X and Reddit per date range**, before search/platform filters and pagination. Growth returns all available mentions. Check the response's `meta.sampled` and `meta.totalMentions`; a filtered Starter sample is not an exhaustive search.

Starter responses also include `meta.message` and `meta.upgradeUrl`, explaining that the results are a sample and linking to [billing](/dashboard/billing) to unlock all available mentions with Growth. These fields also appear when a Starter query has no results; Growth responses omit them. Starter discovery pauses Reddit at 20 combined stored X/Reddit mentions per website, and X at 100, across all dates. Growth discovery continues as usual.

For restricted account tokens, enable Notes read/write in [Account settings → API](/dashboard/settings?tab=api) using **Edit permissions**. Your token stays the same. Website keys and `*` tokens work automatically. Permission editing is dashboard-only, never available to MCP.

## Websites

Mirrors [Account API — websites](/docs/api/account) and [CLI websites](/docs/cli-websites).

| Tool | Description |
|---|---|
| `datafast_websites_list` | List websites the token can access, with role |
| `datafast_websites_get` | Full settings for one website |
| `datafast_websites_create` | Create a website — **dft_ only** |
| `datafast_websites_update` | Update one or more settings |

## API keys

Mirrors [CLI website API keys](/docs/cli-websites#website-api-keys-df). Never returns secret values except once, on create/roll.

| Tool | Description |
|---|---|
| `datafast_apikeys_list` | List a website's `df_` keys (prefixes only) |
| `datafast_apikeys_create` | ⚠️ confirm — create a new `df_` key; full value returned once |
| `datafast_apikeys_roll` | ⚠️ confirm — regenerate a key, old one stops working immediately |
| `datafast_apikeys_delete` | ⚠️ confirm — permanently delete a key |

## Team

Mirrors [CLI team management](/docs/cli-websites#team-management). Invite/remove are owner-only and **dft_ only**.

| Tool | Description |
|---|---|
| `datafast_team_list` | List members with role |
| `datafast_team_invite` | Invite by email (owner only) |
| `datafast_team_remove` | ⚠️ confirm — remove a member (owner only); also deletes their `df_` keys for that website |

## Goals

Mirrors [Account API goal customizations](/docs/api/account/goal-customizations) and [CLI goals](/docs/cli-goals).

| Tool | Description |
|---|---|
| `datafast_goals_track` | Record a custom goal event for a visitor |
| `datafast_goals_delete_events` | ⚠️ confirm — bulk-delete recorded custom goal events |
| `datafast_goals_list` | Tracked goals with completion counts and conversion rate |
| `datafast_goals_customizations_list` | Saved display overrides (name, color, description, hidden) |
| `datafast_goals_customizations_update` | Set a goal's display customization |
| `datafast_goals_customizations_reset` | ⚠️ confirm — revert a goal's display customization to default |

## Funnels

Mirrors [CLI funnels](/docs/cli-funnels).

| Tool | Description |
|---|---|
| `datafast_funnels_list` | List active funnels |
| `datafast_funnels_create` | Create a funnel (2–8 pageview/goal steps) |
| `datafast_funnels_update` | Update name, steps, or active state |
| `datafast_funnels_delete` | ⚠️ confirm — soft-delete (sets inactive) |

## Visitors

Mirrors [Visitors API](/docs/api/website/visitors) and [CLI visitors](/docs/cli-visitors).

| Tool | Description |
|---|---|
| `datafast_visitors_search` | Search visitors by page, goal, geography, device, referrer, UTM, customer status |
| `datafast_visitors_get` | Full detail for one visitor: identity, activity, identify profile, prediction |

## Alerts

Mirrors the dashboard alerts feature (no CLI equivalent yet).

| Tool | Description |
|---|---|
| `datafast_alerts_list` | List configured alerts |
| `datafast_alerts_create` | Create an email alert on goal completion |
| `datafast_alerts_update` | Update name, trigger goal, message, or enabled state |
| `datafast_alerts_delete` | ⚠️ confirm — permanently delete an alert |
| `datafast_alerts_history` | Recent trigger logs (sent/failed) |

## Account

Mirrors [CLI `whoami`](/docs/cli-introduction).

| Tool | Description |
|---|---|
| `datafast_account_get` | Caller's profile and plan info |
| `datafast_account_update` | Update display name |

## Access tokens

Mirrors [CLI tokens](/docs/cli-tokens). **dft_ only** — account-level resource.

| Tool | Description |
|---|---|
| `datafast_access_tokens_list` | List the caller's `dft_` tokens (metadata only) |
| `datafast_access_tokens_create` | ⚠️ confirm — mint a new `dft_` token; can't exceed the caller's own scope; value returned once |
| `datafast_access_tokens_delete` | ⚠️ confirm — permanently revoke a token |

## Payment integrations

Read-only status for diagnosing missing revenue. Connecting or disconnecting providers is dashboard-only (no live payment credentials through MCP).

| Tool | Description |
|---|---|
| `datafast_integrations_status` | Connection status for Stripe, Paddle, Polar, Lemon Squeezy, Shopify, WooCommerce |

## Related

- [Get started with MCP](/docs/mcp-introduction)
- [Authentication and scopes](/docs/api/authentication)
- [Account API](/docs/api/account)
- [DataFast CLI](/docs/cli-introduction)
