Skip to content

adapters.md

Latest commit

 

History

History
68 lines (53 loc) · 2.7 KB

adapters.md

File metadata and controls

68 lines (53 loc) · 2.7 KB

Adapters

Adapters convert external protocol input into the same SDK runtime operations. They are transport shells, not separate memory runtimes.

For protocol-specific routes, frames, topics, tools, and bridge messages, see Deployment Guide. This document defines the shared adapter contract.

Shared Chain

All protocol deployments should follow this chain:

transport bytes -> adapter command -> bm-entry -> bm-adapter -> MemoryRuntime -> adapter response

bm-entry opens the store and runtime, normalizes identity/scope/auth/source/idempotency data, then dispatches an AdapterCommand through bm-adapter.

Entry Runtime Shape

use bm_entry::{
    EntryAuthConfig, EntryIdentity, EntryIdempotencyConfig, EntryRuntime, EntryRuntimeConfig,
    EntryScope, EntryStoreConfig, EntryTransportConfig,
};
use bm_sdk::{
    MemoryCapabilityPolicy, MemoryPrivacyPolicy, ProfileId, StoreBackendKind,
};

let mut capability = MemoryCapabilityPolicy::strict_profile();
capability.communication_adapter_enabled = true;

let entry = EntryRuntime::open(EntryRuntimeConfig {
    profile: ProfileId::ServerLinuxMemoryGateway,
    identity: EntryIdentity {
        agent_id: "gateway-agent".to_string(),
        owner_id: "owner-default".to_string(),
    },
    scope: EntryScope {
        channel: "gateway".to_string(),
        chat_id: "chat-1".to_string(),
    },
    store: EntryStoreConfig {
        backend: StoreBackendKind::InMemory,
        data_path: None,
        fsync: false,
    },
    transports: EntryTransportConfig::all_enabled(),
    auth: EntryAuthConfig::disabled_for_local(),
    idempotency: EntryIdempotencyConfig { max_keys: 128 },
    privacy: MemoryPrivacyPolicy::standard_private_boundary(),
    capability,
})?;

Transport Crates

Transport Crate Current interface
CLI bm-cli Local memory commands and platform capability snapshots.
HTTP bm-http Request decoding, runtime shell, and standard-library listener backend.
WebSocket bm-wss Command frames, subscriptions, budgets, and WebSocket backend.
MCP bm-mcp Stdio JSON-RPC tool-call bridge.
A2A bm-a2a HTTP bridge for peer memory messages.

Transport helpers use the shared JSON adapter decoder for declared memory operations. Treat AdapterCommand as the shared semantic contract, and treat each transport crate's route/frame/tool/message catalog as the executable protocol surface for that crate.

Security Boundary

AdapterAuthContext and EntryAuthConfig represent authentication decisions at the entry layer. They do not replace SDK privacy policy or profile capability checks. Adapter visibility must still come from the runtime capability catalog.