Server definition
- Hash
- sha256:f96dbc2eb83c30e8845ed75946241f0c109397a81d1167f2dd693e2b32930810
- What it is
- What a remote MCP server returned when asked what it offers: 54 tools
The blob, as servednamed by its sha256
{
"instructions": null,
"tools": [
{
"description": "Append a screen to a screenshot set (at the end; reorder with sonar_update_screenshot_set). Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"layout": {
"additionalProperties": {},
"description": "Omit for a blank screen.",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"set_id": {
"description": "Screenshot set to append to.",
"minLength": 1,
"type": "string"
}
},
"required": [
"set_id"
],
"type": "object"
},
"name": "sonar_add_screenshot",
"outputSchema": null
},
{
"description": "The detected alert events for your workspace, newest first — the same feed as the in-app Recent Alerts panel and the email digest: rank drops/gains, top-10 entries/exits, new rankings, rating drops, review spikes, and competitor changes, each with a type-specific payload (app/keyword names, old vs new values). Events only exist for alert types you've enabled rules for (sonar_set_alert); detection runs once daily. Poll with `since` to react to changes programmatically. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Filter to events about one tracked app (Sonar app UUID or store id).",
"minLength": 1,
"type": "string"
},
"limit": {
"description": "Max events to return (1-200). Default 50.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"since": {
"description": "Only events created at/after this ISO 8601 timestamp (e.g. \"2026-08-01T00:00:00Z\"). Use your last poll time to fetch only new events.",
"minLength": 1,
"type": "string"
},
"type": {
"description": "Filter to one alert type. Omit for all types.",
"enum": [
"rank_drop",
"rank_gain",
"entered_top10",
"left_top10",
"new_ranking",
"rating_drop",
"review_spike",
"competitor_change",
"top_chart"
],
"type": "string"
}
},
"type": "object"
},
"name": "sonar_alert_events",
"outputSchema": null
},
{
"description": "WRITE tool — generates a fresh AI competitive insight for one of your own apps: clusters the keyword gaps vs your competitors into named opportunity themes (with a why-now narrative and per-keyword metrics), writes threat narratives for competitors climbing on your keywords, and diffs against the previous analysis. At most one analysis per app per 7 days (429 with the next available time while in cooldown — use sonar_competitor_landscape to read the current one). Requires a paid (non-trial) Indie plan and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of YOUR OWN tracked app to analyze. NOT a store id, NOT a competitor id.",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_analyze_competitors",
"outputSchema": null
},
{
"description": "Calculate an ASO (App Store Optimization) audit score (0-100) for an app. Returns the overall score plus an itemized breakdown of checks (title length, keyword usage, screenshots, ratings, etc.) so you can identify what to improve. Works without an API key (free tier, limited daily use per IP).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Any App Store storefront (175 countries) or Google Play market (145). Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_app_aso_score",
"outputSchema": null
},
{
"description": "Change history for a tracked app — detected releases, metadata edits, screenshot swaps, price changes, and category moves, newest first. Useful for correlating rank movements with what the app (or a competitor) changed. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
},
"limit": {
"description": "Max changes to return (1-200). Default 50.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "Filter to one change type. Omit for all types.",
"enum": [
"release",
"metadata",
"screenshots",
"price",
"category"
],
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_app_changes",
"outputSchema": null
},
{
"description": "App Store Connect App Analytics for one of your own iOS apps: the impressions → product page views → downloads funnel with conversion rates (`page_view_rate`, `download_rate`) and App Store search share, impressions by source (App Store search, browse, app referrer, web referrer…), plus daily installs, deletions and sessions. Impressions follow App Store Connect's definition and INCLUDE product page views, so totals reconcile with ASC. Downloads come from the Sales report. Same numbers as the Engagement page. iOS only. Requires the Agency plan (403 on other plans) AND an App Store Connect connection with an Admin-role key (`key_lacks_analytics` otherwise); Apple delivers the first analytics 24-48 hours after connecting (`pending`). Always check `status`: anything other than `ready` (not_connected, not_ios, app_not_in_account, pending, key_lacks_analytics) means there's no data and `message` says how to fix it — never read an empty series as zero. Days Apple hasn't reported yet have `reported: false` and null metrics.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of one of your own tracked iOS apps — the `id` returned by sonar_list_apps or sonar_create_product. The app's store id (bundle id) also works; pass `store` if it exists in both stores.",
"minLength": 1,
"type": "string"
},
"days": {
"description": "Window length in days (1-366) when `start` is omitted. Default 30.",
"maximum": 366,
"minimum": 1,
"type": "integer"
},
"end": {
"description": "Last day of the window (YYYY-MM-DD, inclusive). Default yesterday (UTC) — Apple posts a day the next morning at the earliest.",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
"start": {
"description": "First day of the window (YYYY-MM-DD, inclusive). Omit to count `days` back from `end`.",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
"store": {
"description": "Only needed when `app_id` is a store id tracked in both stores. App Store Connect data is iOS-only.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_app_engagement",
"outputSchema": null
},
{
"description": "Extract the most likely target keywords from an app's title and description, ranked by relevance. Useful for understanding what an app (yours or a competitor) is optimizing for. Works without an API key (free tier, limited daily use per IP).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Any App Store storefront (175 countries) or Google Play market (145). Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"max": {
"default": 20,
"description": "Maximum number of keywords to extract (1-50, default 20).",
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_app_extract_keywords",
"outputSchema": null
},
{
"description": "List the keywords tracked for an app in the caller's Sonar workspace, with latest difficulty, popularity, results count, note, and starred_at (favorite/target marker) per keyword. Returns the tracked-keyword ids used by sonar_update_keyword_note and sonar_star_keyword, and the keyword_ids used by sonar_keyword_rankings. Cursor-paginated (default 50 per page). Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous call's `next_cursor`. Omit for the first page.",
"minLength": 1,
"type": "string"
},
"limit": {
"description": "Page size (1-200). Server default applies when omitted.",
"maximum": 200,
"minimum": 1,
"type": "integer"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_app_keywords",
"outputSchema": null
},
{
"description": "Look up a single app by its store ID. Returns app metadata including name, developer, category, rating, reviews, installs (Android), and price. Works without an API key (free tier, limited daily use per IP). If the store is throttling, the result may be Sonar's stored copy: it then comes back as `{ data, meta }` with `meta.stale: true`, its date in `meta.stale_as_of`, and a `meta.note` to pass on to the user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Any App Store storefront (175 countries) or Google Play market (145). Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier. iOS: numeric track ID (e.g. \"123456789\"). Android: package name (e.g. \"com.spotify.music\").",
"minLength": 1,
"type": "string"
}
},
"required": [
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_app_lookup",
"outputSchema": null
},
{
"description": "The dashboard's computed scoreboard for one of your apps in a single call: visibility index and share of voice (with 7-day deltas and a daily spark), ranked / top-10 keyword counts with movement, best rank, the biggest 7-day improvements and drops, the rank-distribution trend, and the actionable opportunity list (near_page_one / top_three_push / easy_target). Read this FIRST when asked how an app is doing — it's the same numbers the dashboard renders, so you don't need to recompute anything from raw rank history. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of one of your own tracked apps — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
},
"days": {
"description": "Rank-history window in days (7-90). Default 30.",
"maximum": 90,
"minimum": 7,
"type": "integer"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_app_overview",
"outputSchema": null
},
{
"description": "Rank history for an app's tracked keywords — daily ranks over the requested window, one history array per keyword. Prefer observations for daily status: ranked has a numeric rank; not_found means a completed search did not return the app (results_count is the returned search size); not_observed means no confirmed check, including legacy gaps. Never interpret an absent rank as a collection failure or assign a numeric rank to it. The legacy history array contains positive ranks only. Use this to check how rankings moved after a metadata change or to find keywords trending up or down. Cursor-paginated over keywords (default 50 per page). Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous call's `next_cursor`. Omit for the first page.",
"minLength": 1,
"type": "string"
},
"days": {
"description": "History window in days (1-365). Default 30.",
"maximum": 365,
"minimum": 1,
"type": "integer"
},
"keyword_id": {
"description": "Restrict to one keyword — a keyword_id from sonar_app_keywords. Omit for all tracked keywords.",
"minLength": 1,
"type": "string"
},
"limit": {
"description": "Page size (1-200). Server default applies when omitted.",
"maximum": 200,
"minimum": 1,
"type": "integer"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_app_rankings",
"outputSchema": null
},
{
"description": "Estimate monthly revenue for an app, based on install counts, ratings, and category benchmarks. Returns the dollar estimate, a confidence grade (high/medium/low) with the factors behind it, and the methodology used — always communicate the confidence alongside the number.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Any App Store storefront (175 countries) or Google Play market (145). Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_app_revenue",
"outputSchema": null
},
{
"description": "Fetch user reviews for an app. Supports filtering by star rating range and sorting by recent or helpful. Useful for sentiment analysis, feature-request mining, and competitive research. If the store is throttling, the result may be Sonar's stored copy: it then comes back as `{ data, meta }` with `meta.stale: true`, its date in `meta.stale_as_of`, and a `meta.note` to pass on to the user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Any App Store storefront (175 countries) or Google Play market (145). Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"lang": {
"description": "Android only: fetch one language feed (e.g. ar, fr). Omit to merge the market language plus en, es, fr, ar; coverage is not exhaustive.",
"pattern": "^[a-z]{2}$",
"type": "string"
},
"limit": {
"description": "Maximum number of reviews to return (1-200).",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"max_rating": {
"description": "Filter to reviews with a star rating <= this value (1-5).",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"min_rating": {
"description": "Filter to reviews with a star rating >= this value (1-5).",
"maximum": 5,
"minimum": 1,
"type": "integer"
},
"sort": {
"default": "recent",
"description": "Sort order. \"recent\" returns newest first, \"helpful\" returns most-voted first.",
"enum": [
"recent",
"helpful"
],
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_app_reviews",
"outputSchema": null
},
{
"description": "App Store Connect sales for one of your own iOS apps: daily first-time downloads, redownloads, in-app purchase units and approximate USD proceeds (`proceeds_usd_approx`, converted with a static FX table — present it as approximate), window totals, and a per-country breakdown sorted by downloads. Same numbers as the Performance page. iOS only. Requires the Agency plan (403 on other plans) AND an App Store Connect connection at /settings/connections. Always check `status`: anything other than `ready` (not_connected, not_ios, app_not_in_account, pending, key_lacks_analytics) means there's no data and `message` says how to fix it — never read an empty series as zero. Days Apple hasn't reported yet have `reported: false` and null metrics.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of one of your own tracked iOS apps — the `id` returned by sonar_list_apps or sonar_create_product. The app's store id (bundle id) also works; pass `store` if it exists in both stores.",
"minLength": 1,
"type": "string"
},
"days": {
"description": "Window length in days (1-366) when `start` is omitted. Default 30.",
"maximum": 366,
"minimum": 1,
"type": "integer"
},
"end": {
"description": "Last day of the window (YYYY-MM-DD, inclusive). Default yesterday (UTC) — Apple posts a day the next morning at the earliest.",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
"start": {
"description": "First day of the window (YYYY-MM-DD, inclusive). Omit to count `days` back from `end`.",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string"
},
"store": {
"description": "Only needed when `app_id` is a store id tracked in both stores. App Store Connect data is iOS-only.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_app_sales",
"outputSchema": null
},
{
"description": "Search apps in the App Store or Google Play by keyword. Returns ranked list of apps with metadata (results are returned in store ranking order). Works without an API key (free tier, limited daily use per IP). If the store is throttling, the result may be Sonar's stored copy: it then comes back as `{ data, meta }` with `meta.stale: true`, its date in `meta.stale_as_of`, and a `meta.note` to pass on to the user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Any App Store storefront (175 countries) or Google Play market (145). Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"num": {
"default": 10,
"description": "Number of results to return (1-50, default 10).",
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"query": {
"description": "Search query (e.g. \"meditation\", \"meal planner\").",
"minLength": 1,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"query",
"store"
],
"type": "object"
},
"name": "sonar_app_search",
"outputSchema": null
},
{
"description": "Keywords a tracked competitor currently ranks for (last 7 days of SERP data), with difficulty and popularity per keyword. Pass own_app_id for gap analysis: keywords where the competitor ranks but your app doesn't are marked gap=missing. Cursor-paginated (default 50 per page). Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"competitor_app_id": {
"description": "Sonar app UUID of the competitor — the `competitor.id` from sonar_track_competitor, or an `id` from sonar_list_apps where is_own is false. NOT a store id.",
"minLength": 1,
"type": "string"
},
"cursor": {
"description": "Pagination cursor from a previous call's `next_cursor`. Omit for the first page.",
"minLength": 1,
"type": "string"
},
"limit": {
"description": "Page size (1-200). Server default applies when omitted.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"own_app_id": {
"description": "Sonar app UUID of your own app. When set, each keyword includes your current rank and a gap marker for keywords you don't rank for.",
"minLength": 1,
"type": "string"
}
},
"required": [
"competitor_app_id"
],
"type": "object"
},
"name": "sonar_competitor_keywords",
"outputSchema": null
},
{
"description": "The full competitive keyword picture for one of your own apps vs every tracked competitor, in one call: live stats (keyword gaps where competitors rank and you don't, winnable gaps, competitors climbing on your tracked keywords, keywords you lead), the top gap/threat/lead rows with metrics, and the latest AI insight if one was generated (opportunity clusters, threat narratives, strengths, posture). Read this before deciding which keywords to target next. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of YOUR OWN tracked app (an `id` from sonar_list_apps where is_own is true). NOT a store id, NOT a competitor id.",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_competitor_landscape",
"outputSchema": null
},
{
"description": "WRITE tool — creates a product in the caller's Sonar workspace and starts tracking the given app(s). A product is the cross-store unit (one iOS + one Android app, or just one of either). Returns the product id and the Sonar app ids needed by sonar_track_keywords and sonar_track_competitor. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"apps": {
"description": "1-2 store versions: a single iOS or Android app, or one of each for a cross-store product.",
"items": {
"description": "One store version of the product.",
"properties": {
"country": {
"description": "ISO 3166-1 alpha-2 country code (e.g. \"us\"). Optional — defaults server-side.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"store",
"store_id"
],
"type": "object"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
},
"name": {
"description": "Product name. Optional — defaults to the first app's name.",
"maxLength": 120,
"minLength": 1,
"type": "string"
}
},
"required": [
"apps"
],
"type": "object"
},
"name": "sonar_create_product",
"outputSchema": null
},
{
"description": "Create an app-store screenshot set for a product. Read sonar_screenshot_layout_guide first, then author the screens array. The set is immediately visible/editable for humans in the Screenshot Studio (studio_url in the response). Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"device_size": {
"description": "Device id from sonar_screenshot_devices, e.g. \"iphone-6.7\".",
"minLength": 1,
"type": "string"
},
"name": {
"description": "Display name.",
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"product_id": {
"description": "Product the set belongs to.",
"minLength": 1,
"type": "string"
},
"screens": {
"description": "Initial screens, in order (max 10). Either this or template_id, not both; with neither you get one blank screen.",
"items": {
"additionalProperties": {},
"description": "A screenshot layout document ({background, layers}) — see sonar_screenshot_layout_guide. Image fields accept https:// URLs.",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"maxItems": 10,
"minItems": 1,
"type": "array"
},
"store": {
"description": "Target app store.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"template_id": {
"description": "Seed from a built-in template (see sonar_screenshot_layout_guide) instead of providing screens.",
"minLength": 1,
"type": "string"
}
},
"required": [
"product_id",
"store",
"device_size"
],
"type": "object"
},
"name": "sonar_create_screenshot_set",
"outputSchema": null
},
{
"description": "WRITE tool — delete an alert subscription in the caller's Sonar workspace. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"id": {
"description": "The alert subscription UUID — the `id` returned by sonar_list_alerts or sonar_set_alert.",
"minLength": 1,
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sonar_delete_alert",
"outputSchema": null
},
{
"description": "WRITE tool — delete a product and untrack its apps in the caller's Sonar workspace. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"product_id": {
"description": "Sonar product UUID — the `id` returned by sonar_list_products or sonar_create_product.",
"minLength": 1,
"type": "string"
}
},
"required": [
"product_id"
],
"type": "object"
},
"name": "sonar_delete_product",
"outputSchema": null
},
{
"description": "Delete one screen from a screenshot set. A set keeps at least one screen — deleting the last one is rejected. Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"screenshot_id": {
"description": "Screen id to delete.",
"minLength": 1,
"type": "string"
}
},
"required": [
"screenshot_id"
],
"type": "object"
},
"name": "sonar_delete_screenshot",
"outputSchema": null
},
{
"description": "Permanently delete a screenshot set and everything in it (screens, translations). Irreversible — confirm with the user before deleting work they may want. Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"set_id": {
"description": "Screenshot set id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"set_id"
],
"type": "object"
},
"name": "sonar_delete_screenshot_set",
"outputSchema": null
},
{
"description": "WRITE tool — stop tracking one keyword/app pair in the caller's Sonar workspace. Identify the pair by its tracked-keyword id (from sonar_app_keywords). Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"tracked_keyword_id": {
"description": "The tracked-keyword UUID — the `id` returned by sonar_app_keywords. NOT the keyword_id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"tracked_keyword_id"
],
"type": "object"
},
"name": "sonar_delete_tracked_keyword",
"outputSchema": null
},
{
"description": "Keywords Sonar's discovery engine surfaced for one of your tracked apps but that aren't tracked yet — ranked finds (the app already ranks, unnoticed), competitor gaps, and AI/autocomplete-sourced ideas — each with popularity, difficulty, AI relevance, and an opportunity score (0-100, best first). This is Sonar's \"what should I track next\" answer: read it, pick the winners, then track them with sonar_track_keywords. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of one of your tracked apps — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
},
"bucket": {
"description": "Filter by classification: \"ranked\" = the app already ranks for it, \"gap\" = a competitor ranks but the app does not, \"idea\" = verified research suggestion with no rank evidence yet. Omit for all.",
"enum": [
"ranked",
"gap",
"idea"
],
"type": "string"
},
"country": {
"description": "Filter to one market (ISO country code). Omit for all markets.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"limit": {
"description": "Max rows to return (1-500). Default 200.",
"maximum": 500,
"minimum": 1,
"type": "integer"
},
"min_opportunity": {
"description": "Only rows with an opportunity score at or above this value (0-100).",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"min_relevance": {
"description": "Only rows with AI relevance at or above this value (0-100).",
"maximum": 100,
"minimum": 0,
"type": "integer"
},
"source": {
"description": "Filter by how the keyword was discovered. Omit for all sources.",
"enum": [
"autocomplete",
"metadata",
"serp_scan",
"competitor",
"apple_ads",
"ai"
],
"type": "string"
},
"status": {
"description": "Filter by row status. Default \"new\" — the still-actionable suggestions; \"all\" includes rows already tracked or hidden.",
"enum": [
"new",
"tracked",
"hidden",
"all"
],
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_discovered_keywords",
"outputSchema": null
},
{
"description": "WRITE tool — generates a fresh AI review analysis for a tracked app from its recent reviews (praise/complaint themes, sentiment, feature requests, trend vs the previous run). At most one analysis per app+country every 90 days (429 with the next available time while in cooldown — use sonar_review_insights to read the current one); needs at least 5 recent reviews. Requires a paid (non-trial) Indie plan and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of a tracked app — your own or a competitor (an `id` from sonar_list_apps). NOT a store id.",
"minLength": 1,
"type": "string"
},
"country": {
"default": "us",
"description": "Reviews market (ISO country code). Insights are generated per country. Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_generate_review_insights",
"outputSchema": null
},
{
"description": "Get full details for one tracked app in the caller's Sonar workspace: store metadata plus up to 90 daily snapshots of rating, review count, version, and installs. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_get_app",
"outputSchema": null
},
{
"description": "Fetch a screenshot set in full: every screen's layout JSON plus per-screen translation overrides keyed by locale. By default inline image data is replaced with placeholders to keep the response readable.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"include_image_data": {
"default": false,
"description": "When false (default), inline base64 images are replaced with short placeholders to keep the response small. Set true only when you need the raw data URLs (a layout containing placeholders is rejected on update).",
"type": "boolean"
},
"set_id": {
"description": "Screenshot set id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"set_id"
],
"type": "object"
},
"name": "sonar_get_screenshot_set",
"outputSchema": null
},
{
"description": "Difficulty + popularity for a specific keyword (or up to 25 in bulk). Use this when you already know which keywords you care about — costs 1 credit per keyword. Works without an API key for up to 5 keywords/day (free tier, per IP); an API key removes that cap. Use sonar_keyword_search instead when you want related keyword ideas alongside metrics. Answers within about 30 seconds: a keyword that can't be computed in that time comes back as `pending` (queued on Sonar's scrape fleet, not charged, results are being cached) — call again after `retry_after_seconds` for just those keywords.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "One of Sonar's 72 keyword-research markets, as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"jp\", \"br\"). Keyword data isn't available for other storefronts. Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"keyword": {
"description": "Single keyword to fetch metrics for. Use this OR `keywords`, not both.",
"minLength": 1,
"type": "string"
},
"keywords": {
"description": "Bulk list of keywords to fetch metrics for (max 25). Use this OR `keyword`, not both. 1 credit per keyword.",
"items": {
"minLength": 1,
"type": "string"
},
"maxItems": 25,
"minItems": 1,
"type": "array"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"store"
],
"type": "object"
},
"name": "sonar_keyword_metrics",
"outputSchema": null
},
{
"description": "SERP history for one tracked keyword — which apps ranked in the top results on each measured day, newest first. Use this to see who competes on a keyword and how the top spots shifted over time. The keyword must be tracked in the caller's Sonar workspace. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"days": {
"description": "History window in days (1-365). Default 30.",
"maximum": 365,
"minimum": 1,
"type": "integer"
},
"keyword_id": {
"description": "Sonar keyword UUID — a `keyword_id` from sonar_app_keywords or sonar_competitor_keywords. NOT the keyword text.",
"minLength": 1,
"type": "string"
}
},
"required": [
"keyword_id"
],
"type": "object"
},
"name": "sonar_keyword_rankings",
"outputSchema": null
},
{
"description": "Research a keyword and related terms. Returns difficulty (0-100), popularity score, and results count for the seed keyword plus related autocomplete suggestions. Use this to find keywords worth targeting. Answers within about 30 seconds; a related term that couldn't be computed in time comes back marked `pending` (queued, not charged) — get it later with sonar_keyword_metrics.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "One of Sonar's 72 keyword-research markets, as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"jp\", \"br\"). Keyword data isn't available for other storefronts. Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"query": {
"description": "Seed keyword to research (e.g. \"meditation\", \"recipe app\").",
"minLength": 1,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"query",
"store"
],
"type": "object"
},
"name": "sonar_keyword_search",
"outputSchema": null
},
{
"description": "Get autocomplete suggestions for a seed keyword from the App Store or Google Play. Returns terms with a priority score (higher = more searched). Lighter and faster than sonar_keyword_search — use when you only need term ideas without difficulty/popularity scoring. Works without an API key (free tier, limited daily use per IP). If the store is throttling, the result may be Sonar's stored copy: it then comes back as `{ data, meta }` with `meta.stale: true`, its date in `meta.stale_as_of`, and a `meta.note` to pass on to the user.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Nearly every App Store storefront and Google Play market works; the few small storefronts that are not supported return an error naming them. Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"seed": {
"description": "Seed keyword. The store will return autocomplete suggestions starting from this term.",
"minLength": 1,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"seed",
"store"
],
"type": "object"
},
"name": "sonar_keyword_suggestions",
"outputSchema": null
},
{
"description": "List your alert subscriptions — each rule defines a change type (rank drops, review spikes, etc.), its scope (a specific app or org-wide), threshold, and whether it's enabled. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "sonar_list_alerts",
"outputSchema": null
},
{
"description": "List the apps tracked in the caller's Sonar workspace (own apps + competitors), each with its latest snapshot (rating, review count, version, installs). Returns the Sonar app UUIDs needed by sonar_get_app, sonar_app_keywords, sonar_app_rankings, and sonar_app_changes. Cursor-paginated (default 100 per page). Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"cursor": {
"description": "Pagination cursor from a previous call's `next_cursor`. Omit for the first page.",
"minLength": 1,
"type": "string"
},
"limit": {
"description": "Page size (1-200). Server default applies when omitted.",
"maximum": 200,
"minimum": 1,
"type": "integer"
}
},
"type": "object"
},
"name": "sonar_list_apps",
"outputSchema": null
},
{
"description": "List your products with their linked store versions and competitor counts. Use it to discover product/app UUIDs. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "sonar_list_products",
"outputSchema": null
},
{
"description": "List a product's app-store screenshot sets (metadata only: store, device size, locales, studio_url). Use sonar_get_screenshot_set for full layouts.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"product_id": {
"description": "Product id (find it with sonar_list_products).",
"minLength": 1,
"type": "string"
}
},
"required": [
"product_id"
],
"type": "object"
},
"name": "sonar_list_screenshot_sets",
"outputSchema": null
},
{
"description": "The whole portfolio's health in one call — for orgs managing many apps: per-app KPIs (visibility + 7-day delta, ranked/top-10 counts, net rank movement, rating, review count), org-wide totals, the biggest keyword movers in both directions, a needs-attention triage list (visibility drops, rating drops, not-ranked apps), and the best discovered-keyword opportunities across all apps. Same numbers as the /portfolio page. Requires an Agency plan (403 on other plans).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "sonar_portfolio",
"outputSchema": null
},
{
"description": "WRITE tool — remove a competitor from a product in the caller's Sonar workspace. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"competitor_app_id": {
"description": "Sonar app UUID of the competitor to remove (the competitor's `id`, NOT a store id).",
"minLength": 1,
"type": "string"
},
"product_id": {
"description": "Sonar product UUID — the `id` returned by sonar_list_products or sonar_create_product.",
"minLength": 1,
"type": "string"
}
},
"required": [
"product_id",
"competitor_app_id"
],
"type": "object"
},
"name": "sonar_remove_competitor",
"outputSchema": null
},
{
"description": "The latest AI review analysis for a tracked app (your own or a competitor): what users praise and complain about as named themes with frequency, verbatim quotes, and trend movement (new / persisting / growing / improving / resolved), plus overall sentiment, surfaced feature requests, and what changed vs the previous analysis. `insight` is null if none has been generated yet — use sonar_generate_review_insights. Requires an Indie plan (trial counts).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID of a tracked app — your own or a competitor (an `id` from sonar_list_apps). NOT a store id.",
"minLength": 1,
"type": "string"
},
"country": {
"default": "us",
"description": "Reviews market (ISO country code). Insights are generated per country. Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_review_insights",
"outputSchema": null
},
{
"description": "WRITE tool — runs an AI keyword discovery scan on a tracked competitor: generates the search terms the competitor's listing is optimized for (brand terms included), queues them for SERP verification, and verifies the first batch inline (~30s), recording both apps' ranks. Returns generated/queued/verified_now counts; the rest verify in the background over the following hours — read results with sonar_competitor_keywords. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"competitor_app_id": {
"description": "Sonar app UUID of the competitor to scan — the `competitor.id` from sonar_track_competitor, or an `id` from sonar_list_apps where is_own is false. NOT a store id.",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
},
"own_app_id": {
"description": "Sonar app UUID of your own app the scan compares against. The competitor must be linked to this app.",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"type": "string"
}
},
"required": [
"competitor_app_id",
"own_app_id"
],
"type": "object"
},
"name": "sonar_scan_competitor",
"outputSchema": null
},
{
"description": "List the device sizes supported for app-store screenshot sets, with their canvas dimensions (the pixel coordinate space all layouts use) and which store each belongs to. Pick a device here before sonar_create_screenshot_set.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "sonar_screenshot_devices",
"outputSchema": null
},
{
"description": "The layout-format reference for Sonar screenshot sets. Call this ONCE before creating or editing screenshot layouts — it documents the layout JSON schema, coordinate system, image handling (remote URLs), flowing background shapes, fonts, translation overrides, and the recommended workflow.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {},
"type": "object"
},
"name": "sonar_screenshot_layout_guide",
"outputSchema": null
},
{
"description": "WRITE tool — create or update an alert subscription in the caller's Sonar workspace. Upserts on (type + scope): re-submitting the same type/scope updates the existing rule. Omit `threshold` for the per-type default; omit `scope_app_id` for an org-wide rule. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"countries": {
"anyOf": [
{
"items": {
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"maxItems": 10,
"type": "array"
},
{
"type": "null"
}
],
"description": "top_chart only: storefronts to watch (ISO 3166-1 alpha-2, e.g. [\"us\", \"de\"]), max 10. Omit to keep the stored list; null or [] = the countries you track keywords in."
},
"enabled": {
"description": "Whether the rule is active. Defaults to enabled when omitted.",
"type": "boolean"
},
"scope_app_id": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"description": "Limit the alert to a single app (Sonar app UUID). Omit or null for an org-wide rule covering all tracked apps."
},
"threshold": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"description": "Sensitivity threshold (meaning depends on type; for top_chart it's the rank cutoff, 1-200, default 200). Omit or null to use the per-type default."
},
"type": {
"description": "The alert type to subscribe to. top_chart = one of your own apps entered or left a store top chart (overall + its category, free/paid/grossing).",
"enum": [
"rank_drop",
"rank_gain",
"entered_top10",
"left_top10",
"new_ranking",
"rating_drop",
"review_spike",
"competitor_change",
"top_chart"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"name": "sonar_set_alert",
"outputSchema": null
},
{
"description": "Write a locale's translation overrides for screens in a screenshot set (text copy, localized captures/images). Geometry and styling always come from the source layout; anything not overridden falls back to it. The locale is auto-enabled on the set. Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"entries": {
"description": "One entry per screen to localize.",
"items": {
"properties": {
"overrides": {
"additionalProperties": {},
"description": "Sparse overrides keyed by layer id, e.g. {\"headline\": {\"text\": \"…\"}, \"device\": {\"screenshotDataUrl\": \"https://…\"}}. Replaces the screen's stored overrides for this locale wholesale.",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"screenshot_id": {
"description": "Screen this entry localizes.",
"minLength": 1,
"type": "string"
}
},
"required": [
"screenshot_id",
"overrides"
],
"type": "object"
},
"maxItems": 50,
"minItems": 1,
"type": "array"
},
"locale": {
"description": "Target locale code, e.g. \"de-DE\", \"pt-BR\", \"zh-Hans\".",
"maxLength": 8,
"minLength": 2,
"type": "string"
},
"set_id": {
"description": "Screenshot set id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"set_id",
"locale",
"entries"
],
"type": "object"
},
"name": "sonar_set_screenshot_translations",
"outputSchema": null
},
{
"description": "WRITE tool — stars or unstars a tracked keyword in the caller's Sonar workspace. A star marks the keyword as a favorite/target the user is actively pursuing; starred keywords carry a starred_at timestamp in sonar_app_keywords results. Idempotent: re-starring refreshes the timestamp, unstarring a non-starred keyword is a no-op. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"starred": {
"description": "true to star the keyword (mark as a favorite/target), false to unstar.",
"type": "boolean"
},
"tracked_keyword_id": {
"description": "Tracked-keyword UUID — the `id` (not keyword_id) returned by sonar_app_keywords or sonar_track_keywords.",
"minLength": 1,
"type": "string"
}
},
"required": [
"tracked_keyword_id",
"starred"
],
"type": "object"
},
"name": "sonar_star_keyword",
"outputSchema": null
},
{
"description": "Get a store top chart (free / paid / grossing, overall or by category) with day-over-day movement: per-app rank delta, apps new to the chart, biggest movers and apps that dropped out. Use to see what's rising in a market or category. Note: summary, movers and droppedApps always describe the full top 200 — `limit` truncates the returned entries only. Movement is empty on the first day a chart is requested (no previous snapshot yet). Answers within about 30 seconds: when a live refresh can't finish in time the newest stored chart is returned with `stale: true` and its `measuredAt` date. Works without an API key (free tier, limited daily use per IP).",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"category": {
"default": "overall",
"description": "Category key, e.g. \"HEALTH_AND_FITNESS\" (iOS) or \"HEALTH_AND_FITNESS\" / \"GAME\" (Android). Use \"overall\" (default) for the store-wide chart.",
"type": "string"
},
"chart": {
"default": "free",
"description": "Chart type: \"free\", \"paid\" or \"grossing\". Default \"free\".",
"enum": [
"free",
"paid",
"grossing"
],
"type": "string"
},
"country": {
"default": "us",
"description": "Market as an ISO 3166-1 alpha-2 code (e.g. \"us\", \"gb\", \"de\", \"mt\"). Nearly every App Store storefront and Google Play market works; the few small storefronts that are not supported return an error naming them. Default \"us\".",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"limit": {
"default": 50,
"description": "Number of chart entries to return (1-200). Default 50.",
"maximum": 200,
"minimum": 1,
"type": "integer"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"required": [
"store"
],
"type": "object"
},
"name": "sonar_top_charts",
"outputSchema": null
},
{
"description": "WRITE tool — links the second-store version of an existing Sonar product (e.g. the product already tracks the iOS app and you want to add the Android version, or vice versa). Each product holds at most one iOS + one Android app; to start tracking a brand-new app, use sonar_create_product instead. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"description": "ISO 3166-1 alpha-2 country code (e.g. \"us\"). Optional — defaults server-side.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"product_id": {
"description": "Sonar product UUID (from sonar_create_product). NOT a store id.",
"minLength": 1,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier of the version to link. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"product_id",
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_track_app",
"outputSchema": null
},
{
"description": "WRITE tool — adds a competitor app under a Sonar product so its keywords and rankings get tracked alongside the product's own app. The product must already have its own app linked in the same store as the competitor. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"country": {
"description": "ISO 3166-1 alpha-2 country code (e.g. \"us\"). Optional — defaults server-side.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"product_id": {
"description": "Sonar product UUID (from sonar_create_product). NOT a store id.",
"minLength": 1,
"type": "string"
},
"store": {
"description": "App store. \"ios\" for Apple App Store, \"android\" for Google Play.",
"enum": [
"ios",
"android"
],
"type": "string"
},
"store_id": {
"description": "Store-specific app identifier of the COMPETITOR app to track. iOS: numeric track ID. Android: package name.",
"minLength": 1,
"type": "string"
}
},
"required": [
"product_id",
"store",
"store_id"
],
"type": "object"
},
"name": "sonar_track_competitor",
"outputSchema": null
},
{
"description": "WRITE tool — starts daily rank tracking for one or more keywords on an app in the caller's Sonar workspace. Idempotent: re-posting the same terms reports them as already_tracked instead of creating duplicates. Returns per-keyword outcomes (created / already_tracked / failed). Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID — the `apps[].id` returned by sonar_create_product (or sonar_track_app). NOT a store id; the store is implied by the app.",
"minLength": 1,
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-2 country code (e.g. \"us\"). Optional — defaults to the product's country.",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"keywords": {
"description": "Keywords to start tracking (1-200). Duplicates and already-tracked terms are reported, not duplicated.",
"items": {
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"maxItems": 200,
"minItems": 1,
"type": "array"
}
},
"required": [
"app_id",
"keywords"
],
"type": "object"
},
"name": "sonar_track_keywords",
"outputSchema": null
},
{
"description": "WRITE tool — untrack an app and its associated tracking data in the caller's Sonar workspace. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"app_id": {
"description": "Sonar app UUID — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_untrack_app",
"outputSchema": null
},
{
"description": "WRITE tool — bulk-untrack keywords for an app in the caller's Sonar workspace. Pass `all: true` to remove every tracked keyword, OR `ids: [...]` to remove specific ones (exactly one of the two). Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"all": {
"description": "Set true to untrack ALL keywords for the app. Mutually exclusive with `ids` — pass exactly one of `all` or `ids`.",
"type": "boolean"
},
"app_id": {
"description": "Sonar app UUID — the `id` returned by sonar_list_apps or sonar_create_product. NOT a store id.",
"minLength": 1,
"type": "string"
},
"ids": {
"description": "Tracked-keyword ids to untrack (from sonar_app_keywords). Mutually exclusive with `all` — pass exactly one of `all` or `ids`.",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"type": "array"
}
},
"required": [
"app_id"
],
"type": "object"
},
"name": "sonar_untrack_keywords",
"outputSchema": null
},
{
"description": "WRITE tool — sets or clears the note on a tracked keyword in the caller's Sonar workspace (e.g. why it's tracked, an optimization hypothesis, a reminder). Idempotent: re-sending the same note is a no-op. Requires an Indie plan (trial counts) and an authorized Sonar account or an API key with the write scope.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"note": {
"anyOf": [
{
"maxLength": 1000,
"type": "string"
},
{
"type": "null"
}
],
"description": "Note text (max 1000 chars). Pass null or an empty string to clear the note."
},
"tracked_keyword_id": {
"description": "Tracked-keyword UUID — the `id` (not keyword_id) returned by sonar_app_keywords or sonar_track_keywords.",
"minLength": 1,
"type": "string"
}
},
"required": [
"tracked_keyword_id",
"note"
],
"type": "object"
},
"name": "sonar_update_keyword_note",
"outputSchema": null
},
{
"description": "Replace one screen's layout in a screenshot set. Whole-document replace — fetch the current layout, modify it, send it back. The change shows up immediately in the Screenshot Studio for human review. Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"layout": {
"additionalProperties": {},
"description": "The FULL replacement layout — this replaces the whole document, it does not merge. Never send a layout containing '[inline image omitted…]' placeholders; refetch with include_image_data first.",
"propertyNames": {
"type": "string"
},
"type": "object"
},
"screenshot_id": {
"description": "Screen id (from the set's screens array).",
"minLength": 1,
"type": "string"
}
},
"required": [
"screenshot_id",
"layout"
],
"type": "object"
},
"name": "sonar_update_screenshot",
"outputSchema": null
},
{
"description": "Rename a screenshot set, replace its extra-locale list, and/or reorder its screens. Returns the updated set (with image data stripped). Requires an authorized Sonar account or a write-scope API key.",
"inputSchema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"locales": {
"description": "Replaces the extra-locale list (e.g. [\"de-DE\",\"fr-FR\"]). Locales removed here lose their stored translations.",
"items": {
"maxLength": 8,
"minLength": 2,
"type": "string"
},
"maxItems": 40,
"type": "array"
},
"name": {
"description": "New display name.",
"maxLength": 120,
"minLength": 1,
"type": "string"
},
"screen_order": {
"description": "Full permutation of the set's screen ids in the new display order.",
"items": {
"minLength": 1,
"type": "string"
},
"minItems": 1,
"type": "array"
},
"set_id": {
"description": "Screenshot set id.",
"minLength": 1,
"type": "string"
}
},
"required": [
"set_id"
],
"type": "object"
},
"name": "sonar_update_screenshot_set",
"outputSchema": null
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:f96dbc2eb83c30e8845ed75946241f0c109397a81d1167f2dd693e2b32930810 | sha256sum