share_link
Public share link.
The public share link of a free scan's report (scan_id) or a paid order's report (order_id). get (scan:read): whether it is on, and the link. on and off (scan:write): anyone with the link can read the report (never the email or account details); off kills the link, and on again makes a new one. Links are off by default: switch one on only when the person asks.
Who can use it
- Access
- Any account, for its own scans and orders.
- 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: get.
| action | Scope | What it does |
|---|---|---|
get | scan:read | Whether the public share link of a scan (scan_id) or an order's report (order_id) is on, and the link. |
on | scan:write | A write action: the description above says what it changes. |
off | scan:write | A write action: the description above says what it changes. |
Inputs
| Name | Type | Required | Values and limits |
|---|---|---|---|
action | string | No | get, on, off. Default get |
scan_id | string | No | |
order_id | string | No |
What it answers
Every answer has status and, where useful, message in plain words.
| Field | Meaning |
|---|---|
on | Whether the link is on. Links are off by default. |
url | The public link, or null. |
on_since | The day it was switched on. |
Errors
| status | What it means |
|---|---|
invalid_input | Neither scan_id nor order_id was given, or an action that isn't in the list. |
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 scan. |
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": "share_link",
"arguments": {
"action": "get",
"scan_id": "00000000-0000-4000-8000-000000000001"
}
}
}{
"status": "ok",
"scan_id": "00000000-0000-4000-8000-000000000001",
"on": false,
"url": null,
"on_since": null
}