fayzfayz sdk
PTEN

← Plugin catalog

plugin-menu

Beta

@fayz-ai/plugin-menu

A menu is the product catalog of a food business — and it changes by the hour. plugin-menu is the management surface for that: items, categories, allergens, and modifiers, with sold-out toggles that take effect instantly. It's the foundation the orders flow reads from, so the two compose into a working restaurant.

Preview of plugin-menu as the customer sees it

Overview

Menu management: items, categories and modifiers, with availability control (available / sold out). It mounts the /menu page. It's a vertical plugin (scope: 'vertical'), normally paired with plugin-orders.

It packages no migrations. By default it runs on a mock provider and, for the Fayz platform, uses createFayzMenuProvider with configurable tables (categoriesTable, productsTable). The modifiers module ships enabled; deliveryPricing is opt-in. The stable channel already pins ^0.3.0.

For AI, it exposes listMenuItems and toggleMenuItemAvailability. Status beta / partial capability.

When to use it

  • Keep a menu with categories and modifiers.
  • Mark an item sold out in real time, including through AI.
  • Feed plugin-orders with the item catalog.

Specs

Package@fayz-ai/plugin-menu
Version0.3.0
Statusbeta
CapabilityPartial capability
Stable channel^0.3.0
Migrationsnone
FactorycreateMenuPlugin()

Data model

No tables of its own — this plugin uses the core / archetype library (same rule: tenant_id + RLS). See Data model.

AI tools

idmodedescription
menu.list-itemsreadLists menu items, optionally filtered by category or status.
menu.toggle-availabilitypersistMarks a menu item as available or sold out.

Tools an agent can call against your app. Your app as a data layer.

Integrations

No hosted connector — external providers come in via the connector spine. integrations catalog.

Use this page as a skill. .md of this page is the agent-consumable contract — data model, tools and integrations in a single file an AI reads directly. Preview fayz skill add plugin-menu is coming soon to install this as a skill. See Skills.

Integrate

Add the plugin to surfaces.admin.plugins in your app's app.manifest.json and run the doctor to validate:

{
  "surfaces": {
    "admin": {
      "plugins": [
        { "id": "menu", "enabled": true }
      ]
    }
  }
}
npx fayz doctor

fayz doctor checks the manifest against the SDK catalog. See Configuration.