Search the company registry
well_search_company_registrySearch the public company registries for a company by name, to find the one a workspace IS before you create its company workspace. This draws nothing on the user's screen.
Use it in the zero-company case: a membership workspace has no company attached and no detected candidate, so you search the registry for the user's company. Use it too when the user says the company set on this workspace is wrong: the pick makes a new workspace and the set one is untouched. Each hit carries an id — the registry ref — that you pass to well_create_company_candidate as registry_ref to mint a candidate from that hit, then well_create_company_workspace to make it the company workspace.
Pass purpose: "own_company" when the person is picking their own company, to create its company workspace. On WhatsApp Well then sends the hits to the phone as numbered choices after your line, so write none of them; the person's pick comes back as the next message and names the hit. Omit it for any other search, such as a customer, a supplier or an address.
Pass country when the user names one, to scope the search to that jurisdiction. The result carries degraded: true when a provider was unreachable and the hits are partial. Confirm the exact company with the user before you create anything from a hit; never pick one from a name alone.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | Yes | The company name to search for. At least 2 characters. | |
| country | No | Scope the search to this jurisdiction. Omit to search across registries. | |
| purpose | No | own_company when the person is picking their own company to create its company workspace; omit for any other search. | |
| 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 |
|---|---|---|---|
| hits | Yes | ||
| error | No | ||
| success | Yes | ||
| degraded | Yes | True when a registry provider was unreachable and the hits are partial; the search still returned what it could. | |
| 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. |