rig-agent 0.46.0

Rig's classic agent runtime.
Documentation
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
//! Mutable tool registries that publish their registrations to attached
//! handler tables.
//!
//! A registration under the default `tool:<name>` key is served under a fresh
//! generation key (`<owner>/tool:<name>#<n>`); an explicit key is used
//! verbatim. A replaced generation leaves the tables at once: a request
//! catalog keeps the registration it pinned and runs it directly.
//!
//! ```
//! use rig_agent::tool::server::ToolServer;
//! let registry = ToolServer::new().owner("assistant").run();
//! assert!(registry.snapshot().is_empty());
//! ```

use std::collections::HashMap;
use std::sync::{
    Arc, PoisonError, RwLock, RwLockReadGuard, RwLockWriteGuard,
    atomic::{AtomicU64, Ordering},
};

use crate::handlers::{Handlers, WeakHandlers};
use indexmap::IndexMap;
use rig_core::error::ProviderError;
use rig_core::serve::adapters::RetrieveAdapter;
use rig_core::{
    effect::Key,
    effect::{HandlerKey, family},
    vector_store::{VectorStoreIndex, request::DynamicSearchFilter},
    wasm_compat::{WasmCompatSend, WasmCompatSync},
};

use crate::{
    agent::register_generated,
    completion::ToolDefinition,
    tool::{DynamicTool, RegisteredTool, Tool, ToolCatalog, ToolSet},
};

/// The per-process counter behind a registry's default owner label.
static NEXT_REGISTRY: AtomicU64 = AtomicU64::new(0);

/// A retrieval index registered for tool retrieval: its key and how many
/// tools to sample.
#[derive(Clone)]
struct RetrievalIndex {
    samples: usize,
    key: HandlerKey,
    handler: rig_core::serve::ErasedHandler,
}

struct ToolServerState {
    /// The registry's label, the owner segment of every key it mints.
    owner: String,
    retrieval_indexes: Vec<RetrievalIndex>,
    toolset: ToolSet,
    managed_generations: HashMap<String, ManagedToolToken>,
    /// The name whose registration was published last under each key: an
    /// explicit key can be reused across names.
    bindings: HashMap<HandlerKey, String>,
    /// The tables this registry publishes onto, while they live.
    tables: Vec<WeakHandlers>,
    next_generation: u64,
}

impl ToolServerState {
    fn generation_key(&mut self, name: &str) -> Key<family::Tool> {
        let n = self.next_generation;
        self.next_generation += 1;
        Key::new_unchecked(HandlerKey::from(format!("{}/tool:{name}#{n}", self.owner)))
    }

    /// The tables still alive, forgetting the dropped ones.
    fn tables(&mut self) -> Vec<Handlers> {
        let mut live = Vec::with_capacity(self.tables.len());
        self.tables.retain(|table| match table.upgrade() {
            Some(table) => {
                live.push(table);
                true
            }
            None => false,
        });
        live
    }

    fn publish(&mut self, tool: &RegisteredTool) {
        for table in self.tables() {
            register_generated(
                table.register_erased(tool.key().raw().clone(), tool.handler().clone()),
            );
        }
    }

    /// Take the key of `name`'s registration off the tables, unless a later
    /// registration was published under it.
    fn unpublish(&mut self, name: &str) {
        let Some(key) = self.toolset.get(name).map(|tool| tool.key().raw().clone()) else {
            return;
        };
        if self.bindings.get(&key).is_some_and(|owner| owner == name) {
            self.bindings.remove(&key);
            for table in self.tables() {
                table.deregister(&key);
            }
        }
    }

    /// Insert a registration under a fresh generation, publishing it.
    fn register(&mut self, tool: RegisteredTool, always_exposed: bool) -> String {
        let name = tool.name();
        // A registration under the default `tool:<name>` key gets a fresh
        // generation; an explicit key (a replayer's recorded key, a host's
        // own) is served as given.
        let tool = if tool.has_default_key() {
            let key = self.generation_key(&name);
            tool.with_key(key)
        } else {
            tool
        };
        // An explicit key that is the live key replaces the handler in place.
        let same_key = self
            .toolset
            .get(&name)
            .is_some_and(|live| live.key() == tool.key());
        if !same_key {
            self.unpublish(&name);
        }
        self.publish(&tool);
        self.bindings.insert(tool.key().raw().clone(), name.clone());
        if always_exposed {
            self.toolset.add_registered_tool(tool);
        } else {
            let mut set = ToolSet::default();
            set.add_registered_tool(tool);
            self.toolset.add_retrievable_tools(set);
        }
        name
    }

    fn remove(&mut self, name: &str) {
        self.unpublish(name);
        self.toolset.remove_tool(name);
        self.managed_generations.remove(name);
    }

    fn retire_disconnected_tools(&mut self) {
        let disconnected = self
            .toolset
            .names()
            .filter(|name| self.toolset.get(name).is_none_or(|tool| !tool.is_live()))
            .map(str::to_owned)
            .collect::<Vec<_>>();

        for name in disconnected {
            self.remove(&name);
            tracing::debug!(tool_name = %name, "retired disconnected tool registration");
        }
    }

    fn attach(&mut self, table: &Handlers) {
        for (name, tool) in self.toolset.iter() {
            if self
                .bindings
                .get(tool.key().raw())
                .is_some_and(|owner| owner == name)
            {
                register_generated(
                    table.register_erased(tool.key().raw().clone(), tool.handler().clone()),
                );
            }
        }
        for index in &self.retrieval_indexes {
            register_generated(table.register_erased(index.key.clone(), index.handler.clone()));
        }
        self.tables.push(table.downgrade());
    }
}

pub use rig_core::tool::{ManagedToolSink, ManagedToolToken};

/// A tool registry under construction; [`ToolServer::run`] turns it into
/// the shareable [`ToolServerHandle`].
pub struct ToolServer {
    owner: Option<String>,
    /// Retrieval indexes by sample count, keyed once the registry knows its
    /// owner label.
    retrieval_indexes: Vec<(usize, rig_core::serve::ErasedHandler)>,
    toolset: ToolSet,
}

impl Default for ToolServer {
    fn default() -> Self {
        Self::new()
    }
}

impl ToolServer {
    /// An empty registry.
    pub fn new() -> Self {
        Self {
            owner: None,
            retrieval_indexes: Vec::new(),
            toolset: ToolSet::default(),
        }
    }

    /// Name the registry: the owner segment of every key it mints
    /// (`<owner>/tool:<name>#<n>`, `<owner>/retrieve:tools#<n>`). The
    /// default is `tools#<m>` from a per-process counter, distinct per
    /// registry; name it when a host shares one table between registries and
    /// wants to read the keys.
    pub fn owner(mut self, label: impl Into<String>) -> Self {
        self.owner = Some(label.into());
        self
    }

    /// Add a typed tool.
    pub fn tool(mut self, tool: impl Tool + 'static) -> Self {
        self.toolset.add_tool(tool);
        self
    }

    /// Add a runtime-defined tool.
    pub fn dynamic_tool(mut self, tool: DynamicTool) -> Self {
        self.toolset.add_dynamic_tool(tool);
        self
    }

    /// Add runtime-defined tools.
    pub fn dynamic_tools(self, tools: Vec<DynamicTool>) -> Self {
        tools.into_iter().fold(self, Self::dynamic_tool)
    }

    /// Add a registration built elsewhere.
    pub fn registered_tool(mut self, tool: RegisteredTool) -> Self {
        self.toolset.add_registered_tool(tool);
        self
    }

    /// Add retrievable tools: `sample` of them are advertised per request,
    /// chosen by `index`.
    pub fn retrieved_tools<I, F>(self, sample: usize, index: I, toolset: ToolSet) -> Self
    where
        I: VectorStoreIndex<Filter = F> + 'static,
        F: DynamicSearchFilter + WasmCompatSend + WasmCompatSync + 'static,
    {
        self.retrieved_tools_handler(sample, RetrieveAdapter::new(index), toolset)
    }

    /// Add tools selected per request by a retrieval-family handler answering
    /// `TopNIds`, registered under a generated retrieval index key.
    pub fn retrieved_tools_handler(
        mut self,
        sample: usize,
        handler: impl rig_core::serve::Serve + 'static,
        toolset: ToolSet,
    ) -> Self {
        self.retrieval_indexes
            .push((sample, rig_core::serve::ErasedHandler::new(handler)));
        self.toolset.add_retrievable_tools(toolset);
        self
    }

    /// Start the registry.
    pub fn run(mut self) -> ToolServerHandle {
        let owner = self
            .owner
            .take()
            .unwrap_or_else(|| format!("tools#{}", NEXT_REGISTRY.fetch_add(1, Ordering::Relaxed)));
        let handle = ToolServerHandle(Arc::new(RwLock::new(ToolServerState {
            owner,
            retrieval_indexes: Vec::new(),
            toolset: ToolSet::default(),
            managed_generations: HashMap::new(),
            bindings: HashMap::new(),
            tables: Vec::new(),
            next_generation: 0,
        })));
        handle.extend(self);
        handle
    }
}

/// The shareable, runtime-mutable tool registry.
#[derive(Clone)]
pub struct ToolServerHandle(Arc<RwLock<ToolServerState>>);

impl ToolServerHandle {
    fn state(&self) -> RwLockReadGuard<'_, ToolServerState> {
        self.0.read().unwrap_or_else(PoisonError::into_inner)
    }

    fn state_mut(&self) -> RwLockWriteGuard<'_, ToolServerState> {
        self.0.write().unwrap_or_else(PoisonError::into_inner)
    }

    /// Publish every registration onto `table`, now and as they change.
    pub fn attach(&self, table: &Handlers) {
        self.state_mut().attach(table);
    }

    /// The registry's label: the owner segment of the keys it mints.
    pub fn owner(&self) -> String {
        self.state().owner.clone()
    }

    fn register(&self, tool: RegisteredTool) {
        let mut state = self.state_mut();
        let name = state.register(tool, true);
        state.managed_generations.remove(&name);
    }

    /// Add a typed tool.
    pub fn add_tool<T>(&self, tool: T)
    where
        T: Tool + 'static,
    {
        self.register(RegisteredTool::from_tool(tool));
    }

    /// Add a runtime-defined tool.
    pub fn add_dynamic_tool(&self, tool: DynamicTool) {
        self.register(RegisteredTool::from_dynamic(tool));
    }

    /// Add a registration built elsewhere.
    pub fn add_registered_tool(&self, tool: RegisteredTool) {
        self.register(tool);
    }

    fn add_managed(&self, tools: Vec<RegisteredTool>) -> HashMap<String, ManagedToolToken> {
        let mut state = self.state_mut();
        let mut managed = HashMap::with_capacity(tools.len());

        for tool in tools {
            if !tool.is_live() {
                tracing::debug!(
                    tool_name = %tool.name(),
                    "ignored initial registration from disconnected MCP owner"
                );
                continue;
            }

            let name = state.register(tool, true);
            let token = ManagedToolToken::new();
            state
                .managed_generations
                .insert(name.clone(), token.clone());
            managed.insert(name, token);
        }

        managed
    }

    fn reconcile_managed(
        &self,
        mut expected: HashMap<String, ManagedToolToken>,
        tools: Vec<RegisteredTool>,
    ) -> HashMap<String, ManagedToolToken> {
        let mut state = self.state_mut();
        let mut refreshed = HashMap::with_capacity(tools.len());
        let mut managed_order = Vec::with_capacity(tools.len());
        let mut seen = std::collections::HashSet::with_capacity(tools.len());

        state.retire_disconnected_tools();

        for tool in tools {
            if !tool.is_live() {
                tracing::debug!(
                    tool_name = %tool.name(),
                    "ignored registration from disconnected MCP owner"
                );
                continue;
            }

            let name = tool.name();
            if !seen.insert(name.clone()) {
                tracing::warn!(tool_name = %name, "ignoring duplicate MCP tool definition");
                continue;
            }
            let present = state.toolset.contains(&name);
            let may_register = match expected.remove(&name) {
                Some(token) if present => state.managed_generations.get(&name) == Some(&token),
                Some(_) => true,
                None => !present,
            };

            if may_register {
                state.register(tool, true);
                let token = ManagedToolToken::new();
                state
                    .managed_generations
                    .insert(name.clone(), token.clone());
                refreshed.insert(name.clone(), token);
                managed_order.push(name);
            } else {
                tracing::debug!(
                    tool_name = name,
                    "MCP refresh left a newer same-name registration intact"
                );
            }
        }

        for (name, token) in expected {
            if state.managed_generations.get(&name) == Some(&token) {
                state.remove(&name);
            }
        }

        for name in managed_order {
            state.toolset.move_to_end(&name);
        }

        refreshed
    }

    /// Add `server`'s tools and retrieval indexes, keyed under this
    /// registry's owner (`server`'s own owner label is not used).
    pub(crate) fn extend(&self, server: ToolServer) {
        {
            let mut state = self.state_mut();
            for (samples, handler) in server.retrieval_indexes {
                let n = state.retrieval_indexes.len();
                let key = HandlerKey::from(format!("{}/retrieve:tools#{n}", state.owner));
                for table in state.tables() {
                    register_generated(table.register_erased(key.clone(), handler.clone()));
                }
                state.retrieval_indexes.push(RetrievalIndex {
                    samples,
                    key,
                    handler,
                });
            }
        }
        self.add_tools(server.toolset);
    }

    /// Merge a tool set's registrations.
    pub fn add_tools(&self, toolset: ToolSet) {
        let mut state = self.state_mut();
        let exposed: Vec<String> = toolset.always_exposed_names().map(str::to_owned).collect();
        for (name, tool) in toolset.iter() {
            let always_exposed = exposed.iter().any(|exposed| exposed == name);
            let name = state.register(tool.clone(), always_exposed);
            state.managed_generations.remove(&name);
        }
    }

    /// Remove the tool named `tool_name`.
    pub fn remove_tool(&self, tool_name: &str) {
        self.state_mut().remove(tool_name);
    }

    /// Run `f` over the registry, retiring disconnected tools first: under
    /// the read lock while every tool is live, the write lock otherwise.
    fn with_registry<R>(&self, f: impl FnOnce(&ToolServerState) -> R) -> R {
        {
            let state = self.state();
            if state.toolset.iter().all(|(_, tool)| tool.is_live()) {
                return f(&state);
            }
        }
        let mut state = self.state_mut();
        state.retire_disconnected_tools();
        f(&state)
    }

    /// The always-exposed registrations, pinned.
    pub fn snapshot(&self) -> ToolCatalog {
        ToolCatalog::from_registered(
            self.with_registry(|state| snapshot_registered_tools(state, &[])),
        )
    }

    /// A fork of the registry's tool set.
    pub fn toolset(&self) -> ToolSet {
        self.with_registry(|state| state.toolset.clone())
    }

    /// Retrieve advertised definitions for `prompt`, returning retrieval failures
    /// or incompatible result shapes as definition errors.
    pub async fn tool_defs(
        &self,
        prompt: Option<String>,
    ) -> Result<Vec<Arc<ToolDefinition>>, ToolServerError> {
        Ok(self.snapshot_tool_defs(prompt).await?.take_definitions())
    }

    /// Return registered retrieval index keys in registration order.
    pub fn retrieval_keys(&self) -> Vec<HandlerKey> {
        self.state()
            .retrieval_indexes
            .iter()
            .map(|index| index.key.clone())
            .collect()
    }

    /// Build one `TopNIds` effect per retrieval index for the supplied prompt.
    /// Returns no effects without a prompt; pass returned IDs to
    /// [`Self::snapshot_with_dynamic`] after dispatch.
    pub fn retrieval_effects(
        &self,
        prompt: Option<String>,
    ) -> Vec<(HandlerKey, rig_core::effect::EffectKind)> {
        let Some(text) = prompt else {
            return Vec::new();
        };
        let retrieval_indexes = {
            let state = self.state();
            state.retrieval_indexes.clone()
        };
        retrieval_indexes
            .into_iter()
            .map(|index| {
                let req = rig_core::vector_store::request::VectorSearchRequest::builder()
                    .query(text.clone())
                    .samples(index.samples as u64)
                    .build();
                (
                    index.key,
                    rig_core::effect::EffectKind::Retrieve {
                        query: rig_core::effect::RetrieveQuery::TopNIds {
                            req: req.map_filter(rig_core::vector_store::request::Filter::interpret),
                        },
                    },
                )
            })
            .collect()
    }

    /// Pin retrieved tools in ID order, then always-exposed tools in registration
    /// order. Deduplicates names and skips missing registrations.
    pub fn snapshot_with_dynamic(&self, dynamic_tool_ids: &[String]) -> ToolCatalog {
        ToolCatalog::from_registered(
            self.with_registry(|state| snapshot_registered_tools(state, dynamic_tool_ids)),
        )
    }

    /// The registrations a request with `prompt` advertises, answering the
    /// retrieval queries inline on the registry's own handlers. This is the
    /// standalone registry read ([`ToolServerHandle::tool_defs`]); the
    /// engine dispatches the same queries through its handlers instead.
    pub(crate) async fn snapshot_tool_defs(
        &self,
        prompt: Option<String>,
    ) -> Result<ToolCatalog, ToolServerError> {
        let retrieval_indexes = {
            let state = self.state();
            state.retrieval_indexes.clone()
        };

        let dynamic_tool_ids = if let Some(ref text) = prompt {
            let search_futures = retrieval_indexes.iter().map(|index| {
                let text = text.clone();
                let samples = index.samples;
                let handler = index.handler.clone();

                async move {
                    let req = rig_core::vector_store::request::VectorSearchRequest::builder()
                        .query(text)
                        .samples(samples as u64)
                        .build();
                    // Retrieval for advertisement runs inline on the registry's
                    // own handler: it is a registry read, not a run effect.
                    let outcome = rig_core::serve::serve_inline(
                        &handler,
                        rig_core::effect::EffectKind::Retrieve {
                            query: rig_core::effect::RetrieveQuery::TopNIds {
                                req: req
                                    .map_filter(rig_core::vector_store::request::Filter::interpret),
                            },
                        },
                    )
                    .await
                    .map_err(|report| {
                        rig_core::vector_store::VectorStoreError::DatastoreError(Box::new(report))
                    })?;
                    let ids = match outcome {
                        rig_core::effect::Answered::Documents(
                            rig_core::effect::RetrievedDocuments::Ids(ids),
                        ) => ids.into_iter().map(|(_, id)| id).collect::<Vec<String>>(),
                        other => {
                            return Err(rig_core::vector_store::VectorStoreError::DatastoreError(
                                Box::new(rig_core::error::ErrorReport::new(
                                    rig_core::error::ErrorKind::Internal,
                                    format!(
                                        "tool retrieval answered with a {} outcome",
                                        other.family()
                                    ),
                                )),
                            ));
                        }
                    };

                    Ok::<_, rig_core::vector_store::VectorStoreError>(ids)
                }
            });

            futures::future::try_join_all(search_futures)
                .await
                .map_err(|e| ToolServerError::DefinitionError(ProviderError::request(e)))?
                .into_iter()
                .flatten()
                .collect::<Vec<String>>()
        } else {
            Vec::new()
        };

        Ok(ToolCatalog::from_registered(self.with_registry(|state| {
            snapshot_registered_tools(state, &dynamic_tool_ids)
        })))
    }
}

fn snapshot_registered_tools(
    state: &ToolServerState,
    dynamic_tool_ids: &[String],
) -> IndexMap<String, RegisteredTool> {
    let mut tools = IndexMap::new();
    let insert = |tools: &mut IndexMap<String, RegisteredTool>, name: &str, warn_missing| {
        if tools.contains_key(name) {
            tracing::debug!(
                tool_name = %name,
                "dropping duplicate tool definition from the request"
            );
            return;
        }
        match state.toolset.get(name).cloned() {
            Some(tool) => {
                tools.insert(name.to_string(), tool);
            }
            None if warn_missing => {
                tracing::warn!("Tool implementation not found in toolset: {name}");
            }
            None => {}
        }
    };

    for name in dynamic_tool_ids {
        insert(&mut tools, name, true);
    }
    for name in state.toolset.always_exposed_names() {
        insert(&mut tools, name, false);
    }
    tools
}

#[cfg(not(target_family = "wasm"))]
const _: () = {
    const fn assert_send_sync_static<T: Send + Sync + 'static>() {}
    assert_send_sync_static::<ToolSet>();
    assert_send_sync_static::<ToolCatalog>();
    assert_send_sync_static::<ToolServerHandle>();
};

/// Errors from reading the registry.
#[derive(Debug, thiserror::Error)]
pub enum ToolServerError {
    /// The advertised definitions could not be computed.
    #[error("Failed to retrieve tool definitions: {0}")]
    DefinitionError(ProviderError),
}

impl ManagedToolSink for ToolServerHandle {
    fn add_managed_tools(&self, tools: Vec<DynamicTool>) -> HashMap<String, ManagedToolToken> {
        self.add_managed(
            tools
                .into_iter()
                .map(RegisteredTool::from_dynamic)
                .collect(),
        )
    }

    fn reconcile_managed_tools(
        &self,
        expected: HashMap<String, ManagedToolToken>,
        tools: Vec<DynamicTool>,
    ) -> HashMap<String, ManagedToolToken> {
        self.reconcile_managed(
            expected,
            tools
                .into_iter()
                .map(RegisteredTool::from_dynamic)
                .collect(),
        )
    }
}

#[cfg(test)]
mod tests;