skills/seo-foundations/references/tool-index.md

# Ubersuggest MCP tool index

Generated by `pnpm generate:tools` — do not edit by hand.

All 58 tools on the **ubersuggest** MCP server. Names are bare here —
the fully-qualified prefix depends on how the server was installed — so match
on the tool name. Flags:
**requires login** (fails without an authenticated account), **costs credits**
(spends the plan's monthly credit allowance — confirm with the user first), and
async (the report is built server-side; poll with a cap instead of retrying
blindly).

For full parameter descriptions, response fields and examples, see
https://ubersuggest-mcp.neilpatelapi.com/llms.md

## Authentication

### auth_status

Check current authentication status and account tier.

- Required: none

## Domain Analysis

### domain_overview

Get a comprehensive overview of a domain including traffic, organic keywords count, domain authority, and backlinks summary.

- Required: `domain` (string)
- Optional: `language`, `locId`

### domain_keywords

Get the organic or paid keywords ranking for a domain, with search volume, position, and difficulty.

- Required: `domain` (string)
- Optional: `language`, `locId`, `searchType`, `limit`, `previousKey`

### domain_top_pages

Get the top pages of a domain ranked by estimated traffic.

- Required: `domain` (string)
- Optional: `language`, `locId`, `limit`, `offset`

### domain_top_countries

Get the top countries where a domain gets organic traffic.

- Required: `domain` (string), `lang_locs` (string[])
- Optional: `path`

### competitors

async (poll)

Find the main organic competitors of a domain.

- Required: `domain` (string)
- Optional: `language`, `locId`, `competitors`, `limit`

### page_overview

Get an overview of a specific page including its organic keywords and traffic.

- Required: `page` (string)
- Optional: `language`, `locId`

### page_keywords

Get the keywords that a specific page ranks for.

- Required: `page` (string)
- Optional: `language`, `locId`, `limit`

### traffic_value

**requires login**

Get the estimated monthly value in USD of a domain's organic traffic (the equivalent Google Ads spend).

- Required: `domain` (string)
- Optional: `project_id`

## Keyword Research

### keyword_overview

Get search volume, CPC, SEO difficulty, and paid difficulty for a keyword.

- Required: `keyword` (string)
- Optional: `language`, `locId`

### keyword_suggestions

Get related keyword suggestions with metrics for seed keywords, as a flat list.

- Required: `keywords` (string[])
- Optional: `language`, `locId`

### keyword_metrics

**costs monthly credits** · async (poll)

Recalculate a specific metric for a keyword: search difficulty or search intent.

- Required: `keyword` (string), `language` (string), `metric` ("search_difficulty" | "search_intent")
- Optional: `locId`

### serp_analysis

Analyze the SERP (Search Engine Results Page) for a keyword, showing top ranking URLs with metrics.

- Required: `keyword` (string)
- Optional: `language`, `locId`, `limit`

### match_keywords

Find keywords matching seed terms with volume, difficulty, and CPC data.

- Required: `keywords` (string[])
- Optional: `language`, `locId`, `sortby`, `limit`, `offset`, `domain`

### google_suggestions

Expand keywords into Google autocomplete suggestions, grouped the way the Ubersuggest web app groups them.

- Required: `keywords` (string[])
- Optional: `language`, `country`

### estimate_serp_clicks

Estimate monthly click-through traffic for each SERP result, given its search volume, position, and result type.

- Required: `serps` (object[])

## Keyword Lists

### keyword_lists

List the user's saved keyword lists with their aggregates.

- Required: none

### keyword_list

Read one saved keyword list: its keywords with volume, CPC and difficulty.

- Required: `list_id` (string)
- Optional: `limit`, `offset`

### create_keyword_list

Create a saved keyword list, optionally filling it with keywords.

- Required: `name` (string)
- Optional: `keywords`

### add_keywords_to_list

Add keywords to a saved keyword list.

- Required: `list_id` (string), `keywords` (object[])

### remove_keywords_from_list

Remove keywords from a saved keyword list.

- Required: `list_id` (string), `keywords` (object[])

### rename_keyword_list

Rename a saved keyword list.

- Required: `list_id` (string), `name` (string)

### delete_keyword_list

Delete a saved keyword list and every keyword in it.

- Required: `list_id` (string)

## Backlinks

### backlinks_overview

Get a backlinks summary for a domain: total backlinks, referring domains, domain authority.

- Required: `domain` (string)

### backlinks

List individual backlinks pointing to a domain or page.

- Required: `domain` (string)
- Optional: `mode`, `limit`, `offset`, `one_per_domain`, `order_by`

### anchor_texts

Get the most common anchor texts used in backlinks to a domain.

- Required: `domain` (string)
- Optional: `mode`, `limit`, `offset`

### linking_domains

Get referring domains that a target domain recently gained or lost.

- Required: `domain` (string)
- Optional: `mode`, `filter_by`, `begin_date`, `end_date`, `limit`, `offset`

### backlink_opportunity

Find backlink opportunities: referring domains that link to your competitors ('positive_targets') but not to you ('negative_targets').

- Required: `positive_targets` (object[])
- Optional: `negative_targets`, `limit`, `offset`

## Content

### content_ideas

Get content ideas for keywords: top-performing pages by social shares, estimated visits, and backlinks.

- Required: `keywords` (string[])
- Optional: `language`, `locId`, `sortby`, `limit`, `offset`, `filters`

### page_shares

Get social media share counts + backlink/traffic metrics for a batch of page URLs.

- Required: `page_urls` (string[])
- Optional: `language`, `locId`, `mode`

## Site Audit

### site_audit

**requires login**

Starts (or re-starts) a site audit crawl for a domain AND returns the initial crawl status.

- Required: `domain` (string)
- Optional: `path`, `crawlMaxPages`, `recrawl`

### site_audit_status

**requires login** · async (poll)

Checks the progress/result of a site audit previously started with 'site_audit'.

- Required: `domain` (string)
- Optional: `path`, `crawlMaxPages`

### site_audit_results

**requires login**

Gets the list of pages affected by a specific SEO issue from a completed site audit.

- Required: `domain` (string), `issue` (string)
- Optional: `path`

### site_audit_pages

**requires login**

Lists every URL that was crawled during a completed site audit, with HTTP status and index state.

- Required: `domain` (string)

### pagespeed_audit

async (poll)

Run a PageSpeed audit on a domain to check Core Web Vitals and performance.

- Required: `domain` (string)
- Optional: `forceUpdate`, `devices`

## Projects

### list_projects

**requires login**

List all your tracked projects/domains.

- Required: none

### get_project

**requires login**

Get details of a specific project including tracked keywords and settings.

- Required: `project_id` (string)

### project_position_info

**requires login** · async (poll)

Get ranking positions for the tracked keywords of a project (rank tracking report).

- Required: `project_id` (string), `startDate` (string), `endDate` (string)
- Optional: `locId`, `language`, `device`

### seo_opportunities

**requires login**

Get SEO improvement opportunities for a project.

- Required: `project_id` (string)

### create_project

**requires login**

Create a new tracked project for a domain.

- Required: `domain` (string), `locations` (object[])
- Optional: `title`, `keywords`, `competitors`, `business_summary`, `project_type`

### onboard_project

Run the full first-time setup for a domain: analyse the business, suggest competitors, generate AI Search Visibility topics and prompts, generate keywords, then create the project and its brand.

- Required: `domain` (string)
- Optional: `locations`, `confirm`, `title`, `brand_name`, `project_type`, `skip_brand`, `business_summary`, `competitors`, `topics`, `keywords`, `brand_competitors`, `project_id`

### add_project_keywords

**requires login**

Add keywords to an existing project.

- Required: `project_id` (string), `keywords` (object)

### add_project_competitors

**requires login**

Add competitors to an existing project.

- Required: `project_id` (string), `competitors` (object)
- Optional: `competitors_locations`

## AI Search Visibility

### brand_config

**requires login**

Get the AI Search Visibility (AISV) brand setup for a project: tracked topics and prompts, competitors, alias groups, update frequency and limits.

- Required: `project_id` (string)

### brand_visibility_overview

**requires login**

Get the headline AI Search Visibility (AISV) metrics for a project's brand: how often the brand appears in AI assistant answers (visibility %), average rank, share of voice, total mentions and sentiment — overall and broken down by provider — plus the competitive brand ranking and aggregated search intents.

- Required: `project_id` (string)
- Optional: `start_date`, `end_date`, `provider`

### brand_prompts

**requires login**

Get the per-prompt AI Search Visibility (AISV) breakdown for a project's brand: for each tracked prompt, how the user's brand ranks, which brands were found, sentiment, sentiment keywords (positive/negative) and search intents.

- Required: `project_id` (string)
- Optional: `start_date`, `end_date`, `provider`

### configure_brand

Create or update the AI Search Visibility (AISV) brand for a project: the topics and prompts tracked across ChatGPT, Gemini and Google AI Overviews, plus the competitor brands compared against.

- Required: `project_id` (string), `brand_name` (string), `topics` (object[])
- Optional: `competitors`

### industry_detect

Work out which industry a brand belongs to, and suggest related topics worth tracking in AI Search Visibility.

- Required: `domain` (string), `brand_name` (string), `loc_id` (number), `language` (string)

### industry_prompts

Generate the prompts to track for a brand's topics — the questions real users would ask an AI assistant about that topic.

- Required: `brand_name` (string), `domain` (string), `topics` (object[])
- Optional: `project_id`

## Content Studio

### project_business_summary

**requires login**

Makes sure a project has the business summary that Content Studio requires, and returns it.

- Required: none
- Optional: `project_id`, `domain`, `language`, `business_summary`

### article_title_suggestions

**requires login**

Suggests article titles plus a content angle for a project, from a keyword or a free-form prompt.

- Required: `project_id` (string)
- Optional: `source_type`, `keyword`, `prompt`, `language`, `locId`

### generate_article

**requires login** · **costs 100 monthly credits**

Starts writing a full SEO article for a project and returns its 'article_id'.

- Required: `project_id` (string), `title` (string), `content_idea` (string)
- Optional: `source_type`, `keyword`, `prompt`, `language`, `locId`

### get_article

**requires login** · async (poll)

Reads a Content Studio article and its generation status.

- Required: `project_id` (string), `article_id` (string)

## Utilities

### validate_site

Validate if a domain or URL is reachable and can be analyzed by Ubersuggest.

- Required: `site` (string)
- Optional: `is_domain`

### location_suggest

Search for location IDs by name.

- Required: `query` (string)
- Optional: `lang`, `limit`

### location_details

Get details (name, type, parent hierarchy) for one or more location IDs, countries included.

- Required: `location_ids` (string,number[])
- Optional: `lang`

### user_limits

Get the account's plan allowances.

- Required: none

## Blog

### search_neilpatel_blog

Search articles from Neil Patel's blog.

- Required: none
- Optional: `query`, `category`, `limit`, `full_content`