Skip to content

00-index.md

Latest commit

 

History

History
28 lines (22 loc) · 1.45 KB

00-index.md

File metadata and controls

28 lines (22 loc) · 1.45 KB

DreamGraph Plugin Reference Manual

Audience: Plugin authors and host implementors needing strict, normative tables. Engine baseline: v12.1.0 "Living DreamGraph". Companion: see the Plugin Developer Guide for task-oriented walkthroughs.

This reference is the source of truth. Where the guide and the reference disagree, the reference wins. Where the reference and the SDK source disagree, the SDK source wins (and a doc bug should be filed).

Sections

  1. Manifest schema — every field, every constraint.
  2. Capabilities — the locked vocabulary.
  3. Effects — observable cognitive effects.
  4. Reject reasons — every plugin.output.rejected.reason.
  5. PluginContext API — TypeScript surface.
  6. Events — stable kinds, experimental kinds, payload schemas.
  7. CLI — dg plugin subcommands.
  8. Host configuration — env vars and instance.json.
  9. Telemetry events — the plugin.* stream.
  10. Architect tabs — declarative tab contract, plan state, routes, lifecycle, and telemetry.

Conventions

  • MUST / MUST NOT / SHOULD are used in the RFC 2119 sense.
  • Tables are exhaustive unless explicitly marked "non-exhaustive".
  • Source-code references link to the canonical file at the repo root.