-
Notifications
You must be signed in to change notification settings - Fork 222
Expand file tree
/
Copy pathagent.rs
More file actions
6159 lines (5711 loc) · 223 KB
/
agent.rs
File metadata and controls
6159 lines (5711 loc) · 223 KB
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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Methods and notifications the agent handles/receives.
//!
//! This module defines the Agent trait and all associated types for implementing
//! an AI coding agent that follows the Agent Client Protocol (ACP).
use std::{path::PathBuf, sync::Arc};
#[cfg(any(feature = "unstable_auth_methods", feature = "unstable_llm_providers"))]
use std::collections::HashMap;
use derive_more::{Display, From};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_with::{DefaultOnError, VecSkipError, serde_as, skip_serializing_none};
#[cfg(feature = "unstable_llm_providers")]
use crate::RequiredNullable;
use crate::{
ClientCapabilities, ContentBlock, ExtNotification, ExtRequest, ExtResponse, IntoOption, Meta,
ProtocolVersion, SessionId, SkipListener,
};
#[cfg(feature = "unstable_nes")]
use crate::{
AcceptNesNotification, CloseNesRequest, CloseNesResponse, DidChangeDocumentNotification,
DidCloseDocumentNotification, DidFocusDocumentNotification, DidOpenDocumentNotification,
DidSaveDocumentNotification, NesCapabilities, PositionEncodingKind, RejectNesNotification,
StartNesRequest, StartNesResponse, SuggestNesRequest, SuggestNesResponse,
};
#[cfg(feature = "unstable_nes")]
use crate::nes::{
DOCUMENT_DID_CHANGE_METHOD_NAME, DOCUMENT_DID_CLOSE_METHOD_NAME,
DOCUMENT_DID_FOCUS_METHOD_NAME, DOCUMENT_DID_OPEN_METHOD_NAME, DOCUMENT_DID_SAVE_METHOD_NAME,
NES_ACCEPT_METHOD_NAME, NES_CLOSE_METHOD_NAME, NES_REJECT_METHOD_NAME, NES_START_METHOD_NAME,
NES_SUGGEST_METHOD_NAME,
};
// Initialize
/// Request parameters for the initialize method.
///
/// Sent by the client to establish connection and negotiate capabilities.
///
/// See protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)
#[serde_as]
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = INITIALIZE_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct InitializeRequest {
/// The latest protocol version supported by the client.
pub protocol_version: ProtocolVersion,
/// Capabilities supported by the client.
#[serde(default)]
pub client_capabilities: ClientCapabilities,
/// Information about the Client name and version sent to the Agent.
///
/// Note: in future versions of the protocol, this will be required.
#[serde_as(deserialize_as = "DefaultOnError")]
#[serde(default)]
pub client_info: Option<Implementation>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl InitializeRequest {
#[must_use]
pub fn new(protocol_version: ProtocolVersion) -> Self {
Self {
protocol_version,
client_capabilities: ClientCapabilities::default(),
client_info: None,
meta: None,
}
}
/// Capabilities supported by the client.
#[must_use]
pub fn client_capabilities(mut self, client_capabilities: ClientCapabilities) -> Self {
self.client_capabilities = client_capabilities;
self
}
/// Information about the Client name and version sent to the Agent.
#[must_use]
pub fn client_info(mut self, client_info: impl IntoOption<Implementation>) -> Self {
self.client_info = client_info.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// Response to the `initialize` method.
///
/// Contains the negotiated protocol version and agent capabilities.
///
/// See protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)
#[serde_as]
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = INITIALIZE_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct InitializeResponse {
/// The protocol version the client specified if supported by the agent,
/// or the latest protocol version supported by the agent.
///
/// The client should disconnect, if it doesn't support this version.
pub protocol_version: ProtocolVersion,
/// Capabilities supported by the agent.
#[serde(default)]
pub agent_capabilities: AgentCapabilities,
/// Authentication methods supported by the agent.
#[serde_as(deserialize_as = "DefaultOnError<VecSkipError<_, SkipListener>>")]
#[serde(default)]
pub auth_methods: Vec<AuthMethod>,
/// Information about the Agent name and version sent to the Client.
///
/// Note: in future versions of the protocol, this will be required.
#[serde_as(deserialize_as = "DefaultOnError")]
#[serde(default)]
pub agent_info: Option<Implementation>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl InitializeResponse {
#[must_use]
pub fn new(protocol_version: ProtocolVersion) -> Self {
Self {
protocol_version,
agent_capabilities: AgentCapabilities::default(),
auth_methods: vec![],
agent_info: None,
meta: None,
}
}
/// Capabilities supported by the agent.
#[must_use]
pub fn agent_capabilities(mut self, agent_capabilities: AgentCapabilities) -> Self {
self.agent_capabilities = agent_capabilities;
self
}
/// Authentication methods supported by the agent.
#[must_use]
pub fn auth_methods(mut self, auth_methods: Vec<AuthMethod>) -> Self {
self.auth_methods = auth_methods;
self
}
/// Information about the Agent name and version sent to the Client.
#[must_use]
pub fn agent_info(mut self, agent_info: impl IntoOption<Implementation>) -> Self {
self.agent_info = agent_info.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// Metadata about the implementation of the client or agent.
/// Describes the name and version of an MCP implementation, with an optional
/// title for UI representation.
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct Implementation {
/// Intended for programmatic or logical use, but can be used as a display
/// name fallback if title isn’t present.
pub name: String,
/// Intended for UI and end-user contexts — optimized to be human-readable
/// and easily understood.
///
/// If not provided, the name should be used for display.
pub title: Option<String>,
/// Version of the implementation. Can be displayed to the user or used
/// for debugging or metrics purposes. (e.g. "1.0.0").
pub version: String,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl Implementation {
#[must_use]
pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self {
Self {
name: name.into(),
title: None,
version: version.into(),
meta: None,
}
}
/// Intended for UI and end-user contexts — optimized to be human-readable
/// and easily understood.
///
/// If not provided, the name should be used for display.
#[must_use]
pub fn title(mut self, title: impl IntoOption<String>) -> Self {
self.title = title.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
// Authentication
/// Request parameters for the authenticate method.
///
/// Specifies which authentication method to use.
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = AUTHENTICATE_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AuthenticateRequest {
/// The ID of the authentication method to use.
/// Must be one of the methods advertised in the initialize response.
pub method_id: AuthMethodId,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl AuthenticateRequest {
#[must_use]
pub fn new(method_id: impl Into<AuthMethodId>) -> Self {
Self {
method_id: method_id.into(),
meta: None,
}
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// Response to the `authenticate` method.
#[skip_serializing_none]
#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = AUTHENTICATE_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AuthenticateResponse {
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl AuthenticateResponse {
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
// Logout
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Request parameters for the logout method.
///
/// Terminates the current authenticated session.
#[cfg(feature = "unstable_logout")]
#[skip_serializing_none]
#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = LOGOUT_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct LogoutRequest {
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_logout")]
impl LogoutRequest {
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Response to the `logout` method.
#[cfg(feature = "unstable_logout")]
#[skip_serializing_none]
#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = LOGOUT_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct LogoutResponse {
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_logout")]
impl LogoutResponse {
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Authentication-related capabilities supported by the agent.
#[cfg(feature = "unstable_logout")]
#[serde_as]
#[skip_serializing_none]
#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AgentAuthCapabilities {
/// Whether the agent supports the logout method.
///
/// By supplying `{}` it means that the agent supports the logout method.
#[serde_as(deserialize_as = "DefaultOnError")]
#[serde(default)]
pub logout: Option<LogoutCapabilities>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_logout")]
impl AgentAuthCapabilities {
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// Whether the agent supports the logout method.
#[must_use]
pub fn logout(mut self, logout: impl IntoOption<LogoutCapabilities>) -> Self {
self.logout = logout.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Logout capabilities supported by the agent.
///
/// By supplying `{}` it means that the agent supports the logout method.
#[cfg(feature = "unstable_logout")]
#[skip_serializing_none]
#[derive(Default, Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[non_exhaustive]
pub struct LogoutCapabilities {
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_logout")]
impl LogoutCapabilities {
#[must_use]
pub fn new() -> Self {
Self::default()
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq, Hash, Display, From)]
#[serde(transparent)]
#[from(Arc<str>, String, &'static str)]
#[non_exhaustive]
pub struct AuthMethodId(pub Arc<str>);
impl AuthMethodId {
#[must_use]
pub fn new(id: impl Into<Arc<str>>) -> Self {
Self(id.into())
}
}
/// Describes an available authentication method.
///
/// The `type` field acts as the discriminator in the serialized JSON form.
/// When no `type` is present, the method is treated as `agent`.
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(tag = "type", rename_all = "snake_case")]
#[non_exhaustive]
pub enum AuthMethod {
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// User provides a key that the client passes to the agent as an environment variable.
#[cfg(feature = "unstable_auth_methods")]
EnvVar(AuthMethodEnvVar),
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Client runs an interactive terminal for the user to authenticate via a TUI.
#[cfg(feature = "unstable_auth_methods")]
Terminal(AuthMethodTerminal),
/// Agent handles authentication itself.
///
/// This is the default when no `type` is specified.
#[serde(untagged)]
Agent(AuthMethodAgent),
}
impl AuthMethod {
/// The unique identifier for this authentication method.
#[must_use]
pub fn id(&self) -> &AuthMethodId {
match self {
Self::Agent(a) => &a.id,
#[cfg(feature = "unstable_auth_methods")]
Self::EnvVar(e) => &e.id,
#[cfg(feature = "unstable_auth_methods")]
Self::Terminal(t) => &t.id,
}
}
/// The human-readable name of this authentication method.
#[must_use]
pub fn name(&self) -> &str {
match self {
Self::Agent(a) => &a.name,
#[cfg(feature = "unstable_auth_methods")]
Self::EnvVar(e) => &e.name,
#[cfg(feature = "unstable_auth_methods")]
Self::Terminal(t) => &t.name,
}
}
/// Optional description providing more details about this authentication method.
#[must_use]
pub fn description(&self) -> Option<&str> {
match self {
Self::Agent(a) => a.description.as_deref(),
#[cfg(feature = "unstable_auth_methods")]
Self::EnvVar(e) => e.description.as_deref(),
#[cfg(feature = "unstable_auth_methods")]
Self::Terminal(t) => t.description.as_deref(),
}
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(&self) -> Option<&Meta> {
match self {
Self::Agent(a) => a.meta.as_ref(),
#[cfg(feature = "unstable_auth_methods")]
Self::EnvVar(e) => e.meta.as_ref(),
#[cfg(feature = "unstable_auth_methods")]
Self::Terminal(t) => t.meta.as_ref(),
}
}
}
/// Agent handles authentication itself.
///
/// This is the default authentication method type.
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AuthMethodAgent {
/// Unique identifier for this authentication method.
pub id: AuthMethodId,
/// Human-readable name of the authentication method.
pub name: String,
/// Optional description providing more details about this authentication method.
pub description: Option<String>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl AuthMethodAgent {
#[must_use]
pub fn new(id: impl Into<AuthMethodId>, name: impl Into<String>) -> Self {
Self {
id: id.into(),
name: name.into(),
description: None,
meta: None,
}
}
/// Optional description providing more details about this authentication method.
#[must_use]
pub fn description(mut self, description: impl IntoOption<String>) -> Self {
self.description = description.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Environment variable authentication method.
///
/// The user provides credentials that the client passes to the agent as environment variables.
#[cfg(feature = "unstable_auth_methods")]
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AuthMethodEnvVar {
/// Unique identifier for this authentication method.
pub id: AuthMethodId,
/// Human-readable name of the authentication method.
pub name: String,
/// Optional description providing more details about this authentication method.
pub description: Option<String>,
/// The environment variables the client should set.
pub vars: Vec<AuthEnvVar>,
/// Optional link to a page where the user can obtain their credentials.
pub link: Option<String>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_auth_methods")]
impl AuthMethodEnvVar {
#[must_use]
pub fn new(
id: impl Into<AuthMethodId>,
name: impl Into<String>,
vars: Vec<AuthEnvVar>,
) -> Self {
Self {
id: id.into(),
name: name.into(),
description: None,
vars,
link: None,
meta: None,
}
}
/// Optional link to a page where the user can obtain their credentials.
#[must_use]
pub fn link(mut self, link: impl IntoOption<String>) -> Self {
self.link = link.into_option();
self
}
/// Optional description providing more details about this authentication method.
#[must_use]
pub fn description(mut self, description: impl IntoOption<String>) -> Self {
self.description = description.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Describes a single environment variable for an [`AuthMethodEnvVar`] authentication method.
#[cfg(feature = "unstable_auth_methods")]
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AuthEnvVar {
/// The environment variable name (e.g. `"OPENAI_API_KEY"`).
pub name: String,
/// Human-readable label for this variable, displayed in client UI.
pub label: Option<String>,
/// Whether this value is a secret (e.g. API key, token).
/// Clients should use a password-style input for secret vars.
///
/// Defaults to `true`.
#[serde(default = "default_true", skip_serializing_if = "is_true")]
#[schemars(extend("default" = true))]
pub secret: bool,
/// Whether this variable is optional.
///
/// Defaults to `false`.
#[serde(default, skip_serializing_if = "is_false")]
#[schemars(extend("default" = false))]
pub optional: bool,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_auth_methods")]
fn default_true() -> bool {
true
}
#[cfg(feature = "unstable_auth_methods")]
#[expect(clippy::trivially_copy_pass_by_ref)]
fn is_true(v: &bool) -> bool {
*v
}
#[cfg(feature = "unstable_auth_methods")]
#[expect(clippy::trivially_copy_pass_by_ref)]
fn is_false(v: &bool) -> bool {
!*v
}
#[cfg(feature = "unstable_auth_methods")]
impl AuthEnvVar {
/// Creates a new auth env var.
#[must_use]
pub fn new(name: impl Into<String>) -> Self {
Self {
name: name.into(),
label: None,
secret: true,
optional: false,
meta: None,
}
}
/// Human-readable label for this variable, displayed in client UI.
#[must_use]
pub fn label(mut self, label: impl IntoOption<String>) -> Self {
self.label = label.into_option();
self
}
/// Whether this value is a secret (e.g. API key, token).
/// Clients should use a password-style input for secret vars.
#[must_use]
pub fn secret(mut self, secret: bool) -> Self {
self.secret = secret;
self
}
/// Whether this variable is optional.
#[must_use]
pub fn optional(mut self, optional: bool) -> Self {
self.optional = optional;
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Terminal-based authentication method.
///
/// The client runs an interactive terminal for the user to authenticate via a TUI.
#[cfg(feature = "unstable_auth_methods")]
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AuthMethodTerminal {
/// Unique identifier for this authentication method.
pub id: AuthMethodId,
/// Human-readable name of the authentication method.
pub name: String,
/// Optional description providing more details about this authentication method.
pub description: Option<String>,
/// Additional arguments to pass when running the agent binary for terminal auth.
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub args: Vec<String>,
/// Additional environment variables to set when running the agent binary for terminal auth.
#[serde(default, skip_serializing_if = "HashMap::is_empty")]
pub env: HashMap<String, String>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
#[cfg(feature = "unstable_auth_methods")]
impl AuthMethodTerminal {
#[must_use]
pub fn new(id: impl Into<AuthMethodId>, name: impl Into<String>) -> Self {
Self {
id: id.into(),
name: name.into(),
description: None,
args: Vec::new(),
env: HashMap::new(),
meta: None,
}
}
/// Additional arguments to pass when running the agent binary for terminal auth.
#[must_use]
pub fn args(mut self, args: Vec<String>) -> Self {
self.args = args;
self
}
/// Additional environment variables to set when running the agent binary for terminal auth.
#[must_use]
pub fn env(mut self, env: HashMap<String, String>) -> Self {
self.env = env;
self
}
/// Optional description providing more details about this authentication method.
#[must_use]
pub fn description(mut self, description: impl IntoOption<String>) -> Self {
self.description = description.into_option();
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
// New session
/// Request parameters for creating a new session.
///
/// See protocol docs: [Creating a Session](https://agentclientprotocol.com/protocol/session-setup#creating-a-session)
#[skip_serializing_none]
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
#[schemars(extend("x-side" = "agent", "x-method" = SESSION_NEW_METHOD_NAME))]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct NewSessionRequest {
/// The working directory for this session. Must be an absolute path.
pub cwd: PathBuf,
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Additional workspace roots for this session. Each path must be absolute.
///
/// These expand the session's filesystem scope without changing `cwd`, which
/// remains the base for relative paths. When omitted or empty, no
/// additional roots are activated for the new session.
#[cfg(feature = "unstable_session_additional_directories")]
#[serde(default, skip_serializing_if = "Vec::is_empty")]
pub additional_directories: Vec<PathBuf>,
/// List of MCP (Model Context Protocol) servers the agent should connect to.
pub mcp_servers: Vec<McpServer>,
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[serde(rename = "_meta")]
pub meta: Option<Meta>,
}
impl NewSessionRequest {
#[must_use]
pub fn new(cwd: impl Into<PathBuf>) -> Self {
Self {
cwd: cwd.into(),
#[cfg(feature = "unstable_session_additional_directories")]
additional_directories: vec![],
mcp_servers: vec![],
meta: None,
}
}
/// **UNSTABLE**
///
/// This capability is not part of the spec yet, and may be removed or changed at any point.
///
/// Additional workspace roots for this session. Each path must be absolute.
#[cfg(feature = "unstable_session_additional_directories")]
#[must_use]
pub fn additional_directories(mut self, additional_directories: Vec<PathBuf>) -> Self {
self.additional_directories = additional_directories;
self
}
/// List of MCP (Model Context Protocol) servers the agent should connect to.
#[must_use]
pub fn mcp_servers(mut self, mcp_servers: Vec<McpServer>) -> Self {
self.mcp_servers = mcp_servers;
self
}
/// The _meta property is reserved by ACP to allow clients and agents to attach additional
/// metadata to their interactions. Implementations MUST NOT make assumptions about values at
/// these keys.
///
/// See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)
#[must_use]
pub fn meta(mut self, meta: impl IntoOption<Meta>) -> Self {
self.meta = meta.into_option();
self
}
}
/// Response from creating a new session.
///
/// See protocol docs: [Creating a Session](https://agentclientprotocol.com/protocol/session-setup#creating-a-session)
#[serde_as]