Skip to content

order_setup

Set up a paid order.

After payment: the website and phrases a paid order tracks, so its first check can start (the order page's setup). Give site_id (one of your sites) or url with site_type (and city for a local business), and phrases: up to the number bought, questions a customer would ask an AI without the business name. Until the first check runs the whole list can be replaced; after that use phrases. Needs scan:write.

Who can use it

Access
A paid order that hasn't had its first check yet (after that, use phrases).
Scope
scan:write
Changes anything
Yes.

Inputs

NameTypeRequiredValues and limits
order_idstringYesAn order id from get_dashboard (orders_waiting_for_setup)
site_idstringNo
urlstringNo
site_typestringNolocal_service, local_storefront, local_professional, agency, saas, ecommerce, marketplace, creator, nonprofit, publisher, other
citystringNo
namestringNoThe business name
phrasesarray of stringYes1 to 200 items

What it answers

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

FieldMeaning
order_id, site_idThe order and the site it now tracks.
phrasesThe phrases set: phrase_id, text, kind.
messageConfirms it; the first check starts on its own and check_status shows it.

Errors

statusWhat it means
invalid_inputorder_id isn't an order id. Take one from get_dashboard.
not_foundNo order with that id on this account.
invalid_inputNo site given, more phrases than bought, or a phrase that names the business (the message says which).
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": "order_setup",
    "arguments": {
      "order_id": "00000000-0000-4000-8000-000000000002",
      "site_id": "00000000-0000-4000-8000-000000000004",
      "phrases": [
        "emergency plumber boise"
      ]
    }
  }
}
The answer (structured content)
{
  "status": "ok",
  "order_id": "00000000-0000-4000-8000-000000000002",
  "site_id": "00000000-0000-4000-8000-000000000004",
  "phrases": [
    {
      "phrase_id": "00000000-0000-4000-8000-000000000005",
      "text": "emergency plumber boise",
      "kind": "generic"
    }
  ],
  "message": "Set: the website and 1 phrase. The first check starts on its own; check_status shows it."
}