/iblai-vibe-org-metadata

Mirrored from iblai/vibe · skills/organizations/iblai-vibe-org-metadata/SKILL.md. This page is generated — edit it in the repository, not here.

First time here? If iblai.env has no ARCHITECTURE=, run /iblai-vibe-start first (four questions; two minutes) — it decides single-org / multi-org / headless and who signs in, and every skill reads the answer.

Every organization has one public metadata object. The ibl.ai OS keeps its own settings there (default agent, help center URL, chat width, feature toggles, the sign-in page branding), and your app can keep its own keys beside them. It is how an app remembers org-level choices — which agent the home page uses, what the app is called, a welcome message — without a database.

Common setup (brand, conventions, env files, verification): see docs/skill-setup.md.

The two rules

1. PUT replaces the whole object. PUT …/orgs/{org}/metadata/ with only your keys silently deletes overall_default_mentor, help_center_url, auth_web_mentorai, every toggle — and breaks the OS for that org. The helper in this skill always GET → merge → PUT, re-reading right before it writes.
2. It is a public read. GET …/orgs/{org}/metadata/ needs no auth. Never store a secret, a token, a price you do not want visible, or a person's data there. Ids and display strings only.

Writes need an org admin; the platform answers 403 otherwise.

What you get

• useOrgSettings<T>() in lib/iblai/metadata.ts (installed by /iblai-vibe-user-metadata; the two share the file) — typed read/merge under metadata.apps.<slug>, GET-merge-PUT on write.
• OrgSettingsForm — an admin card (app name, welcome message, support URL) for /admin/organization.
• vibe-starter's /setup stores defaultAgentId, appName, and setupCompletedAt here; the home page reads defaultAgentId when NEXT_PUBLIC_DEFAULT_AGENT_ID is empty.

Where branding lives instead

Step 1: Install

useOrgSettings ships in lib/iblai/metadata.ts — run /iblai-vibe-user-metadata Step 2 if the app does not have it. Then render assets/org-settings.tsx.j2 → components/settings/org-settings.tsx (needs shadcn card, input, label).

Step 2: Use it

"use client";

import { useOrgSettings } from "@/lib/iblai/metadata";

type MyOrgSettings = { welcomeMessage?: string; supportUrl?: string };

export function Welcome() {
  const { settings } = useOrgSettings<MyOrgSettings>({ welcomeMessage: "", supportUrl: "" });
  return settings.welcomeMessage ? <p>{settings.welcomeMessage}</p> : null;
}

Admins save with update({ welcomeMessage: "…" }); every member reads it. Mount <OrgSettingsForm /> on an admin-only page (/iblai-vibe-admin).

Step 3: Add your own keys

Extend OrgSettings in lib/iblai/metadata.ts and the form. Keep values JSON-serializable and small; this object is fetched by every ibl.ai front end that opens the org.

Verify

1. pnpm typecheck && pnpm test.
2. Before and after saving, compare curl -s https://api.$DOMAIN/dm/api/core/orgs/$PLATFORM/metadata/ | python3 -m json.tool — only metadata.apps.<slug> changed; overall_default_mentor and the auth_web_* blocks are intact.
3. A non-admin's save fails with a toast, not a crash.

Platform data

REST reference: iblai-api-org.

Related skills

• /iblai-vibe-user-metadata — per-user twin
• /iblai-vibe-account, /iblai-vibe-admin — where to mount the form
• /iblai-vibe-auth — the sign-in page branding keys