Interface: AvailableAdapter

Makaio Framework / services-core/settings / AvailableAdapter

Interface: AvailableAdapter

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:20

Adapter metadata discovered at boot and consumed by settings/UI layers.

This contract is shared across framework runtime code and host/application consumers, so it lives in the framework-owned @makaio/services-core package rather than a host-owned service package.

Properties

clientId?

optional clientId?: string

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:32

Stable client identifier that this adapter belongs to (e.g. 'claude-code').

description?

optional description?: string

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:26

Short description for tooltips/selection UI.

displayName

displayName: string

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:24

Human-readable display name for UI.

helpLinks?

optional helpLinks?: readonly HelpLink[]

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:28

Help links for documentation.

instructions?

optional instructions?: string

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:30

Setup instructions in Markdown format.

name

name: string

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:22

Adapter driver name (e.g., 'claude-code', 'openai-node').

protocol?

optional protocol?: "anthropic" | "openai"

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:34

Wire protocol this adapter speaks (e.g., 'anthropic', 'openai').

providerDefinitionIds?

optional providerDefinitionIds?: readonly string[]

Defined in: ../../../packages/services/core/src/settings/available-adapter.ts:41

Provider definition IDs this adapter can run against.

This is the stable compatibility seam for onboarding and binding suggestions. It avoids guessing from wire protocol alone.