Interface: AdapterManifest

Makaio Framework / contracts/extension / AdapterManifest

Interface: AdapterManifest

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:132

Describes an adapter contributed by an extension.

Serializable metadata for discovery, filtering, and inspection. The executable runtime source is MakaioExtension.adapters[].manifest, paired with its adapter definition; descriptor-level contributions do not register adapters by themselves.

The protocols field is required because an adapter must declare at least which wire protocol(s) it implements; all other fields are optional metadata.

Properties

clients?

readonly optional clients?: readonly AdapterClientRef[]

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:151

Client packages this adapter depends on.

Each entry declares a required client by ID and semver range. Executable adapter processors verify that referenced clients are installed and compatible before activating the adapter.

defaultProvider?

readonly optional defaultProvider?: string

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:166

Identifier of the provider this adapter defaults to.

When omitted, the runtime or user selects the provider. Must reference a registered provider definition id.

description?

readonly optional description?: string

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:143

Short description of what this adapter does.

displayName?

readonly optional displayName?: string

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:141

Human-readable display name shown in the UI (e.g., 'Claude Code').

name

readonly name: string

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:139

Stable machine identifier for this adapter contribution (e.g., 'claude-code').

Used as the key in adapter registries. Must be unique within the declaring extension.

protocols

readonly protocols: readonly ProtocolRef[]

Defined in: ../../../packages/contracts/src/extension/contribution-manifest.ts:159

Wire protocol(s) this adapter implements.

At least one entry is required. Each entry is either a plain ProtocolId string or a ProtocolRef config object with per-protocol overrides.