com.finalpos/final

Est-ce que com.finalpos/final est sûr ?

Au dernier audit MCP Hub, le serveur MCP « com.finalpos/final » est classé « Non encore testé ». Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur. Le verdict est réévalué en continu ; consultez la fiche pour l'état à jour.

Méthode : MCP Hub analyse la description de chaque outil (couche 1) et, pour le verdict fort, exécute le serveur dans une micro-VM isolée avec leurres et réseau bloqué (couche 2). On publie des noms et des compteurs, jamais le contenu brut renvoyé par un outil.

Les 177 outils

• ask_finai≈ 258 tokens

  Hand a task in words to Finai, Final's own AI agent, and get its finished answer. It runs as this connection's user on its company, within the allowed packs, and uses Final's tools itself (looking records up, creating products, building or deploying an app). Use it for multi-step merchant jobs you would rather describe than orchestrate; call tools directly when you need the raw data. Pass conversationId to continue an earlier thread.

  Paramètres, retour & exemple (2)

  Paramètres

  • task · string · requis
    What to do or find out, in plain language, with every id or value Finai needs.
  • conversationId · string · optionnel
    A conversationId from an earlier ask_finai result, to continue that thread.

  Exemple d'appel

  {"name": "ask_finai", "arguments": {"task": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• call_tool≈ 198 tokens

  Run a read-only tool from any allowed pack by its full name (for example hub_find_low_stock) without it being listed. Only tools that read are accepted; tools that change data run through call_write_tool. Arguments follow that tool's own input schema, which find_tools returns.

  Paramètres, retour & exemple (2)

  Paramètres

  • name · string · requis
    The tool's gateway name, e.g. hub_get_products or flow_list_flows.
  • arguments · object · optionnel
    The tool's arguments.

  Exemple d'appel

  {"name": "call_tool", "arguments": {"name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• call_write_tool≈ 215 tokens

  Run a tool that creates, changes, deletes, sends or deploys from any allowed pack by its full name (for example hub_update_product) without it being listed. Only tools find_tools marks as writes are accepted; read-only tools run through call_tool. Arguments follow that tool's own input schema, which find_tools returns.

  Paramètres, retour & exemple (2)

  Paramètres

  • name · string · requis
    The tool's gateway name, e.g. hub_update_product or flow_deploy_flow.
  • arguments · object · optionnel
    The tool's arguments.

  Exemple d'appel

  {"name": "call_write_tool", "arguments": {"name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• disable_packs≈ 131 tokens

  Remove packs from tools/list for this connection to keep the list short. Tools stay reachable through call_tool and call_write_tool.

  Paramètres, retour & exemple (1)

  Paramètres

  • packs · array · requis

  Exemple d'appel

  {"name": "disable_packs", "arguments": {"packs": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• enable_packs≈ 140 tokens

  Add packs to tools/list for this connection (remembered). Only allowed packs can be listed; the client refreshes its tool list.

  Paramètres, retour & exemple (1)

  Paramètres

  • packs · array · requis
    Pack ids from list_packs.

  Exemple d'appel

  {"name": "enable_packs", "arguments": {"packs": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• find_tools≈ 196 tokens

  Search every allowed pack for tools by what you want to do ("low stock", "create a product", "deploy the app"). Returns matching tool names with their pack, whether they are listed and whether they change data. Run a read-only match with call_tool and a write with call_write_tool, or enable_packs to list its pack.

  Paramètres, retour & exemple (2)

  Paramètres

  • limit · integer · optionnel
  • query · string · requis
    Plain-language description of the task or the record type.

  Exemple d'appel

  {"name": "find_tools", "arguments": {"query": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_apply_blueprint_widgets≈ 575 tokens

  COPY vetted blueprint widgets into a flow as real files — byte-exact, no transcription. Pass picks of { blueprintId, widgetId } (from list_blueprints / search_blueprints); the widget files land under src/widgets/<blueprint>/ with their command-frame plumbing intact, persisted as a restorable checkpoint + builder-chat note like write_flow_files. Returns a manifest (paths, export names, props, a ready-to-paste import block) — never the code. Compose your screens by importing the manifest paths; adapt an applied widget with a small write_flow_files edit, never a wholesale rewrite, and never re-type code from get_blueprint. A selfPersisting blueprint's copied code reads/writes its OWN custom tables by exact name: this tool PROVISIONS those tables into your organization automatically, possibly under org-scoped names (see `tables` in the result — the copied code already uses the final names) — never create them yourself and never create a lookalike. Tables owned by a platform extension are reported under `extensionTables` (with extensionIds when pinned): only installing that extension provides them (install_extension, with user consent). Secrets the code reads are reported under `secrets` — each missing key gets a fill-in request in the builder automatically; values never travel over MCP. Re-applying a pick restores the widget's vetted contents.

  Paramètres, retour & exemple (5)

  Paramètres

  • note · string · optionnel
    One-line summary of the change, shown in the builder chat.
  • agent · string · optionnel
  • picks · array · requis
  • flowId · string · requis
  • hubToken · string · optionnel
    Optional organization JWT for the Final hub, used to provision the blueprint's custom tables when your organization has no stored hub credential.

  Exemple d'appel

  {"name": "flow_apply_blueprint_widgets", "arguments": {"picks": [], "flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_apply_upstream_update≈ 531 tokens

  Apply the update reviewed with get_upstream_update. Pass resolutions: exactly one entry per conflict — { path, contents } with the COMPLETE merged file, or { path, delete: true } when the file should not exist. Missing, unknown or ambiguous entries fail the whole call with nothing written (the plan is recomputed here, so re-review if the flow changed since). What it does, in order: saves the current files as a restorable "Before update" checkpoint, lands the merged tree (an open builder tab picks it up safely), records an "Update from upstream vX" checkpoint narrated in the builder chat, re-stamps the clone's update pointer so the next check compares against this release, provisions custom tables the update introduced (org-scoped names — the merged code already uses them), and raises a fill-in request for each missing secret (values never travel over MCP). If the review said adoptMode: true, call with adopt: true and NO resolutions to replace the files with the original's latest release wholesale — undoable via the safety checkpoint; confirm with your user first.

  Paramètres, retour & exemple (6)

  Paramètres

  • note · string · optionnel
    One-line summary for the builder chat.
  • adopt · boolean · optionnel
    Only when the review reported adoptMode: true — replace the flow's files with the original's latest release wholesale.
  • agent · string · optionnel
  • flowId · string · requis
  • hubToken · string · optionnel
  • resolutions · array · optionnel

  Exemple d'appel

  {"name": "flow_apply_upstream_update", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_connect_chat≈ 150 tokens

  Attach this agent session to an EXISTING flow as a chat in the builder's rail (so the flow's owner sees your work alongside their own chats). Also use log_message to narrate what you're doing.

  Paramètres, retour & exemple (2)

  Paramètres

  • agent · string · optionnel
  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_connect_chat", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_create_custom_table≈ 649 tokens

  Create a new custom data table (schema: name + typed columns) in your Final organization. USE THIS for any data the app must keep — loyalty stamps, waitlists, bookings, inventory logs, settings: the platform syncs the table to every station running the flow and keeps it working offline at the POS, so it replaces ANY browser-storage or hand-rolled persistence (localStorage/IndexedDB are forbidden and fail validate_flow). NEVER store credentials in a table — that's what the secrets vault (request_secret) is for. This creates the table IMMEDIATELY and ORG-WIDE (visible to every station and every flow, not just this one), so unless the user actually asked for stored data, confirm before creating; creation can also be plan-gated — surface a plan/permission error to the user rather than retrying. Check list_custom_tables first to reuse an existing table, and search_blueprints before building functionality around a new one: a selfPersisting blueprint brings its OWN tables by exact name and apply_blueprint_widgets provisions them for you, so a lookalike would sit dead while the feature keeps reading the real one. Create tables only for net-new data no applied blueprint persists. The name is normalized to kebab-case; generated code reads/writes rows via renderClient.getCustomTableData / upsertCustomTableData.

  Paramètres, retour & exemple (4)

  Paramètres

  • name · string · requis
    Table name; normalized to a kebab-case id, e.g. 'gift-cards'.
  • fields · array · requis
  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.
  • description · string · optionnel

  Exemple d'appel

  {"name": "flow_create_custom_table", "arguments": {"name": "texte", "fields": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_create_flow≈ 822 tokens

  Create a new, empty flow (app build) in your Final organization for YOU to write the app into. It appears in the Miami builder immediately, with this agent session attached as a chat. Optional theme knobs seed the live palette. Optional `device` ("mobile", "kiosk", "iphone", …) sets the preview frame it opens in; see set_flow_device. Returns the flow id and a builder deep link. Call get_scaffold before writing files. For an app the user merely DESCRIBED, use start_build.

  Paramètres, retour & exemple (9)

  Paramètres

  • agent · string · optionnel
    Display name for this tool in the builder chat rail, e.g. 'Claude Code'.
  • color · string · optionnel
    A colour the user asked for, as they said it ("pink", "dark green", "navy and gold", or a hex). Resolved to a full custom palette for the flow's appearance — prefer this over guessing customColors hexes. Ignored when customColors is also given.
  • fonts · object · optionnel
  • shape · string · optionnel · sharp | rounded | round
  • theme · string · optionnel · light | dark
  • title · string · requis
  • device · ? · optionnel
    Default preview device for the new flow (the frame the builder opens it in). Omit for the user's Settings default.
  • palette · string · optionnel · final | mono | ocean | sunset | forest | grape | candy | custom
  • customColors · object · optionnel

  Exemple d'appel

  {"name": "flow_create_flow", "arguments": {"title": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_create_flow_from_blueprint≈ 1349 tokens

  Create a NEW flow that starts as a complete, vetted application rather than an empty file tree — the fastest path to a working build when an FBB (a Final Business Blueprint: a whole app) matches what the user wants. For an app the user merely DESCRIBED, use start_build (the website's own start picks the FBB); this verb is for when the user asked YOU to copy one. Find one with search_blueprints({ kind: "fbb" }). The app's screens, navigation and command-frame wiring are copied byte-exact from the build the FBB points at, its custom tables are re-created under THIS organization's names (the copied code already uses those names — keep them), and a fill-in request is raised for each secret it reads. This ALWAYS creates a new flow: an FBB cannot be merged into an existing build (there are no screen-graph merge semantics). To add parts to a build you already have, use apply_blueprint_widgets instead. THE COPY ENDS YOUR TURN. It is the finished deliverable, not step one — the app is vetted and already runs. When it returns, say its `report` line and stop: do NOT preview, validate, edit or extend it, and do not start on anything else the user described. The result names the tools not to call.

  Paramètres, retour & exemple (13)

  Paramètres

  • agent · string · optionnel
  • color · string · optionnel
    A colour the user asked for, as they said it ("pink", "dark green", "navy and gold", or a hex). Resolved to a full custom palette for the flow's appearance — prefer this over guessing customColors hexes. Ignored when customColors is also given.
  • fonts · object · optionnel
  • shape · string · optionnel · sharp | rounded | round
  • theme · string · optionnel · light | dark
  • title · string · optionnel
    Name for the new flow. Defaults to the blueprint's title.
  • device · ? · optionnel
    Override the copy's default preview device (the frame the builder opens it in): a surface word (mobile, tablet, kiosk, …), a get_scaffold profile, a skin (iphone, ipad, …) or a full DeviceConfig. Omit to follow the blueprint's surface. Changeable later with set_flow_device.
  • flowId · string · optionnel
    NOT SUPPORTED — passing this returns an error. An FBB replaces an app's entire screen graph, so it can only start a NEW build. It is declared here purely so a caller that assumes otherwise fails loudly instead of having the field stripped and getting a second flow it never asked for. To add parts to an existing build, use apply_blueprint_widgets({ flowId, picks }).
  • palette · string · optionnel · final | mono | ocean | sunset | forest | grape | candy | custom
  • hubToken · string · optionnel
  • blueprintId · string · requis
    The exact FBB id, e.g. 'flow.coffee-quick-service'. An id without a version suffix resolves to the newest published version.
  • customColors · object · optionnel
  • supersedesFlowId · string · optionnel
    The EMPTY placeholder flow you were told to build into, when a starter prompt pinned you to one before you knew an FBB would be used. This does NOT write into that flow — nothing can — it marks it as abandoned in favour of the flow created here, so the human's already-open builder tab follows you instead of watching an empty workspace forever. Pass the flow id from your instructions. Ignored (reported back as superseded:false) if that flow has any files, so it can never redirect a real build.

  Exemple d'appel

  {"name": "flow_create_flow_from_blueprint", "arguments": {"blueprintId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_delete_flow_files≈ 152 tokens

  Remove files from a flow's tree by path. Engine-owned paths are rejected. Recorded as a checkpoint + chat note like writes.

  Paramètres, retour & exemple (3)

  Paramètres

  • agent · string · optionnel
  • paths · array · requis
  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_delete_flow_files", "arguments": {"paths": [], "flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_deploy_flow≈ 434 tokens

  Direct deploy for CI/agent workflows: builds the app in a server sandbox (npm install + vite build) and publishes the dist to Final web-hosting as a new live version. Two things stop a deploy: a failing build, and a hardcoded credential (a build is distributable to other companies, so a baked-in secret would ship to all of them — use request_secret). Guardrail and type findings do NOT block; run validate_flow first if you want them. Omit `changelog` and the release notes are drafted for you from what changed since your last deploy — call log_message (or pass `note` on write_flow_files) as you work so those notes describe intent rather than just file names. Uses your organization's provisioned hub credential automatically (the same long-term org JWT the extension tools use) — no token argument needed once you've connected. Pass `hostingToken` only as an escape hatch to override it; if no credential is available, reconnect via the Connect dialog or use open_in_builder and deploy from the Launch tool instead.

  Paramètres, retour & exemple (4)

  Paramètres

  • flowId · string · requis
  • version · string · requis
  • changelog · string · optionnel
  • hostingToken · string · optionnel
    Organization JWT accepted by hosting.finalpos.com. Optional escape hatch — omit to use your organization's stored hub credential (the same long-term org JWT the extension tools use).

  Exemple d'appel

  {"name": "flow_deploy_flow", "arguments": {"flowId": "texte", "version": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_get_blueprint≈ 306 tokens

  INSPECTION ONLY — read a blueprint's overlay code by id (from list_blueprints) to understand how it works. To USE a blueprint, apply it: apply_blueprint_widgets for a widget-set (materializes its widgets byte-exact with the command-frame plumbing intact AND provisions the custom tables its code depends on), create_flow_from_blueprint for an FBB. Do NOT re-type code from this tool into write_flow_files — that silently drops the vetted plumbing and leaves its tables unprovisioned. `tables` (when present) lists the custom tables the code binds to by exact name. For a WHOLE-FLOW blueprint this returns the screen manifest WITHOUT file bytes by default — an entire app is far too large to read this way, and you never need to: instantiation copies it server-side. Pass includeFiles: true only to audit the source.

  Paramètres, retour & exemple (2)

  Paramètres

  • id · string · requis
  • includeFiles · boolean · optionnel

  Exemple d'appel

  {"name": "flow_get_blueprint", "arguments": {"id": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_get_preview_status≈ 152 tokens

  Authoritative server-side health probe of the flow's preview sandbox, plus a short snapshot of recent dev-server logs (useful to diagnose a red screen or crash).

  Paramètres, retour & exemple (2)

  Paramètres

  • flowId · string · requis
  • logSeconds · integer · optionnel

  Exemple d'appel

  {"name": "flow_get_preview_status", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_get_scaffold≈ 274 tokens

  The contract every Final flow app is built against: which files the ENGINE owns (never write them — they are re-asserted verbatim), the baseline package.json (Vite + React 19 + TS + Tailwind + command-frame), the rules your files must follow, and the runtime contracts that compile and preview fine but fail on a real device (money in minor units, the first-load handshake, getX response unwrapping, tender success semantics). Call this once before writing any files; pass `device` for layout guidance.

  Paramètres, retour & exemple (1)

  Paramètres

  • device · string · optionnel
    Target surface — "portrait-handheld", "counter-tablet", "wall-kiosk" or "tv-display". Approximate words work ("kiosk", "phone", "menu board"); an unrecognized value just returns the device-agnostic contract.

  Exemple d'appel

  {"name": "flow_get_scaffold", "arguments": {"device": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_get_upstream_status≈ 279 tokens

  Has the build this flow was copied from released a newer version? Covers both a "Make it yours" clone of a listing and a build started from an FBB. Returns update.status: "available" (a newer deployed release exists — review it with get_upstream_update), "current" (up to date), "unknown" (the original has no comparable release), or "gone" (the original was DELETED — for a share clone, also if it was un-shared; an FBB's parent stays reachable while it exists, because the catalog vouches for it rather than the owner's share toggle), with the release notes published since the copy. Flows that are not snapshot-sourced copies return update: null. Cheap — safe to call whenever the user asks about updates.

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_get_upstream_status", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_get_upstream_update≈ 410 tokens

  Review what an update from the original build would change — the same review the builder shows its maker, shaped for an agent. Returns the releases since the clone, the clean changes (added/changed/removed paths, with full incoming contents for added+changed), and CONFLICTS: files where this flow's own edits and the update collide, each with complete base/ours/theirs contents. RESOLUTION CONTRACT (match the builder's behavior): when both sides' changes serve different purposes, merge them yourself — one file keeping BOTH sides' improvements; never wholesale-pick a side out of convenience. ONLY when the two sides genuinely contradict on the same visible thing (a color, a layout, a label, a behavior) ask YOUR user which they want, in plain product language — describe the visible difference, never file names or code. Then call apply_upstream_update with exactly one resolution per conflict. The trees you see are already in THIS organization's table namespace — never rename tableName literals yourself. adoptMode: true means the merge base is unrecoverable, so no merge is possible: offer the user adopting the latest release wholesale (apply_upstream_update with adopt: true) or staying put. upToDate: true means there is nothing to do.

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_get_upstream_update", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_install_extension≈ 346 tokens

  Install an extension ORG-WIDE: creates the install link on EVERY company in your Final organization (demo companies included), skipping companies that already have it, so it is safe to retry. Installing is deliberate and org-visible — confirm with your user and call this ONLY when they explicitly asked for the extension. Find the id with list_extensions (organization and public extensions both install); after a successful install the extension's surfaces become embeddable — inspect them with list_extension_surfaces and build the ones carrying requirementsMd natively instead of embedding. Per-company failures are collected in the result rather than thrown, and `installState` reports the org-wide outcome (installed / partial / none).

  Paramètres, retour & exemple (2)

  Paramètres

  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.
  • extensionId · string · requis
    The extension's id (the `id` from a list_extensions result — org or public source).

  Exemple d'appel

  {"name": "flow_install_extension", "arguments": {"extensionId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_blueprints≈ 398 tokens

  List EVERY vetted, type-checked blueprint available to reuse — working functionality (gift cards, loyalty, payment surfaces, product grids, carts, customer views, order tickets, receipts), not just screen layouts. Check the catalog BEFORE creating custom tables or hand-rolling a capability. Returns id, kind, slot, title, summary, surfaces, tags, and selfPersisting per blueprint — selfPersisting: true means it reads/writes its OWN custom tables by exact name inside its code, which applying then provisions in your organization automatically (some are extension-owned and come from installing that extension); never create a table for a feature it covers. TWO KINDS, used differently: kind "widget-set" (the default this returns) is a set of parts you copy into an existing build with apply_blueprint_widgets; kind "fbb" is a Final Business Blueprint — a COMPLETE APP. It has no widgets to copy and is used with create_flow_from_blueprint to start a NEW flow. Pass kind: "fbb" to browse complete apps, or kind: "any" for both. To find the best match for a specific capability instead of scanning the whole catalog, use search_blueprints. get_blueprint is read-only inspection.

  Paramètres, retour & exemple (1)

  Paramètres

  • kind · string · optionnel · widget-set | fbb | whole-flow | any

  Exemple d'appel

  {"name": "flow_list_blueprints", "arguments": {"kind": "widget-set"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_custom_tables≈ 362 tokens

  List your organization's custom data tables with their column schemas. Custom tables are Final's built-in, station-syncing database — data written on one station is automatically synced to every other station running the flow, and keeps working OFFLINE at the point of sale. They are the ONLY sanctioned persistence for generated apps (browser storage is per-device, never syncs, and is wiped on real Render terminals — validate_flow rejects it). Call this before create_custom_table to reuse an existing table instead of duplicating one. For NEW functionality, check search_blueprints before designing tables — a vetted blueprint may already provide the feature, and a selfPersisting blueprint's tables may NOT appear in this list (often extension-owned, resolved by name at runtime): their absence is never a reason to create lookalikes. Generated code reads/writes rows at runtime via renderClient.getCustomTableData / upsertCustomTableData (ground with lookup_command_frame).

  Paramètres, retour & exemple (1)

  Paramètres

  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.

  Exemple d'appel

  {"name": "flow_list_custom_tables", "arguments": {"hubToken": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_extension_custom_tables≈ 286 tokens

  List the CUSTOM TABLES an extension registers (table name + typed columns), so generated code can read/write its data at runtime via renderClient.getCustomTableData / upsertCustomTableData by table name (ground the calls with lookup_command_frame). Only the org's OWN extensions expose their tables — a public / other-org extension returns an empty list with a note. Pass the extension's id from list_extensions; the org's non-extension tables come from list_custom_tables. Read-only. Does not write files.

  Paramètres, retour & exemple (2)

  Paramètres

  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.
  • extensionId · string · requis
    The extension's id (the `id` from a list_extensions result).

  Exemple d'appel

  {"name": "flow_list_extension_custom_tables", "arguments": {"extensionId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_extension_surfaces≈ 365 tokens

  List the SURFACES an extension exposes — embeddable iframe injection points, each with a surfaceId, a platform (builder/hub/render), a type, and a url. Render an installed surface inside a generated screen with the engine component `<ExtensionSurface surfaceId="<surfaceId>" />` (ground it with lookup_engine_component). A surface may carry `requirementsMd` — full markdown build instructions for re-implementing it NATIVELY in the app: when present, prefer building that surface as first-class native screens in the app's own styling with real command-frame wiring, and embed `<ExtensionSurface>` only for surfaces without it. Works for the org's own extensions (hub credential) and public ones (resolved via the public marketplace, no credential needed). Pass the extension's id from list_extensions. Read-only. Does not write files.

  Paramètres, retour & exemple (2)

  Paramètres

  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.
  • extensionId · string · requis
    The extension's id (the `id` from a list_extensions result).

  Exemple d'appel

  {"name": "flow_list_extension_surfaces", "arguments": {"extensionId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_extensions≈ 477 tokens

  List the platform EXTENSIONS available to your organization — the org's own plus the public marketplace — so you can suggest, inspect, or install one. Each entry carries an id, label, category, short description, and its source (organization or public); public results need no hub credential, and a note tells you when the org-owned side was unavailable. Pass query with the capability the user asked for — results are relevance-ranked against it (label, category, and the vocabulary of the blueprints each extension enables) and capped to the genuine matches, so an empty list means NO extension provides that capability. Omit query to browse the whole catalog with skip/limit paging — publicTotal reports how many marketplace rows exist. Inspect a result with list_extension_surfaces / list_extension_custom_tables; install it org-wide with install_extension ONLY when your user explicitly asked for it. Read-only. Does not write files.

  Paramètres, retour & exemple (4)

  Paramètres

  • skip · integer · optionnel
    Public-marketplace page offset (default 0).
  • limit · integer · optionnel
    Public-marketplace page size (default 24, max 50).
  • query · string · optionnel
    The capability the user asked for, in their own words (e.g. 'loyalty points', 'age gate', 'gift card') — results are relevance-ranked and capped to genuine matches. Omit to browse the org's own plus the first public page.
  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.

  Exemple d'appel

  {"name": "flow_list_extensions", "arguments": {"skip": 1, "limit": 1, "query": "texte", "hubToken": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_flows≈ 199 tokens

  List the flows (app builds) in your organization, newest first: id, title, timestamps, and live theme knobs. Final staff sessions also see Final's own flows, marked owner: "Final". Use a flow id with the other tools, or create_flow to start fresh. Clones of listed builds carry an upstreamUpdate field when the build they were copied from has released a newer version — review and apply it with get_upstream_update / apply_upstream_update.

  Paramètres, retour & exemple (1)

  Paramètres

  • limit · integer · optionnel

  Exemple d'appel

  {"name": "flow_list_flows", "arguments": {"limit": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_list_secret_keys≈ 213 tokens

  List the key NAMES already stored in your organization's encrypted secrets vault — never the values (no tool returns a secret value). Use this to (a) reuse an existing key instead of requesting a new one, and (b) poll whether a request_secret ask has been fulfilled by the human. Generated code reads a secret at RUNTIME with renderClient.getSecretVal({ key }) — the build ships key names only.

  Paramètres, retour & exemple (1)

  Paramètres

  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.

  Exemple d'appel

  {"name": "flow_list_secret_keys", "arguments": {"hubToken": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_log_message≈ 186 tokens

  Record a message in this agent's chat inside the builder — the user's request (role 'user') or your own progress/summary (role 'assistant'). Keeps the builder timeline faithful to what happened in this session.

  Paramètres, retour & exemple (4)

  Paramètres

  • role · string · requis · user | assistant
  • text · string · requis
  • agent · string · optionnel
  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_log_message", "arguments": {"role": "user", "text": "texte", "flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_lookup_command_frame≈ 333 tokens

  Look up the EXACT, version-locked command-frame API a generated Final POS app runs on: renderClient method signatures + params, CF* entity field lists, pub/sub topic event vocabularies, and worked examples. Pass one of method/entity/topic for a precise lookup, entity+field to confirm a field exists, query for fuzzy search, or the plural batch forms. Ground every renderClient call in this before writing it — fabricated fields/methods fail on real Render devices. Typed signatures and entity fields are authoritative; the worked examples come from upstream docs and are NOT typechecked, so where they disagree, trust the types. Results carry `traps` for known field-level gotchas.

  Paramètres, retour & exemple (8)

  Paramètres

  • field · string · optionnel
  • query · string · optionnel
  • topic · string · optionnel
  • entity · string · optionnel
  • method · string · optionnel
  • topics · array · optionnel
  • methods · array · optionnel
  • entities · array · optionnel

  Exemple d'appel

  {"name": "flow_lookup_command_frame", "arguments": {"field": "texte", "query": "texte", "topic": "texte", "entity": "texte", "method": "texte", "topics": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_lookup_engine_component≈ 261 tokens

  Look up the exact props/signature of an engine-owned `./final/*` helper: the `@/final/ui` primitives (Button, IconButton, Card, Tile, Input, Field, Chip, ListRow, Dialog, Sheet, Toolbar, Heading, EmptyState, cn) plus usePrint, StationHomeButton, SwitchUserButton, useStationHome, Barcode, BootSplash. These are re-asserted into every generated app — compose screens from the primitives (see get_scaffold contracts.designLadder) and import the rest instead of hand-rolling buttons/cards/dialogs, printing, station-home/switch-user, barcodes, or the loading splash. Pass name for a precise lookup, query for fuzzy search, or neither to list all.

  Paramètres, retour & exemple (2)

  Paramètres

  • name · string · optionnel
  • query · string · optionnel

  Exemple d'appel

  {"name": "flow_lookup_engine_component", "arguments": {"name": "texte", "query": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_lookup_pos_api≈ 281 tokens

  Look up the Final POS REST API (https://api.finalpos.com) — endpoint method/path, request fields, response shape, and a worked fetch example. This is the ONLINE-ONLY fallback for admin/management operations command-frame cannot express (creating products/variants/categories, customer management, outlets/stations/tax tables, webhooks). Command-frame is ALWAYS first choice for live POS data — it works offline and the host owns money/totals. A call to this API is network egress from the station: it fails whenever connectivity does, so never put one in the sale path — use it for setup/admin work and degrade gracefully. Pass resource to list a domain, operation for one endpoint, or query for fuzzy search.

  Paramètres, retour & exemple (3)

  Paramètres

  • query · string · optionnel
  • resource · string · optionnel
  • operation · string · optionnel

  Exemple d'appel

  {"name": "flow_lookup_pos_api", "arguments": {"query": "texte", "resource": "texte", "operation": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_open_in_builder≈ 156 tokens

  The recommended way to finish: a deep link that opens this flow in the Miami builder, where the owner can review the work, restore checkpoints, and deploy through the Launch tool (validation gates, listing media, changelog, version history).

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_open_in_builder", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_read_flow_files≈ 137 tokens

  Read a flow's generated source tree. Omit `paths` to list all file paths (cheap); pass `paths` to fetch specific files' contents.

  Paramètres, retour & exemple (2)

  Paramètres

  • paths · array · optionnel
  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_read_flow_files", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_rename_flow≈ 220 tokens

  Rename a build (flow) authoritatively across the platform in one call: the builder header, list_flows / open_in_builder, and the Deerlake catalog all reflect the new title, and updatedAt is bumped. A deployed build keeps its hosted web app: the hostname and version history are unchanged, and the next deploy_flow publishes the next version. Does NOT edit the app source: rename a hardcoded old name yourself with write_flow_files.

  Paramètres, retour & exemple (3)

  Paramètres

  • agent · string · optionnel
  • title · string · requis
  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_rename_flow", "arguments": {"title": "texte", "flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_request_secret≈ 482 tokens

  Ask the flow's owner to enter a third-party credential (API key, auth token, webhook secret) into Final's encrypted vault. THIS TOOL TAKES NO VALUE and no tool ever returns one — the human types it into a masked input in the Miami builder, and it goes straight into the vault. Why: flow builds are DISTRIBUTABLE to other companies, so a credential must never be baked into the code (validate_flow and deploy_flow scan for and block hardcoded secrets). Your generated code reads it at RUNTIME with renderClient.getSecretVal({ key }) and must degrade gracefully while the key isn't stored yet (disable the integration + tell the user to configure it — never crash). After calling this: tell YOUR user to open the builder link and enter the value, and poll list_secret_keys to detect when it lands.

  Paramètres, retour & exemple (8)

  Paramètres

  • key · string · requis
    Kebab-case vault key the code will read, e.g. 'twilio-auth-token'.
  • agent · string · optionnel
  • label · string · requis
    Human label shown in the builder, e.g. 'Twilio Auth Token'.
  • flowId · string · requis
  • reason · string · requis
    Why the app needs this credential.
  • docsUrl · string · optionnel
    Where the user can find/generate the credential.
  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.
  • provider · string · optionnel
    The third-party service, e.g. 'Twilio'.

  Exemple d'appel

  {"name": "flow_request_secret", "arguments": {"key": "texte", "label": "texte", "flowId": "texte", "reason": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_search_blueprints≈ 584 tokens

  SEMANTIC search over the vetted blueprint catalog — matches are ranked by what you MEAN, not by shared words, so describe the capability in plain language ('rewards for repeat customers' finds the loyalty blueprint). RUN THIS FIRST — before creating custom tables or hand-rolling a capability: blueprints ship working FUNCTIONALITY (gift cards, loyalty, payment surfaces, carts), not just screen layouts. Search once per FEATURE you're adding (smart grid, gift cards, loyalty points, receipts) and REPEAT it for each distinct capability rather than issuing one broad query — a build usually combines several. Returns { results, note? }: blueprint summaries (id, slot, title, summary, surfaces, tags, selfPersisting, match score in [0,1]) best match first. selfPersisting: true means the blueprint reads/writes its OWN custom tables by exact name inside its code, and apply_blueprint_widgets provisions them in your organization automatically (extension-owned ones come from installing that extension) — NEVER create a table for a feature it covers. Prefer this over list_blueprints when you know what you need. Pick the widgets you need and copy them with apply_blueprint_widgets({ flowId, picks }) — applied ON TOP of the current build, never replacing it. Low match scores across the board mean no vetted blueprint fits — only then build that piece from scratch grounded in the command-frame docs. Optional `slot`/`surface` narrow the results; `limit` caps how many are returned (default 10).

  Paramètres, retour & exemple (5)

  Paramètres

  • kind · string · optionnel · widget-set | fbb | whole-flow | any
  • slot · string · optionnel · product-grid | search | cart | payment | customer | order-list | refund | order-ticket
  • limit · integer · optionnel
  • query · string · requis
  • surface · string · optionnel · desktop | tablet | mobile | kiosk | kitchen-display | menu-board | drive-thru

  Exemple d'appel

  {"name": "flow_search_blueprints", "arguments": {"query": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_start_preview≈ 205 tokens

  Boot the flow's server-side preview sandbox (Vite dev server) — or reconcile a running one to the flow's current files — and return its public HTTPS URL already pinned to this flow's mock dataset: the maker's pick, else its vertical's (sushi, not restaurant). Open the URL in a browser to see the app; call again after write_flow_files to sync. Previews idle-stop on their own; call stop_preview when done to free resources sooner.

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_start_preview", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_stop_preview≈ 117 tokens

  Stop the flow's preview sandbox and free its resources. The next start_preview cold-boots in a couple of seconds.

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_stop_preview", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_sync_preview≈ 241 tokens

  Reconcile a (running or cold) preview sandbox to the flow's current files and run the green-build gate (tsc + vite build). Returns the gate result — the fastest way to know your code actually compiles. The engine forces parts of package.json on every sync: the dev/build/typecheck scripts, and the vendored command-frame + mock packages to their bundled tarballs. Baseline and build dependencies are re-added only when you declared them nowhere, so your own additions and pins survive. Shares one rate bucket with start_preview — sync once per change-set, not per file.

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_sync_preview", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_update_custom_table≈ 638 tokens

  Evolve an EXISTING custom data table's schema: add columns, change existing ones (rename/retype — destructive for stored rows, use sparingly), or drop columns. The table is identified by its kebab-case name from list_custom_tables. Tables are ORG-WIDE, so a schema change lands for every flow and station already using this one — check who reads it before reshaping. NEVER rename or reshape a table a selfPersisting blueprint reads/writes — its copied code references the exact current names. Per-operation failures are collected rather than aborting the whole change. Row data itself stays a runtime concern of the generated app (renderClient).

  Paramètres, retour & exemple (5)

  Paramètres

  • hubToken · string · optionnel
    Organization JWT fallback, only if the hub rejects your API key for this route.
  • addFields · array · optionnel
  • tableName · string · requis
    The existing table's kebab-case name (see list_custom_tables).
  • removeFields · array · optionnel
    Columns to drop (destructive: their data is removed).
  • updateFields · array · optionnel

  Exemple d'appel

  {"name": "flow_update_custom_table", "arguments": {"tableName": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_validate_flow≈ 336 tokens

  Deterministic STATIC checks against the platform contract: (1) guardrails — fabricated renderClient methods, forbidden browser APIs/imports, engine-file writes; (2) a REAL TypeScript check of command-frame usage against the PINNED .d.ts the app installs (the version is stamped in the result) — this proves TYPES, never runtime behaviour and never device parity; (3) a hardcoded-credentials scan; (4) `flowTypeErrors` — a whole-tree `tsc` against REAL react types, which catches what (2) cannot see (e.g. a `useEffect` cleanup that returns a value, a hard TS2345 the builder's in-chat gate will report to whoever opens this flow); plus advisory `warnings` (client money math, hardcoded catalog data, missing station-home/data-test, tip-as-cart-fee) that don't affect `clean` but each predict a real on-device failure. secretFindings BLOCK deploy_flow; everything else is advisory. Run it after each write batch, before start_preview.

  Paramètres, retour & exemple (1)

  Paramètres

  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_validate_flow", "arguments": {"flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• flow_write_flow_files≈ 328 tokens

  Create or overwrite files in a flow's tree (full contents, not diffs). Engine-owned paths are rejected — see get_scaffold. Every write lands as a restorable checkpoint and is narrated in the builder chat. If a live preview is running, follow up with start_preview to sync it. Validate with validate_flow before deploying. If a call returns an error the files may STILL have landed (and a very large payload can truncate mid-file) — re-read with read_flow_files before retrying, never blind-retry. Because writes replace whole files, keep files small and single-purpose so an edit can't clobber unrelated working code.

  Paramètres, retour & exemple (4)

  Paramètres

  • note · string · optionnel
    One-line summary of the change, shown in the builder chat.
  • agent · string · optionnel
  • files · array · requis
  • flowId · string · requis

  Exemple d'appel

  {"name": "flow_write_flow_files", "arguments": {"files": [], "flowId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• get_connection≈ 118 tokens

  Who this connection acts as: organisation, user, the company Hub tools act on and the companies you may switch to, the allowed and listed packs, and how to reach tools that are not listed.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "get_connection", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_add_customer_note≈ 197 tokens

  Add a note to a customer — an allergy, a preference, what happened with an order. Existing notes are KEPT; this appends. Takes the customer ID from get_customers. Staff read these in the cabinet, so write what the merchant said, not your own summary.

  Paramètres, retour & exemple (2)

  Paramètres

  • message · string · requis
    The note text
  • customerId · string · requis
    Customer id from get_customers — not a name

  Exemple d'appel

  {"name": "hub_add_customer_note", "arguments": {"message": "texte", "customerId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_add_modifier_choice≈ 411 tokens

  Add one choice to an existing modifier, leaving the rest alone. This is the safe way to extend a modifier — unlike update_modifier, it cannot drop anything. Appends to the end unless sortOrder says otherwise. price is the extra charge per unit as a human amount ("0.70"); omit it for a choice that costs nothing, which still prints on the receipt.

  Paramètres, retour & exemple (7)

  Paramètres

  • name · string · requis
    What the cashier sees, e.g. "Oat milk"
  • price · string · optionnel
    Extra charge per unit, e.g. "0.70". Omit or "0" for a choice that costs nothing
  • isDefault · boolean · optionnel
    Pre-selected at the till. On "Pick one" at most one choice may have it
  • sortOrder · integer · optionnel
    Position in the list. Omit to append
  • modifierId · string · requis
    Modifier id from get_modifiers
  • defaultQuantity · integer · optionnel
    Starting count — stepper modifiers only
  • unavailableOutletIds · array · optionnel
    Outlets where this choice is NOT sold (an exception list — omit or [] means sold everywhere). Outlet ids from get_outlets

  Exemple d'appel

  {"name": "hub_add_modifier_choice", "arguments": {"name": "texte", "modifierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_add_product_images≈ 340 tokens

  Add photos to an existing product — from public URLs, or as base64 bytes when the merchant attached the file itself and there is no URL. URL images are downloaded and stored on the platform, so the product never depends on someone else's site staying up. Existing photos are KEPT — this adds to them. JPEG/PNG/WebP/GIF/HEIC, up to 20MB each. Takes the product ID from get_products, never a name.

  Paramètres, retour & exemple (3)

  Paramètres

  • imageUrls · array · optionnel
    Public URLs of the photos to add
  • productId · string · requis
    Product id from get_products — not a name
  • imageFiles · array · optionnel
    Photos the merchant attached — use when there is no public URL

  Exemple d'appel

  {"name": "hub_add_product_images", "arguments": {"productId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_add_tax_rate_to_group≈ 334 tokens

  Add an EXISTING rate to a tax group, or change that rate’s compounding flag within the group. Both ids come from get_taxes. This shares the rate — it does not copy it. The group starts charging the rate’s existing per-outlet percentages, and a later edit to that rate changes this group too. Use create_tax_rate instead when the rate does not exist yet. The rate is appended last in the charging order; use update_tax_group with rateIdsInOrder to move it. CONFIRM WITH THE MERCHANT — this immediately adds tax to every product in the group. Sales already rung up are NOT recalculated — this only affects sales from now on.

  Paramètres, retour & exemple (3)

  Paramètres

  • taxRateId · string · requis
    Tax rate id from get_taxes — an existing rate, shared not copied
  • taxGroupId · string · requis
    Tax group id from get_taxes
  • compounding · boolean · optionnel
    Charge this rate on the running total including the rates above it. Default false

  Exemple d'appel

  {"name": "hub_add_tax_rate_to_group", "arguments": {"taxRateId": "texte", "taxGroupId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_adjust_stock≈ 552 tokens

  Change the count of ONE variant at ONE outlet — the cabinet's "Adjust Inventory" action. CONFIRM WITH THE MERCHANT FIRST, repeating the product, the outlet, the reason and the number: this writes immediately, is permanently recorded against the employee in the stock history, and there is no undo from here. Reasons: STOCK_RECEIVED (a delivery arrived) and RESTOCK_RETURN (a return put back on the shelf) ADD the quantity; DAMAGE, THEFT and LOSS SUBTRACT it; INVENTORY_RECOUNT SETS the count to exactly the quantity you pass (a physical stocktake). Always pass quantity as a positive number — the reason decides the direction. Pick the reason the merchant actually gave; these end up in reports, so recording theft as damage misstates their loss. If stock is not tracked for that variant at that outlet, NOTHING is written and the result says applied: false — do not report success, and do not read it as "the stock is 0". Tracking has to be turned on for the product first. To move units between outlets use create_stock_transfer instead.

  Paramètres, retour & exemple (5)

  Paramètres

  • action · string · requis · STOCK_RECEIVED | DAMAGE | THEFT | LOSS | RESTOCK_RETURN | INVENTORY_RECOUNT
    Why the count changed. Adds: STOCK_RECEIVED, RESTOCK_RETURN. Subtracts: DAMAGE, THEFT, LOSS. Sets: INVENTORY_RECOUNT
  • outletId · string · requis
    Outlet id from get_outlets — the adjustment applies only there
  • quantity · integer · requis
    Always positive. Units added or removed — or, for INVENTORY_RECOUNT, the new total on hand
  • productId · string · requis
    Product id from get_products
  • variantId · string · requis
    Variant id from get_products — the exact variant being counted

  Exemple d'appel

  {"name": "hub_adjust_stock", "arguments": {"action": "STOCK_RECEIVED", "outletId": "texte", "quantity": 1, "productId": "texte", "variantId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_assign_role≈ 420 tokens

  Move a team member onto a different role — this is how someone gains or loses access. Answers 'give Maria access to the reports', 'make him a cashier again', 'take away her permissions'. PERMISSIONS ARE POWER. Confirm with the merchant first, naming the person and the role out loud ("give Maria the Manager role — yes?"), and never act on a role change you inferred rather than were asked for. The change is live on the next request: rights are re-read from the role every time, so no one logs out and no agent key stops working — including yours, if the change reaches your own account. It swaps their WHOLE permission set for that role’s, so read get_roles first and check the new role really carries what the merchant asked for and nothing dangerous besides — if no existing role fits, say so rather than picking the closest one. You may also point the merchant’s own account at another role, including the account this agent key belongs to, which would change your own permissions from the next call onward: never do that unless the merchant asked for it in those words. To change what a role itself allows, without moving anyone, use update_role.

  Paramètres, retour & exemple (2)

  Paramètres

  • roleId · string · requis
    Role id from get_roles — not a role name
  • userId · string · requis
    User id from get_team — not a name

  Exemple d'appel

  {"name": "hub_assign_role", "arguments": {"roleId": "texte", "userId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_cancel_booking≈ 166 tokens

  Release a booked window. The order stays as it is — cancelling a booking is not a refund, and money is never moved here; if the customer is owed money, do that on the order. Confirm with the merchant before cancelling a booking somebody already paid for.

  Paramètres, retour & exemple (1)

  Paramètres

  • holdId · string · requis
    The booking to release

  Exemple d'appel

  {"name": "hub_cancel_booking", "arguments": {"holdId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_cancel_purchase_order≈ 240 tokens

  Cancel an order the merchant no longer wants. CONFIRM FIRST, naming the supplier and the PO number — there is no undo, and the order disappears from the list rather than showing as cancelled. REFUSED once any stock has been received against it: that stock is real and the record has to stay. Receive the rest instead, or leave it partially received. Cancelling does NOT tell the supplier anything. If the order was already sent, the merchant still has to contact them — say so.

  Paramètres, retour & exemple (1)

  Paramètres

  • purchaseOrderId · string · requis
    Purchase order id from get_purchase_orders — not a PO number

  Exemple d'appel

  {"name": "hub_cancel_purchase_order", "arguments": {"purchaseOrderId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_confirm_booking≈ 196 tokens

  Turn a hold into a real booking once the order behind it is paid, so it stops expiring. Needs the order the booking was sold on — confirming without one is refused, because a confirmed booking nobody can find on a receipt is worse than an expired hold.

  Paramètres, retour & exemple (2)

  Paramètres

  • holdId · string · requis
    From hold_booking
  • orderId · string · requis
    The paid order carrying this booking

  Exemple d'appel

  {"name": "hub_confirm_booking", "arguments": {"holdId": "texte", "orderId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_booking_resource≈ 268 tokens

  Add one bookable thing to the company directory. Call get_booking_resources first — a resource is reused across every service, so a second "Marco" would split one barber into two calendars and let him be booked twice at once. The name is what staff will see in the calendar.

  Paramètres, retour & exemple (3)

  Paramètres

  • tag · string · optionnel
    Identifier of this exact instance if it has one: room number, plate, QR, e.g. "SC-07"
  • kind · string · requis · asset | room | property | space | staff | table
    What sort of thing it is — drives the labels the merchant sees
  • name · string · requis
    As the merchant says it, e.g. "Marco", "Room 101", "Scooter 7"

  Exemple d'appel

  {"name": "hub_create_booking_resource", "arguments": {"kind": "asset", "name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_booking_rules≈ 799 tokens

  Create a booking policy. Call get_booking_rules FIRST and reuse a matching set instead — these are shared company-wide, not per product. `weeklyHours` are LOCAL wall-clock times at the outlet; if neither the outlet nor the company has a timezone the engine refuses availability with a 400, so fix the outlet rather than guessing an offset. `bufferMinutes` consumes grid time for slot bookings (cleaning between appointments); for overnight stays use checkInTime/checkOutTime instead and leave the buffer at 0 — the cleaning window lives in the gap and does not consume a night.

  Paramètres, retour & exemple (11)

  Paramètres

  • name · string · requis
    How the merchant refers to it, e.g. "Haircuts 9–18"
  • ratePeriod · string · requis · slot | day | night
    What ONE unit of price buys. `slot` for appointments and hourly rental. `week` and `month` are in the enum but NOT offered: the grid still cuts them one day at a time, so a weekly rate would be charged per day
  • bookingType · string · requis · rental | appointment | overnight | group
    appointment = a person's time; rental = an asset; overnight = nights; group = a class
  • checkInTime · string · optionnel
    Overnight only, "15:00"
  • holdMinutes · integer · optionnel
    How long an unpaid hold survives before the window frees itself. Default 10
  • weeklyHours · array · requis
    Opening hours per weekday, local time. Days left out are closed. For overnight stays leave hours off only if the property has none — an empty list there means every day.
  • checkOutTime · string · optionnel
    Overnight only, "11:00"
  • bufferMinutes · integer · optionnel
    Dead time after each booking, e.g. 15 for cleaning. Consumes the grid
  • maxAdvanceDays · integer · optionnel
    How far ahead bookings open. 0 = no limit
  • minNoticeMinutes · integer · optionnel
    Shortest notice accepted, e.g. 60
  • slotLengthMinutes · integer · requis
    How long one booking lasts, e.g. 30

  Exemple d'appel

  {"name": "hub_create_booking_rules", "arguments": {"name": "texte", "ratePeriod": "slot", "bookingType": "rental", "weeklyHours": [], "slotLengthMinutes": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_category≈ 320 tokens

  Create a product category. Call get_categories FIRST — a second "Drinks" is easy to make and there is no merge. Pass parentId to make it a subcategory; leave it out for a top-level one. The cabinet's own form asks for a description, so ask the merchant for one rather than inventing it. This does NOT move any product into the category — do that with update_product and its categoryIds.

  Paramètres, retour & exemple (5)

  Paramètres

  • name · string · requis
    Category name as the merchant said it, e.g. "Beverages"
  • image · string · optionnel
    Image URL, or a Lucide icon reference like "lucide:coffee"
  • parentId · string · optionnel
    Parent category id from get_categories — a name is rejected. Omit for top level
  • sortOrder · number · optionnel
    Position among its siblings, lowest first. Omit to leave it unsorted
  • description · string · optionnel
    Short description shown in the cabinet

  Exemple d'appel

  {"name": "hub_create_category", "arguments": {"name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_customer≈ 522 tokens

  Create a customer. Call get_customers with the email or name FIRST — a duplicate splits one person’s order history in two and there is no merge from here. Email is required, exactly as in the cabinet's own customer form. Ask the merchant for anything you do not know instead of inventing it — an invented phone number or address is worse than a missing one.

  Paramètres, retour & exemple (7)

  Paramètres

  • note · string · optionnel
    A first note about this customer, if the merchant gave one
  • email · string · requis
    Required — the customer’s email address
  • phone · string · optionnel
    Phone as the merchant said it, e.g. "+1 555 123 4567"
  • billing · object · optionnel
    Billing address
  • lastName · string · optionnel
  • shipping · object · optionnel
    Shipping address. Omit to reuse the billing address
  • firstName · string · optionnel

  Exemple d'appel

  {"name": "hub_create_customer", "arguments": {"email": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_modifier≈ 614 tokens

  Create a new question the till can ask, with its choices. THIS ALONE DOES NOTHING AT THE TILL — follow it with link_modifier_to_category, or the modifier sits unused. Choose selectionType carefully, because it CANNOT be changed afterwards: "single" = pick exactly one (milk, cooking temperature); "multiple" = tick any number of different choices (toppings); "multiple" with allowQuantity true = tick choices AND say how many of each; "quantity" = every choice is a stepper (extra shots). The last two count UNITS, not distinct choices. allowQuantity is only accepted on "multiple" and is refused on the others. Names must be unique for the merchant, ignoring case.

  Paramètres, retour & exemple (4)

  Paramètres

  • name · string · requis
    What the cashier sees, e.g. "Milk" or "Toppings"
  • choices · array · optionnel
    The choices. Can also be added later one at a time
  • allowQuantity · boolean · optionnel
    Only with selectionType "multiple": let each ticked choice carry a count. CANNOT be changed later
  • selectionType · string · requis · single | multiple | quantity
    How it is answered. CANNOT be changed later

  Exemple d'appel

  {"name": "hub_create_modifier", "arguments": {"name": "texte", "selectionType": "single"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_outlet≈ 535 tokens

  Open a new point of sale — the cabinet’s Add Outlet form. Name and the full street address (address, city, state, postCode) are all REQUIRED, exactly as on that form. Do NOT try to set a country: every outlet inherits the company’s country, and it can never be changed per outlet. Ask the merchant for any part of the address you do not know — an invented address ends up on receipts. This is BILLABLE: a new outlet counts against the company plan’s outlet allowance and the call is refused once that allowance is used up. Confirm with the merchant before calling. Afterwards the platform seeds a stock row of 0 for every product at the new outlet in the background, so its stock reads as empty until someone receives or transfers stock in. Linking a Stripe account to the outlet is NOT possible from here — the merchant does that in Settings → Outlets.

  Paramètres, retour & exemple (9)

  Paramètres

  • city · string · requis
    City
  • name · string · requis
    Outlet name as the merchant calls it, e.g. "King Street"
  • alias · string · optionnel
    Short code used by the WooCommerce / Metorik integration. Can never be changed once set — leave it out unless the merchant asked for it
  • phone · string · optionnel
    Phone number of this location
  • state · string · requis
    State or province, e.g. "ON"
  • taxId · string · optionnel
    Business tax number printed on this outlet’s receipts (BN / GST / HST / VAT / EIN)
  • address · string · requis
    Street address, e.g. "123 King St W"
  • address2 · string · optionnel
    Unit, suite or floor
  • postCode · string · requis
    ZIP / postal code

  Exemple d'appel

  {"name": "hub_create_outlet", "arguments": {"city": "texte", "name": "texte", "state": "texte", "address": "texte", "postCode": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_product≈ 754 tokens

  Create a product in the merchant's catalogue. Call get_products first to make sure it does not already exist. Prices are HUMAN strings like "19.99" — this tool converts them into the company's currency itself, so never send cents. Tax: the company's standard tax table is applied by default; pass taxable:false for an untaxed product. Ask the merchant for anything you do not know instead of inventing it.

  Paramètres, retour & exemple (15)

  Paramètres

  • sku · string · optionnel
  • name · string · requis
    Product name as the merchant said it
  • price · string · requis
    Selling price as a human string, e.g. "19.99"
  • barcode · string · optionnel
    EAN/UPC if the merchant gave one
  • options · object · optionnel
    Variation axes and the values to build variants from, e.g. {"Size":["Small","Large"]}. Every combination becomes a variant. Call get_product_options FIRST and reuse existing axes. Every variant gets `price` unless variantPrices says otherwise.
  • taxable · boolean · optionnel
    Default true: applies the standard tax table
  • costPrice · string · optionnel
    What the merchant pays for it, human string
  • outletIds · array · optionnel
    Outlet ids. Omit for everywhere
  • taxTableId · string · optionnel
    A specific tax table, for non-standard tax
  • categoryIds · array · optionnel
    Category ids — names are rejected
  • description · string · optionnel
  • productType · string · optionnel · simple | variable | booking
    Only pass this for "booking" — a service sold as TIME (a haircut, a room for the night, an hour on a scooter). simple/variable are derived from `options`, so leave it out for goods. A booking product is not bookable until set_product_booking_setup gives it a rule set and resources.
  • variantPrices · array · optionnel
    Per-variant prices at creation, one entry per combination that differs from `price`, e.g. {"options":{"Size":"Large"},"price":"21.99"}. `options` must name one value for EVERY axis in `options`.
  • trackInventory · boolean · optionnel
    Default false. True manages stock
  • shortDescription · string · optionnel

  Exemple d'appel

  {"name": "hub_create_product", "arguments": {"name": "texte", "price": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_product_option≈ 229 tokens

  Create a new variation axis with its possible values. Use it only when get_product_options shows nothing suitable. The axis is shared across the whole catalogue, not one product — so confirm the name and values with the merchant first and reuse an existing axis when one fits.

  Paramètres, retour & exemple (2)

  Paramètres

  • name · string · requis
    Axis name as the merchant says it, e.g. "Size"
  • values · array · requis
    Possible values in display order, e.g. ["Small","Medium","Large"]

  Exemple d'appel

  {"name": "hub_create_product_option", "arguments": {"name": "texte", "values": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_purchase_order≈ 815 tokens

  Write a new order to a supplier. It is created as a DRAFT — nothing reaches the supplier and no stock moves until send_purchase_order. PREREQUISITES, in this order: get_suppliers for the supplierId, get_outlets for the outlet the goods will be delivered INTO, then get_supplier_items WITH that outletId for the lines — variantId and unitCost come from there, and an item that is not linked to this supplier is refused. unitCost is what the merchant pays per unit as a human amount ("12.50"), prefilled from the supplier link but editable if this order was negotiated differently. quantity is in the item’s selling unit and may be fractional for goods sold by weight or length. Read the lines back to the merchant with the total before sending — a wrong quantity here becomes wrong stock later.

  Paramètres, retour & exemple (10)

  Paramètres

  • lines · array · requis
    What to order
  • notes · string · optionnel
    Note for the supplier / for the merchant’s own records
  • discount · string · optionnel
    Flat discount on the whole order, e.g. "25.00". Not with discountPercent
  • dutyFees · string · optionnel
    Duty / customs charged on the order
  • outletId · string · requis
    Outlet id from get_outlets — where the goods will be received
  • customFees · array · optionnel
    Any other named charge on the order, e.g. "Handling"
  • supplierId · string · requis
    Supplier id from get_suppliers
  • shippingFee · string · optionnel
    Shipping charged on the order, e.g. "18.00"
  • expectedDate · string · optionnel
    ISO date the merchant expects delivery
  • discountPercent · number · optionnel
    Discount as a percentage of the items subtotal

  Exemple d'appel

  {"name": "hub_create_purchase_order", "arguments": {"lines": [], "outletId": "texte", "supplierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_role≈ 404 tokens

  Create a new role with a chosen set of permissions — for when no existing role fits what the merchant wants someone to do. Check get_roles first; a near-match plus update_role is usually better than a fourth almost-identical role. PERMISSIONS ARE POWER. Confirm with the merchant first, naming the person and the role out loud ("give Maria the Manager role — yes?"), and never act on a role change you inferred rather than were asked for. The change is live on the next request: rights are re-read from the role every time, so no one logs out and no agent key stops working — including yours, if the change reaches your own account. Permission ids come from get_permissions. List back in plain words what the role will be able to do and get an explicit yes before calling. Creating a role gives nobody anything until assign_role puts a person on it. If you are signed in as an employee you can only grant permissions you hold yourself — the cabinet works the same way — and the call is refused otherwise.

  Paramètres, retour & exemple (2)

  Paramètres

  • name · string · requis
    What the merchant calls it, e.g. "Shift lead"
  • permissionIds · array · requis
    Permission ids from get_permissions — everything not listed is switched off

  Exemple d'appel

  {"name": "hub_create_role", "arguments": {"name": "texte", "permissionIds": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_station≈ 377 tokens

  Add a VIRTUAL till — a browser-based station, the cabinet’s "Add Virtual Station". It is created at one outlet and starts AVAILABLE. You CANNOT create a native (device) station from here and must not try: a physical till enrols itself when someone opens the POS app on the device and names it there. THIS IS BILLABLE — a new station counts against the company plan’s station allowance and the call is refused once that allowance is used up. Confirm with the merchant before calling. flowSrcId is the POS layout the till runs. The cabinet’s wizard makes picking one mandatory and there is no tool here that lists flows, so unless the merchant gave you an id, create the station and then tell them plainly to open Run → Stations and choose the flow — until they do, the station exists but cannot be launched.

  Paramètres, retour & exemple (3)

  Paramètres

  • name · string · requis
    Station name as staff will see it, e.g. "POS 2"
  • outletId · string · requis
    Which outlet this till belongs to — id from get_outlets, not a name
  • flowSrcId · string · optionnel
    Id of the POS layout (flow) the till runs, if the merchant gave one

  Exemple d'appel

  {"name": "hub_create_station", "arguments": {"name": "texte", "outletId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_stock_transfer≈ 529 tokens

  Move stock from one outlet to another — 'send 10 of these from the warehouse to the King Street shop'. CONFIRM WITH THE MERCHANT FIRST, naming both outlets and every quantity: this writes immediately and there is no undo from here. The stock LEAVES the source outlet at once; the destination only gains it when someone confirms arrival with receive_stock_transfer, so until then those units are in transit and count in neither shop. Tell the merchant that. Variant ids come from get_products, outlet ids from get_outlets. Check availability with get_stock first: sending more than the source holds is rejected, and so is sending a variant whose stock is not tracked at the source — there is no count there to move. To correct a count in place (damage, theft, a recount) use adjust_stock instead; to book in a supplier delivery use adjust_stock with STOCK_RECEIVED.

  Paramètres, retour & exemple (5)

  Paramètres

  • note · string · optionnel
    A note staff will read on the transfer
  • items · array · requis
    What to move. One entry per variant
  • invoice · string · optionnel
    Invoice or reference number, if the merchant gave one
  • toOutletId · string · requis
    Destination outlet id from get_outlets — must differ from the source
  • fromOutletId · string · requis
    Source outlet id from get_outlets — stock leaves here immediately

  Exemple d'appel

  {"name": "hub_create_stock_transfer", "arguments": {"items": [], "toOutletId": "texte", "fromOutletId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_supplier≈ 395 tokens

  Add a business the merchant buys from. Only the name is required, and it must be unique among this company’s suppliers. Set contactEmail if the merchant will ever email purchase orders to this supplier — send_purchase_order has nowhere to send without it. A brand-new supplier carries NO items, so it cannot be ordered from yet: link its items with link_supplier_items before creating a purchase order. Ask the merchant for details you do not have rather than inventing them — this ends up on the orders their supplier reads.

  Paramètres, retour & exemple (11)

  Paramètres

  • city · string · optionnel
  • name · string · requis
    Supplier name as the merchant calls it
  • notes · string · optionnel
    Free-text notes, e.g. delivery days or account number
  • phone · string · optionnel
  • state · string · optionnel
    State or province
  • country · string · optionnel
  • address1 · string · optionnel
    Street address
  • address2 · string · optionnel
    Unit, suite or floor
  • postCode · string · optionnel
    ZIP / postal code
  • contactName · string · optionnel
    Person the merchant deals with
  • contactEmail · string · optionnel
    Where purchase orders are emailed

  Exemple d'appel

  {"name": "hub_create_supplier", "arguments": {"name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_tax_group≈ 274 tokens

  Create an empty tax group (a tax profile that products get assigned to, e.g. "Standard", "Food", "Zero-rated"). Call get_taxes FIRST — a second group with the same meaning splits the catalogue and is a common way to end up charging two different taxes for one thing. The group charges nothing until you add rates with create_tax_rate or add_tax_rate_to_group, and no product uses it until someone assigns it. isStandard marks the company default — set it only if the merchant explicitly says so. CONFIRM the name with the merchant before calling.

  Paramètres, retour & exemple (2)

  Paramètres

  • name · string · requis
    What the merchant calls it, e.g. "Standard Tax"
  • isStandard · boolean · optionnel
    Make this the company default group. Default false

  Exemple d'appel

  {"name": "hub_create_tax_group", "arguments": {"name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_tax_rate≈ 535 tokens

  Create a named tax rate ("State Sales Tax", "GST") with its percentage, and optionally put it straight into a tax group. Check get_taxes first: if a rate with this meaning already exists, add_tax_rate_to_group reuses it, which is almost always what the merchant wants — duplicating a rate means the next change has to be made twice and one of them gets forgotten. Give either percentage (the same at every outlet) or perOutlet (different per store) — never both, and never neither, since a rate with no percentage charges nothing. Without taxGroupId the rate exists but is charged nowhere. CONFIRM THE EXACT PERCENTAGE WITH THE MERCHANT before calling — do not infer it from suggest_tax_rate or from what is usual in that region. Sales already rung up are NOT recalculated — this only affects sales from now on.

  Paramètres, retour & exemple (5)

  Paramètres

  • name · string · requis
    What appears on the receipt, e.g. "GST", "State Sales Tax"
  • perOutlet · array · optionnel
    Outlet-specific percentages, using outlet ids from get_taxes. REPLACES the stored list whole — an outlet you leave out stops charging this rate
  • percentage · number · optionnel
    One percentage for every outlet, e.g. 13 for 13%
  • taxGroupId · string · optionnel
    Tax group id from get_taxes to add it to right away
  • compounding · boolean · optionnel
    Only with taxGroupId: charge on the running total including the rates above it. Default false

  Exemple d'appel

  {"name": "hub_create_tax_rate", "arguments": {"name": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_create_user≈ 492 tokens

  Add a POS user — someone who signs in at the till with a PIN. Mirrors the cabinet’s "New POS user" form: first and last name, a 4-6 digit PIN, a role, optionally a phone. They get access to every outlet of the company, which update_user can narrow afterwards. BACK-OFFICE (Hub) users are NOT created here: those are invited by email from the cabinet, and that invitation flow is not available through this tool. If the merchant wants someone who can log in to the back office, say that and point them at Manage → Team → Users → Add User. The role decides what the new person may do, so PERMISSIONS ARE POWER. Confirm with the merchant first, naming the person and the role out loud ("give Maria the Manager role — yes?"), and never act on a role change you inferred rather than were asked for. The change is live on the next request: rights are re-read from the role every time, so no one logs out and no agent key stops working — including yours, if the change reaches your own account. A new user also counts against the company plan’s user allowance and the call is refused once it is used up.

  Paramètres, retour & exemple (5)

  Paramètres

  • phone · string · optionnel
    Phone as the merchant said it, e.g. "+1 555 123 4567"
  • roleId · string · requis
    Role id from get_roles — required, and it decides their permissions
  • pincode · string · requis
    Required — 4 to 6 digits, what they type at the till
  • lastName · string · requis
    Required
  • firstName · string · requis
    Required

  Exemple d'appel

  {"name": "hub_create_user", "arguments": {"roleId": "texte", "pincode": "texte", "lastName": "texte", "firstName": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_category≈ 226 tokens

  Delete a category. Takes the category id ONLY — look it up with get_categories and never guess. CONFIRM WITH THE MERCHANT BEFORE CALLING, naming the category: there is no undo from here. Products in the category are NOT deleted — they are kept and simply lose this category, so a product that had no other category ends up uncategorised. A category that still has subcategories is refused: move or delete those first. So is a category synced from an integration.

  Paramètres, retour & exemple (1)

  Paramètres

  • categoryId · string · requis
    Category id from get_categories — not a name

  Exemple d'appel

  {"name": "hub_delete_category", "arguments": {"categoryId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_customer≈ 188 tokens

  Remove a customer from the merchant's list. Takes the customer ID ONLY — look it up with get_customers and never guess. CONFIRM WITH THE MERCHANT BEFORE CALLING, naming the customer: there is no undo from here. Their past orders are kept. If several customers match, list them and ask which one instead of picking.

  Paramètres, retour & exemple (1)

  Paramètres

  • customerId · string · requis
    Customer id from get_customers — not a name

  Exemple d'appel

  {"name": "hub_delete_customer", "arguments": {"customerId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_media_file≈ 332 tokens

  Permanently delete one file from the media library. Takes the file ID from get_media_library ONLY — never guess it. CONFIRM WITH THE MERCHANT BEFORE CALLING, naming the file: the image is destroyed and there is NO UNDO. Tell them this too, because the platform does not check it and nothing is cleaned up afterwards: if any product or category uses this image, it KEEPS the dead URL and its picture turns into a broken image — the file is not detached, it is only made unreachable. There is no reverse lookup here from a file to the products using it, so if they are unsure, say so and let them check on the Media screen in the cabinet rather than deleting on a guess. The file may also stay listed on that screen afterwards, because that screen is fed by a separate service. Removing a photo from ONE product without destroying the file is not this tool — that is a product edit.

  Paramètres, retour & exemple (1)

  Paramètres

  • fileId · string · requis
    File id from get_media_library — not a name or a URL

  Exemple d'appel

  {"name": "hub_delete_media_file", "arguments": {"fileId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_modifier≈ 186 tokens

  Remove a modifier from the catalogue AND detach it from every category at once — the till stops asking it everywhere. Check get_modifier first and tell the merchant which categories lose it. To stop asking it in ONE place only, use unlink_modifier_from_category. Past orders keep the options that were already rung up.

  Paramètres, retour & exemple (1)

  Paramètres

  • modifierId · string · requis
    Modifier id from get_modifiers

  Exemple d'appel

  {"name": "hub_delete_modifier", "arguments": {"modifierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_modifier_choice≈ 172 tokens

  Remove one choice from a modifier. Refused when it would leave a category asking for more choices than remain — the explanation names the category.

  Paramètres, retour & exemple (2)

  Paramètres

  • choiceId · string · requis
    Choice id from get_modifier
  • modifierId · string · requis
    Modifier id from get_modifiers

  Exemple d'appel

  {"name": "hub_delete_modifier_choice", "arguments": {"choiceId": "texte", "modifierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_outlet≈ 282 tokens

  Close a point of sale permanently. Takes the outlet id from get_outlets. CONFIRM WITH THE MERCHANT FIRST, naming the outlet — there is NO undo from here. Tell them what goes with it: the stock recorded AT that outlet is removed and is NOT moved anywhere else (transfer it out first if they want to keep it), and so are the outlet’s tax rate values and its per-outlet product visibility. Past orders, sessions and reports still name the outlet and are not touched, and the stations that belonged to it are NOT deleted — they have to be dealt with separately. An outlet that WooCommerce uses as its default is refused: the merchant must change that default or uninstall the WooCommerce extension first.

  Paramètres, retour & exemple (1)

  Paramètres

  • outletId · string · requis
    Outlet id from get_outlets — not a name

  Exemple d'appel

  {"name": "hub_delete_outlet", "arguments": {"outletId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_product≈ 188 tokens

  Remove a product from the merchant's catalogue. Takes the product ID ONLY — look it up with get_products and never guess. CONFIRM WITH THE MERCHANT BEFORE CALLING, naming the product: this also removes all of its variants and there is no undo. If several products match, list them and ask which one instead of picking.

  Paramètres, retour & exemple (1)

  Paramètres

  • productId · string · requis
    Product id from get_products — not a name

  Exemple d'appel

  {"name": "hub_delete_product", "arguments": {"productId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_role≈ 211 tokens

  Delete a role the merchant no longer uses. Takes the roleId from get_roles. CONFIRM FIRST, naming the role — there is no undo. A role that anyone still holds cannot be deleted: the server refuses and tells you how many people are on it. Move them with assign_role first, and check with the merchant which role they should land on — that move changes what those people can do. You cannot delete the role you are signed in under.

  Paramètres, retour & exemple (1)

  Paramètres

  • roleId · string · requis
    Role id from get_roles — not a role name

  Exemple d'appel

  {"name": "hub_delete_role", "arguments": {"roleId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_station≈ 291 tokens

  Remove a till from Run → Stations. Takes the station id from get_stations. CONFIRM WITH THE MERCHANT FIRST, naming the station — there is NO undo from here, and it takes a working register out of service: the device that used it has to be set up again in the POS app, and it comes back as a NEW station with a new id. A station reporting IN_USE is REFUSED, exactly as the cabinet greys the button out — the shift has to be closed on the device first. If the merchant insists that till is idle, the flag is stale (it was closed while the device was offline); it clears once the device reconnects, so try again then instead of forcing anything. Past orders, sessions and End of Session reports keep naming this station and are not touched.

  Paramètres, retour & exemple (1)

  Paramètres

  • stationId · string · requis
    Station id from get_stations — not a name

  Exemple d'appel

  {"name": "hub_delete_station", "arguments": {"stationId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_supplier≈ 233 tokens

  Remove a supplier the merchant no longer buys from. CONFIRM WITH THE MERCHANT FIRST, naming the supplier — there is no undo from here. Its item links go with it, so any auto-reorder rule pointing at this supplier stops producing suggestions. REFUSED while the supplier still has an open purchase order (anything not fully received): receive or cancel those first — get_purchase_orders filtered by this supplier shows them. Purchase orders already placed are kept and still name the supplier.

  Paramètres, retour & exemple (1)

  Paramètres

  • supplierId · string · requis
    Supplier id from get_suppliers — not a name

  Exemple d'appel

  {"name": "hub_delete_supplier", "arguments": {"supplierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_tax_group≈ 324 tokens

  Delete a tax group. Takes the tax group id from get_taxes. THIS MOVES PRODUCTS: every product assigned to this group is re-pointed at replacementTaxGroupId, or — if you omit it — left with NO tax group at all, meaning those products are sold UNTAXED from that moment. Always ask the merchant which of the two they want and pass a replacement unless they say otherwise. The rates inside it are NOT deleted; they stay available to the other groups (use delete_tax_rate if the merchant really wants a rate gone). CONFIRM WITH THE MERCHANT BEFORE CALLING, naming the group and how many products it affects. There is no undo. Sales already rung up are NOT recalculated — this only affects sales from now on.

  Paramètres, retour & exemple (2)

  Paramètres

  • taxGroupId · string · requis
    Tax group id from get_taxes — not a name
  • replacementTaxGroupId · string · optionnel
    Tax group its products move to. OMIT ONLY if the merchant wants those products left untaxed

  Exemple d'appel

  {"name": "hub_delete_tax_group", "arguments": {"taxGroupId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_delete_tax_rate≈ 291 tokens

  Permanently delete a tax rate FROM THE WHOLE COMPANY. Takes the tax rate id from get_taxes. THIS CASCADES: the rate is stripped out of every tax group that lists it and all of its per-outlet percentages are deleted with it. Products in those groups immediately stop being charged this tax. This is almost never what a merchant means when they say "remove the tax from X" — that is remove_tax_rate_from_group. Use this one only when they say the rate should not exist at all any more. CONFIRM WITH THE MERCHANT BEFORE CALLING, naming the rate and listing every group it will disappear from. There is no undo and no way to recover the percentages. Sales already rung up are NOT recalculated — this only affects sales from now on.

  Paramètres, retour & exemple (1)

  Paramètres

  • taxRateId · string · requis
    Tax rate id from get_taxes — not a name

  Exemple d'appel

  {"name": "hub_delete_tax_rate", "arguments": {"taxRateId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_export_records≈ 416 tokens

  Dump one resource in spreadsheet shape — every record flattened to the same columns the import tools accept, WITH its id. Answers 'export my catalogue / my customers', and it is the required first step before any import that changes existing records: the `updates` arrays all key on the ids this returns. For QUESTIONS about the data ("how many products", "find John") use get_products / get_customers / get_categories / get_outlets / get_options instead — they read better and filter server-side. LIMITATIONS: no filtering and no sorting; records come back in stored order, one window at a time. It also cannot produce a FILE — if the merchant wants a .csv/.xlsx download, send them to Settings → Import / Export → Export in the cabinet and do not page through thousands of rows to imitate it. Money is in minor units (cents), matching what the import tools read back.

  Paramètres, retour & exemple (3)

  Paramètres

  • limit · integer · optionnel
    Records to return, default 100, max 500
  • offset · integer · optionnel
    Records to skip, default 0
  • resource · string · requis · products | customers | categories | options | outlets
    Which resource to dump. "options" means product attributes (Size, Colour) — the cabinet calls them Attributes

  Exemple d'appel

  {"name": "hub_export_records", "arguments": {"resource": "products"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_export_stock_csv≈ 435 tokens

  The stock export file for ONE outlet, as CSV text: Variation ID, Product Name, Variation name, SKU, Stock Management, Cur Qty, New Qty. Use it when the merchant asks for the stock sheet itself — a stocktake worksheet, a hand-off to a supplier, 'give me my stock as CSV'. For stock QUESTIONS — how many of X are left, what is running out, history of a change — use get_stock, find_low_stock and get_stock_history: they filter on the server and explain when tracking is switched off. This dump includes untracked rows and cannot tell "zero" apart from "not counted here". It is READ-ONLY: to write counts back, edit the New Qty column and send the file to import_stock_csv. Large catalogues are truncated — the reply reports the true row count.

  Paramètres, retour & exemple (5)

  Paramètres

  • maxRows · integer · optionnel
    Data rows to return, default 200, max 2000
  • outletId · string · requis
    Outlet id from get_outlets — not a store name
  • statuses · array · optionnel
    Restrict to these product statuses
  • categoryIds · array · optionnel
    Category ids from get_categories
  • productTypes · array · optionnel
    Restrict to these product types

  Exemple d'appel

  {"name": "hub_export_stock_csv", "arguments": {"outletId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_find_low_stock≈ 316 tokens

  What is running out. Answers 'what is low', 'what do I need to reorder', 'what has run out at the warehouse'. Returns the stock-tracked (variant, outlet) lines at or below a threshold, lowest first. Threshold defaults to 5; pass threshold: 0 for "what has actually hit zero". Lines where stock is NOT tracked are excluded on purpose — they have no count, so they can never be low, and reporting them would invent a shortage that does not exist. This is per outlet: the same variant can be empty in one shop and full in another. For one specific product use get_stock instead.

  Paramètres, retour & exemple (3)

  Paramètres

  • limit · integer · optionnel
    How many lines to return, default 25
  • outletId · string · optionnel
    Outlet id from get_outlets. Omit to cover every outlet
  • threshold · integer · optionnel
    Report lines with this many units or fewer. Default 5; use 0 for out-of-stock only

  Exemple d'appel

  {"name": "hub_find_low_stock", "arguments": {"limit": 1, "outletId": "texte", "threshold": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_booking_availability≈ 300 tokens

  The bookable windows for a product over a date range, per resource, with what is already taken. Quote times from THIS — never compute a grid yourself: the engine applies the hours, the buffer, notice and advance limits, and the outlet timezone, and a hold whose start is not exactly a slot start is refused. Ask for a few days at a time; a year-wide range is slow and pointless.

  Paramètres, retour & exemple (4)

  Paramètres

  • to · string · requis
    ISO instant, end of the range
  • from · string · requis
    ISO instant, start of the range, e.g. "2026-09-12T00:00:00Z"
  • outletId · string · optionnel
    The shop the booking is for — decides the local wall clock. Omit for the company default
  • productId · string · requis
    Product id from get_products

  Exemple d'appel

  {"name": "hub_get_booking_availability", "arguments": {"to": "texte", "from": "texte", "productId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_booking_events≈ 213 tokens

  The trail of what happened to bookings — held, confirmed, cancelled, expired — newest first, with who did it. Use it to answer "what happened to this booking"; an actor of `system` is the server freeing an expired hold, not a person. Each row is immutable, so this is the record even when the booking itself is gone.

  Paramètres, retour & exemple (2)

  Paramètres

  • limit · integer · optionnel
    How many rows, newest first. Default 100
  • productId · string · optionnel
    Narrow to one product. Omit for the whole company

  Exemple d'appel

  {"name": "hub_get_booking_events", "arguments": {"limit": 1, "productId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_booking_resources≈ 171 tokens

  List what can be booked — the staff, rooms, tables or assets in the company directory. A resource is whatever can only be in one place at a time, and it is shared across services: the same barber is one resource whether he cuts hair or trims a beard, which is why booking him for one closes the other. Read this before creating anything and reuse what is there.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_booking_resources", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_booking_rules≈ 164 tokens

  List the reusable booking policies the merchant already has — opening hours, slot length, buffer, how far ahead people may book. A rule set is shared by every product pointing at it, exactly like a tax table, so ALWAYS read this before creating one and offer an existing set when it fits. Editing a set changes every product that uses it.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_booking_rules", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_categories≈ 267 tokens

  The merchant's product categories, as the tree they see in the cabinet: every category with its subcategories nested inside it, sorted by sortOrder. Answers "what categories do I have", "is there a Drinks category", "where does Beer sit". Use it to get the category id any other tool needs. It returns categories ONLY — never products, and never a product count. There is no way to list the products of a category from this server today: get_products searches by name or SKU and cannot filter by category, so say that plainly instead of guessing. To put a product INTO a category, go to the product side: create_product / update_product take categoryIds. The whole tree comes back at once — there is no paging and no search argument, so filter by name yourself.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_categories", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_category_modifiers≈ 242 tokens

  Where modifiers are actually asked: one row per category↔modifier link, with that category’s own rules (required, min, max, order). This is what makes a modifier reach the till, so use it to answer "what options does this category ask" or "where is this modifier used". Narrow to one category with categoryId. Remember products also inherit their ancestors’ links, so a subcategory asks more than its own rows show. The id on each row is the LINK id — that is what update_category_modifier and unlink_modifier_from_category take.

  Paramètres, retour & exemple (1)

  Paramètres

  • categoryId · string · optionnel
    Category id from get_categories. Omit for every category

  Exemple d'appel

  {"name": "hub_get_category_modifiers", "arguments": {"categoryId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_customer≈ 181 tokens

  Everything known about ONE customer: addresses, notes, how many orders they placed, what they spent and what was refunded. Takes the customer ID from get_customers, never a name. Use it before answering a question about a specific person — the list leaves notes and refunds out.

  Paramètres, retour & exemple (1)

  Paramètres

  • customerId · string · requis
    Customer id from get_customers — not a name

  Exemple d'appel

  {"name": "hub_get_customer", "arguments": {"customerId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_customer_orders≈ 308 tokens

  ONE customer's history as a single timeline, newest first: their orders AND the refunds taken against them, each row marked type "order" or "refund" — the same list the customer screen shows. Answers 'what has this person bought', 'did we refund them', 'when were they last in'. Takes the customer ID from get_customers, never a name. get_orders with customerIds returns the orders alone and a total count; use this tool when the refunds belong in the answer. No total count comes back here — keep paging until a page returns fewer rows than asked for.

  Paramètres, retour & exemple (3)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • pageSize · integer · optionnel
    Rows per page, default 20
  • customerId · string · requis
    Customer id from get_customers — not a name

  Exemple d'appel

  {"name": "hub_get_customer_orders", "arguments": {"customerId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_customers≈ 306 tokens

  List the merchant's customers. Answers 'who are my customers', 'find John's email', 'has this person bought from us'. Search matches email, first name, last name and full name — NOT phone numbers, addresses or notes. LIMITATION — there is no sorting: results come back in stored order and cannot be ordered by spend, name or last visit. So 'my best customers' or 'who spent the most' CANNOT be answered from this tool, and you must NOT page through everyone trying. Say plainly that sorting is not supported yet, then offer what does work: search by a name or email, or ask the merchant to narrow it down.

  Paramètres, retour & exemple (3)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • search · string · optionnel
    Filter by email, first name, last name or full name
  • pageSize · integer · optionnel
    Results per page, default 20

  Exemple d'appel

  {"name": "hub_get_customers", "arguments": {"page": 1, "search": "texte", "pageSize": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_employee_orders≈ 366 tokens

  The orders ONE staff member rang up in a date range. Takes the employee id from get_employee_sales, never a name. Use it to back up a claim about a person — 'show me the sales behind Maria's number', 'which orders did he refund'.

  Paramètres, retour & exemple (7)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • endDate · string · requis
    End of the window, ISO 8601. Inclusive of the day when a bare date is given
  • outlets · array · optionnel
    Outlet ids to restrict to. Omit for all outlets
  • pageSize · integer · optionnel
    Orders per page, default 20
  • stations · array · optionnel
    Station ids to restrict to. Omit for all stations
  • startDate · string · requis
    Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"
  • employeeId · string · requis
    Employee id from get_employee_sales — not a name

  Exemple d'appel

  {"name": "hub_get_employee_orders", "arguments": {"endDate": "texte", "startDate": "texte", "employeeId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_employee_sales≈ 428 tokens

  Sales per staff member for a date range — Reports → Employee Sales. Answers 'who is my best seller', 'how much did Maria sell', 'who took the most refunds', 'average ticket per employee'. One row per employee with orders, gross sales, refunds, tips and average transaction. Staff lists are short, so ranking is safe: pull the rows and sort them yourself rather than asking the merchant to narrow down. Pass employeeId to get a single person. For the actual orders one person rang up, use get_employee_orders.

  Paramètres, retour & exemple (7)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • endDate · string · requis
    End of the window, ISO 8601. Inclusive of the day when a bare date is given
  • outlets · array · optionnel
    Outlet ids to restrict to. Omit for all outlets
  • pageSize · integer · optionnel
    Rows per page, default 50
  • stations · array · optionnel
    Station ids to restrict to. Omit for all stations
  • startDate · string · requis
    Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"
  • employeeId · string · optionnel
    Restrict to one employee, by id from a previous call

  Exemple d'appel

  {"name": "hub_get_employee_sales", "arguments": {"endDate": "texte", "startDate": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_extension_catalog≈ 342 tokens

  The extension STORE: every built-in extension the platform offers, the same list for every merchant. Answers 'what can I add', 'do you have a WooCommerce integration', 'can I get X'. For 'what do I already have', use get_installed_extensions instead — this tool only flags each entry with `installed`. `availableOnYourPlan: false` means the subscription plan excludes it: the store hides it in the cabinet and install_extension will refuse — say so instead of trying. LIMITATIONS, do not paper over them: the platform stores only a name, a category, a price and an id per built-in extension — there is NO stored description, so do not invent what an extension does; say what the name and category say and offer to open its page in the cabinet. `price` is a bare stored string with no currency attached — quote it verbatim, never as a formatted amount. Custom extensions built by an organisation are NOT in this list (they need an organisation scope this agent key does not carry); they do show up in get_installed_extensions once installed.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_extension_catalog", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_extension_surfaces≈ 319 tokens

  What the installed extensions ADD to the apps — the answer to "where did this new menu item come from", "what is this extra block on the product page", "what did installing X actually change". Every entry belongs to an installed extension; nothing here is part of the base product. Read `platform` to know where it shows up: `hub` = this admin cabinet, `builder` = the POS flow builder, `render` = the station screen. Within `hub`, type `merchant-hub-page` is a navigation entry of its own and `merchant-hub-widget` is a block embedded in a detail page — `attachedTo` says which one (products / orders / customers / users). LIMITATION: this tells you which extension-provided screens EXIST, not what they contain — each one is an embedded page owned by its extension, and this agent cannot open or read it. It also cannot say which extension contributed a given entry. To go the other way — what is installed at all — use get_installed_extensions.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_extension_surfaces", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_financial_summary≈ 357 tokens

  THE headline money report for a date range — the same numbers as Reports → Financial Summary. Answers 'how much did we make last week', 'what were sales this month', 'how much tax do I owe', 'what lands in my bank'. Returns gross sales, discounts, refunds, fees, tax, tips, net sales, and the settlement split (card / cash / custom) down to what the merchant actually receives. Start here for any "how did the business do" question, and only reach for get_sales_breakdown when the merchant wants the individual orders behind these totals.

  Paramètres, retour & exemple (4)

  Paramètres

  • endDate · string · requis
    End of the window, ISO 8601. Inclusive of the day when a bare date is given
  • outlets · array · optionnel
    Outlet ids to restrict to. Omit for all outlets
  • stations · array · optionnel
    Station ids to restrict to. Omit for all stations
  • startDate · string · requis
    Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"

  Exemple d'appel

  {"name": "hub_get_financial_summary", "arguments": {"endDate": "texte", "startDate": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_installed_extensions≈ 299 tokens

  What THIS company actually has installed — built-in and organisation-built (custom) extensions alike. This is the answer to 'which extensions do I have', 'is WooCommerce turned on for me', 'what am I paying for'. Not to be confused with get_extension_catalog, which lists what exists on the platform whether or not this merchant has it. Each row carries `extensionId` (pass this to install_extension / uninstall_extension) and `companyExtensionId` (the install record itself — you never need to pass that one). `description` is filled in only for custom extensions; built-in ones store no prose, so do not guess what they do. LIMITATION: the install date is not stored — you cannot say when an extension was added or who added it. To answer what an installed extension CHANGED in the cabinet — a new menu entry, a block on a detail page — use get_extension_surfaces.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_installed_extensions", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_linkable_items≈ 284 tokens

  Catalogue items this supplier does NOT carry yet but could — the picker behind "add items to supplier". Feed what you choose to link_supplier_items. Only stock-managed items appear: something the merchant does not track stock for cannot be purchase-ordered at all, so if an expected item is missing here and missing from get_supplier_items too, the reason is almost always that stock tracking is off for it — say that instead of guessing. Omit supplierId to search the whole linkable catalogue, e.g. while deciding which supplier to create. Returns everything matching, unpaged, so pass a search.

  Paramètres, retour & exemple (2)

  Paramètres

  • search · string · optionnel
    Match product name, item name, SKU or barcode
  • supplierId · string · optionnel
    Supplier id — omit to see the whole linkable catalogue

  Exemple d'appel

  {"name": "hub_get_linkable_items", "arguments": {"search": "texte", "supplierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_media_library≈ 380 tokens

  List the image files stored on the merchant's account. Answers 'what images do I have', 'do I already have a photo of X', 'what did I upload recently', and it is where you get a file id before deleting one, or a URL to reuse on a product or category. Newest first; search is a case-insensitive match on the FILE NAME only. LIMITATIONS, state them rather than working around them: there is no other sorting, and no title, alt text, description, folder, file size or image dimensions here — the Media screen in the cabinet shows those, but they are stored by a different service that this tool cannot read, so it may list files this tool does not and vice versa. There is also NO WAY TO RENAME a file from here: if the merchant asks to rename one, or to change its alt text, title or folder, say that has to be done on the Media screen in the cabinet. Do not delete and re-upload to fake a rename.

  Paramètres, retour & exemple (3)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • search · string · optionnel
    Filter by file name, e.g. "logo" or "shirt"
  • pageSize · integer · optionnel
    Results per page, default 20

  Exemple d'appel

  {"name": "hub_get_media_library", "arguments": {"page": 1, "search": "texte", "pageSize": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_modifier≈ 202 tokens

  One modifier in full: its choices with prices and defaults, and every category it is linked to with that category’s own rules. Read this before editing — update_modifier REPLACES the whole choice list, so you need the current one to send back. Each choice carries price (formatted, for reading out) and priceAmount (plain, what the write tools accept back). Pass priceAmount, never price.

  Paramètres, retour & exemple (1)

  Paramètres

  • modifierId · string · requis
    Modifier id from get_modifiers

  Exemple d'appel

  {"name": "hub_get_modifier", "arguments": {"modifierId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_modifiers≈ 219 tokens

  Every modifier the merchant has — the questions the till can ask about an item, with their choices and prices. Start here for anything about options, add-ons, extras, toppings, sizes, milk, cooking temperature or "how do I let them choose X". Each row says how it is answered: "Pick one" (radio), "Pick many" (checkboxes), "Pick many · qty" or "stepper per choice" (the last two count UNITS, so one choice taken three times counts as 3). usedIn is how many categories it is linked to — a modifier with usedIn 0 is invisible at the till no matter how well it is set up.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_modifiers", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_order≈ 321 tokens

  Everything inside ONE order: line items with quantity, unit price and per-line tax, custom sales, gift-card and other non-revenue lines, the totals block, every payment taken (method, processor, card type and last 4, tip, change), every refund already made against it, plus the customer, outlet, station, employee and order notes. Answers 'what was in order 1042', 'how did they pay', 'was this one refunded', 'why is this total different'. Takes the order ID from get_orders — a receipt number will NOT work, search for it with get_orders first. READ-ONLY, and there is no sibling tool that writes: an order's status cannot be changed, an order cannot be cancelled or completed, and a refund cannot be created from this API — refunds are taken on the POS terminal against the original payment. Say that plainly instead of hunting for another tool.

  Paramètres, retour & exemple (1)

  Paramètres

  • orderId · string · requis
    Order id from get_orders — not a receipt number

  Exemple d'appel

  {"name": "hub_get_order", "arguments": {"orderId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_order_count≈ 201 tokens

  How many orders the company has, in total or at given outlets — 'how many orders do we have', 'how busy is the King Street shop'. Cheap: it counts, it loads no order data. It counts EVERY order ever recorded and takes no date, status or source filter. For anything time-boxed or filtered, call get_orders and read its `matching` count, or use get_financial_summary for a period.

  Paramètres, retour & exemple (1)

  Paramètres

  • outlets · array · optionnel
    Outlet ids to restrict to. Omit to count every outlet

  Exemple d'appel

  {"name": "hub_get_order_count", "arguments": {"outlets": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_orders≈ 755 tokens

  Find orders — the same rows as Manage → Orders. Answers 'show me order 1042', 'what did we sell on Saturday', 'are there parked orders', 'orders rung up by Maria', 'orders over $500 at the King Street shop'. Filter by receipt number, status, source, employee, customer, product, date window, order total, outlet or station. Results are ALWAYS newest first — there is no other sorting, so a "biggest order" question needs the amount filter, not paging. Search matches the receipt number and the order id ONLY, never customer names or product names: for those, pass customerIds from get_customers or productIds from get_products. One row per order with its total; for what is INSIDE an order — line items, payments, refunds, notes — call get_order with the id from here. For how much the business took over a period use get_financial_summary or get_sales_breakdown instead of adding these rows up.

  Paramètres, retour & exemple (14)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • search · string · optionnel
    Receipt number or order id. Does NOT match customer or product names
  • source · array · optionnel
    e.g. ["in-store"], ["woo-commerce"]
  • status · array · optionnel
    Final POS statuses: "completed", "refunded", "partial-refund", "parked". WooCommerce orders keep their own ("processing", "on-hold", "pending", "cancelled", "failed") — pass "other" to match every status outside the four Final POS ones
  • endDate · string · optionnel
    Only orders created at or before this ISO 8601 moment
  • outlets · array · optionnel
    Outlet ids. Combined with stations by OR
  • maxTotal · number · optionnel
    Maximum order total in MINOR units (cents)
  • minTotal · number · optionnel
    Minimum order total in MINOR units (cents), e.g. 50000 for $500
  • pageSize · integer · optionnel
    Orders per page, default 20
  • stations · array · optionnel
    Station ids. Combined with outlets by OR
  • startDate · string · optionnel
    Only orders created at or after this ISO 8601 moment
  • productIds · array · optionnel
    Product ids from get_products — matches orders containing them
  • customerIds · array · optionnel
    Customer ids from get_customers, not names
  • employeeIds · array · optionnel
    Employee ids — from get_employee_sales, not names

  Exemple d'appel

  {"name": "hub_get_orders", "arguments": {"page": 1, "search": "texte", "source": [], "status": [], "endDate": "texte", "outlets": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_outlets≈ 300 tokens

  Every point of sale (store, location, branch) the merchant has — the same list as Settings → Outlets. Answers 'how many stores do I have', 'what is the address of the King Street shop', 'what is that location’s phone number'. ALSO THE WAY TO TURN A STORE NAME INTO AN ID: the reports, inventory and station tools filter by outlet ID and never by name, so when the merchant says 'sales for King Street' or 'stock at the warehouse', call this FIRST and pass the id you find here. Returns every outlet in one call — the list is short, there is no paging and no server-side search, so match the name yourself. Deleted outlets are not returned. Outlets carry NO opening hours, timezone or currency: store hours are not stored anywhere on this platform and currency is a company-wide setting, so say that plainly instead of guessing. Per-outlet tax percentages are not here either — those belong to the tax tools.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_outlets", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_payment_methods_breakdown≈ 319 tokens

  How customers paid over a date range, netted of refunds — 'how much came in on card vs cash', 'what did processing fees cost me', 'how much hits my bank account'. Card and each custom processor also report their processing fees and the resulting deposit; cash has no fees. The same aggregation the Financial Summary settlement section uses, so the two always agree.

  Paramètres, retour & exemple (4)

  Paramètres

  • endDate · string · requis
    End of the window, ISO 8601. Inclusive of the day when a bare date is given
  • outlets · array · optionnel
    Outlet ids to restrict to. Omit for all outlets
  • stations · array · optionnel
    Station ids to restrict to. Omit for all stations
  • startDate · string · requis
    Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"

  Exemple d'appel

  {"name": "hub_get_payment_methods_breakdown", "arguments": {"endDate": "texte", "startDate": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_permissions≈ 222 tokens

  The catalogue of permissions a role can be given — every switch on the Roles screen, with the id create_role and update_role need. Call this to turn a request like 'let her see the reports' into the right permission id; match on the label and the permission path, and ask the merchant if two of them could both be meant. Permissions are granted exactly as named — there is no parent-grants-the-children cascade here — so pass every line the merchant actually needs. The list is the same for every merchant; it is not their current setup. For what a role currently grants, use get_roles.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_permissions", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_product_booking_setup≈ 175 tokens

  Which resources serve this bookable product. Use it to check a product is actually ready to take bookings before quoting availability — an empty resource list means every hold will be refused, however correct the rule set looks.

  Paramètres, retour & exemple (1)

  Paramètres

  • productId · string · requis
    Product id from get_products — not a name

  Exemple d'appel

  {"name": "hub_get_product_booking_setup", "arguments": {"productId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_product_options≈ 150 tokens

  List the variation axes the merchant already has — e.g. 'Size' with Small/Medium/Large. Call this BEFORE creating a product with variants and offer the existing axes instead of inventing new ones. Only call create_product_option when the merchant needs an axis that is not in this list.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_product_options", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_products≈ 365 tokens

  List products in the merchant's catalogue. Answers 'what products do I have', 'find the Coca-Cola product', 'how much is X'. Pass categoryIds to answer 'what is in the Drinks category' — take the ids from get_categories, which does not return products itself. LIMITATION — there is no sorting: results come back in catalogue order and cannot be ordered by price, name or date. So 'the most expensive products' CANNOT be answered from this tool, and you must NOT page through the whole catalogue trying. Say plainly that sorting is not supported yet, then offer what does work: search by a name or SKU, filter by category, or ask the merchant to narrow it down.

  Paramètres, retour & exemple (4)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • search · string · optionnel
    Filter by product name or SKU (partial match)
  • pageSize · integer · optionnel
    Results per page, default 20
  • categoryIds · array · optionnel
    Only products in these categories. Ids come from get_categories; a product matching any of them is returned

  Exemple d'appel

  {"name": "hub_get_products", "arguments": {"page": 1, "search": "texte", "pageSize": 1, "categoryIds": []}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_purchase_order≈ 335 tokens

  One purchase order in full: supplier, outlet, status, and every line — what was ORDERED and what has actually ARRIVED, per item, across each delivery. Answers 'what is on this order', 'what is still outstanding', 'did the price change from what we agreed'. Money appears twice on every writable field: the formatted one (CA$12.50) is for reading out to the merchant, the *Amount twin (12.50) is what update_purchase_order accepts back. The `ordered` block is the agreed order; each entry in `receipts` is one delivery booked against it, with its invoice number. Compare an item’s ordered quantity against the sum of its received quantities to see what is still owed — receiving more than ordered is allowed, so an overage is real, not an error. ALWAYS CALL THIS AFTER receive_purchase_order instead of retrying the receive: it is the way to confirm what was booked.

  Paramètres, retour & exemple (1)

  Paramètres

  • purchaseOrderId · string · requis
    Purchase order id from get_purchase_orders — not a PO number

  Exemple d'appel

  {"name": "hub_get_purchase_order", "arguments": {"purchaseOrderId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_purchase_orders≈ 654 tokens

  Stock the merchant has ordered from suppliers — the same list as Purchasing → Purchase Orders, and THE tool for any purchasing question over a period: 'what did I spend on stock last month', 'what is still on order', 'what have I ordered from this supplier', 'what is arriving this week'. Filter by status, supplier, outlet and a created-date range. READ totalCost CAREFULLY: it is what the order was placed FOR, not what was paid, and it sits on suggested and draft rows too — summing the whole list answers 'what have I proposed', not 'what did I spend'. For spend, filter status to ['sent','partially_received','fully_received']; for what a delivery actually cost, read the receipts block of get_purchase_order. Statuses, in order: suggested (auto-proposed by a reorder rule, not ordered), draft (being written), sent (with the supplier), partially_received (some arrived), fully_received (all in). "Open" means anything not fully_received. Cancelled orders are gone from this list entirely. The date range filters on when the order was CREATED, not when it was sent or received. Costs here are what the merchant pays suppliers — for sales and revenue use the report tools instead.

  Paramètres, retour & exemple (10)

  Paramètres

  • page · integer · optionnel
    1-based page, default 1
  • search · string · optionnel
    Match the PO number
  • sortBy · string · optionnel · createdAt | poNumber | expectedDate | status | sentAt
    Default createdAt
  • status · array · optionnel
    Keep only these statuses
  • endDate · string · optionnel
    ISO date — orders created up to and including this day
  • pageSize · integer · optionnel
    Rows per page, default 20
  • outletIds · array · optionnel
    Outlet ids from get_outlets
  • sortOrder · string · optionnel · asc | desc
    Default desc
  • startDate · string · optionnel
    ISO date — orders created on or after this day
  • supplierIds · array · optionnel
    Supplier ids from get_suppliers

  Exemple d'appel

  {"name": "hub_get_purchase_orders", "arguments": {"page": 1, "search": "texte", "sortBy": "createdAt", "status": [], "endDate": "texte", "pageSize": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_receive_progress≈ 276 tokens

  How far a delivery has got in being applied to stock. A large delivery is applied item by item in the background, so its order keeps its old status until the work finishes — this is the only place that shows the real progress. Call it with the receiptId that receive_purchase_order returned, or the one get_purchase_order reports as still being received. Read `failures` seriously: those items did NOT get their stock and say why (the item was deleted, the outlet no longer exists, the supplier link was removed). Everything else on the delivery still landed, so the fix is per item, not a re-receive of the whole thing.

  Paramètres, retour & exemple (1)

  Paramètres

  • receiptId · string · requis
    Receipt id from receive_purchase_order

  Exemple d'appel

  {"name": "hub_get_receive_progress", "arguments": {"receiptId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_refunds≈ 317 tokens

  Refunds recorded against orders, newest first: what was refunded, why, by whom, on which order and for which customer. Answers 'what did we refund lately', 'show the refunds on order 1042', 'who processed that refund'. Filter by order id, or search by the REFUND's own receipt number. LIMITATIONS: no date filter and no total count — for refunds in a date range use get_sales_breakdown (one row per refund) or get_financial_summary (refund totals). Refunds CANNOT be created here: they are taken on the POS terminal against the original payment. This tool only reads.

  Paramètres, retour & exemple (4)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • search · string · optionnel
    Search by the refund's receipt number
  • orderId · string · optionnel
    Only refunds against this order — id from get_orders
  • pageSize · integer · optionnel
    Refunds per page, default 20

  Exemple d'appel

  {"name": "hub_get_refunds", "arguments": {"page": 1, "search": "texte", "orderId": "texte", "pageSize": 1}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_reorder_suggestions≈ 265 tokens

  What the platform thinks should be reordered: rescans stock against the merchant's auto-reorder rules and returns the suggested orders it left behind, grouped by supplier and outlet. Answers 'what am I running low on', 'what should I order this week'. A suggestion is NOT an order — nothing has been sent and no supplier knows about it. Turn one into a real order with update_purchase_order (which accepts it as a draft) and then send_purchase_order. Only items with an auto-reorder rule can appear here, so an empty result usually means no rules are set rather than nothing being low — say that, and offer set_reorder_rule. The rescan is skipped and the stored suggestions returned when one ran moments ago; `rescanned: false` says so.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_reorder_suggestions", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_roles≈ 194 tokens

  The roles this merchant has defined and exactly what each one is allowed to do — Settings → Roles. Answers 'what can a cashier do', 'which roles exist', 'who is on the Manager role'. A role is the ONLY place permissions live: people do not carry their own. Read this before changing anything, and take permission ids from the granted list when revoking. Owners and organisation-level accounts hold no role and are never restricted by one — a role change cannot take anything away from them.

  Paramètres, retour & exemple (0)

  Exemple d'appel

  {"name": "hub_get_roles", "arguments": {}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_sales_breakdown≈ 442 tokens

  Order-by-order breakdown for a date range — the same rows as Reports → Sales Breakdown. One row per order AND per refund. Answers 'show me the orders from Saturday', 'which order had that big discount', 'how many refunds last month', 'sales per day'. The `totals` and `dailyTrend` in the reply cover the WHOLE date range, not just the returned page — quote them directly instead of adding up rows. For headline figures alone use get_financial_summary; this tool is for when the merchant wants to see the actual orders.

  Paramètres, retour & exemple (7)

  Paramètres

  • page · integer · optionnel
    Page number, default 1
  • endDate · string · requis
    End of the window, ISO 8601. Inclusive of the day when a bare date is given
  • outlets · array · optionnel
    Outlet ids to restrict to. Omit for all outlets
  • pageSize · integer · optionnel
    Rows per page, default 50
  • stations · array · optionnel
    Station ids to restrict to. Omit for all stations
  • timezone · string · optionnel
    IANA timezone for the daily grouping, e.g. "America/Toronto". Defaults to the server timezone
  • startDate · string · requis
    Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"

  Exemple d'appel

  {"name": "hub_get_sales_breakdown", "arguments": {"endDate": "texte", "startDate": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_session_report≈ 214 tokens

  The full End of Session report for ONE shift: sales, taxes, settlement, refunds, staff sales, tips and the cash drawer. Answers 'does the drawer balance', 'was the till short last night', 'what did that shift take'. Takes the session id from get_sessions, never a station or a person. The cash drawer section is what tells you over / short — report it plainly, and do not compute it yourself from the other sections.

  Paramètres, retour & exemple (1)

  Paramètres

  • sessionId · string · requis
    Session id from get_sessions

  Exemple d'appel

  {"name": "hub_get_session_report", "arguments": {"sessionId": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

• hub_get_sessions≈ 324 tokens

  Register sessions (shifts) opened and closed in a date range — the list behind Reports → End of Session. Answers 'what shifts ran yesterday', 'who closed the register last night', 'is a session still open'. Returns who opened and closed each one, the opening float and the declared closing amounts. A session with no closeTime is still open. For the full money report of one shift, pass its id to get_session_report.

  Paramètres, retour & exemple (4)

  Paramètres

  • endDate · string · requis
    End of the window, ISO 8601. Inclusive of the day when a bare date is given
  • outlets · array · optionnel
    Outlet ids to restrict to. Omit for all outlets
  • stations · array · optionnel
    Station ids to restrict to. Omit for all stations
  • startDate · string · requis
    Start of the window, ISO 8601, e.g. "2026-08-01" or "2026-08-01T00:00:00Z"

  Exemple d'appel

  {"name": "hub_get_sessions", "arguments": {"endDate": "texte", "startDate": "texte"}}

  Exemple de retour

  {"content": [{"type": "text", "text": "…"}]}

+ 57 autres outils (affichage limité à 120).

C'est votre serveur ?

Revendiquez-le sur l'espace créateur (preuve GitHub, domaine ou npm) pour afficher le badge « propriétaire vérifié » et lancer un pentest comportemental à la demande afin d'obtenir le badge « Vérifié ».

Créer un compte / revendiquer →

Source

https://ai.finalpos.com/mcp