1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
use std::collections::BTreeSet;
use std::sync::{Arc, Mutex};
use std::time::Duration;
use tools_kit::ToolsetBackend;
use providers_kit::ProviderBackend;
use tokio::sync::oneshot;
use tokio::task::JoinHandle;
use crate::agent_storage::AgentStorageClaim;
use crate::backends::{codex, custom, opencode};
use crate::{
Agent, AgentBackend, AgentConfig, AgentId, AgentInfo, AgentStorage, BackendConfig, KitError,
KnowledgeOwnerId, ManagedKnowledge, ToolSelection,
};
use storage_kit::{Database, DatabaseBackend, StateStore, StateStoreBackend};
/// Configures creation or reopening of one durable [`Agent`].
///
/// The builder accepts already-built provider, tool, and storage values without
/// exposing their implementation details through `agents-kit`.
///
/// The hierarchy preserves concrete `S`, `D`, `P` and `T` types, with no Clone
/// requirement on caller backends or `T::Handler`. New identity creation and
/// durable reopen use separate constructors; reopening resupplies integrations
/// instead of reconstructing credentials or lower configuration from records.
///
/// Native Codex/OpenCode can select `P` as static composition context without
/// owning a provider value. Custom requires a value through [`Self::with_provider`].
/// The builder owns supplied values, while [`Self::build`] accepts construction
/// and cleanup work. Await consuming [`AgentBackend::shutdown`] on the built Agent
/// while its runtime remains driven.
///
/// The local example uses memory Lance and a passively constructed Provider. It
/// selects an exact model without verifying a running service or generating output.
///
/// See the [construction example](crate) and [`Self::reopen`] for durable reopen.
pub struct AgentBuilder<
S: StateStoreBackend = StateStore,
D: DatabaseBackend = Database,
P: ProviderBackend = providers_kit::Provider,
T: ToolsetBackend = tools_kit::Toolset,
> {
config: AgentConfig,
storage: AgentStorage<S>,
mode: AgentBuildMode,
provider: Option<P>,
toolsets: Vec<Arc<T>>,
knowledge_database: Option<D>,
}
enum AgentBuildMode {
Create,
Reopen(AgentId),
}
impl<S: StateStoreBackend> AgentBuilder<S, Database, providers_kit::Provider> {
/// Configures a new durable agent over the required control-plane store.
///
/// This records creation intent without opening a backend. [`Self::build`] creates
/// a fresh durable identity. Storage is required up front and retains its exact
/// associated transaction type. For an existing identity use [`Self::reopen`].
///
/// See the [construction example](crate). To choose caller-owned lower types, see [`Self::with_provider`] and [`Self::with_toolset`].
pub fn create(config: AgentConfig, storage: AgentStorage<S>) -> Self {
Self::create_for_backends::<providers_kit::Provider, tools_kit::Toolset>(config, storage)
}
/// Configures a new agent with fixed Provider and Toolset implementation types.
///
/// Codex and OpenCode retain their native providers, so this selects only
/// the static provider type shared with other agents in a caller-owned
/// composition. Custom agents receive their provider value through
/// [`Self::with_provider`]. Repeated [`Self::with_toolset`] calls append T2
/// values to one homogeneous inventory without normalization or a Clone bound.
///
/// See [`Self::reopen_for_backends`] for typed creation and reopening.
/// [`Self::with_provider`] and [`Self::with_toolset`] accept caller-owned lower types.
pub fn create_for_backends<P2: ProviderBackend, T2: ToolsetBackend>(
config: AgentConfig,
storage: AgentStorage<S>,
) -> AgentBuilder<S, Database, P2, T2> {
AgentBuilder {
config,
storage,
mode: AgentBuildMode::Create,
provider: None,
toolsets: Vec::new(),
knowledge_database: None,
}
}
/// Configures reopening of an existing durable agent.
///
/// Selects an existing identity; it never falls back to creating one. Build checks
/// stored compatibility and the storage clone family's live-ownership claim.
/// Resupply fresh provider/tool/database values required by that identity.
/// An AgentStorage clone shares coordination without requiring `S: Clone`.
///
/// # Examples
///
/// This owns one Lance directory and reopens it through a fresh connection. Memory
/// stores instead require the same retained storage family. Shutdown is awaited
/// before inspection errors are propagated; unsuccessful runs retain their files.
///
/// ```
/// use std::{num::NonZeroUsize, time::Duration};
/// use agents_kit::{AgentBackend, AgentBuilder, AgentStorage};
/// use agents_kit::config::{AgentConfig, CustomAgentConfig, CustomLoopLimits, CustomToolApproval};
/// use agents_kit::{model::ModelSelector, tool::ToolSelection};
/// use providers_kit::{Provider, ProviderConfig};
/// use providers_kit::config::{OllamaConfig, ProviderKind, TransportConfig};
/// use storage_kit::{StateStore, state::config::{LanceStateStoreConfig, StateStoreConfig}};
/// let directory = std::env::temp_dir().join(format!("agent-reopen-doc-{}", uuid::Uuid::new_v4()));
/// std::fs::create_dir(&directory)?;
/// let store_config = StateStoreConfig::lance(LanceStateStoreConfig::directory(&directory));
/// # tokio::runtime::Builder::new_current_thread().enable_all().build()?.block_on(async {
/// let custom = CustomAgentConfig::new(ModelSelector::new("exact-model")?, ToolSelection::None,
/// CustomLoopLimits::new(4, 0, 1)?, CustomToolApproval::Deny)?;
/// let config = AgentConfig::new(custom.into(), Duration::from_secs(10), NonZeroUsize::MIN)?;
/// let provider_config = ProviderConfig::new(
/// ProviderKind::Ollama(OllamaConfig::local()), TransportConfig::default(),
/// );
/// let store = StateStore::connect(store_config.clone()).await?;
/// let agent = AgentBuilder::create(config.clone(), AgentStorage::new(store))
/// .with_provider(Provider::from_config(provider_config.clone())?).build().await?;
/// let id = agent.id();
/// agent.shutdown().await?;
///
/// let store = StateStore::connect(store_config).await?;
/// let reopened = AgentBuilder::reopen(config, AgentStorage::new(store), id.clone())
/// .with_provider(Provider::from_config(provider_config)?).build().await?;
/// let result = reopened.info().await;
/// let cleanup = reopened.shutdown().await;
/// let info = match (result, cleanup) {
/// (Ok(info), Ok(())) => Ok(info),
/// (Err(primary), Err(cleanup)) => Err(primary.with_supplementary(cleanup)),
/// (Err(error), _) | (_, Err(error)) => Err(error),
/// }?;
/// assert_eq!(info.id(), &id);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// # })?;
/// // Only successful shutdown and readback permit deleting this owned directory.
/// std::fs::remove_dir_all(directory)?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn reopen(config: AgentConfig, storage: AgentStorage<S>, id: AgentId) -> Self {
Self::reopen_for_backends::<providers_kit::Provider, tools_kit::Toolset>(
config, storage, id,
)
}
/// Configures reopening with fixed Provider and Toolset implementation types.
///
/// This is the reopening counterpart to [`Self::create_for_backends`]. It
/// selects no provider value and performs no provider operation.
///
/// # Examples
///
/// ```
/// use std::{num::NonZeroUsize, time::Duration};
/// use agents_kit::{AgentBackend, AgentBuilder, AgentStorage};
/// use agents_kit::config::{AgentConfig, CustomAgentConfig, CustomLoopLimits, CustomToolApproval};
/// use agents_kit::{model::ModelSelector, tool::ToolSelection};
/// use providers_kit::{Provider, ProviderConfig, config::{OllamaConfig, ProviderKind, TransportConfig}};
/// use storage_kit::{StateStore, state::config::{LanceStateStoreConfig, StateStoreConfig}};
/// # let runtime = tokio::runtime::Builder::new_current_thread().enable_all().build()?;
/// # runtime.block_on(async {
/// let store = StateStore::connect(StateStoreConfig::Lance(LanceStateStoreConfig::memory())).await?;
/// let storage = AgentStorage::new(store);
/// let custom = CustomAgentConfig::new(ModelSelector::new("exact-model")?, ToolSelection::None,
/// CustomLoopLimits::new(4, 0, 1)?, CustomToolApproval::Deny)?;
/// let config = AgentConfig::new(custom.into(), Duration::from_secs(10), NonZeroUsize::MIN)?;
/// let provider_config = ProviderConfig::new(ProviderKind::Ollama(OllamaConfig::local()), TransportConfig::default());
/// let provider = Provider::from_config(provider_config.clone())?;
/// let agent = AgentBuilder::create_for_backends::<Provider, tools_kit::Toolset>(
/// config.clone(), storage.clone(),
/// )
/// .with_provider(provider).build().await?;
/// let id = agent.id();
/// agent.shutdown().await?;
/// let builder = AgentBuilder::reopen_for_backends::<Provider, tools_kit::Toolset>(
/// config, storage, id.clone(),
/// );
/// let reopened = builder.with_provider(Provider::from_config(provider_config)?).build().await?;
/// let reopened_id = reopened.id();
/// reopened.shutdown().await?;
/// assert_eq!(reopened_id, id);
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// # })?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn reopen_for_backends<P2: ProviderBackend, T2: ToolsetBackend>(
config: AgentConfig,
storage: AgentStorage<S>,
id: AgentId,
) -> AgentBuilder<S, Database, P2, T2> {
let mut builder = Self::create_for_backends::<P2, T2>(config, storage);
builder.mode = AgentBuildMode::Reopen(id);
builder
}
}
impl<S: StateStoreBackend, D: DatabaseBackend, P: ProviderBackend, T: ToolsetBackend>
AgentBuilder<S, D, P, T>
{
/// Supplies the already-built provider required by the Custom backend.
///
/// Consumes the provider and changes the builder's concrete provider parameter;
/// accepted Toolsets and the Database remain attached. Replacing an earlier value
/// drops that value, so complete any required lower lifecycle work before replacing
/// it. Codex/OpenCode reject a supplied provider value during build; use typed
/// construction to select their static provider parameter without a value.
///
/// See the [construction example](crate).
///
/// Direct implementations retain `P::Model` and `T::Handler`; neither `T` nor
/// its handler requires Clone. See [`providers_kit::ProviderBackend`] and
/// [`tools_kit::ToolsetBackend`] for runnable implementations, and the
/// [Custom composition examples](https://github.com/jecsand838/ai-kit/blob/main/agents-kit/tests/custom_mock_composition.rs)
/// for their use together with the real agent loop. Other lower operations
/// keep their owning trait's explicit unsupported behavior.
pub fn with_provider<P2: ProviderBackend>(self, provider: P2) -> AgentBuilder<S, D, P2, T> {
AgentBuilder {
config: self.config,
storage: self.storage,
mode: self.mode,
provider: Some(provider),
toolsets: self.toolsets,
knowledge_database: self.knowledge_database,
}
}
/// Appends one already-built executable Toolset implementation.
///
/// T remains fixed by construction. Changing the Provider or Database keeps
/// every accepted Toolset; its unique Handler remains associated as `T::Handler`.
///
/// Each call appends a value of the construction-selected `T`; use caller-owned
/// exhaustive Toolset/Handler enums for heterogeneous sources. Custom executes the
/// associated Handler directly. Build validates unique effective names and selected
/// tools before publication. Native support is backend-specific: OpenCode rejects
/// supplied executable toolsets. Builder transfer alone never invokes a handler.
///
/// # Examples
///
/// ```
/// use std::{num::NonZeroUsize, time::Duration};
/// use agents_kit::{AgentBackend, AgentBuilder, AgentStorage};
/// use agents_kit::config::{AgentConfig, CustomAgentConfig, CustomLoopLimits, CustomToolApproval};
/// use agents_kit::{model::ModelSelector, tool::ToolSelection};
/// use providers_kit::{Provider, ProviderConfig, config::{OllamaConfig, ProviderKind, TransportConfig}};
/// use storage_kit::{StateStore, state::config::{LanceStateStoreConfig, StateStoreConfig}};
/// # let runtime = tokio::runtime::Builder::new_current_thread().enable_all().build()?;
/// # runtime.block_on(async {
/// let store = StateStore::connect(StateStoreConfig::Lance(LanceStateStoreConfig::memory())).await?;
/// let storage = AgentStorage::new(store);
/// let custom = CustomAgentConfig::new(ModelSelector::new("exact-model")?, ToolSelection::None,
/// CustomLoopLimits::new(4, 0, 1)?, CustomToolApproval::Deny)?;
/// let config = AgentConfig::new(custom.into(), Duration::from_secs(10), NonZeroUsize::MIN)?;
/// let provider_config = ProviderConfig::new(ProviderKind::Ollama(OllamaConfig::local()), TransportConfig::default());
/// let provider = Provider::from_config(provider_config.clone())?;
/// use tools_kit::{Toolset, declaration::{ToolInfo, ToolName}, execution::ToolResult,
/// local::ToolRegistration, schema::JsonSchema};
/// let tools = Toolset::local(vec![ToolRegistration::function(
/// ToolInfo::new(ToolName::new("ping")?, JsonSchema::strict(serde_json::json!({"type":"object"}))),
/// |_| async { Ok(ToolResult::text("pong")) },
/// )])?;
/// let agent = AgentBuilder::create(config, storage)
/// .with_toolset(tools).with_provider(provider).build().await?;
/// let result = agent.list_workspaces().await;
/// // Shutdown settles the transferred Toolset and Provider even if listing failed.
/// let cleanup = agent.shutdown().await;
/// let workspaces = match (result, cleanup) {
/// (Ok(value), Ok(())) => Ok(value),
/// (Err(primary), Err(cleanup)) => Err(primary.with_supplementary(cleanup)),
/// (Err(error), _) | (_, Err(error)) => Err(error),
/// }?;
/// assert!(workspaces.is_empty());
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// # })?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub fn with_toolset(mut self, toolset: T) -> Self {
self.toolsets.push(Arc::new(toolset));
self
}
/// Supplies the Database used by the private managed-knowledge owner.
///
/// Consumes a direct Database implementation and changes only the builder's
/// concrete `D` parameter. Existing Toolsets and Provider remain attached. This
/// Database is separate from AgentStorage's control-plane records and exposes no
/// public knowledge runtime. Reopen must resupply a compatible Database when the
/// durable identity requires managed knowledge.
///
/// See [`IngestKnowledgeRequest`](crate::knowledge::IngestKnowledgeRequest) for request construction and the [Custom composition examples](https://github.com/jecsand838/ai-kit/blob/main/agents-kit/tests/custom_mock_composition.rs) for caller-owned knowledge storage.
pub fn with_knowledge_database<D2: DatabaseBackend>(
self,
database: D2,
) -> AgentBuilder<S, D2, P, T> {
AgentBuilder {
config: self.config,
storage: self.storage,
mode: self.mode,
provider: self.provider,
toolsets: self.toolsets,
knowledge_database: Some(database),
}
}
/// Validates the complete configuration and creates or reopens the agent.
///
/// Takes ownership of construction after acceptance. On failure, prepared resources
/// are cleaned in reverse ownership order within the lifecycle deadline; the first
/// failure remains primary and later failures remain supplementary. Losing the
/// caller observation does not detach accepted build/cleanup ownership.
///
/// On success the unique Agent owns its runtime and transferred integrations.
/// Keep Tokio and lower runtimes driven through consuming shutdown. Custom model
/// selection alone does not verify remote model availability; later provider
/// operations own service validation.
///
/// # Errors
///
/// Returns InvalidConfig for invalid backend/integration combinations (including a
/// missing Custom provider), Unsupported for a supplied integration the selected
/// backend cannot represent, and Conflict/Busy for incompatible or already-owned
/// reopen state. Missing identities use NotFound; malformed durable evidence uses
/// InvalidState. Process, transport, protocol, storage and deadline failures retain
/// their owning portable classification. Inspect [`KitError::kind`] and
/// [`KitError::context`]; build and reopen carry distinct operation context.
///
/// This example requires an installed, configured `codex` executable and its real
/// App Server process. It does not submit a model prompt.
///
/// # Examples
///
/// ```no_run
/// use std::{num::NonZeroUsize, time::Duration};
/// use agents_kit::{AgentBackend, AgentBuilder, AgentStorage};
/// use agents_kit::config::{AgentConfig, CodexConfig};
/// use storage_kit::{StateStore, state::config::{LanceStateStoreConfig, StateStoreConfig}};
/// # let runtime = tokio::runtime::Builder::new_current_thread().enable_all().build()?;
/// # runtime.block_on(async {
/// let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
/// Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
/// let store = StateStore::connect(StateStoreConfig::Lance(LanceStateStoreConfig::memory())).await?;
/// let agent = AgentBuilder::create(config, AgentStorage::new(store)).build().await?;
/// let observed = agent.info().await;
/// let cleanup = agent.shutdown().await;
/// let info = match (observed, cleanup) {
/// (Ok(value), Ok(())) => Ok(value),
/// (Err(primary), Err(cleanup)) => Err(primary.with_supplementary(cleanup)),
/// (Err(error), _) | (_, Err(error)) => Err(error),
/// }?;
/// assert!(!info.id().as_str().is_empty());
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// # })?;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
pub async fn build(self) -> Result<Agent<S, D, P, T>, KitError> {
let operation = match self.mode {
AgentBuildMode::Create => crate::error::Operation::Build,
AgentBuildMode::Reopen(_) => crate::error::Operation::Reopen,
};
AgentBuildPublication::<Agent<S, D, P, T>>::run(AgentBuildOwner::new(self))
.await
.map_err(|error| {
error
.at_operation(operation)
.in_phase(crate::error::ErrorPhase::Admission)
})
}
}
struct AgentBuildOwner<
S: StateStoreBackend,
D: DatabaseBackend,
P: ProviderBackend,
T: ToolsetBackend,
> {
config: Option<AgentConfig>,
mode: AgentBuildMode,
provider: Option<P>,
toolsets: Vec<Arc<T>>,
storage: Option<AgentStorage<S>>,
knowledge_database: Option<D>,
claim: Option<AgentStorageClaim>,
agent: Option<Agent<S, D, P, T>>,
cleanup_timeout: Duration,
tracing_enabled: bool,
}
impl<S: StateStoreBackend, D: DatabaseBackend, P: ProviderBackend, T: ToolsetBackend>
AgentBuildOwner<S, D, P, T>
{
fn new(builder: AgentBuilder<S, D, P, T>) -> Self {
let cleanup_timeout = builder.config.lifecycle_timeout();
let tracing_enabled = builder.config.tracing_enabled();
let AgentBuilder {
config,
storage,
mode,
provider,
toolsets,
knowledge_database,
} = builder;
Self {
config: Some(config),
mode,
provider,
toolsets,
storage: Some(storage),
knowledge_database,
claim: None,
agent: None,
cleanup_timeout,
tracing_enabled,
}
}
async fn build(mut self) -> Result<Agent<S, D, P, T>, KitError> {
if let Err(error) = self.validate().await {
return Err(self.cleanup_after_error(error).await);
}
let lifecycle_deadline = match tokio::time::Instant::now().checked_add(self.cleanup_timeout)
{
Some(deadline) => deadline,
None => {
return Err(self
.cleanup_after_error(KitError::invalid_config(
"lifecycle timeout cannot be represented",
))
.await);
}
};
let storage = self
.storage
.as_ref()
.expect("validated AgentStorage must be present")
.clone();
let reopen = matches!(&self.mode, AgentBuildMode::Reopen(_));
let info = match &self.mode {
AgentBuildMode::Reopen(id) => match storage.agent_info(id.clone()).await {
Ok(info)
if self
.config
.as_ref()
.expect("build configuration must remain owned")
.display_name()
.is_some_and(|name| Some(name) != info.display_name()) =>
{
return Err(self
.cleanup_after_error(KitError::conflict(
"configured agent display name differs from durable identity",
))
.await);
}
Ok(info) => info,
Err(error) => return Err(self.cleanup_after_error(error).await),
},
AgentBuildMode::Create => match AgentInfo::new(
AgentId::new(),
self.config
.as_ref()
.expect("build configuration must remain owned")
.display_name()
.map(str::to_owned),
) {
Ok(info) => info,
Err(error) => return Err(self.cleanup_after_error(error).await),
},
};
self.claim = match storage.claim_agent(info.id()) {
Ok(claim) => Some(claim),
Err(error) => return Err(self.cleanup_after_error(error).await),
};
let knowledge = self
.knowledge_database
.take()
.map(|database| ManagedKnowledge::new(storage.clone(), database));
if reopen {
if let Err(error) = storage
.settle_knowledge_forgets(knowledge.as_ref(), info.id(), lifecycle_deadline)
.await
{
return Err(self.cleanup_after_error(error).await);
}
if let Some(knowledge) = &knowledge {
let owner = KnowledgeOwnerId::Agent {
agent_id: info.id().clone(),
};
let verification = match tokio::time::timeout_at(
lifecycle_deadline,
knowledge.verify(owner),
)
.await
{
Ok(result) => result,
Err(_) => Err(KitError::timeout(
"knowledge reconciliation deadline elapsed",
)),
};
if let Err(error) = verification {
return Err(self.cleanup_after_error(error).await);
}
}
}
let config = self
.config
.take()
.expect("build configuration must transfer exactly once");
let backend = config.backend().clone();
let claim = self
.claim
.take()
.expect("validated live-agent claim must transfer exactly once");
let built = match backend {
BackendConfig::Codex(_) => {
let toolsets = std::mem::take(&mut self.toolsets);
codex::agent::CodexAgent::build(
info, config, storage, knowledge, claim, toolsets, reopen,
)
.await
.map(Agent::codex)
}
BackendConfig::OpenCode(_) => opencode::agent::OpenCodeAgent::build(
info, config, storage, knowledge, claim, reopen,
)
.await
.map(Agent::opencode),
BackendConfig::Custom(_) => {
let composition = custom::CustomAgent::<S, D, P, T>::compose(
self.provider
.take()
.expect("validated provider must transfer exactly once"),
std::mem::take(&mut self.toolsets),
);
custom::CustomAgent::build(
info,
config,
storage,
knowledge,
claim,
composition,
reopen,
)
.await
.map(Agent::custom)
}
};
let agent = match built {
Ok(agent) => agent,
Err(error) => return Err(self.cleanup_after_error(error).await),
};
self.agent = Some(agent);
Ok(self
.agent
.take()
.expect("constructed Agent must publish exactly once"))
}
async fn validate(&mut self) -> Result<(), KitError> {
let agent_config = self
.config
.as_ref()
.expect("build configuration must remain owned");
agent_config.validate()?;
if tokio::time::Instant::now()
.checked_add(agent_config.lifecycle_timeout())
.is_none()
{
return Err(KitError::invalid_config(
"lifecycle timeout cannot be represented",
));
}
let has_provider = self.provider.is_some();
let has_tools = !self.toolsets.is_empty();
match agent_config.backend() {
BackendConfig::Codex(_) => {
if has_provider {
return Err(KitError::invalid_config(
"selected runtime does not accept a model runtime",
));
}
codex::tools::CodexTools::<S, T>::validate_registrations(&self.toolsets).await?;
}
BackendConfig::OpenCode(_) => {
if has_provider {
return Err(KitError::invalid_config(
"selected runtime does not accept a model runtime",
));
}
if has_tools {
return Err(KitError::unsupported(
"selected runtime does not accept executable tools",
));
}
}
BackendConfig::Custom(config) => {
if !has_provider {
return Err(KitError::invalid_config(
"selected runtime requires a configured model runtime",
));
}
let catalog = self.validate_catalog().await?;
Self::validate_custom_selection(config.default_tool_selection(), &catalog)?;
}
}
Ok(())
}
async fn validate_catalog(&self) -> Result<BTreeSet<String>, KitError> {
let mut executable_names = BTreeSet::new();
for toolset in &self.toolsets {
for tool in toolset.list_tools().await? {
let name = tool.name.as_str().to_owned();
if !executable_names.insert(name.clone()) {
return Err(KitError::invalid_config(
"configured tool names must be unique",
));
}
}
}
Ok(executable_names)
}
fn validate_custom_selection(
selection: &ToolSelection,
executable_names: &BTreeSet<String>,
) -> Result<(), KitError> {
selection.validate()?;
match selection {
ToolSelection::Auto | ToolSelection::None => Ok(()),
ToolSelection::Required if executable_names.is_empty() => {
Err(KitError::invalid_config(
"required tool selection needs at least one configured tool",
))
}
ToolSelection::Required => Ok(()),
ToolSelection::Allowed(names) | ToolSelection::RequiredOneOf(names) => {
Self::require_known_names(names, executable_names, "default selected tool")
}
}
}
fn require_known_names(
requested: &[String],
available: &BTreeSet<String>,
label: &str,
) -> Result<(), KitError> {
let missing = requested
.iter()
.filter(|name| !available.contains(*name))
.cloned()
.collect::<Vec<_>>();
if missing.is_empty() {
Ok(())
} else {
Err(KitError::invalid_config(format!(
"{label} names must exist in the supplied Toolsets"
)))
}
}
async fn cleanup_after_error(mut self, mut primary: KitError) -> KitError {
let cleanup_deadline = tokio::time::Instant::now()
.checked_add(self.cleanup_timeout)
.unwrap_or_else(tokio::time::Instant::now);
if let Some(agent) = self.agent.take()
&& let Err(cleanup_error) = agent.shutdown().await
{
if self.tracing_enabled {
tracing::warn!(
cleanup_target = "agent",
"agent build cleanup did not complete successfully"
);
}
primary = primary
.with_supplementary(cleanup_error.at_phase(crate::error::ErrorPhase::Cleanup));
}
drop(self.claim.take());
while let Some(toolset) = self.toolsets.pop() {
let cleanup =
tokio::time::timeout_at(cleanup_deadline, async { toolset.shutdown().await }).await;
if !matches!(cleanup, Ok(Ok(()))) && self.tracing_enabled {
tracing::warn!(
cleanup_target = "toolset",
"agent build cleanup did not complete successfully"
);
}
let error = match cleanup {
Ok(Ok(())) => None,
Ok(Err(error)) => Some(KitError::from(error)),
Err(_) => Some(
KitError::timeout("tool cleanup deadline elapsed").with_detail(
crate::error::ErrorDetail::DeadlineElapsed {
kind: crate::error::DeadlineKind::Lifecycle,
timeout: Some(self.cleanup_timeout),
},
),
),
};
if let Some(error) = error {
primary =
primary.with_supplementary(error.at_phase(crate::error::ErrorPhase::Cleanup));
}
}
if let Some(provider) = self.provider.take() {
let cleanup =
tokio::time::timeout_at(cleanup_deadline, async { provider.shutdown().await })
.await;
if !matches!(cleanup, Ok(Ok(()))) && self.tracing_enabled {
tracing::warn!(
cleanup_target = "provider",
"agent build cleanup did not complete successfully"
);
}
let error = match cleanup {
Ok(Ok(())) => None,
Ok(Err(error)) => Some(KitError::from_provider(&error)),
Err(_) => Some(
KitError::timeout("provider cleanup deadline elapsed").with_detail(
crate::error::ErrorDetail::DeadlineElapsed {
kind: crate::error::DeadlineKind::Lifecycle,
timeout: Some(self.cleanup_timeout),
},
),
),
};
if let Some(error) = error {
primary =
primary.with_supplementary(error.at_phase(crate::error::ErrorPhase::Cleanup));
}
}
primary
}
}
struct AgentBuildPublication<A> {
result: Mutex<Option<Result<A, KitError>>>,
handle: Mutex<Option<JoinHandle<()>>>,
}
impl<S: StateStoreBackend, D: DatabaseBackend, P: ProviderBackend, T: ToolsetBackend>
AgentBuildPublication<Agent<S, D, P, T>>
{
fn new() -> Self {
Self {
result: Mutex::new(None),
handle: Mutex::new(None),
}
}
async fn run(owner: AgentBuildOwner<S, D, P, T>) -> Result<Agent<S, D, P, T>, KitError> {
let publication = Arc::new(Self::new());
let task_publication = Arc::clone(&publication);
let (start_sender, start_receiver) = oneshot::channel();
let (ready_sender, ready_receiver) = oneshot::channel();
let (claimed_sender, claimed_receiver) = oneshot::channel();
let handle = tokio::spawn(async move {
if start_receiver.await.is_err() {
let _ = owner
.cleanup_after_error(KitError::invalid_state(
"agent build owner could not start",
))
.await;
task_publication.finish();
return;
}
let result = owner.build().await;
let successful = result.is_ok();
task_publication.publish(result);
if ready_sender.send(()).is_err() {
if successful {
task_publication.cleanup_unclaimed().await;
}
task_publication.finish();
return;
}
if successful && claimed_receiver.await.is_err() {
task_publication.cleanup_unclaimed().await;
}
task_publication.finish();
});
publication.install(handle);
start_sender
.send(())
.map_err(|_| KitError::invalid_state("agent build owner could not start"))?;
ready_receiver
.await
.map_err(|_| KitError::invalid_state("agent build owner terminated unexpectedly"))?;
let mut agent = publication.take()?;
agent.retain_storage_claim();
if claimed_sender.send(()).is_err() {
let primary =
KitError::invalid_state("agent build publication terminated unexpectedly")
.with_detail(crate::error::ErrorDetail::TaskTerminated)
.in_phase(crate::error::ErrorPhase::Publication);
return Err(match agent.shutdown().await {
Ok(()) => primary,
Err(cleanup) => {
primary.with_supplementary(cleanup.at_phase(crate::error::ErrorPhase::Cleanup))
}
});
}
Ok(agent)
}
fn install(&self, handle: JoinHandle<()>) {
*self
.handle
.lock()
.unwrap_or_else(|poisoned| poisoned.into_inner()) = Some(handle);
}
fn publish(&self, result: Result<Agent<S, D, P, T>, KitError>) {
*self
.result
.lock()
.unwrap_or_else(|poisoned| poisoned.into_inner()) = Some(result);
}
fn take(&self) -> Result<Agent<S, D, P, T>, KitError> {
self.result
.lock()
.unwrap_or_else(|poisoned| poisoned.into_inner())
.take()
.ok_or_else(|| KitError::invalid_state("agent build result was not published"))?
}
async fn cleanup_unclaimed(&self) {
let result = self
.result
.lock()
.unwrap_or_else(|poisoned| poisoned.into_inner())
.take();
if let Some(Ok(agent)) = result {
let _ = agent.shutdown().await;
}
}
fn finish(&self) {
self.handle
.lock()
.unwrap_or_else(|poisoned| poisoned.into_inner())
.take();
}
}