agent-workspace-contract 0.5.1

Transport-neutral contracts for Agent Infra workspace APIs
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

use super::*;

/// Product path for installing a Skills Hub package into a running Sandbox.
pub const SANDBOX_SKILLS_PATH: &str = "/internal/v1/workspace/sandboxes/{sandboxId}/skills";

/// Product path for searching published Skills Hub packages.
pub const SKILLS_SEARCH_PATH: &str = "/internal/v1/workspace/skills:search";

/// Sandbox-root directory that receives unpacked skill packages.
pub const SANDBOX_SKILL_INSTALL_ROOT: &str = "skills";

/// Default Skills Hub version selector when the caller omits `version`.
pub const SANDBOX_SKILL_DEFAULT_VERSION: &str = "latest";

/// Default sandbox provider when the caller omits `provider`.
pub const SANDBOX_SKILL_DEFAULT_PROVIDER: &str = "local";

fn default_sandbox_skill_provider() -> String {
    SANDBOX_SKILL_DEFAULT_PROVIDER.to_string()
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "camelCase")]
pub struct InstallSandboxSkillRequest {
    pub group: String,
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    /// Sandbox provider to write into: `local`, `e2b`, or `moulin`.
    #[serde(default = "default_sandbox_skill_provider")]
    pub provider: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields, rename_all = "camelCase")]
pub struct InstallSandboxSkillResource {
    pub sandbox_id: String,
    pub provider: String,
    pub group: String,
    pub name: String,
    pub version: String,
    pub install_path: String,
    pub files: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SkillPackageFile {
    pub path: String,
    pub content: Vec<u8>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SkillPackage {
    pub group: String,
    pub name: String,
    pub version: String,
    pub files: Vec<SkillPackageFile>,
}

#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SkillSearchQuery {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub q: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub page: Option<u32>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<u32>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SkillSearchItem {
    pub group: String,
    pub name: String,
    pub full_name: String,
    #[serde(default)]
    pub description: String,
    #[serde(default)]
    pub latest_version: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub skill_type: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SkillSearchPage {
    pub items: Vec<SkillSearchItem>,
    #[serde(default)]
    pub page: u32,
    #[serde(default)]
    pub limit: u32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub total: Option<u64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_more: Option<bool>,
}

/// Downloads a published skill archive. Implementations live in adapter crates.
#[async_trait]
pub trait SkillHubClient: Send + Sync + Debug {
    async fn download_skill(
        &self,
        group: &str,
        name: &str,
        version: &str,
        user_authorization: &str,
    ) -> Result<SkillPackage>;

    async fn search_skills(
        &self,
        query: &SkillSearchQuery,
        user_authorization: &str,
    ) -> Result<SkillSearchPage>;
}