fayzfayz sdk
PTEN

← Plugin catalog

plugin-admin

Preview

@fayz-ai/plugin-admin

Every SaaS/admin-template app already resolves a shell config — sidebar or topbar layout, rail or tabs for module navigation, a mobile header treatment, whether org/branding settings are shown — from FayzAppConfig (src/config/app.tsx / theme.ts) at build time. Today an operator can't see any of that from the Panel; changing it means hand-editing config files and redeploying. plugin-admin adds an…

Preview of plugin-admin as the customer sees it
Full documentation is coming. For now, this page summarizes what the SDK catalog knows about the plugin.

Specs

Package@fayz-ai/plugin-admin
Version0.1.0
Statuspreview
CapabilityPartial capability
Stable channelnot published yet
Migrationsnone
FactorycreateAdminPlugin()

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
admin.get-shell-settingsreadReturns the app shell configuration: layout variant, module nav style, mobile header treatment, and whether org/branding settings are shown.

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-admin 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": "admin", "enabled": true }
      ]
    }
  }
}
npx fayz doctor

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