@solumflow-app/crm-mcp-server 0.12.0 → 0.13.0

package/README.md

@@ -90,10 +90,88 @@ scope the key lacks answers `forbidden` and names the scope it needs.
 | `list_api_webhooks` | `shop:manage` | The addresses told about changes, never their signing keys. |
 | `upsert_api_webhook` | `shop:manage` | Make or change one, such as the site's revalidation route; a new one answers its signing key once. |
 | `run_test_order` | `shop:manage`, `cart:write`, `orders:write`, `orders:read` | Cart, postage, order and a payment with Stripe's test card, read back until paid. Only in test mode. |
+| `list_currencies` | `catalog:read` | The currencies the shop sells in, its own first. |
+| `upsert_products` | `catalog:write` | Make or change many products in one call, each known by `source` + `externalRef`. |
+| `set_product_extras` | `catalog:write` | Set what may be taken with a product. |
+| `set_product_options` | `catalog:write` | Set the options with a surcharge on a product. |
+| `delete_product` | `catalog:write` | Delete a product for good. |
+| `delete_field` | `catalog:write` | Take a catalogue field away (to the trash). |
+| `restore_field` | `catalog:write` | Bring a catalogue field back from the trash. |
+| `get_category_by_ref` | `catalog:read` | Find a category by your own reference. |
+| `upload_catalog_file` | `catalog:write` | Upload a picture or a file from disk for a product. |
+| `get_consent_banner` | `website:manage` | Read the cookie banner. |
+| `update_consent_banner` | `website:manage` | Set the cookie banner. |
+| `list_form_definitions` | `forms:manage` | The forms to build, with their status. |
+| `get_form_definition` | `forms:manage` | One form as the builder keeps it: fields, settings, spam settings. |
+| `create_form` | `forms:manage` | Make an empty draft form. |
+| `update_form` | `forms:manage` | Change a form, or publish it. |
+| `get_hosting_order_page` | `hosting-order:manage` | Read the hosting order page. |
+| `update_hosting_order_page` | `hosting-order:manage` | Set up the hosting order page. |
+| `get_order` | `orders:read` | One order by number, id or PaymentIntent: status, lines, totals, the seller's mark and the customer account it made. Never the buyer. |
+| `list_orders` | `orders:read` | The orders, a page by id; `sellerRef` narrows them to those paid through a link with `?ref=<sellerRef>`. |
+| `list_record_lists` | `records:read` | The lists of contacts, companies and own records. |
+| `search_records` | `records:read` | Search the records of one list. |
+| `get_record` | `records:read` | One record with its fields. |
+| `create_record` | `records:write` | Make a record. |
+| `update_record` | `records:write` | Change a record. |
+| `list_tags` | `records:read` | The tags of the account. |
+| `list_notes` | `records:read` | The notes on a record. |
+| `add_note` | `records:write` | Write a note on a record. |
+| `upsert_contact` | `contacts:write` | Add a contact, or find the one already known. |
+| `list_pipelines` | `deals:read` | The pipelines and their stages. |
+| `list_deals` | `deals:read` | Deals, by pipeline, stage or contact. |
+| `get_deal` | `deals:read` | One deal. |
+| `create_deal` | `deals:write` | Make a deal. |
+| `update_deal` | `deals:write` | Change or move a deal. |
+| `list_deal_notes` | `deals:read` | The notes on a deal. |
+| `add_deal_note` | `deals:write` | Write a note on a deal. |
+| `list_tax_rates` | `documents:read` | The VAT rates. |
+| `create_estimate_draft` | `documents:write` | Make a draft estimate. Numbering and sending stay in the app. |
+| `update_estimate_draft` | `documents:write` | Change a draft estimate. |
+| `create_invoice_draft` | `documents:write` | Make a draft invoice. |
+| `update_invoice_draft` | `documents:write` | Change a draft invoice. |
+| `list_payment_pages` | `payment-pages:read` | The payment pages. |
+| `get_payment_page` | `payment-pages:read` | One payment page. |
+| `create_payment_page` | `payment-pages:write` | Make a payment page. |
+| `update_payment_page` | `payment-pages:write` | Change a payment page. |
+| `list_email_templates` | `email-templates:manage` | The e-mail templates. |
+| `get_email_template` | `email-templates:manage` | One e-mail template. |
+| `create_email_template` | `email-templates:manage` | Save a new e-mail template. Never sends one. |
+| `update_email_template` | `email-templates:manage` | Change an e-mail template. |
+| `list_tasks` | `tasks:read` | Tasks outside projects. |
+| `get_task` | `tasks:read` | One task outside a project. |
+| `create_task` | `tasks:write` | Make a task on a contact, a deal or nothing. |
+| `update_task` | `tasks:write` | Change or complete a task. |
+| `list_appointments` | `calendar:read` | Appointments outside projects, in a window of at most 92 days. |
+| `get_appointment` | `calendar:read` | One appointment outside a project. |
+| `upsert_calendar` | `calendar:manage` | Make or change a calendar by its slug: `event`, `round_robin`, or the account's own services calendar. |
+| `set_calendar_availability` | `calendar:manage` | A calendar's weekly hours and its exceptions per date. |
+| `upsert_services` | `calendar:manage` | Up to fifty bookable services by slug; one nobody performs gets the account's owner. |
+| `list_client_accounts` | `clients:manage` | The customer accounts a reseller sold, with their owner and modules. |
+| `get_client_account` | `clients:manage` | One of them. |
+| `create_client_account` | `clients:manage` | A customer account with a workspace of its own and a mail to its owner; the same owner twice makes nothing. |
+| `set_client_modules` | `clients:manage` | The modules a customer account is sold with, within what the reseller may hand out. |
 
 Every catalogue tool takes an optional `object`: the slug of another catalogue
 of the account (from `list_catalogs`). Left out, it is the account's own.
 
+## Customer accounts for a reseller
+
+A key of a reseller with `clients:manage` sets up the accounts it sells:
+`create_client_account`, `set_client_modules`, and for booking
+`upsert_calendar`, `set_calendar_availability` and `upsert_services` through
+that customer's own key. **A key for a customer is never made by a tool**:
+whatever a tool answers lands in the agent's transcript. A script makes it
+with the client package and hands it straight to where it is kept:
+
+```ts
+const key = await client.createClientApiKey(clientAccountId, {
+  name: 'Website',
+  scopes: ['website:manage', 'forms:manage', 'calendar:manage'],
+});
+// key.token exists only here: pass it on, never print it.
+```
+
 ## After an update
 
 An agent keeps the tool definitions it was handed when its session began, and a