rs-utcp 0.3.1

Rust implementation of the Universal Tool Calling Protocol (UTCP).
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

use anyhow::Result;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

/// Minimal JSON Schema-like description for tool inputs/outputs.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ToolInputOutputSchema {
    #[serde(rename = "type")]
    pub type_: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub properties: Option<HashMap<String, serde_json::Value>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub required: Option<Vec<String>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub items: Option<HashMap<String, serde_json::Value>>,
    #[serde(rename = "enum", skip_serializing_if = "Option::is_none")]
    pub enum_: Option<Vec<serde_json::Value>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub minimum: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub maximum: Option<f64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub format: Option<String>,
}

/// Canonical tool definition used by UTCP transports and repositories.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Tool {
    pub name: String,
    pub description: String,
    pub inputs: ToolInputOutputSchema,
    pub outputs: ToolInputOutputSchema,
    pub tags: Vec<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub average_response_size: Option<i64>,
    #[serde(rename = "tool_provider", skip_serializing_if = "Option::is_none")]
    pub provider: Option<serde_json::Value>,
}

/// Strategy abstraction used to search tools by query string.
#[async_trait]
pub trait ToolSearchStrategy: Send + Sync {
    /// Return tools matching the query string, limited to `limit` results when non-zero.
    async fn search_tools(&self, query: &str, limit: usize) -> Result<Vec<Tool>>;
}