List workspaces
well_list_workspacesList the workspaces this connection is authorized to access. This draws nothing on the user's screen.
Use this FIRST when a single token may cover more than one workspace, and settle on your OWN every case you can: exactly one workspace, a hint that matches one, a pin this conversation already wrote, or none at all. Read the rows and say which workspace you took. ⚠️ TO ASK THE USER WHICH WORKSPACE, CALL well_show_workspace_picker INSTEAD: it draws one tile per workspace and waits for a click. Ask only when the token authorizes several AND no hint resolves.
When a message names a company or a workspace that the person has none of, the reply lists every workspace of the person by its name: the conversation's own workspace first, then each workspace the list holds, also one whose read found nothing. It never counts some of them in place of their names.
With one authorized workspace you can omit workspace_id everywhere; with several, read tools fan out across all of them unless you pass a workspace_id, and write tools require one.
Each row's fields (kind, workspace_situation, anchor and role, read_only, has_bank_transactions, holds_records, the default and the session's selections) are explained in the result's field_legend: read it before you choose a scope or read a row, and never act on default_workspace_id without the person's choice.
TO ASK THE USER WHICH COMPANY a workspace of theirs is, call well_show_company_candidates, never this read: this list never shows the candidates.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspace_id | No | Target workspace. Optional: this tool describes the token itself rather than one workspace's data, so omitting it returns the same answer. | |
| 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 | ||
| session | No | What this conversation's card clicks recorded so far; null/empty fields when nothing was clicked yet. | |
| success | Yes | ||
| workspaces | Yes | ||
| field_legend | No | ||
| 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. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| default_workspace_id | Yes | The tile the picker card preselects on a brand-new account: the demo workspace, when the grant holds exactly one demo and every other workspace is still empty (no company of its own, no registered name, currency or fiscal year, no connected source, no business data) and this conversation has not pinned another workspace. Null otherwise, and on a scoped picker. It chooses nothing: nothing acts on it without the person's click. Not the same as is_primary. | |
| 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. |