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

supercode_harness/
lib.rs
