Skip to main content
The Peec AI MCP Server has 8 read-only tools. Your AI assistant calls these automatically based on your questions. You don’t need to invoke them directly, but this reference helps you understand what data is available.
All tools except list_projects require a project_id. Your AI assistant handles this automatically after you pick a project.

list_projects

Lists all projects your account has access to. This is always called first. Returns: {data: [{id, name, status}]}

list_brands

List brands (your brand and tracked competitors) in a project.
ParameterTypeRequiredDescription
project_idstringYesThe project ID
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
Returns: {data: [{id, name, domains, is_own}]} The is_own field indicates whether this is your brand (true) or a competitor (false).

list_topics

Lists topic groupings in a project. Each prompt belongs to one topic.
ParameterTypeRequiredDescription
project_idstringYesThe project ID
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
Returns: {data: [{id, name}]}

list_tags

Lists tags (cross-cutting labels) in a project.
ParameterTypeRequiredDescription
project_idstringYesThe project ID
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
Returns: {data: [{id, name}]}

list_prompts

Lists prompts in a project. You can filter by topic or tag.
ParameterTypeRequiredDescription
project_idstringYesThe project ID
topic_idstringNoFilter by topic ID
tag_idstringNoFilter by tag ID
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
Returns: {data: [{id, text, tags: [{id}], topic: {id} | null}]}

get_brand_report

Returns brand visibility, sentiment, position, and share of voice across AI search engines.

Parameters

ParameterTypeRequiredDescription
project_idstringYesThe project ID
start_datestringYesStart date (YYYY-MM-DD)
end_datestringYesEnd date (YYYY-MM-DD)
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
dimensionsstring[]NoBreak down by: prompt_id, model_id, tag_id, topic_id, date, country_code, chat_id
filtersobject[]NoFilter results (see Filtering)

Response fields

FieldTypeDescription
brandobject{id, name}
visibilitynumber0 to 1. Fraction of AI responses that mention the brand
mention_countnumberTotal times the brand was mentioned
share_of_voicenumber0 to 1. Brand’s share of total mentions across all brands
sentimentnumber0 to 100. How positively AI platforms describe the brand. Most brands score 65 to 85
positionnumberAverage rank when mentioned. Lower is better (1 = mentioned first)
The response also includes raw aggregation fields (visibility_count, visibility_total, sentiment_sum, sentiment_count, position_sum, position_count) for custom calculations across segments.

get_domain_report

Returns source domain retrieval and citation metrics across AI search engines.

Parameters

ParameterTypeRequiredDescription
project_idstringYesThe project ID
start_datestringYesStart date (YYYY-MM-DD)
end_datestringYesEnd date (YYYY-MM-DD)
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
dimensionsstring[]NoBreak down by: prompt_id, model_id, tag_id, topic_id, date, country_code, chat_id
filtersobject[]NoFilter results (see Filtering)

Response fields

FieldTypeDescription
domainstringThe source domain (e.g. example.com)
classificationstringDomain type: OWN, CORPORATE, EDITORIAL, INSTITUTIONAL, UGC, REFERENCE, COMPETITOR, or OTHER
retrieved_percentagenumber0 to 1. Fraction of chats that retrieved this domain
retrieval_ratenumberAverage URLs retrieved per chat. Can exceed 1.0 (this is an average, not a percentage)
citation_ratenumberAverage citations when retrieved. Can exceed 1.0

get_url_report

Returns URL-level retrieval and citation metrics across AI search engines.

Parameters

ParameterTypeRequiredDescription
project_idstringYesThe project ID
start_datestringYesStart date (YYYY-MM-DD)
end_datestringYesEnd date (YYYY-MM-DD)
limitnumberNoMax results (default: 100)
offsetnumberNoResults to skip (default: 0)
dimensionsstring[]NoBreak down by: prompt_id, model_id, tag_id, topic_id, date, country_code, chat_id
filtersobject[]NoFilter results (see Filtering)

Response fields

FieldTypeDescription
urlstringThe full source URL
classificationstringPage type: HOMEPAGE, CATEGORY_PAGE, PRODUCT_PAGE, LISTICLE, COMPARISON, PROFILE, ALTERNATIVE, DISCUSSION, HOW_TO_GUIDE, ARTICLE, or OTHER
titlestringPage title (if available)
retrievalsnumberTotal times this URL was retrieved
citation_countnumberTotal citations across all chats
citation_ratenumberAverage citations per retrieval. Can exceed 1.0

Filtering

The three report tools support filters to narrow results. Each filter looks like this:
{
  "field": "model_id",
  "operator": "in",
  "values": ["chatgpt-scraper", "perplexity-scraper"]
}

Filter fields

FieldAvailable inDescription
model_idAll reportsAI search engine (e.g. chatgpt-scraper, perplexity-scraper, gemini-scraper, google-ai-overview-scraper, google-ai-mode-scraper, gpt-4o-search, claude-sonnet-4, microsoft-copilot-scraper, grok-scraper, deepseek-r1)
topic_idAll reportsTopic grouping ID
tag_idAll reportsTag ID
prompt_idAll reportsIndividual prompt ID
country_codeAll reportsISO 3166-1 alpha-2 code (e.g. US, DE, GB)
brand_idBrand reportBrand ID
domainDomain and URL reportsDomain name
urlDomain and URL reportsFull URL
chat_idAll reportsIndividual chat/conversation ID

Operators

OperatorDescription
inInclude only matching values
not_inExclude matching values
You can combine multiple filters. They’re joined with AND logic.

Dimensions

Dimensions break down results into rows grouped by a specific field. Without dimensions, results are totals for the entire date range.
DimensionWhat it doesWhen to use it
dateDaily breakdown (YYYY-MM-DD)Tracking trends over time
model_idPer AI search engineComparing performance across ChatGPT, Perplexity, etc.
topic_idPer topic groupingFinding your strongest and weakest topic areas
tag_idPer tagAnalyzing custom segments
prompt_idPer individual promptDrilling into specific queries
country_codePer countryChecking geographic differences
chat_idPer individual AI conversationInspecting specific responses
You can combine dimensions. For example, ["date", "model_id"] gives you daily trends per AI model.