Skip to content

get_brand_brief

Facts about the business.

Every fact ScanFree holds about one of your sites, each with where it came from and when: what you told us in About your business, what your site says about itself (name, description, services, areas, hours, phone, email, credentials, profiles, each with the page or tag it came from), the name, address, phones and hours read on your site, prices read on your site, your article pages from the sitemap with their dates, review counts and dates per platform (never review text), the claims you marked wrong and the pages you published. Nothing is inferred; a fact we don't have is left out. Use these as the only facts a fix may state. format "markdown" returns the same text as the About page's Markdown download.

Who can use it

Access
Any of your sites; most facts come from paid checks and the About page.
Scope
scan:read
Changes anything
No. Read-only.

Inputs

NameTypeRequiredValues and limits
site_idstringYes
formatstringNojson, markdown

What it answers

Every answer has status and, where useful, message in plain words.

FieldMeaning
business, url, type, city, built_onThe site, and when the brief was built.
you_told_usWhat the person entered in About your business, each with its date.
read_on_your_siteWhat the site says about itself (name, services, areas, hours, phone, email and so on), each with the page or tag it came from.
prices_on_your_sitePrices read on the site, with the quote and page.
articlesArticle pages from the sitemap with their dates, and the ones that may need a refresh.
reviewsReview counts and dates per platform. Never review text.
marked_wrongClaims the person marked wrong, and when a fix went live.
publishedPages the person published and logged.
markdownWith format markdown: the same brief as the About page's download, as text.

Errors

statusWhat it means
invalid_inputsite_id isn't a site id. Take one from sites (action list) or get_dashboard.
not_foundNo site with that id on this account.
invalid_inputformat must be json or markdown.
forbiddenThe credential lacks the tool's scope, or an agent's owner has no ScanFree account yet (the owner signs in on the website once).
Input validation errorAn argument doesn't match the schema below. The call fails with MCP error -32602, naming the field.

Errors before the tool runs (a missing key, too many requests) are on the MCP page.

Example

Example shape; values are illustrative.

The call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_brand_brief",
    "arguments": {
      "site_id": "00000000-0000-4000-8000-000000000004",
      "format": "json"
    }
  }
}
The answer (structured content)
{
  "status": "ok",
  "site_id": "00000000-0000-4000-8000-000000000004",
  "business": "Example Plumbing",
  "url": "https://example.com/",
  "type": "local_service",
  "city": "Boise, Idaho",
  "built_on": "2026-11-21",
  "header": "…",
  "you_told_us": [
    {
      "field": "services",
      "value": "Drain cleaning",
      "source": "About your business",
      "how": "typed",
      "date": "2026-11-02"
    }
  ],
  "read_on_your_site": [
    {
      "field": "phone",
      "value": "…",
      "page": "https://example.com/contact",
      "source": "page text",
      "date": "2026-11-18"
    }
  ],
  "prices_on_your_site": [],
  "marked_wrong": [],
  "articles": {
    "sitemap": true,
    "count": 4,
    "newest": "2026-09-30",
    "line": "…",
    "list": [],
    "refresh": [],
    "read_on": "2026-11-18"
  },
  "reviews": {
    "line": null,
    "checked_on": null,
    "platforms": []
  },
  "published": [],
  "note": "…"
}