Preview provider exports
well_preview_provider_exportShow the user what Well can fetch from a provider's own web app, and the Deploy action that fetches it. Draws a "deploy agent" card with one row per provider. Each row lists every file the agent can download, each with its export_id, label, format and whether it is selected. The row's deploy_url opens Well's /collect page, the same page that deploys the invoice agents, naming the provider in providers and the selected files in fetch. When the user starts the export there, the Well browser extension opens the provider in a new tab and its agent downloads the selected files, one at a time, in the user's own signed-in session, then files each one in this workspace.
Use it when the user wants data from a provider that Well cannot connect to directly, asks to "download", "export", "fetch everything" or "get the CSV" from a provider, or when the connector route is unavailable. Pass provider_slugs to preview the providers the user named; omit it to show every provider Well can fetch from. Pass export_ids when the user asked for specific files; omit it to fetch every file. A provider Well has no export for comes back in unknown_provider_slugs, and a file it does not list in unknown_export_ids: say plainly that Well cannot fetch it yet. A row whose export_ids matched none of its files selects nothing and has a null deploy_url: offer its listed files instead.
This tool starts nothing and downloads nothing. Never say a file was fetched by this call: the run happens in the browser extension after the user clicks, and the extension's side panel reports it. A row's last_run is the one record of an earlier run in this workspace: when the user asks whether a run worked, report its status, when it ended and its files_filed as returned, and nothing more. When refresh_due is true, offer to fetch the files again with the row's Deploy; Well never re-runs on its own. When harness_access is refused, no row has a deploy_url: say this browser agent is not open to the user's account yet, and offer the upload route. When the user wants several providers at once and deploy_all_url is set, offer it: it deploys every row with a link, one provider after the other. When it is null, offer each row's own deploy_url. Give each deploy_url and deploy_all_url as returned and never build or edit one. The run needs the Well browser extension, and the user must be signed in to the provider in that browser; when a login or a two-factor code stands in the way, the agent hands the tab back to the user. When error is set, report it and do not read harness_access.
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| export_ids | No | The files to fetch, by export_id, e.g. ['payroll_journal','employee_roster']. Omit to fetch every file. Each id selects that file on every named provider whose spec lists it. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| provider_slugs | No | Provider slugs to preview, e.g. ['gusto']. Omit to preview every provider Well can fetch from. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| providers | Yes | ||
| workspace_id | Yes | ||
| deploy_all_url | Yes | One /collect link that deploys every row with a deploy_url, one provider after the other. Null unless at least two rows have one, and null when their files together exceed what one link can carry. | |
| harness_access | Yes | Whether this account may run the browser agent. Null when the call failed before access was checked. | |
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| unknown_export_ids | Yes | ||
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. | |
| unknown_provider_slugs | Yes |