get_dashboard
Paid orders at a glance.
For each website of the account: its paid orders, the last check, the two scores (AI visibility rate split into live search and training data, and site readiness; never added together), the next check, whether a check is running now, and what is due back to the card for answers that never came back (refunded when the order ends).
Who can use it
- Access
- Accounts with a paid order (an empty list otherwise).
- Scope
scan:read- Changes anything
- No. Read-only.
Inputs
None.
What it answers
Every answer has status and, where useful, message in plain words.
| Field | Meaning |
|---|---|
sites | Each website: site_id, site, url, open_findings and its orders. |
orders[] | order_id, state, ends_on, phrases_in_use of phrases_bought, next_check, check_in_progress, needs_setup, checks_paused, refund_due_usd (answers that never came back, refunded to the card when the order ends) and results_url. |
last_check | date, named_answers of answers, and could_not_run. |
visibility_live_search, visibility_training_data | The visibility rate in words for each kind of AI answer, with the change since the check before. Never added together. |
likely_range_* | Where the true rate would fall, once there are enough answers. |
readiness | How many site checks pass, as X of Y. A separate figure. |
orders_waiting_for_setup | Paid orders with no website yet, each with setup_url. |
Errors
| status | What it means |
|---|---|
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": "get_dashboard",
"arguments": {}
}
}{
"status": "ok",
"sites": [
{
"site_id": "00000000-0000-4000-8000-000000000004",
"site": "example.com",
"url": "https://example.com/",
"open_findings": 2,
"findings_checked_on": "2026-11-18",
"orders": [
{
"order_id": "00000000-0000-4000-8000-000000000002",
"state": "active",
"ends_on": "2027-02-18",
"phrases_in_use": 10,
"phrases_bought": 10,
"next_check": "2026-12-18",
"check_in_progress": false,
"needs_setup": false,
"checks_paused": false,
"refund_due_usd": 0,
"last_check": {
"date": "2026-11-18",
"named_answers": 14,
"answers": 80,
"could_not_run": 0
},
"visibility_live_search": "…",
"visibility_training_data": "…",
"likely_range_live_search": null,
"likely_range_training_data": null,
"readiness": "7 of 9 checks pass",
"results_url": "https://app.scanfree.dev/app/orders/00000000-0000-4000-8000-000000000002"
}
]
}
],
"orders_waiting_for_setup": [],
"note": "…"
}