supercode_harness/
lib.rs

1//! # Volter Harness
2//!
3//! A lightweight, fully-customizable AI coding-agent SDK in Rust.
4//!
5//! `supercode` is a native agent loop — it talks directly to any model through
6//! [OpenRouter](https://openrouter.ai) (or any other OpenAI-compatible endpoint),
7//! drives a configurable set of tools, and is designed to be a superset of what
8//! tools like Claude Code and Codex can do: every prompt, every tool description,
9//! and every tool's on/off state is yours to control.
10//!
11//! ## Quick start
12//!
13//! ```no_run
14//! use supercode_harness::{Agent, Config};
15//!
16//! # async fn run() -> supercode_harness::Result<()> {
17//! // Reads OPENROUTER_API_KEY from the environment by default.
18//! let config = Config::builder()
19//!     .model("anthropic/claude-opus-4-8")
20//!     .system_prompt("You are a terse, expert pair programmer.")
21//!     .build();
22//!
23//! let mut agent = Agent::new(config)?;
24//! let reply = agent.send("List the files in the current directory.").await?;
25//! println!("{reply}");
26//! # Ok(())
27//! # }
28//! ```
29//!
30//! ## Design
31//!
32//! - [`Config`] — the single knob box: model, endpoint, credentials, sampling,
33//!   the system prompt, and per-tool overrides (enable/disable + custom
34//!   descriptions).
35//! - [`Provider`] — the model transport. [`OpenAiProvider`] speaks the
36//!   OpenAI chat-completions wire format and defaults to OpenRouter, so it
37//!   reaches Claude, GPT, Gemini, Llama, and anything else OpenRouter exposes.
38//! - [`Tool`] / [`ToolRegistry`] — the capability surface. Built-ins cover
39//!   file read/write/edit, directory listing, glob, content search, and shell
40//!   execution. Register your own to extend it.
41//! - [`Agent`] — the loop that ties it together: it streams a turn, runs any
42//!   tool calls the model requests, feeds results back, and repeats until the
43//!   model produces a final answer.
44
45#![warn(missing_docs)]
46
47#[cfg(feature = "adapter-acp")]
48/// The supercode ontology (`docs/ONTOLOGY.md`): the one model under sessions and the
49/// orchestration.
50pub use supercode_interchange::ontology;
51/// The orchestration piece of the ontology: a harness's operational home as one typed value.
52pub use supercode_interchange::orchestration;
53
54#[cfg(feature = "adapter-acp")]
55pub mod acp_frontend;
56#[cfg(feature = "adapter-acp")]
57pub mod acp_server;
58mod agent;
59pub mod agent_package;
60pub mod approvals;
61pub mod audit;
62pub mod channels;
63pub mod checkpoint;
64pub mod claude_compat;
65pub mod claude_peer;
66pub mod claude_relay;
67pub mod claude_runtime_state;
68pub mod codex_peer;
69mod config;
70pub mod config_schema;
71pub mod configfile;
72pub mod context_injection;
73mod error;
74pub mod formatters;
75#[cfg(feature = "adapter-api")]
76pub mod frontend;
77#[cfg(not(feature = "adapter-api"))]
78#[allow(dead_code)]
79mod frontend;
80#[allow(missing_docs)]
81mod frontend_contract_generated;
82pub mod git_metadata;
83pub mod goals;
84pub mod harness_auth;
85pub mod harness_command;
86#[cfg(feature = "adapter-api")]
87pub mod harness_service;
88#[cfg(not(feature = "adapter-api"))]
89#[allow(dead_code)]
90mod harness_service;
91pub mod hermes_import;
92pub mod human_export;
93pub mod interop_settings;
94pub mod jobs;
95pub mod jobs_control;
96pub mod jobs_notepad;
97pub mod live_runtime;
98pub mod lsp;
99#[cfg(feature = "adapter-api")]
100pub mod mail_mcp;
101pub mod mail_question;
102#[cfg(feature = "adapter-api")]
103pub mod mail_route;
104#[cfg(feature = "adapter-api")]
105pub mod mail_send;
106pub mod mail_transcript;
107#[cfg(feature = "adapter-api")]
108pub mod mail_watch;
109pub mod mailbox;
110pub mod mcp;
111pub mod mcp_oauth;
112pub mod memory;
113pub mod model_catalog;
114pub mod model_change;
115pub mod modules;
116mod native_materialize;
117pub mod orchestration_doors;
118pub mod orchestrator;
119pub mod orchestrator_door;
120pub mod output_style;
121pub mod parity;
122pub mod path_rules;
123pub mod permissions;
124pub mod plugins;
125pub mod presets;
126pub mod pricing;
127pub mod pricing_ref;
128pub mod profiles;
129pub mod profiles_control;
130mod provider;
131pub mod reduce;
132#[cfg(feature = "adapter-api")]
133pub mod relay_endpoint;
134mod residue_store;
135pub mod routes;
136pub mod runs;
137pub mod runtime;
138pub mod runtime_lease;
139#[cfg(feature = "adapter-api")]
140pub mod runtime_mail;
141#[cfg(feature = "adapter-api")]
142pub mod runtime_registry;
143mod safe_path;
144pub mod sandbox;
145pub mod schema;
146pub mod sdk;
147#[cfg(feature = "adapter-api")]
148pub mod server;
149#[cfg(not(feature = "adapter-api"))]
150#[allow(dead_code, unused_imports)]
151mod server;
152pub mod session_activity;
153pub mod session_index;
154pub mod session_journal;
155pub mod session_title;
156pub mod sessions_control;
157pub mod skills;
158pub mod skills_control;
159pub mod startup_prompts;
160pub mod store;
161pub mod subagents;
162pub mod support;
163pub mod teams;
164pub mod tools;
165pub mod triggers;
166pub mod trust;
167pub mod tui;
168pub mod turn_record;
169pub mod usage_log;
170pub mod workflow_doors;
171
172#[cfg(feature = "adapter-acp")]
173pub use acp_frontend::{AcpFrontendCheckpoint, AcpFrontendConnectOptions, AcpFrontendRuntime};
174pub use agent::{Agent, ContextUsage};
175pub use approvals::{
176    approval_harnesses, lists_approvals, plan_reply, ApprovalChoice, ApprovalDecision,
177    ApprovalDoor, ApprovalKind, ApprovalOption, ApprovalRegistry, ApprovalResolution,
178    ApprovalResolveError, ApprovalRow, ApprovalStatus, ApprovalsQuery, ApprovalsResolveParams,
179};
180pub use channels::{
181    channel_status, list_channels, ChannelError, ChannelRow, ChannelStatus, CHANNELS_SCHEMA,
182    CHANNEL_HARNESSES,
183};
184pub use claude_peer::{
185    read_claude_peer_settings, read_registry as read_claude_peer_registry, resolve_live_session,
186    update_claude_peer_settings, user_settings_path as claude_user_settings_path,
187    write_claude_peer_settings, ClaudeCrossSessionInbound, ClaudePeerRefusal,
188    ClaudePeerRefusalError, ClaudePeerSession, ClaudePeerSettings, ClaudePeerSettingsError,
189    ClaudePeerStatus,
190};
191pub use claude_runtime_state::{
192    ClaudeBackgroundChild, ClaudeBackgroundState, ClaudeCronJob, ClaudeQueueState,
193    ClaudeRuntimeManifest, ClaudeRuntimePosture, ClaudeRuntimeResidue, ClaudeWakeup,
194    CLAUDE_RUNTIME_MANIFEST_VERSION,
195};
196pub use config::{
197    project_root_for, ApprovalPolicy, CachePlan, Config, ConfigBuilder, ConfigFile, ConfigProfile,
198    ContextInjectionBlock, HookDecision, LifecycleEvent, LifecycleHook, PreToolOutcome,
199    SteeringMode, StopGateHook, ToolAdvertising, ToolOverride, ToolOverrideProfile,
200    DEFAULT_SYSTEM_PROMPT,
201};
202pub use configfile::HarnessConfig;
203pub use interop_settings::{
204    configure_harness_interop_settings, inspect_harness_interop_settings, HarnessAdvisorySeverity,
205    HarnessInteropAdvisory, HarnessInteropControl, HarnessInteropSettingsError,
206    HarnessInteropSettingsReport, HarnessSettingChange, HarnessSettingChoice,
207    HarnessSettingRecommendation, HarnessSettingScope, CLAUDE_CROSS_SESSION_INBOUND_KEY,
208    HARNESS_INTEROP_SETTINGS_SCHEMA,
209};
210pub use jobs::{
211    get_job, list_jobs, supports_jobs, JobDeliver, JobPayload, JobSchedule, JobScope, JobSource,
212    JobsListing, JobsQuery, ScheduledJob, CLAUDE_SESSION_SCAN_LIMIT, JOB_HARNESSES,
213};
214pub use jobs_control::{
215    harness_program, mutate, supports_job_control, JobControlError, JobDeliverSpec, JobMutation,
216    JobMutationOutcome, JobPayloadSpec, JobScheduleSpec, JobVerb, CONTROLLED_JOB_HARNESSES,
217};
218pub use jobs_notepad::{JobNotepad, JobNotepadEntry, JobNotepadRequest};
219pub use live_runtime::{
220    discover_live_runtime, find_live_runtime, forget_live_runtime, list_live_runtimes,
221    register_live_runtime, register_live_runtime_with_metadata, resolve_live_runtime,
222    LiveRuntimeEndpoint, LiveRuntimeMetadata, LiveRuntimeReceiptError, LiveRuntimeRecord,
223    LiveRuntimeRegistration, LiveRuntimeSource, LiveRuntimeSupervisor, ResolvedLiveRuntime,
224};
225pub use memory::{
226    search_memory, show_memory, supports_memory, MemoryDocument, MemoryError, MemoryMatch,
227    MemoryQuery, MemoryScope, MemorySearchQuery, MEMORY_HARNESSES, MEMORY_SCHEMA,
228};
229pub use modules::{ModuleActivation, ModuleId};
230pub use orchestrator::{
231    clear_lease, daemon_entry, install_service, live_lease, lock_path, read_lease, resolve_program,
232    service_name, service_status, service_unit, uninstall_service, write_lease, write_unit, Lease,
233    OrchestratorError, ServiceState, ServiceUnit, DAEMON_ENTRY, LOCK_FILE, SERVICE_DIR,
234    SERVICE_NAME,
235};
236pub use orchestrator_door::{
237    daemon_is_live, socket_path, Door, DoorAnswer, DoorError, NODE_BIN_ENV, SOCKET_FILE,
238};
239pub use profiles::{
240    get_profile, list_profiles, ProfileError, ProfileKind, ProfileRow, HERMES_DEFAULT_PROFILE,
241    PROFILES_SCHEMA, PROFILE_HARNESSES,
242};
243pub use profiles_control::{
244    supports_profile_control, ProfileControlError, ProfileMutation, ProfileMutationOutcome,
245    ProfileVerb, CONTROLLED_PROFILE_HARNESSES,
246};
247pub use routes::{list_routes, RouteError, RouteMatch, RouteRow, ROUTES_SCHEMA, ROUTE_HARNESSES};
248pub use runs::{
249    get_run, list_runs, supports_runs, HarnessRun, RunDelivery, RunSource, RunsListing, RunsQuery,
250    RUN_HARNESSES,
251};
252pub use sessions_control::{
253    controlled_verbs, supports_session_control, SessionControlError, SessionDoor, SessionMutation,
254    SessionMutationOutcome, SessionVerb, CONTROLLED_SESSION_HARNESSES,
255};
256pub use supercode_interchange::catalog::{
257    orchestrator_profile_dirs, DiscoveryPage, DiscoveryQuery, HarnessCatalog, HarnessHomes,
258    HarnessId, SessionDescriptor, SessionLocator, StorageLocator,
259};
260pub use teams::{
261    connector_service_binary as teams_connector_service_binary,
262    connector_service_name as teams_connector_service_name,
263    connector_service_status as teams_connector_service_status,
264    connector_service_unit as teams_connector_service_unit,
265    install_connector_service as install_teams_connector_service,
266    install_service as install_teams_service, service_status as teams_service_status,
267    service_unit as teams_service_unit, teams_entry, teams_home,
268    uninstall_connector_service as uninstall_teams_connector_service,
269    uninstall_service as uninstall_teams_service, write_unit as write_teams_unit, TeamsError,
270    SERVICE_DIR as TEAMS_SERVICE_DIR, SERVICE_NAME as TEAMS_SERVICE_NAME, TEAMS_ENTRY,
271    TEAMS_PACKAGE,
272};
273pub use triggers::{
274    list_triggers, TriggerError, TriggerKind, TriggerRow, TRIGGERS_SCHEMA, TRIGGER_HARNESSES,
275};
276
277/// Format an agent's final reply for output. `json` wraps it as
278/// `{"result": "..."}`; otherwise the reply is returned as-is. The
279/// stream-json form is the live [`AgentEvent`] stream via an [`EventSink`].
280pub fn format_reply(reply: &str, json: bool) -> String {
281    if json {
282        serde_json::json!({ "result": reply }).to_string()
283    } else {
284        reply.to_string()
285    }
286}
287pub use error::{Error, Result};
288#[cfg(feature = "adapter-api")]
289pub use frontend::HttpFrontendRuntime;
290pub use frontend::{
291    FrontendActions, FrontendApprovalDecision, FrontendAttachSnapshot, FrontendAttachment,
292    FrontendCommandDescriptor, FrontendConnectionState, FrontendDisplayCapabilities,
293    FrontendElicitationAction, FrontendEvent, FrontendOperationDescriptor,
294    FrontendOperationInvocation, FrontendOperationKind, FrontendOperationResult, FrontendRequest,
295    FrontendRequestKind, FrontendResponse, FrontendRuntime, FrontendRuntimeDescriptor,
296    FrontendRuntimeError, FrontendRuntimeMetadata, FrontendTurnState, FRONTEND_REPLAY_CAPACITY,
297    FRONTEND_RUNTIME_SCHEMA_VERSION,
298};
299pub use frontend_contract_generated::{
300    FrontendFacadeMethod, FrontendFacadeTransport, GeneratedFrontendClient,
301};
302pub use harness_auth::{
303    harness_authentication_methods, harness_authentication_plan, inspect_harness_authentication,
304    HarnessAuthenticationEnvironment, HarnessAuthenticationError, HarnessAuthenticationInteraction,
305    HarnessAuthenticationLaunch, HarnessAuthenticationMethod, HarnessAuthenticationMethodId,
306    HarnessAuthenticationPlan, HarnessAuthenticationReport, HarnessAuthenticationState,
307    HarnessBrowserBehavior, HARNESS_AUTHENTICATION_SCHEMA,
308};
309pub use harness_service::{
310    DetachedAnswer, DetachedCall, HarnessSessionService, OpenedRuntime, ReturnedRuntime,
311    RuntimeOpen, DETACHED_CALL_DEADLINE, DETACHED_METHODS, HARNESS_SERVICE_VERSION,
312    RUNTIME_CONTROL_DEADLINE, RUNTIME_EVENT_METHOD, RUNTIME_OPEN_DEADLINE, RUNTIME_OPEN_METHODS,
313    SESSION_ACTIVITY_EVENT_METHOD, SESSION_DISCOVER_DEADLINE, SESSION_EVENT_METHOD,
314    SESSION_INDEX_EVENT_METHOD,
315};
316pub use provider::{
317    model_context_limit, ChatRequest, OpenAiProvider, PromptTokensDetails, Provider, RetryLog,
318    RetryNotice, ToolSchema, Usage, SERVED_MODEL_KEY, UNKNOWN_MODEL_CONTEXT_FLOOR,
319};
320#[cfg(feature = "adapter-api")]
321pub use runtime::SupercodeHttpRuntimeBackend;
322pub use runtime::{
323    AcpRuntimeBackend, BearerToken, ClaudeCodeRuntimeBackend, CodexRuntimeBackend, HarnessEvent,
324    McpServerLaunch, OpenCodeRuntimeBackend, PiRuntimeBackend, ResolvedRuntimeConnection,
325    RuntimeAttachRequest, RuntimeBackend, RuntimeCapabilities, RuntimeConnectLaunch,
326    RuntimeConnection, RuntimeEndpoint, RuntimeHandle, RuntimeInput, RuntimeLaunch,
327    RuntimeStartRequest,
328};
329pub use runtime_lease::{
330    CoordinatedRuntime, CoordinatedRuntimeClient, RuntimeAuthorization, RuntimeClientId,
331    RuntimeControllerLease, RuntimeLeaseCoordinator, RuntimeLeaseError, RuntimeLeaseSnapshot,
332    RuntimeObserverLease, RuntimePermission, DEFAULT_RUNTIME_LEASE_TTL_MS,
333};
334#[cfg(feature = "adapter-api")]
335pub use runtime_registry::{
336    LocalRuntimeRegistry, RuntimeRegistryEntry, RuntimeRegistryEvent, RuntimeRegistryOwner,
337    RuntimeRegistryQuery, RuntimeRegistryState, RuntimeRegistryWatch,
338};
339pub use sandbox::{landlock_available, netns_available, SandboxEnvPolicy, SandboxEscalation};
340pub use sdk::{
341    create_agent, discover_session_page, discover_sessions, load_session, load_session_path,
342    resume_agent, show_model_input, submit_agent, submit_agent_with_images, RuntimeSubmitError,
343    SdkAgent, SdkCapabilities, SdkError, SdkErrorCode, SdkEvent, SdkOperation, SdkPromptSource,
344    SdkRequest, SdkRuntime, SdkRuntimeEvent, SdkService, SDK_SCHEMA_VERSION,
345};
346pub use server::RpcEngine;
347pub use session_activity::{
348    SessionActivity, SessionActivityEvidence, SessionPresence, SessionTurnState,
349};
350pub use session_index::{SessionIndexChange, SessionIndexDelta, SessionIndexKey};
351pub use skills::{
352    declared_skill_name, list_skills, skill_roots, writable_skill_roots, SkillHomes, SkillRow,
353    SkillScope, SkillsQuery, SKILL_HARNESSES,
354};
355pub use skills_control::{
356    mutate_skill, supports_skill_control, SkillControlError, SkillMutation, SkillMutationOutcome,
357    SkillVerb, CONTROLLED_SKILL_HARNESSES,
358};
359pub use store::{SessionInfo, SessionStore};
360pub use supercode_interchange::session::{
361    CrossSurface, OrchestrationNouns, Recurrence, Session, SessionFormat, SessionMeta,
362    SessionSource, SurfaceKey, Trigger, WorkspaceKind, WorkspaceRef,
363};
364pub use supercode_interchange::watch::{SessionFollower, SessionSnapshotReason, SessionWatchEvent};
365pub use supercode_interchange::{
366    core_messages, measure_fidelity, messages_equal, messages_equal_multimodal, replay_eligible,
367    Fidelity, FidelityMetric, FidelityResidue,
368};
369pub use supercode_interchange::{
370    is_tool_error, mark_tool_error, mark_tool_outcome_unknown, tool_outcome, ChatMessage,
371    FunctionCall, Role, ToolCall, ToolOutcome, TOOL_ERROR_METADATA_KEY,
372    TOOL_OUTCOME_UNKNOWN_METADATA_KEY,
373};
374pub use supercode_runtime::{AgentEvent, EventSink};
375pub use support::{
376    harness_support, harness_support_registry, HarnessSupportDescriptor, ImplementationKind,
377    NativeSupport, RuntimeSupport, SupportRegistryReport, SUPPORT_REGISTRY_SCHEMA,
378};
379pub use tools::{
380    shell_sandbox_unenforceable, SandboxPolicy, SchemaTier, Tool, ToolContext, ToolRegistry,
381    WriteObserver,
382};
supercode_harness/lib.rs

supercode_harness/
lib.rs
