get_report
Download a report.
A signed download link, valid 10 minutes, for one paid order's results: format csv or json (one row per phrase, AI and run: named or not, position, who was named instead; no answer text), or pdf (the report page, while PDF export is switched on). Without check_id: csv and json hold every check, pdf the latest. Give the link to the person; it is the same download as on the order page.
Who can use it
- Access
- A paid order. pdf only while PDF export is switched on.
- Scope
scan:read- Changes anything
- No. Read-only.
Inputs
| Name | Type | Required | Values and limits |
|---|---|---|---|
order_id | string | Yes | An order id from get_dashboard |
format | string | Yes | csv, json, pdf |
check_id | string | No | One check (from get_matrix or get_order) |
What it answers
Every answer has status and, where useful, message in plain words.
| Field | Meaning |
|---|---|
url | A signed download link, valid 10 minutes. Give it to the person. |
expires_at | When the link stops working. |
format, check_id | What the file holds: every check (csv, json) or the latest (pdf), unless check_id was given. |
Errors
| status | What it means |
|---|---|
invalid_input | order_id isn't an order id. Take one from get_dashboard. |
not_found | No order with that id on this account. |
not_found | No such check on that order. |
not_available | PDF export is switched off, or this server can't sign links; the answer says where to download instead. |
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_report",
"arguments": {
"order_id": "00000000-0000-4000-8000-000000000002",
"format": "csv"
}
}
}{
"status": "ok",
"order_id": "00000000-0000-4000-8000-000000000002",
"format": "csv",
"check_id": null,
"url": "https://app.scanfree.dev/api/app/orders/00000000-0000-4000-8000-000000000002/export?format=csv&t=…",
"expires_at": "2026-11-21T10:10:00.000Z",
"message": "A download link for every check (CSV), valid for 10 minutes. …"
}