Describe entity
well_describe_entityGet a grounded description of ONE entity — what it is, using its real field values and one hop of its related records, never a guess. Reach for this on a SPECIFIC question about one already-identified entity that wants a short inline answer: "does this person pay on time", "anything unusual about this invoice", "summarize this company's payment history". An open-ended "tell me about X" / "show me all you got on X" / "everything you have on X" / "what do you have on X" ask is NOT this tool: call well_show_record_graph_summary for it, even for a single entity, because that card carries the entity's graph plus its written summary.
Resolve X to its record id first (well_query_records or well_get_entity), then call this tool with that root + id — never a guessed id or a name string.
Returns description (what this is), positive (an unusually good fact, when one stood out), and flag (an unusual or concerning fact, when one stood out) — positive and flag are "" when nothing stood out, which is expected and not an error. Set deep_search=true only when the ask needs the workspace's recorded notes/context on this entity too, not for a plain describe.
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The entity's public UUID (the value of its *_id field, e.g. company_id). | |
| root | Yes | Which records root the id resolves on, e.g. companies | people | invoices. | |
| deep_search | No | Also search the workspace's recorded notes/context for this entity (additive, not a wider relationship crawl). Default false. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose 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. | |
| 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 |
|---|---|---|---|
| flag | Yes | An unusual or concerning fact, when one stood out. "" when none did. | |
| error | No | ||
| success | Yes | ||
| positive | Yes | An unusually positive fact, when one stood out. "" when none did. | |
| description | Yes | What this entity is, grounded in its real fields and one-hop neighborhood. | |
| fallback_line | Yes | A plain, non-LLM line to fall back on when description is "". | |
| 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. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| 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. |