Expand description
Messages and local IPC framing for the code-mode host boundary.
Protocol version 1 multiplexes session operations and delegate callbacks by request ID over one ordered connection. It defines no optional capabilities yet; capability names provide an extension point for later versions without weakening the v1 decoder.
Structs§
- Capability
- A named protocol feature advertised during connection negotiation.
- Capability
Set - Client
Hello - Delegate
Request Id - Correlates one host delegate request with the client’s response.
- Duplicate
Capability - Encoded
Frame - A serialized IPC frame that has already passed the payload size limit.
- Framed
Reader - Decodes JSON messages prefixed by a four-byte little-endian payload length.
- Framed
Writer - Encodes JSON messages with a four-byte little-endian payload length.
- Host
Hello - Invalid
Identifier - Protocol
Version - Request
Id - Correlates one client operation request with the host’s response.
- Session
Id - Identifies one logical code-mode session on a connection.
- Supported
Protocol Versions - Wire
Cell Id - A cell identifier with a wire representation owned by protocol V1.
- Wire
Execute Request - The complete execute request shape supported by protocol V1.
- Wire
Nested Tool Call - A nested tool invocation sent over the V1 host connection.
- Wire
Tool Definition - A V1 tool definition embedded in an execute request.
- Wire
Tool Name - The V1 wire representation of a tool’s stable name.
- Wire
Wait Request - The complete wait request shape supported by protocol V1.
Enums§
- Client
Hello Error - Client
ToHost - Messages sent from a client to the code-mode host.
- Delegate
Request - Delegate
Response - Handshake
Reject Reason - Explains why connection negotiation was rejected before any session opened.
- Host
Request - Host
Response - Host
ToClient - Messages sent from the code-mode host to a client.
- Invalid
Supported Protocol Versions - Wire
Content Item - One output item emitted by a V1 runtime response.
- Wire
Image Detail - Image detail values accepted in a V1 runtime response.
- Wire
Result - Wire
Runtime Response - Runtime output returned over the V1 host connection.
- Wire
Tool Kind - The tool invocation shape supported by protocol V1.
- Wire
Wait Outcome - Whether a waited-for cell remained live in protocol V1.
Constants§
- MAX_
FRAME_ BYTES - Maximum JSON payload size accepted for one IPC frame.