agent-client-protocol 2.1.0

Core protocol types and traits for the Agent Client Protocol
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

#![cfg(feature = "unstable_session_compaction")]

use agent_client_protocol::JsonRpcMessage;
use agent_client_protocol::schema::v1::{
    AgentNotification, ClientCapabilities, ClientSessionCapabilities, CompactionCapabilities,
    CompactionStatus, CompactionSummaryChunk, CompactionUpdate, ContentBlock, SessionNotification,
    SessionUpdate, TextContent,
};
use serde_json::json;

#[test]
fn v1_compaction_capability_and_updates_pass_through_session_notifications() {
    let capabilities = ClientCapabilities::new()
        .session(ClientSessionCapabilities::new().compaction(CompactionCapabilities::new()));
    assert_eq!(
        serde_json::to_value(capabilities).unwrap()["session"]["compaction"],
        json!({})
    );

    let notification = SessionNotification::new(
        "session-1",
        SessionUpdate::CompactionUpdate(CompactionUpdate::new(
            "compaction-1",
            CompactionStatus::InProgress,
        )),
    );
    let untyped = notification.to_untyped_message().unwrap();
    assert_eq!(untyped.method, "session/update");
    assert_eq!(
        untyped.params["update"],
        json!({
            "sessionUpdate": "compaction_update",
            "compactionId": "compaction-1",
            "status": "in_progress"
        })
    );

    let parsed = AgentNotification::parse_message("session/update", &untyped.params).unwrap();
    assert!(matches!(
        parsed,
        AgentNotification::SessionNotification(SessionNotification {
            update: SessionUpdate::CompactionUpdate(_),
            ..
        })
    ));

    let notification = SessionNotification::new(
        "session-1",
        SessionUpdate::CompactionSummaryChunk(CompactionSummaryChunk::new(
            "compaction-1",
            ContentBlock::Text(TextContent::new("retained context")),
        )),
    );
    let untyped = notification.to_untyped_message().unwrap();
    assert_eq!(
        untyped.params["update"],
        json!({
            "sessionUpdate": "compaction_summary_chunk",
            "compactionId": "compaction-1",
            "content": { "type": "text", "text": "retained context" }
        })
    );
    let parsed = AgentNotification::parse_message("session/update", &untyped.params).unwrap();
    assert!(matches!(
        parsed,
        AgentNotification::SessionNotification(SessionNotification {
            update: SessionUpdate::CompactionSummaryChunk(_),
            ..
        })
    ));
}

#[cfg(feature = "unstable_protocol_v2")]
#[test]
fn draft_v2_compaction_updates_pass_through_session_notifications() {
    use agent_client_protocol::schema::v2;

    let notification = v2::UpdateSessionNotification::new(
        "session-1",
        v2::SessionUpdate::CompactionUpdate(v2::CompactionUpdate::new(
            "compaction-1",
            v2::CompactionStatus::Completed,
        )),
    );
    let untyped = notification.to_untyped_message().unwrap();
    assert_eq!(untyped.method, "session/update");
    assert_eq!(
        untyped.params["update"],
        json!({
            "sessionUpdate": "compaction_update",
            "compactionId": "compaction-1",
            "status": "completed"
        })
    );

    let parsed = v2::AgentNotification::parse_message("session/update", &untyped.params).unwrap();
    let v2::AgentNotification::UpdateSessionNotification(parsed) = parsed else {
        panic!("expected a v2 session update notification");
    };
    assert!(matches!(
        parsed.update,
        v2::SessionUpdate::CompactionUpdate(_)
    ));

    let notification = v2::UpdateSessionNotification::new(
        "session-1",
        v2::SessionUpdate::CompactionSummaryChunk(v2::CompactionSummaryChunk::new(
            "compaction-1",
            v2::ContentBlock::Text(v2::TextContent::new("retained context")),
        )),
    );
    let untyped = notification.to_untyped_message().unwrap();
    assert_eq!(
        untyped.params["update"],
        json!({
            "sessionUpdate": "compaction_summary_chunk",
            "compactionId": "compaction-1",
            "content": { "type": "text", "text": "retained context" }
        })
    );
    let parsed = v2::AgentNotification::parse_message("session/update", &untyped.params).unwrap();
    let v2::AgentNotification::UpdateSessionNotification(parsed) = parsed else {
        panic!("expected a v2 session update notification");
    };
    assert!(matches!(
        parsed.update,
        v2::SessionUpdate::CompactionSummaryChunk(_)
    ));
}