Update a custom connector
well_update_custom_connectorDeclare which tools of a server this workspace added (a custom connector) only read data. Well reads and syncs a tool only when it knows the tool changes nothing. Many servers do not say so for their tools, and then Well reads none of them until an owner or admin declares them here.
Call it only on the person's own ask, with the tool names exactly as well_list_connector_tools returned them. The list replaces the previous one. A tool the server itself marks as changing data is refused ("write_tools"), and a name the server does not list is refused ("unknown_tools"): nothing is saved then. Only a workspace owner or admin can declare; anyone else is refused.
Read outcome. "updated": say which tools Well now reads, by what they do. Any other outcome: say in one line why nothing was saved, and with "unknown_tools" or "write_tools" name the refused tools.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several — a write lands in exactly one workspace and this call would not say which. | |
| 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. | |
| idempotency_key | No | Optional client-supplied key. A retried write with the same key returns the original result instead of re-applying the operation. | |
| read_only_tools | Yes | Every tool of this server the person declares read-only, by its exact name from well_list_connector_tools. The list replaces the previous one: a tool left out is no longer read-only, and an empty list declares none. | |
| 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. | |
| workspace_connector_id | Yes | The custom connection's workspace_connector_id, from well_add_custom_connector or well_list_connectors. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| tools | No | With "unknown_tools" or "write_tools": the names that were refused. | |
| outcome | No | "updated" when the list is saved. Otherwise why nothing was saved: "not_admin", "not_a_custom_connection" (the connection is not a server this workspace added), "too_many_tools", "tools_not_listed" (the server did not list its tools: it may need its sign-in first), "unknown_tools" (names the server does not list) or "write_tools" (tools the server itself marks as changing data). | |
| success | Yes | ||
| 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. | |
| read_only_tools | No | The tools now declared read-only. | |
| 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. |