well_list_customers

io.github.WellApp-ai/well-mcp · Verify this server

List the customers this workspace bills, and the companies it could define as a customer next. Draws the define-customer card. Use it when an invoice needs a customer ("who is this invoice for", "bill Acme"). Pass `query` with the name, domain or registered name the user typed. Without `query` the read proposes the companies the workspace invoiced most recently. Returns `customers` (companies already defined as customers) and `candidates` (companies that could be). Each row carries `entity_kind` ("company" or "person"), `entity_id`, `name`, `provenance`, `confidence` (the share of the workspace's newest issued invoices addressed to the company, null when it has none in that window), `definable` with `definable_reason` when it is false, `invoices_issued`, `first_invoiced`, `people_count`, `identity` (which carries `address` when the company has one) and `other_workspaces` (the member's other workspaces that already hold this same company, each with `workspace_id`, `workspace_name` and `held_as` — "customer" or "own_company"; empty when it is held nowhere else). Pass `include_external: true` with a `query` when the graph holds no match: registry hits come back as candidates with `provenance: "registry"`, and defining one adds the company to the workspace. Never pick a customer from a name alone; the user chooses on the card, then `well_define_customer` records the choice. 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.