The manifest

Every app has a manifest at .brydio/app.json. It names the app, its screens, the records it keeps, where it may appear, and every grant it asks for. @brydio/manifest exports appManifestSchema, its TypeScript types, and defineManifest(). brydio validate and Brydio use the same rules.

This page is generated by bun run docs:manifest. Its field list comes from the Zod schemas, its limits come from the exported constants, and its worked example is the checked-in Issues manifest. Do not edit it by hand.

Issues, as a complete example

This is packages/manifest/examples/issues.json, the proposal app used to exercise project and workspace placements, two collections, generated tools, two screens, collection grants, tool grants, and host grants.

{
  "name": "issues",
  "version": "0.1.0",
  "displayName": "Issues",
  "placements": [
    { "kind": "project-tab", "screen": "board", "label": "Issues", "icon": "kanban" },
    { "kind": "project-sidebar", "screen": "board", "label": "Issues", "icon": "kanban" },
    { "kind": "workspace-sidebar", "screen": "board", "label": "Issues", "icon": "kanban" }
  ],
  "data": {
    "issues": {
      "schema": {
        "title": "string",
        "status": ["todo", "doing", "done"],
        "assignee": "member?",
        "labels": "string[]",
        "body": "text?",
        "project": "project?"
      },
      "search": ["title", "body"],
      "label": "issue"
    },
    "labels": {
      "schema": { "name": "string", "colour": "token" },
      "label": "label"
    }
  },
  "tools": { "generated": true, "custom": [] },
  "screens": {
    "board": { "entry": "screens/board.js" },
    "issue": { "entry": "screens/issue.js" }
  },
  "grants": { "tools": ["*"], "collections": ["*"], "host": ["navigate", "message"] }
}

Top-level fields

Unknown top-level fields are rejected. The sections below expand the fields that have their own nested grammar.

Placements and screens

Each placements entry has a kind, a screen, and optional label and icon text. kind is project-tab, project-sidebar, or workspace-sidebar. screen must name a key in screens. Each screen has one entry, a relative .js or .mjs path inside the built bundle.

Collections and schema types

Each key in data is a collection name. A collection has a required schema, an optional singular label used in generated tool names, and an optional search list. Search fields must use string, text, or string[].

Add ? to a named type to make the field optional, such as member?. A field may also use { "type": ..., "optional": true, "default": ..., "labels": ... }`. Only optional choices and booleans may have defaults. Choice labels are 1 to 60 characters and may name only declared values.

Tools

tools.generated defaults to true. Each collection then gets create, update, get, list, search, delete, and batch tools. tools.custom may hold at most 20 handlers. A custom tool has a lower-case name, a description, a built handler path, and optional input, write, and collection. Its input fields use the same schema types as collection fields. A custom tool that writes must set write: true, which makes Brydio ask the person before it runs.

Grants

grants.tools names generated or custom tools, a collection noun, or *. grants.collections names collections or *. grants.host may contain:

• navigate
• message
• members
• projects
• model

A named connection grant is connection:<name>. * never grants a connection. A collection the app keeps must appear in grants.collections, and a custom tool must appear in grants.tools unless that list has *.

Migrations

When a published version changes a collection schema, migrations explains how records from earlier versions become readable by the new one. Each entry has the target version and 1 to 100 steps. Keep every migration in order so a workspace several versions behind can run each one.

Limits

The generator reads these values from FIELD_LIMITS and DOCUMENT_LIMITS. The manifest validator and the fake host use the same exports.

The full validation list, with every problem code and refusal sentence, is in the publish checklist.