scv_protocol/
lib.rs

1//! Dependency-light wire types shared by SCV clients and the server.
2//!
3//! [`ClientMessage`] is everything a client sends and [`ServerEvent`]
4//! everything the server answers, one JSON object per line ([`FrameDecoder`]
5//! bounds each line). Additive fields, and new values of the enums that
6//! parse unknown values as `Unknown` ([`ErrorCode`], [`ToolErrorKind`],
7//! [`ServerEvent`]), keep [`PROTOCOL_VERSION`]; a breaking change bumps it.
8//! This crate holds no runtime policy and does no I/O.
9
10#![forbid(unsafe_code)]
11#![warn(missing_docs)]
12
13mod attachment;
14mod background;
15mod client;
16mod daemon;
17mod error;
18mod frame;
19mod server;
20
21use serde::{Deserialize, Serialize};
22
23pub use attachment::{Attachment, ReplyAttachment, reply_attachment};
24pub use background::{
25    JobChange, JobReport, JobStatus, OriginKind, TurnOrigin, describe_reports, job_agent,
26};
27pub use client::{ChatLog, ClientMessage};
28pub use daemon::{
29    ComponentHealth, ComponentState, ConfirmInfo, ConfirmState, DEFAULT_CONFIRM_SECONDS,
30    DaemonCommand, DaemonStatus, DelegationInfo, DelegationSummary, MAX_CONFIRM_SECONDS,
31    MailAction, MailCounts, ProjectEvent, ProjectPhase, ProjectReport, ProjectResponse, ProjectRun,
32    ProjectRunStatus, ProjectStatus, ProjectSummary, ProjectTask, ProjectTaskStatus, Purpose,
33    RemoteTools, RestartInfo, Senders,
34};
35pub use error::{ErrorCode, ToolErrorKind};
36pub use frame::{Frame, FrameDecoder, Overflow, Step, encode_frame, trim_line};
37pub use server::ServerEvent;
38
39/// The protocol version. Client and server must speak the same one.
40pub const PROTOCOL_VERSION: u32 = 3;
41
42/// The longest `session.start` channel name.
43pub const MAX_CHANNEL_NAME_BYTES: usize = 32;
44/// Longest `session.start` `system_prompt`, in bytes.
45pub const MAX_SYSTEM_PROMPT_BYTES: usize = 16 * 1024;
46/// Files one `turn.start` may attach.
47pub const MAX_TURN_ATTACHMENTS: usize = 16;
48/// The tool a chat session's model calls to send a file with its reply.
49pub const CHAT_ATTACH_TOOL: &str = "chat_attach";
50
51/// A prompt waiting for the running turn to finish.
52#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
53pub struct QueueEntry {
54    /// Stable ID of this queued prompt.
55    pub queue_id: String,
56    /// Bumped on every change; edits must name the current revision.
57    pub revision: u64,
58    /// The prompt text.
59    pub prompt: String,
60    /// The client that queued it.
61    pub submitter: String,
62    /// Files the queued `turn.start` attached; they run with its prompt.
63    #[serde(default, skip_serializing_if = "Vec::is_empty")]
64    pub attachments: Vec<Attachment>,
65}
66
67/// A client's or server's name and version, exchanged at `initialize`.
68#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
69pub struct PeerInfo {
70    /// Program name, such as `scv-tui`.
71    pub name: String,
72    /// Its release.
73    pub version: String,
74}
75
76/// Tokens a turn used, as the provider reported them.
77#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
78pub struct Usage {
79    /// Prompt tokens, when reported.
80    #[serde(skip_serializing_if = "Option::is_none")]
81    pub input_tokens: Option<u64>,
82    /// Answer tokens, when reported.
83    #[serde(skip_serializing_if = "Option::is_none")]
84    pub output_tokens: Option<u64>,
85}
86
87#[cfg(test)]
88mod tests;
scv_protocol/lib.rs

scv_protocol/
lib.rs
