well_get_workspace_preferences

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

Get resolved preference values for the caller in this workspace. Each key resolves to the caller's own override when they have set one, otherwise the workspace-wide default, otherwise it is absent from the result. Known keys: invoice_default_layout, invoice_design, action_trust, preferred_name, form_of_address, mail_sender_choice, timezone, bank_account_offer, invoice_payment_account, payment_link_reconnect_offer, sunday_routines, customer_facts_note_id. Pass `keys` to limit the read to specific keys; omit it to get every preference currently set. A key with no value set anywhere is simply absent from `preferences`, never returned as null or an empty string. `invoice_design` comes back as the invoice design options object `{ layout, theme, locale, payment_terms_note_id, tax_rate_id, legal_mentions_note_id, payment_means_id }`, the same object `well_generate_document` takes as `design`. To save it on an invoice with `well_update_invoice_design`, convert each key to its `design_*` attribute (`layout` → `design_layout`, `payment_means_id` → `design_payment_means_id`, …). Pass `namespace` to read the values saved for one subject, e.g. `"customer:<company_id or person_id>"` for one customer's invoice design. A namespaced read returns only that namespace's values and never falls back to the un-namespaced ones; read without `namespace` too when the house default should apply. `mail_sender_choice` is a member-private key read one sender at a time: pass `namespace` set to the `namespace` that `well_list_mail_senders` returns for that sender, and it comes back as `{ choice, sender }` from the caller's own saved row only. No other member's choice and no workspace default is returned for it. To read the choices of many senders at once, call `well_get_mail_sender_choices`. A read without `namespace` also returns `invoice_layouts`: every invoice design, as `{ layout, name, description: { fr, en } }`, the default design first. Name a design to the user only with its `name` and its `description` in the conversation's language, and save the `layout` of the one they pick. 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.