Add a custom connector
well_add_custom_connectorSave the MCP server of a tool Well's catalog does not carry as a connector of this workspace. The connector belongs to this workspace only: no other workspace sees it, and Well's catalog does not list it.
Call it only when well_show_connector_request returned can_add_self: true, with the tool's name and the address the person gave, after well_probe_mcp_server answered "mcp_server" for that address. Only a workspace owner or admin can add one; anyone else is refused.
The address is checked again before anything is saved: Well connects only to a public https address that answers as an MCP server, and re-checks it on every request. Never ask for a key, a token or a password in the conversation: this call takes none. A server that asks for a sign-in on its own page is not open yet ("sign_in_not_open"): say so, and say nothing was saved. Adding the same address again returns the same connector.
Read outcome. "added": say the server is saved for this workspace and name the sign-in from sign_in; with "api_key", say its key is added outside the conversation, and never ask for it. Any other outcome: say in one line why nothing was saved.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The full address of the tool's MCP server, exactly as the person gave it, e.g. "https://mcp.example.com/mcp". Never an address you composed or guessed. | |
| name | Yes | The tool's name, as the person wrote it, e.g. "Planday". | |
| 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. | |
| 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 |
|---|---|---|---|
| host | No | The host of the address, to name the server in your line. | |
| error | No | ||
| status | No | The connection's status. | |
| outcome | No | "added" when the server is saved as a connection of this workspace. Otherwise why nothing was saved: "not_admin", "not_a_real_workspace", "address_refused", "unreachable", "not_mcp_server", "sign_in_not_open" (the server asks for a sign-in on its own page, or its sign-in could not be named), or "limit_reached". | |
| sign_in | No | The sign-in the server asks for: "none", "api_key", "oauth" or "unknown". Null when the address did not answer as an MCP server. | |
| success | Yes | ||
| connector_id | No | The id of the saved connector. It belongs to this workspace only. | |
| 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. | |
| 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. | |
| workspace_connector_id | No | The id of the connection, for well_list_connector_tools. |