Инструменты MCP

analytics_metrics read

The hub's analytics metrics: each one's id, name, unit and the dimensions it can be broken down by. Read it before analytics_query.

Роли hub · Право hub: report.read

Без входных данных.

analytics_query read

One query over the chain's sales and stock (spec ANALYTICS.md): metrics by up to 3 dimensions over local dates [from, to), optionally for some stores, groups or items. Money comes in minor units with the answer's currency.

Роли hub · Право hub: report.read

bonus_report read

Employee bonuses over [from, to) (RFC 3339 instants): per employee the lines credited to them, their revenue and the bonus fixed at each sale; at the hub by store, optionally for one store (spec REPORTS.md, Employee bonuses).

Роли store, hub · Право store: bonus.read; hub: bonus.read

floor_status read

The restaurant's floor: each area's tables with their open and billed checks (number, waiter, covers, state, total, when opened), the guest orders waiting and whether the license locks the table for new checks, as rows; tabs at the bar too. No QR tokens, no lines (spec RESTAURANT.md, The floor; LICENSE.md, The restaurant's three places).

Роли store · Право store: check.use

get_dashboard read

One of the hub's dashboards: its parameters and tiles (spec DASHBOARDS.md).

Роли hub · Право hub: report.read

get_item read

One item of the catalog by id: names, codes, kind, unit, group, taxes, barcodes and, in a store, its price.

Роли store, hub · Право store: item.read; hub: item.read

list_dashboards read

The hub's dashboards, the organization's and the ready-made ones.

Роли hub · Право hub: report.read

Без входных данных.

list_groups read

The catalog's item groups with their names and parents.

Роли store, hub · Право store: item.read; hub: item.read

Без входных данных.

list_proposals read

The changes you proposed and their state: pending until a person approves or refuses them in the app.

Роли store, hub · Право store: ; hub:

list_stores read

The chain's stores with their codes, names, currencies, time zones and their nodes' sync state.

Роли hub · Право hub: store.read

Без входных данных.

list_tags read

The catalog's tags with their names in every language.

Роли store, hub · Право store: item.read; hub: item.read

Без входных данных.

list_transfers read

Transfers of stock between the chain's stores with both documents (what was shipped and at what cost, what arrived, shortages with their reasons), by direction or state; at the hub for the chain or one store (spec STOCK.md, Transfers).

Роли store, hub · Право store: document.read; hub: document.read

loyalty_customer_lookup read

Find one loyalty customer by a card number or an E.164 phone number, exactly. The answer is masked: phone, e-mail and card numbers are never shown in full (spec LOYALTY.md, Customers). Give either card or phone.

Роли store, hub · Право store: customer.read; hub: customer.read

open_checks read

Open and billed restaurant checks as rows, oldest first: table or tab, waiter, covers, state, total and minutes open, without their lines (spec RESTAURANT.md, Checks).

Роли store · Право store: check.use

partner_report read

Partners over [from, to) (RFC 3339 instants): receipts with their codes, revenue, cost, margin, commission and the margin left after it; at the hub by store, optionally for one store (spec REPORTS.md, Partners).

Роли store, hub · Право store: report.read; hub: report.read

propose_dashboard write

Propose saving a dashboard document (spec DASHBOARDS.md) as the organization's; a person approves it in the console. The document is checked now: a bad one is refused with its path and reason.

Роли hub · Право hub: dashboard.manage

propose_item_names write

Propose new names of an item in some languages (two-letter codes; en is the default language); the other languages stay. A person approves it in the app.

Роли store, hub · Право store: item.edit; hub: item.edit

propose_prices write

Propose new retail prices in minor units. In a store: one price change document, posted when a person approves it. At the hub: each line names the store whose price changes. Give a short reason.

Роли store, hub · Право store: price.edit, document.edit, document.post; hub: price.edit

propose_purchase_order write

Propose a purchase order to a supplier, sent when a person approves it: lines of items and quantities in thousandths of the item's unit, an optional expected cost per unit and delivery date (spec STOCK.md, Purchase orders).

Роли store · Право store: document.edit, document.post, purchase.manage

propose_transfer write

Propose a transfer of stock to another store of the chain, shipped when a person approves it: lines of items and quantities in thousandths of the item's unit, a batch optionally named (spec STOCK.md, Transfers).

Роли store · Право store: document.edit, document.post, transfer.ship

propose_write_off write

Propose writing stock off (expired, damaged, lost) as one write-off document, posted when a person approves it. Quantities are in thousandths of the item's unit; a batch may be named.

Роли store · Право store: document.edit, document.post

purchase_orders_due read

Purchase orders that are sent or partly received, with what each line ordered, what arrived and what is still due, optionally for one supplier (spec STOCK.md, Purchase orders).

Роли store · Право store: document.read

rollout_status read

The chain's latest release rollout, or the one named: its release, state, waves and gate, and each store as a row with its wave, update state, gate status, versions and error (spec RELEASES.md, Rollouts). Read only: starting, pausing or rolling back a rollout is a person's in the console.

Роли hub · Право hub: release.read

sales_report read

The store's sales report over [from, to) (RFC 3339 instants) by day, employee, item, group or tender: receipts, refunds, gross, discounts, net, tax, revenue, cost, margin, tips (spec REPORTS.md).

Роли store · Право store: report.read

search_items read

Search the catalog by meaning in any language, and by name, SKU, PLU or barcode; optionally in one group or with one tag. Exact matches come first. Uses semantic search where the node has it (spec/SEARCH.md), the exact search otherwise. Answers up to limit items with their ids.

Роли store, hub · Право store: item.read; hub: item.read

stock read

The store's stock report: per item on hand, held, available, lots, the nearest expiry and the value at cost; for some items, one group, or only those below zero (spec REPORTS.md).

Роли store · Право store: report.read

stock_in_transit read

Stock on its way between the chain's stores: each line of a shipped, not yet received transfer with its quantity, cost and stores; at the hub for the chain or one store (spec STOCK.md, Transfers).

Роли store, hub · Право store: stock.read; hub: stock.read