Documentation Sync

This page is auto-generated from plugins/adapters/milky/README.md. Please edit the in-package README and then run pnpm sync:adapter-docs.

@zhin.js/adapter-milky

Zhin.js Milky protocol adapter (Plugin Runtime). Default is forward WebSocket client (connection: ws); also supports Webhook, reverse WS (via httpHostToken), and SSE (HTTP GET /event, parsing text/event-stream via fetch).

Features

• Milky protocol compatible (events + HTTP API)
• Convention-based defineAdapter / definePlugin (no usePlugin needed)
• Forward WebSocket (connection: ws): the application connects to the protocol endpoint ws(s)://baseUrl/event
• access_token authentication (Bearer + query)
• Inbound via Endpoint.emit(...); outbound send({ conversation, payload }) -> HTTP send_*_message

Installation

pnpm add @zhin.js/adapter-milky

Plugin Runtime

• @zhin.js/adapter — convention-based adapters/milky/index.ts (defineAdapter)
• @zhin.js/core — Endpoint.emit(...) inbound, outboundMessageToken outbound
• zhin.js — plugin.ts (definePlugin)
• Configuration goes to plugins.<instanceKey> via the plugin's schema.json

AdapterIndex merges instance defaults with each endpoints[] override. The protocol layer receives one expanded endpoint configuration and does not inspect nested endpoint rows or infer endpoint identity from process environment variables.

Inbound: gateway.receive({ conversation, message, content, sender, metadata }) (kind: 'private'|'group'; temp sessions carry the group in parent) Outbound: send({ conversation, payload }) -> HTTP send_private_message / send_group_message (payload is rendered by gateway/core; no segment-mapper)

Prerequisites

1. Start a compatible Milky implementation and record its HTTP API and event endpoints.
2. Zhin must reach the implementation for WS/SSE; the implementation must reach Zhin for Webhook/reverse WS.
3. Configure the same access_token on both sides. Never expose an unauthenticated production endpoint.

Minimal Configuration

# zhin.config.yml (Plugin Runtime)
plugins:
  milky:
    connection: ws
    reconnect_interval: 5000
    heartbeat_interval: 30000
    endpoints:
      - id: milky-bot
        baseUrl: "http://127.0.0.1:8080"
        access_token: "${MILKY_ACCESS_TOKEN}"

The root plugin zhin.plugins (or project graph) must reference @zhin.js/adapter-milky (instanceKey: milky).

Connection Modes

connection	Status
ws	Implemented (recommended)
sse	HTTP GET /event (Accept: text/event-stream)
wss	Implemented: reverse WS (httpHostToken)

Authentication

• Bearer: Authorization: Bearer <access_token>
• Forward WS attaches request headers during Upgrade and includes access_token in the URL query
• HTTP API uses the same Header / query authentication

Message ID

{message_scene}:{peer_id}:{message_seq} (e.g., group:123456:10001).

AI Tools

Category	Path
Permit vocabulary	PERMITS.md
Skill documentation	skills/milky/SKILL.md

Documentation Links

• Milky Quick Start
• Milky Communication
• Adapters overview

Troubleshooting

Symptom	Check
WS/SSE has no events	baseUrl, connection mode, and implementation event service
401 or handshake failure	Matching access_token in Bearer/query and the implementation
Webhook/WSS cannot connect	HTTP Host, network reachability, and callback path
Receives but cannot send	HTTP API and supported send actions

License

MIT License