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;
101#[cfg(feature = "adapter-api")]
102pub mod mail_route;
103#[cfg(feature = "adapter-api")]
104pub mod mail_send;
105pub mod mail_transcript;
106#[cfg(feature = "adapter-api")]
107pub mod mail_watch;
108pub mod mailbox;
109pub mod mcp;
110pub mod mcp_oauth;
111pub mod memory;
112pub mod model_catalog;
113pub mod model_change;
114pub mod modules;
115mod native_materialize;
116pub mod orchestration_doors;
117pub mod orchestrator;
118pub mod orchestrator_door;
119pub mod output_style;
120pub mod parity;
121pub mod path_rules;
122pub mod permissions;
123pub mod plugins;
124pub mod presets;
125pub mod pricing;
126pub mod pricing_ref;
127pub mod profiles;
128pub mod profiles_control;
129mod provider;
130pub mod reduce;
131#[cfg(feature = "adapter-api")]
132pub mod relay_endpoint;
133mod residue_store;
134pub mod routes;
135pub mod runs;
136pub mod runtime;
137pub mod runtime_lease;
138#[cfg(feature = "adapter-api")]
139pub mod runtime_mail;
140#[cfg(feature = "adapter-api")]
141pub mod runtime_registry;
142mod safe_path;
143pub mod sandbox;
144pub mod schema;
145pub mod sdk;
146#[cfg(feature = "adapter-api")]
147pub mod server;
148#[cfg(not(feature = "adapter-api"))]
149#[allow(dead_code, unused_imports)]
150mod server;
151pub mod session_activity;
152pub mod session_index;
153pub mod session_journal;
154pub mod session_title;
155pub mod sessions_control;
156pub mod skills;
157pub mod skills_control;
158pub mod store;
159pub mod subagents;
160pub mod support;
161pub mod teams;
162pub mod tools;
163pub mod triggers;
164pub mod trust;
165pub mod tui;
166pub mod turn_record;
167pub mod usage_log;
168pub mod workflow_doors;
169
170#[cfg(feature = "adapter-acp")]
171pub use acp_frontend::{AcpFrontendCheckpoint, AcpFrontendConnectOptions, AcpFrontendRuntime};
172pub use agent::{Agent, ContextUsage};
173pub use approvals::{
174    approval_harnesses, lists_approvals, plan_reply, ApprovalChoice, ApprovalDecision,
175    ApprovalDoor, ApprovalKind, ApprovalOption, ApprovalRegistry, ApprovalResolution,
176    ApprovalResolveError, ApprovalRow, ApprovalStatus, ApprovalsQuery, ApprovalsResolveParams,
177};
178pub use channels::{
179    channel_status, list_channels, ChannelError, ChannelRow, ChannelStatus, CHANNELS_SCHEMA,
180    CHANNEL_HARNESSES,
181};
182pub use claude_peer::{
183    read_claude_peer_settings, read_registry as read_claude_peer_registry, resolve_live_session,
184    update_claude_peer_settings, user_settings_path as claude_user_settings_path,
185    write_claude_peer_settings, ClaudeCrossSessionInbound, ClaudePeerRefusal,
186    ClaudePeerRefusalError, ClaudePeerSession, ClaudePeerSettings, ClaudePeerSettingsError,
187    ClaudePeerStatus,
188};
189pub use claude_runtime_state::{
190    ClaudeBackgroundChild, ClaudeBackgroundState, ClaudeCronJob, ClaudeQueueState,
191    ClaudeRuntimeManifest, ClaudeRuntimePosture, ClaudeRuntimeResidue, ClaudeWakeup,
192    CLAUDE_RUNTIME_MANIFEST_VERSION,
193};
194pub use config::{
195    project_root_for, ApprovalPolicy, CachePlan, Config, ConfigBuilder, ConfigFile, ConfigProfile,
196    ContextInjectionBlock, HookDecision, LifecycleEvent, LifecycleHook, PreToolOutcome,
197    SteeringMode, StopGateHook, ToolAdvertising, ToolOverride, ToolOverrideProfile,
198    DEFAULT_SYSTEM_PROMPT,
199};
200pub use configfile::HarnessConfig;
201pub use interop_settings::{
202    configure_harness_interop_settings, inspect_harness_interop_settings, HarnessAdvisorySeverity,
203    HarnessInteropAdvisory, HarnessInteropControl, HarnessInteropSettingsError,
204    HarnessInteropSettingsReport, HarnessSettingChange, HarnessSettingChoice,
205    HarnessSettingRecommendation, HarnessSettingScope, CLAUDE_CROSS_SESSION_INBOUND_KEY,
206    HARNESS_INTEROP_SETTINGS_SCHEMA,
207};
208pub use jobs::{
209    get_job, list_jobs, supports_jobs, JobDeliver, JobPayload, JobSchedule, JobScope, JobSource,
210    JobsListing, JobsQuery, ScheduledJob, CLAUDE_SESSION_SCAN_LIMIT, JOB_HARNESSES,
211};
212pub use jobs_control::{
213    harness_program, mutate, supports_job_control, JobControlError, JobDeliverSpec, JobMutation,
214    JobMutationOutcome, JobPayloadSpec, JobScheduleSpec, JobVerb, CONTROLLED_JOB_HARNESSES,
215};
216pub use jobs_notepad::{JobNotepad, JobNotepadEntry, JobNotepadRequest};
217pub use live_runtime::{
218    discover_live_runtime, find_live_runtime, forget_live_runtime, list_live_runtimes,
219    register_live_runtime, register_live_runtime_with_metadata, resolve_live_runtime,
220    LiveRuntimeEndpoint, LiveRuntimeMetadata, LiveRuntimeReceiptError, LiveRuntimeRecord,
221    LiveRuntimeRegistration, LiveRuntimeSource, LiveRuntimeSupervisor, ResolvedLiveRuntime,
222};
223pub use memory::{
224    search_memory, show_memory, supports_memory, MemoryDocument, MemoryError, MemoryMatch,
225    MemoryQuery, MemoryScope, MemorySearchQuery, MEMORY_HARNESSES, MEMORY_SCHEMA,
226};
227pub use modules::{ModuleActivation, ModuleId};
228pub use orchestrator::{
229    clear_lease, daemon_entry, install_service, live_lease, lock_path, read_lease, resolve_program,
230    service_name, service_status, service_unit, uninstall_service, write_lease, write_unit, Lease,
231    OrchestratorError, ServiceState, ServiceUnit, DAEMON_ENTRY, LOCK_FILE, SERVICE_DIR,
232    SERVICE_NAME,
233};
234pub use orchestrator_door::{
235    daemon_is_live, socket_path, Door, DoorAnswer, DoorError, NODE_BIN_ENV, SOCKET_FILE,
236};
237pub use profiles::{
238    get_profile, list_profiles, ProfileError, ProfileKind, ProfileRow, HERMES_DEFAULT_PROFILE,
239    PROFILES_SCHEMA, PROFILE_HARNESSES,
240};
241pub use profiles_control::{
242    supports_profile_control, ProfileControlError, ProfileMutation, ProfileMutationOutcome,
243    ProfileVerb, CONTROLLED_PROFILE_HARNESSES,
244};
245pub use routes::{list_routes, RouteError, RouteMatch, RouteRow, ROUTES_SCHEMA, ROUTE_HARNESSES};
246pub use runs::{
247    get_run, list_runs, supports_runs, HarnessRun, RunDelivery, RunSource, RunsListing, RunsQuery,
248    RUN_HARNESSES,
249};
250pub use sessions_control::{
251    controlled_verbs, supports_session_control, SessionControlError, SessionDoor, SessionMutation,
252    SessionMutationOutcome, SessionVerb, CONTROLLED_SESSION_HARNESSES,
253};
254pub use supercode_interchange::catalog::{
255    orchestrator_profile_dirs, DiscoveryPage, DiscoveryQuery, HarnessCatalog, HarnessHomes,
256    HarnessId, SessionDescriptor, SessionLocator, StorageLocator,
257};
258pub use teams::{
259    connector_service_binary as teams_connector_service_binary,
260    connector_service_name as teams_connector_service_name,
261    connector_service_status as teams_connector_service_status,
262    connector_service_unit as teams_connector_service_unit,
263    install_connector_service as install_teams_connector_service,
264    install_service as install_teams_service, service_status as teams_service_status,
265    service_unit as teams_service_unit, teams_entry, teams_home,
266    uninstall_connector_service as uninstall_teams_connector_service,
267    uninstall_service as uninstall_teams_service, write_unit as write_teams_unit, TeamsError,
268    SERVICE_DIR as TEAMS_SERVICE_DIR, SERVICE_NAME as TEAMS_SERVICE_NAME, TEAMS_ENTRY,
269    TEAMS_PACKAGE,
270};
271pub use triggers::{
272    list_triggers, TriggerError, TriggerKind, TriggerRow, TRIGGERS_SCHEMA, TRIGGER_HARNESSES,
273};
274
275/// Format an agent's final reply for output. `json` wraps it as
276/// `{"result": "..."}`; otherwise the reply is returned as-is. The
277/// stream-json form is the live [`AgentEvent`] stream via an [`EventSink`].
278pub fn format_reply(reply: &str, json: bool) -> String {
279    if json {
280        serde_json::json!({ "result": reply }).to_string()
281    } else {
282        reply.to_string()
283    }
284}
285pub use error::{Error, Result};
286#[cfg(feature = "adapter-api")]
287pub use frontend::HttpFrontendRuntime;
288pub use frontend::{
289    FrontendActions, FrontendApprovalDecision, FrontendAttachSnapshot, FrontendAttachment,
290    FrontendCommandDescriptor, FrontendConnectionState, FrontendDisplayCapabilities,
291    FrontendElicitationAction, FrontendEvent, FrontendOperationDescriptor,
292    FrontendOperationInvocation, FrontendOperationKind, FrontendOperationResult, FrontendRequest,
293    FrontendRequestKind, FrontendResponse, FrontendRuntime, FrontendRuntimeDescriptor,
294    FrontendRuntimeError, FrontendRuntimeMetadata, FrontendTurnState, FRONTEND_REPLAY_CAPACITY,
295    FRONTEND_RUNTIME_SCHEMA_VERSION,
296};
297pub use frontend_contract_generated::{
298    FrontendFacadeMethod, FrontendFacadeTransport, GeneratedFrontendClient,
299};
300pub use harness_auth::{
301    harness_authentication_methods, harness_authentication_plan, inspect_harness_authentication,
302    HarnessAuthenticationEnvironment, HarnessAuthenticationError, HarnessAuthenticationInteraction,
303    HarnessAuthenticationLaunch, HarnessAuthenticationMethod, HarnessAuthenticationMethodId,
304    HarnessAuthenticationPlan, HarnessAuthenticationReport, HarnessAuthenticationState,
305    HarnessBrowserBehavior, HARNESS_AUTHENTICATION_SCHEMA,
306};
307pub use harness_service::{
308    DetachedAnswer, DetachedCall, HarnessSessionService, OpenedRuntime, ReturnedRuntime,
309    RuntimeOpen, DETACHED_CALL_DEADLINE, DETACHED_METHODS, HARNESS_SERVICE_VERSION,
310    RUNTIME_CONTROL_DEADLINE, RUNTIME_EVENT_METHOD, RUNTIME_OPEN_DEADLINE, RUNTIME_OPEN_METHODS,
311    SESSION_ACTIVITY_EVENT_METHOD, SESSION_DISCOVER_DEADLINE, SESSION_EVENT_METHOD,
312    SESSION_INDEX_EVENT_METHOD,
313};
314pub use provider::{
315    model_context_limit, ChatRequest, OpenAiProvider, PromptTokensDetails, Provider, RetryLog,
316    RetryNotice, ToolSchema, Usage, SERVED_MODEL_KEY, UNKNOWN_MODEL_CONTEXT_FLOOR,
317};
318#[cfg(feature = "adapter-api")]
319pub use runtime::SupercodeHttpRuntimeBackend;
320pub use runtime::{
321    AcpRuntimeBackend, BearerToken, ClaudeCodeRuntimeBackend, CodexRuntimeBackend, HarnessEvent,
322    McpServerLaunch, OpenCodeRuntimeBackend, PiRuntimeBackend, ResolvedRuntimeConnection,
323    RuntimeAttachRequest, RuntimeBackend, RuntimeCapabilities, RuntimeConnectLaunch,
324    RuntimeConnection, RuntimeEndpoint, RuntimeHandle, RuntimeInput, RuntimeLaunch,
325    RuntimeStartRequest,
326};
327pub use runtime_lease::{
328    CoordinatedRuntime, CoordinatedRuntimeClient, RuntimeAuthorization, RuntimeClientId,
329    RuntimeControllerLease, RuntimeLeaseCoordinator, RuntimeLeaseError, RuntimeLeaseSnapshot,
330    RuntimeObserverLease, RuntimePermission, DEFAULT_RUNTIME_LEASE_TTL_MS,
331};
332#[cfg(feature = "adapter-api")]
333pub use runtime_registry::{
334    LocalRuntimeRegistry, RuntimeRegistryEntry, RuntimeRegistryEvent, RuntimeRegistryOwner,
335    RuntimeRegistryQuery, RuntimeRegistryState, RuntimeRegistryWatch,
336};
337pub use sandbox::{landlock_available, netns_available, SandboxEnvPolicy, SandboxEscalation};
338pub use sdk::{
339    create_agent, discover_session_page, discover_sessions, load_session, load_session_path,
340    resume_agent, show_model_input, submit_agent, submit_agent_with_images, RuntimeSubmitError,
341    SdkAgent, SdkCapabilities, SdkError, SdkErrorCode, SdkEvent, SdkOperation, SdkPromptSource,
342    SdkRequest, SdkRuntime, SdkRuntimeEvent, SdkService, SDK_SCHEMA_VERSION,
343};
344pub use server::RpcEngine;
345pub use session_activity::{
346    SessionActivity, SessionActivityEvidence, SessionPresence, SessionTurnState,
347};
348pub use session_index::{SessionIndexChange, SessionIndexDelta, SessionIndexKey};
349pub use skills::{
350    declared_skill_name, list_skills, skill_roots, writable_skill_roots, SkillHomes, SkillRow,
351    SkillScope, SkillsQuery, SKILL_HARNESSES,
352};
353pub use skills_control::{
354    mutate_skill, supports_skill_control, SkillControlError, SkillMutation, SkillMutationOutcome,
355    SkillVerb, CONTROLLED_SKILL_HARNESSES,
356};
357pub use store::{SessionInfo, SessionStore};
358pub use supercode_interchange::session::{
359    CrossSurface, OrchestrationNouns, Recurrence, Session, SessionFormat, SessionMeta,
360    SessionSource, SurfaceKey, Trigger, WorkspaceKind, WorkspaceRef,
361};
362pub use supercode_interchange::watch::{SessionFollower, SessionSnapshotReason, SessionWatchEvent};
363pub use supercode_interchange::{
364    core_messages, measure_fidelity, messages_equal, messages_equal_multimodal, replay_eligible,
365    Fidelity, FidelityMetric, FidelityResidue,
366};
367pub use supercode_interchange::{
368    is_tool_error, mark_tool_error, mark_tool_outcome_unknown, tool_outcome, ChatMessage,
369    FunctionCall, Role, ToolCall, ToolOutcome, TOOL_ERROR_METADATA_KEY,
370    TOOL_OUTCOME_UNKNOWN_METADATA_KEY,
371};
372pub use supercode_runtime::{AgentEvent, EventSink};
373pub use support::{
374    harness_support, harness_support_registry, HarnessSupportDescriptor, ImplementationKind,
375    NativeSupport, RuntimeSupport, SupportRegistryReport, SUPPORT_REGISTRY_SCHEMA,
376};
377pub use tools::{
378    shell_sandbox_unenforceable, SandboxPolicy, SchemaTier, Tool, ToolContext, ToolRegistry,
379    WriteObserver,
380};
supercode_harness/lib.rs

supercode_harness/
lib.rs
