Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| HOST | No | The host address to bind the HTTP server to when running locally (default: 0.0.0.0). | |
| PORT | No | The port number to bind the HTTP server to when running locally (default: 5000). | |
| DATA_API_TOKEN | No | API token for SE Ranking Data API (UUID format). Provides access to keyword research, domain analysis, backlinks data, SERP analysis, and website audits. Tools prefixed with DATA_. | |
| PROJECT_API_TOKEN | No | API token for SE Ranking Project API (40-char hex). Provides access to project management, rank tracking, backlink monitoring, and account management. Tools prefixed with PROJECT_. |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| DATA_getAiDiscoverBrand | Data Tool: Identifies and returns the brand name associated with a given target domain, subdomain, or URL. Useful for determining what brand name to use in other AI search queries. |
| DATA_getAiOverview | Data Tool: Retrieves a high-level overview of a domain's performance in AI search engines. Returns aggregated data if no engine is specified, or engine-specific data if an engine is provided. |
| DATA_getAiOverviewLeaderboard | Data Tool: Compare multiple domains/brands in AI search engines (ChatGPT, Perplexity, Gemini, AI Overview, AI Mode). Use this for AI search comparison, competitor analysis, and visibility benchmarking. Returns brand presence, link presence, share of voice rankings, and leaderboard for each domain across AI engines. |
| DATA_getAiPromptsByBrand | Data Tool: Retrieves a list of prompts where the specified brand is mentioned in AI search results. |
| DATA_getAiPromptsByTarget | Data Tool: Retrieves a list of prompts (queries) that mention the specified target in AI search results. |
| DATA_getAllBacklinks | Data Tool: Retrieves a comprehensive list of backlinks for the specified target, with extensive filtering and sorting options. |
| DATA_getBacklinksAnchors | Data Tool: Retrieves a list of anchor texts for backlinks pointing to the specified target, with sorting and limit options. |
| DATA_getBacklinksAuthority | Data Tool: Fetch authority metrics for a target (domain, host or URL) (v1/backlinks/authority) |
| DATA_getBacklinksIndexedPages | Data Tool: Fetch site pages that have backlinks, with sorting and limit controls (v1/backlinks/indexed-pages) |
| DATA_getBacklinksRefDomains | Data Tool: Retrieves a list of referring domains pointing to the specified target, with options for sorting and limiting results. |
| DATA_getBacklinksSummary | Data Tool: Retrieves a summary of backlink metrics for one or multiple targets (domains, subdomains, or URLs). |
| DATA_getBacklinksMetrics | Data Tool: Returns key statistics for a target, such as the number of backlinks, referring domains, etc. Supports batch requests. |
| DATA_getBacklinksRaw | Data Tool: Returns all backlinks pointing to a target using cursor-based pagination for large datasets. |
| DATA_getBacklinksCount | Data Tool: Returns the total number of backlinks for the target. Supports batch requests. |
| DATA_listNewLostBacklinks | Data Tool: Returns a list of backlinks (newly) found or lost within the specified date range for the specified target. |
| DATA_getNewLostBacklinksCount | Data Tool: Returns a number of (newly) found or lost backlinks for every day within the specified date range. |
| DATA_getTotalRefDomainsCount | Data Tool: Returns the number of unique domains linking to a target. Supports batch requests. |
| DATA_getCumulativeBacklinksHistory | Data Tool: Returns a number of live backlinks for every day within the specified date range for the specified target. |
| DATA_getReferringIps | Data Tool: Returns information about IPv4 addresses that belong to backlinks that point to a target. |
| DATA_getReferringIpsCount | Data Tool: Returns the number of unique IPs linking to a target. |
| DATA_getReferringSubnetsCount | Data Tool: Returns the number of unique subnets/C-blocks linking to a target. |
| DATA_getDistributionOfDomainAuthority | Data Tool: Returns information about the distribution of Domain InLink Rank (Domain Authority) of all the domains that reference a specific target. |
| DATA_getPageAuthority | Data Tool: Returns information about the InLink Rank (Page Authority) for a target URL. |
| DATA_getPageAuthorityHistory | Data Tool: Returns information about the historical values of InLink Rank for a specific target page. |
| DATA_getDomainAuthority | Data Tool: Returns information about the domain InLink Rank (Domain Authority) of the target page’s root domain. |
| DATA_getDomainAuthorityHistory | Data Tool: Returns historical Domain InLink Rank (Domain Authority) values for a target domain. The target is always resolved to its PLD (pay-level domain) regardless of whether a root domain, host, or URL is provided. |
| DATA_getDomainAuthorityHistogram | Data Tool: Returns a bucketed histogram of Domain InLink Rank (Domain Authority) for referring domains linking to the target. |
| DATA_listNewLostReferringDomains | Data Tool: Returns a list of referring domains, at least one backlink from which was (newly) found or lost in the specified date range for the specified target. |
| DATA_getNewLostRefDomainsCount | Data Tool: Returns the number of referring domains, at least one backlink from which was newly found or lost in the specified date range, broken down by day. |
| DATA_exportBacklinksData | Data Tool: Retrieves large-scale backlinks asynchronously, returning a task ID to check status later. |
| DATA_getBacklinksExportStatus | Data Tool: Checks the status of an asynchronous backlinks export task. Returns task status (queued_for_processing, processing, complete) and download URL when complete. |
| DATA_getDomainOverviewDatabases | Data Tool: Fetch domain overview by database (v1/domain/overview/db) |
| DATA_getDomainOverviewWorldwide | Data Tool: Retrieves an aggregated worldwide overview of domain metrics. |
| DATA_getDomainOverviewHistory | Data Tool: Retrieves historical data for domain traffic and keyword rankings. |
| DATA_getDomainKeywords | Data Tool: Retrieves a list of keywords for which a domain ranks in organic or paid search. |
| DATA_getDomainAdsByKeyword | Data Tool: Retrieves paid ads for a specific keyword. |
| DATA_getDomainAdsByDomain | Data Tool: Retrieves paid ads for a specific domain. |
| DATA_getDomainCompetitors | Data Tool: Retrieves a list of organic or paid competitors for a domain. |
| DATA_getDomainKeywordsComparison | Data Tool: Analyzes and compares the keyword rankings of two websites: |
| DATA_getSimilarKeywords | Data Tool: Retrieves a list of keywords similar to the seed keyword. |
| DATA_getRelatedKeywords | Data Tool: Retrieves a list of keywords semantically related to the seed keyword. |
| DATA_getLongTailKeywords | Data Tool: Retrieves a list of long-tail variations for the seed keyword. |
| DATA_getKeywordQuestions | Data Tool: Retrieves a list of question-based keywords containing the seed keyword. |
| DATA_exportKeywords | Data Tool: Retrieves metrics for a bulk list of keywords. |
| DATA_createStandardAudit | Data Tool: Launches a standard website audit that crawls the HTML of a website. Suitable for most static and server-side rendered sites. |
| DATA_createAdvancedAudit | Data Tool: Launches an advanced website audit that renders JavaScript before analyzing the page. Suitable for Single-Page Applications (SPAs) or dynamic content. |
| DATA_updateAuditTitle | Data Tool: Changes the title of an existing website audit report. |
| DATA_listAudits | Data Tool: Retrieves a list of all website audits associated with your account, providing key details and statistics for each. |
| DATA_getAuditReport | Data Tool: Retrieves the full, detailed report for a completed website audit. Includes health score, domain properties, and broken down checks. |
| DATA_getAuditStatus | Data Tool: Checks the real-time status of a specific website audit, whether it’s queued, currently processing, or already finished. |
| DATA_getCrawledPages | Data Tool: Returns a paginated list of all URLs found during an audit, providing a complete sitemap as discovered by the crawler. |
| DATA_getAuditPagesByIssue | Data Tool: Retrieves a paginated list of all URLs affected by a specific issue within a given audit. |
| DATA_getIssuesByUrl | Data Tool: Retrieves a detailed list of all issues (errors, warnings, and notices) that were found on a single, specific page within an audit. |
| DATA_getFoundLinks | Data Tool: Returns a paginated list of every hyperlink discovered across the entire site during the audit. |
| DATA_getAuditHistory | Data Tool: Retrieves a historical snapshot of a specific audit run, providing the full context of that audit. |
| DATA_deleteAudit | Data Tool: Permanently deletes a specified website audit report and all of its associated data. |
| DATA_recheckAudit | Data Tool: Launches a new crawl of a previously completed audit, using the same settings. |
| DATA_getSerpHtmlDump | Data Tool: Retrieves the raw HTML dump of a completed SERP task as a ZIP file. Returns binary ZIP data containing the SERP HTML page(s). Useful for debugging, archiving, or parsing the actual SERP page content. |
| DATA_getSerpLocations | Data Tool: Retrieves available locations for SERP analysis. After getting a location_id, use 'getSerpResults' to run SERP queries. |
| DATA_getSerpResults | Data Tool: Runs a SERP query and returns results. Creates task, polls every 5 seconds until complete (5 min timeout), and returns organic/ads/featured snippets (standard) or all SERP types including AI Overview, Maps, Reviews (advanced). Supports progress notifications. |
| DATA_getSerpTaskAdvancedResults | Data Tool: Retrieves the status or advanced results of a specific SERP task. Note that SERP tasks usually take 60 seconds to finish. If the task is still running, returns {"status": "processing"}. If complete, returns the full JSON results including "items". Returns ALL SERP item types (Maps, Reviews, AI Overview, etc.). Costs 10 credits for the 1st call. |
| DATA_getSerpTaskResults | Data Tool: Retrieves the status or standard results of a specific SERP task. Note that SERP tasks usually take 60 seconds to finish. If the task is still running, returns {"status": "processing"}. If complete, returns the full JSON results including "items". This endpoint provides results for the following SERP item types only: organic, ads, and featured_snippet. For AI Overview, Maps, Reviews, Sitelinks, Videos, Images, Top Ads, etc., use 'getSerpTaskAdvancedResults'. |
| DATA_getSerpTasks | Data Tool: Retrieves a list of all SERP tasks added to the queue in the last 24 hours. |
| PROJECT_listProjects | Project Tool: Requires a project ID. Get a list of all user projects. |
| PROJECT_createProject | Project Tool: Requires a project ID. Add a new project to the user account. |
| PROJECT_updateProject | Project Tool: Requires a project ID. Change/update project settings. |
| PROJECT_deleteProject | Project Tool: Requires a project ID. Delete a project from the user account. |
| PROJECT_getSummary | Project Tool: Requires a project ID. Get a project's summary statistics. |
| PROJECT_getKeywordStats | Project Tool: Requires a project ID. Get keyword ranking statistics for a specified time period. |
| PROJECT_getAdsStats | Project Tool: Requires a project ID. Get total number of top and bottom advertisements by day. |
| PROJECT_addKeywords | Project Tool: Requires a project ID. Add new keywords to a project. |
| PROJECT_deleteKeywords | Project Tool: Requires a project ID. Delete keywords from a project. |
| PROJECT_runPositionCheck | Project Tool: Requires a project ID. Run a ranking position check for specified keywords or for the entire project. |
| PROJECT_getSearchEngines | Project Tool: Requires a project ID. Get a list of search engines employed by a project. |
| PROJECT_listKeywords | Project Tool: Get a list of keywords with target pages for a project. |
| PROJECT_setKeywordPosition | Project Tool: Manually set position for a project's keyword. |
| PROJECT_getHistoricalDates | Project Tool: Returns standard comparison dates (e.g., yesterday, last month, etc.) available for reporting. |
| PROJECT_addSearchEngine | Project Tool: Add a new search engine to a project. |
| PROJECT_updateSearchEngine | Project Tool: Update an existing search engine in a project. |
| PROJECT_deleteSearchEngine | Project Tool: Delete a search engine from a project. |
| PROJECT_listProjectGroups | Project Tool: Requires a project ID. Get a list of all project groups from a user account. |
| PROJECT_createProjectGroup | Project Tool: Requires a project ID. Add a new project group to a user account. |
| PROJECT_updateProjectGroup | Project Tool: Requires a project ID. Rename a project group. |
| PROJECT_deleteProjectGroup | Project Tool: Requires a project ID. Delete a project group. |
| PROJECT_moveProjectsToGroup | Project Tool: Requires a project ID. Transfer projects from one project group to another (or to a specific group). |
| PROJECT_createKeywordGroup | Project Tool: Requires a project ID. Add a group for project keywords. |
| PROJECT_updateKeywordGroup | Project Tool: Requires a project ID. Update the name of a project keyword group. |
| PROJECT_deleteKeywordGroup | Project Tool: Requires a project ID. Delete a project keyword group. |
| PROJECT_listKeywordGroups | Project Tool: Requires a project ID. Get a list of keyword groups for a specified project. |
| PROJECT_moveKeywordsToGroup | Project Tool: Requires a project ID. Transfer project keywords from one group to another. |
| PROJECT_getAvailableSearchEngines | Project Tool: Get the list of all available search engines supported by the system. |
| PROJECT_getAvailableRegions | Project Tool: Get the list of all available regions supported by Google search engine. |
| PROJECT_addCompetitor | Project Tool: Requires a project ID (site_id). Add a competitor website to a project for position tracking. |
| PROJECT_listCompetitors | Project Tool: Requires a project ID (site_id). Get a list of all competitors added to the project together with statistics. |
| PROJECT_getCompetitorPositions | Project Tool: Requires a competitor ID. Get statistics on the positions of competitor keywords that were added to the project. |
| PROJECT_deleteCompetitor | Project Tool: Requires a competitor ID. Remove a competitor website from a user project. |
| PROJECT_getCompetitorTop10 | Project Tool: Requires a project ID (site_id). Get a list of the TOP 10 results for the keywords that are tracked in a project. |
| PROJECT_getCompetitorTop100 | Project Tool: Requires a project ID (site_id). Get a list of the top 100 results for the keywords that are tracked in a project. |
| PROJECT_getAllCompetitorsMetrics | Project Tool: Requires a project ID (site_id). Get data on the sites that were ranked in the TOP 10 for each of the tracked queries. The history is stored for 14 days. |
| PROJECT_listTags | Project Tool: Requires a project ID. Get a list of landing page tags that are added to domains and/or links. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| serp-analysis | Compare SERP results across two locations |
| backlink-gap | Find backlink opportunities by analyzing competitor referring domains |
| domain-traffic-competitors | Analyze domain organic traffic and identify top competitors |
| keyword-clusters | Generate keyword clusters with search volume and content recommendations |
| ai-share-of-voice | Analyze AI share of voice across LLM engines for your domain versus competitors |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |