greenlight.yml

Reference

Every Greenlight-managed repository has a greenlight.yml at the root. It carries identity and documentation in git; agents configure resources, env-var values, and integration grants through MCP tools.

The agent reads app_id from this file on a fresh clone, then calls getApp for everything else.

A minimal example

app_id: app_k9x2m3p
slug: expense-tracker
owner: usr_jane_doe

docs:
  summary: Reimbursement tracker for finance ops.
  purpose: Replace the shared spreadsheet finance currently uses.
  architecture: |
    Single Node.js web service. Postgres for records.
    SSO-gated; UI is shadcn + Tailwind.

registerApp seeds this file plus a Dockerfile, .gitignore, and the Greenlight pipeline workflow. The agent adds resources with greenlight.resource.add and configuration with greenlight.env.set.

Schema

Top-level fields

Field	Required	Description
app_id	yes	Greenlight app identifier; written at registration.
slug	no	URL-safe identifier; informational after registration.
owner	no	Owning user id.
docs	yes	Metadata that seeds Knowledge (see below).

Configured via MCP

These are configured through MCP tools and stored as server-side desired state:

• resources (Postgres, blob) — greenlight.resource.add
• env secret values — greenlight.env.set
• integrations grants — greenlight.requestPermissions
• runtime / build — the repo’s Dockerfile and source code

Declarative manifest sections in git may ship in a future release; configuration today lives in the control plane.

docs

The docs block seeds the app’s Knowledge entries on first registration:

• docs.summary and docs.purpose seed the app-scope architecture entry.
• The repo’s README.md (if present) seeds the runbook entry.
• docs.architecture is concatenated into the seed.

After seeding, entries evolve in the database. Changes to greenlight.yml docs.* do not auto-overwrite live Knowledge — regenerate explicitly from the dashboard if needed.

Tip

Keep docs.* short. Long-form architecture belongs in Knowledge after registration.

Policy check

greenlight.yml is validated on pipeline runs for required identity and docs fields. Infrastructure is not validated from this file.

Next

App environment variables Env vars, reserved names, and local pull policy.

MCP tools resource.add, env.set, registerApp, and the rest of the catalog.

Knowledge How docs.* seeds the app's first Knowledge entries.