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 review;
20mod server;
21mod workbench;
22
23use serde::{Deserialize, Serialize};
24
25pub use attachment::{Attachment, ReplyAttachment, reply_attachment};
26pub use background::{
27    JobChange, JobReport, JobStatus, OriginKind, TurnOrigin, describe_reports, job_agent,
28};
29pub use client::{ChatLog, ClientMessage};
30pub use daemon::{
31    ComponentHealth, ComponentState, ConfirmInfo, ConfirmState, DEFAULT_CONFIRM_SECONDS,
32    DaemonCommand, DaemonStatus, DelegationInfo, DelegationSummary, MAX_CONFIRM_SECONDS,
33    MailAction, MailCounts, ProjectEvent, ProjectPhase, ProjectReport, ProjectResponse, ProjectRun,
34    ProjectRunStatus, ProjectStatus, ProjectSummary, ProjectTask, ProjectTaskStatus, Purpose,
35    RemoteTools, RestartInfo, Senders,
36};
37pub use error::{ErrorCode, ToolErrorKind};
38pub use frame::{Frame, FrameDecoder, Overflow, Step, encode_frame, trim_line};
39pub use review::{
40    JobOutcome, LandMode, LandingEvidence, LandingStatus, LandingSummary, OpenFinding, Refusal,
41    ReviewOutcome, ReviewSummary, ReviewerResult, TriedReviewer, describe_outcome, outcome_notice,
42};
43pub use server::ServerEvent;
44pub use workbench::{
45    AgentState, JobOrigin, RestorableSession, RestoredQueue, RunEvent, RunEventKind, RunLogPage,
46    SendMode, WorkbenchApproval, WorkbenchJob, WorkbenchRun, WorkbenchSession, WorkbenchSnapshot,
47    WorktreeInfo, WorktreeRef,
48};
49
50/// The protocol version. Client and server must speak the same one.
51pub const PROTOCOL_VERSION: u32 = 3;
52
53/// The longest `session.start` channel name.
54pub const MAX_CHANNEL_NAME_BYTES: usize = 32;
55/// Longest `session.start` `system_prompt`, in bytes.
56pub const MAX_SYSTEM_PROMPT_BYTES: usize = 16 * 1024;
57/// Files one `turn.start` may attach.
58pub const MAX_TURN_ATTACHMENTS: usize = 16;
59/// The tool a chat session's model calls to send a file with its reply.
60pub const CHAT_ATTACH_TOOL: &str = "chat_attach";
61
62/// A prompt waiting for the running turn to finish.
63#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
64pub struct QueueEntry {
65    /// Stable ID of this queued prompt.
66    pub queue_id: String,
67    /// Bumped on every change; edits must name the current revision.
68    pub revision: u64,
69    /// The prompt text.
70    pub prompt: String,
71    /// The client that queued it.
72    pub submitter: String,
73    /// Files the queued `turn.start` attached; they run with its prompt.
74    #[serde(default, skip_serializing_if = "Vec::is_empty")]
75    pub attachments: Vec<Attachment>,
76}
77
78/// A client's or server's name and version, exchanged at `initialize`.
79#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
80pub struct PeerInfo {
81    /// Program name, such as `scv-tui`.
82    pub name: String,
83    /// Its release.
84    pub version: String,
85}
86
87/// Tokens a turn used, as the provider reported them.
88#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, Default)]
89pub struct Usage {
90    /// Prompt tokens, when reported.
91    #[serde(skip_serializing_if = "Option::is_none")]
92    pub input_tokens: Option<u64>,
93    /// Answer tokens, when reported.
94    #[serde(skip_serializing_if = "Option::is_none")]
95    pub output_tokens: Option<u64>,
96}
97
98#[cfg(test)]
99mod tests;
scv_protocol/lib.rs

scv_protocol/
lib.rs
