Skip to content

account

Free scans left, email choices, export.

This account. get (scan:read): free scans used and left this month and the reset date (shared with the website), and the email choices; use it to test the connection, it never spends a free scan. export_status (scan:read): the latest data export. With account:write (off unless the person ticked it for this key or app): set_email_preferences (check_emails full, short or off; alerts, ads; payment and refund emails can't be switched off) and start_export (a zip of all the account's data, one an hour, kept 24 hours; it downloads only when the person is signed in).

Who can use it

Access
Any account. Safe for testing the connection: it never spends a free scan.
Scope
scan:read for reading; each write action's scope is below.
Changes anything
Its write actions do; see below.

Actions

Pass one in action. Without it: get.

actionScopeWhat it does
getscan:readFree scans used and left this month, and the email choices.
set_email_preferencesaccount:writeA write action: the description above says what it changes.
start_exportaccount:writeA write action: the description above says what it changes.
export_statusscan:readA write action: the description above says what it changes.

Inputs

NameTypeRequiredValues and limits
actionstringNoget, set_email_preferences, start_export, export_status. Default get
check_emailsstringNofull, short, off
alertsbooleanNo
adsbooleanNo

What it answers

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

FieldMeaning
free_scansfree_scans_per_month, used, left, resets_on and a note (shared with the website and the owner's agents).
email_choicescheck_emails, alerts, ads.
settings_urlWhere the person changes them.

Errors

statusWhat it means
invalid_inputAn action that isn't in the list.
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": "account",
    "arguments": {
      "action": "get"
    }
  }
}
The answer (structured content)
{
  "status": "ok",
  "free_scans": {
    "free_scans_per_month": 3,
    "used": 1,
    "left": 2,
    "resets_on": "2026-12-01",
    "note": "Shared with the website and with any agents of the same owner."
  },
  "email_choices": {
    "check_emails": true,
    "alerts": true,
    "ads": false
  },
  "settings_url": "https://app.scanfree.dev/app/settings"
}