sites
Your businesses.
The websites (businesses) on this account. list (scan:read): each with its site_id, address and kind; use the site_id with get_brand_brief, site_insights, site_tools and published_pages. Writes (scan:write): add (url, site_type, city for a local business, name); update (site_id; name, city, site_type, trade, facts: your own facts by key, merged into what is saved, and remove_facts: a list of keys to take off, e.g. ["phone"]; an empty value in facts also removes one); save_about (site_id, entries [{field, value}], field sell, who, where, different, prices or wrong): About your business, in the person's words; set_competitors (site_id, competitors [{name, domain}] to add or [{competitor_id, active}] to switch). Write only what the person told you.
Who can use it
- Access
- Any account.
- Scope
scan:readfor reading; each write action's scope is below.- Changes anything
- Its write actions do; see below.
Actions
Pass one in action. Without it: list.
| action | Scope | What it does |
|---|---|---|
list | scan:read | The websites on this account. |
add | scan:write | A write action: the description above says what it changes. |
update | scan:write | A write action: the description above says what it changes. |
save_about | scan:write | A write action: the description above says what it changes. |
set_competitors | scan:write | A write action: the description above says what it changes. |
Inputs
| Name | Type | Required | Values and limits |
|---|---|---|---|
action | string | No | list, add, update, save_about, set_competitors. Default list |
site_id | string | No | |
url | string | No | 0 to 500 characters |
site_type | string | No | local_service, local_storefront, local_professional, agency, saas, ecommerce, marketplace, creator, nonprofit, publisher, other |
city | string | No | 0 to 80 characters |
name | string | No | 0 to 120 characters |
trade | string | No | 0 to 60 characters |
facts | object | No | Keys: name, description, phone, email, address, services, areas, hours, prices, credentials, profiles |
remove_facts | array of string | No | at most 20 items. For update: own facts to remove, by key (e.g. ["phone", "hours"]) |
entries | array of object | No | at most 12 items |
competitors | array of object | No | at most 20 items |
What it answers
Every answer has status and, where useful, message in plain words.
| Field | Meaning |
|---|---|
sites | site_id, name, url, kind and site_url. Use site_id with get_brand_brief, site_insights, site_tools and published_pages. |
Errors
| status | What it means |
|---|---|
invalid_input | An action that isn't in the list. |
forbidden | The 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 error | An 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.
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "sites",
"arguments": {
"action": "list"
}
}
}{
"status": "ok",
"sites": [
{
"site_id": "00000000-0000-4000-8000-000000000004",
"name": "example.com",
"url": "https://example.com/",
"kind": "local_service",
"site_url": "https://app.scanfree.dev/app/sites/00000000-0000-4000-8000-000000000004"
}
]
}