System Atlas
SystemAtlas

upload_screenshot

Upload one screenshot of the company's software (PNG, JPEG or WebP, up to 5 MB, base64 or an https URL) with its title and the page URL. Metadata is stripped; it is linked to the matching component or interface, else left unplaced, and stored private and unverified. The same image twice is skipped. Never capture personal or customer data. Needs an editor key.

Write · editor keyMCP tool

Parameters

  • workspacestringrequired

    Workspace slug

    min 1 charmax 80 chars
  • companystringoptional

    Company slug; defaults to the workspace's own company

    min 1 charmax 80 chars
  • imagestringrequired

    The screenshot: base64 (or a data: URL) of a PNG, JPEG or WebP up to 5 MB, or an https URL to fetch it from

    min 1 charmax 7200000 chars
  • titlestringrequired

    What the screen is, in the product's words: 'Invoices list', 'Checkout: payment'

    min 1 charmax 200 chars
  • urlstringoptional

    The page or route the screen shows (https://app.example.com/invoices or /invoices)

    max 1000 chars
  • componentstringoptional

    The component it belongs to: its id, clientId or label. Omit and System Atlas matches it

    min 1 charmax 200 chars
  • interfacestringoptional

    A catalog interface id or label, if the screen is one

    min 1 charmax 200 chars
  • flow_stepstring | numberoptional

    Its place in a flow: a number, or 'checkout: payment'

Example call

Agents call tools by name; you rarely write this by hand. It is here so you can test the server from a shell or your own code.

{
  "name": "upload_screenshot",
  "arguments": {
    "workspace": "acme-builders",
    "image": "iVBORw0KGgo…",
    "title": "Invoices list",
    "url": "/invoices"
  }
}

Response

The result is one text content block holding this JSON (abbreviated here). Errors come back with isError: true and a message such as Error 401: … or Invalid input: ….

Response
{
  "id": "5b1e…",
  "duplicate": false,
  "tier": "private",
  "component": "Billing app"
}

Over REST

The same call without MCP: POST/api/v1/workspaces/:slug/upload/screenshot

Previousupload_notesNext list_screenshots