Plugin Contracts

Plugin contracts define the metadata and compatibility information Atlas exposes for integration-aware consumers.

Plugin Metadata Model

flowchart LR
    Version[Version endpoint] --> Plugin[Plugin metadata]
    Plugin --> Consumers[Umbrella or integration consumers]

This metadata model shows the integration-facing surface clearly. Plugin identity exists so umbrella tools and other consumers can reason about Atlas compatibility without reading source code.

Contract Focus

flowchart TD
    PluginContract[Plugin contract] --> Name[Name]
    PluginContract --> VersionField[Version]
    PluginContract --> Compatibility[Compatible umbrella range]
    PluginContract --> BuildHash[Build hash]

This focus diagram lists the contract fields integrators care about most when deciding whether a plugin instance is compatible and identifiable.

Main Promise

Atlas should expose plugin identity and compatibility metadata in a form that external integrators can reason about without reading internal source code.

Purpose

This page defines the Atlas contract expectations for plugin contracts. Use it when you need the explicit compatibility promise rather than a workflow narrative.

Stability

This page is part of the checked-in contract surface. Changes here should stay aligned with tests, generated artifacts, and release evidence.