Skip to content

Type Alias: ProtocolRef

Makaio Framework


Makaio Framework / contracts/extension / ProtocolRef

ProtocolRef = ProtocolId | { readonly [K in ProtocolId]?: ProtocolConfig }

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

Reference to a supported wire protocol, with optional per-protocol config.

  • Simple string — use the protocol with default settings: 'anthropic'.
  • Config object — declare one or more protocols with overrides: { anthropic: { endpoint: 'https://custom.host/v1' } }.

Both forms are valid in the protocols array on AdapterManifest.

"protocols": ["anthropic", "openai"]
"protocols": [{ "anthropic": { "endpoint": "https://custom.host/v1" } }]
  • ProtocolRef
    • ProtocolId | { readonly [K in ProtocolId]?: ProtocolConfig }
      • ProtocolId
        • z.infer<typeof ProtocolIdSchema>
          • typeof ProtocolIdSchema
      • { readonly [K in ProtocolId]?: ProtocolConfig }
type ProtocolRef = {
toString: (() => string) | (() => string);
valueOf: (() => string) | (() => Object);
};