@superinstance/bottle-protocol

@superinstance/bottle-protocol

Agent messaging protocol: Bottle messages, TidePool BBS, and Mailbox inbox/outbox.

Zero dependencies. Works in browser and Node.js.

Install

npm install @superinstance/bottle-protocol

Quick Start

const { Bottle, BottleType, Priority, TidePool, Mailbox } = require('@superinstance/bottle-protocol');

// Create a message
const msg = new Bottle({
  sender: 'agent-1',
  recipient: 'agent-2',
  content: 'Hello from the fleet!',
  bottleType: BottleType.DIRECT,
  priority: Priority.HIGH,
  tags: ['greeting']
});

// TidePool — BBS-style message board
const pool = new TidePool({ name: 'fleet-board' });
pool.drop(msg);
const messages = pool.collect('agent-2');

// Mailbox — personal inbox with read tracking
const box = new Mailbox({ agentId: 'agent-2' });
box.deliver(msg);
console.log(box.unreadCount); // 1
box.readAll();

API

Bottle

Agent message container with ID, TTL, priority, and tags.

TidePool

BBS-style message board where agents drop and collect bottles.

Mailbox

Personal inbox with read/star tracking.

Enums

• BottleType: DIRECT, BROADCAST, CHANNEL, REQUEST, RESPONSE, ALERT, HEARTBEAT
• Priority: LOW, NORMAL, HIGH, URGENT

License

MIT © Cocapn