Skip to content

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: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:readWhether the public share link of a scan (scan_id) or an order's report (order_id) is on, and the link.
onscan:writeA write action: the description above says what it changes.
offscan:writeA write action: the description above says what it changes.

Inputs

NameTypeRequiredValues and limits
actionstringNoget, on, off. Default get
scan_idstringNo
order_idstringNo

What it answers

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

FieldMeaning
onWhether the link is on. Links are off by default.
urlThe public link, or null.
on_sinceThe day it was switched on.

Errors

statusWhat it means
invalid_inputNeither scan_id nor order_id was given, or an action that isn't in the list.
invalid_inputorder_id isn't an order id. Take one from get_dashboard.
not_foundNo order with that id on this account.
not_foundNo such scan.
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": "share_link",
    "arguments": {
      "action": "get",
      "scan_id": "00000000-0000-4000-8000-000000000001"
    }
  }
}
The answer (structured content)
{
  "status": "ok",
  "scan_id": "00000000-0000-4000-8000-000000000001",
  "on": false,
  "url": null,
  "on_since": null
}