Tool Reference

Dates are business days YYYY-MM-DD (Asia/Baghdad); an omitted date means today. Amounts are in the branch currency returned by get_business_context — never convert them.

Start here

Tool	Answers	Parameters
get_business_context	Bound branch, currency, today's business date, grounding rules	—

Facts (read-only)

Tool	Answers	Parameters
get_sales_summary	Sales over a window	days (1–120, default 14)
get_prime_cost	Prime cost: COGS + labour vs net sales	from, to
get_daily_cogs	Cost of goods sold per day	from, to
get_cost_per_serving	Cost per serving by product	channel (default takeaway), incompleteOnly, page
get_inventory_snapshot	Stock on hand at one location	location name or kind (warehouse, kitchen, …)
get_item_consumption	Items used over a range	from, to
get_loss_summary	Loss over a range	from, to, groupBy (day · shift · material · severity), shift
get_shrinkage_report	Warehouse vs kitchen shrinkage	from, to
get_avt_facts	Actual vs theoretical usage for one day and one book	businessDate, location (kitchen · warehouse)
get_owner_leakage_facts	The owner's leakage facts for one day	businessDate
get_price_variance	Purchase price variance, top movers	from, to, topN
get_purchases_summary	Purchases per day and supplier debt	days (1–365, default 30)
get_reorder_suggestions	What to reorder, from consumption velocity	history window in days
get_payroll_summary	Payroll and headcount	—
get_sales_integrity	Per-cashier discount and void outliers	from, to
get_risk_signals	Current risk signals	limit (1–50, default 10)

Loss is the sum of shortages — a surplus never cancels one — and the warehouse and kitchen books are never netted.

Tables (read-only)

Tool	Does
list_tables	Lists the readable tables and their columns
read_table	Reads rows with filters, sort (asc · desc) and paging
get_record	One row by id
count_table	Counts rows matching filters
aggregate_table	Sum / average / min / max / count, grouped — computed by the database

Sensitive tables (credentials, secrets, audit internals) are never readable.

Actions (write)

Tool	Does
list_actions	Console actions this credential may call — filter by module, search, includeReads
call_action	Performs one: method, path (/api/v1/console/…), body, idempotencyKey

See Actions.