adk-ui 0.8.0

Dynamic UI generation for ADK-Rust agents - render forms, cards, tables, charts and more
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

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_json::Value;

/// Standard envelope protocol marker for render tool outputs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
#[serde(rename_all = "snake_case")]
pub enum ToolEnvelopeProtocol {
    AdkUi,
    A2ui,
    AgUi,
    McpApps,
    #[cfg(feature = "awp")]
    Awp,
}

/// Canonical tool output envelope.
///
/// Payload fields are flattened to preserve backward-compatible response shapes
/// while still attaching protocol metadata.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct ToolEnvelope<P> {
    pub protocol: ToolEnvelopeProtocol,
    pub version: String,
    pub surface_id: String,
    #[serde(flatten)]
    pub payload: P,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub meta: Option<Value>,
    #[cfg(feature = "awp")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub awp_version: Option<String>,
    #[cfg(feature = "awp")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub request_id: Option<String>,
}

impl<P> ToolEnvelope<P> {
    pub fn new(protocol: ToolEnvelopeProtocol, surface_id: impl Into<String>, payload: P) -> Self {
        Self {
            protocol,
            version: "1.0".to_string(),
            surface_id: surface_id.into(),
            payload,
            meta: None,
            #[cfg(feature = "awp")]
            awp_version: None,
            #[cfg(feature = "awp")]
            request_id: None,
        }
    }

    pub fn with_meta(mut self, meta: Option<Value>) -> Self {
        self.meta = meta;
        self
    }
}

#[cfg(feature = "awp")]
impl<P: Serialize> ToolEnvelope<P> {
    /// Set the AWP version on this envelope.
    pub fn with_awp_version(mut self, version: impl Into<String>) -> Self {
        self.awp_version = Some(version.into());
        self
    }

    /// Set the AWP request ID on this envelope.
    pub fn with_request_id(mut self, request_id: impl Into<String>) -> Self {
        self.request_id = Some(request_id.into());
        self
    }

    /// Convert this envelope into an AWP response.
    pub fn to_awp_response(&self) -> Result<awp_types::AwpResponse, crate::compat::AdkError> {
        let payload = serde_json::to_value(&self.payload).map_err(|e| {
            crate::compat::AdkError::tool(format!(
                "Failed to serialize envelope payload for AWP response: {}",
                e
            ))
        })?;
        Ok(awp_types::AwpResponse {
            id: uuid::Uuid::now_v7(),
            version: awp_types::CURRENT_VERSION,
            status: "ok".to_string(),
            payload,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde::Serialize;
    use serde_json::json;

    #[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
    struct Payload {
        value: String,
    }

    #[test]
    fn envelope_serializes_flattened_payload() {
        let envelope = ToolEnvelope::new(
            ToolEnvelopeProtocol::A2ui,
            "main",
            Payload {
                value: "ok".to_string(),
            },
        )
        .with_meta(Some(json!({"trace_id": "abc"})));

        let value = serde_json::to_value(envelope).expect("serialize");
        assert_eq!(value["protocol"], "a2ui");
        assert_eq!(value["surface_id"], "main");
        assert_eq!(value["version"], "1.0");
        assert_eq!(value["value"], "ok");
        assert_eq!(value["meta"]["trace_id"], "abc");
    }
}